Custom Analyzers

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

Custom Analyzers

Overview

A MongoDB Search analyzer prepares a set of documents to be indexed by performing a series of operations to transform, filter, and group sequences of characters. You can define a custom analyzer to suit your specific indexing needs from the Atlas UI.

A custom MongoDB Search analyzer is made up of a [tokenizer](https://www.mongodb.com/docs/search/indexes/analyzers/tokenizers.md#std-label-tokenizers-ref, an optional list of [character filters](https://www.mongodb.com/docs/search/indexes/analyzers/character-filters.md#std-label-character-filters, and an optional list of [token filters](https://www.mongodb.com/docs/search/indexes/analyzers/token-filters.md#std-label-token-filters-ref. When MongoDB Search analyzes text with a custom analyzer, the text passes through the character filters first, then the tokenizer, and then the token filters.

Syntax

A custom analyzer has the following syntax:

"analyzers": [
  {
    "name": "<name>",
    "charFilters": [ <list-of-character-filters> ],
    "tokenizer": {
      "type": "<tokenizer-type>"
    },
    "tokenFilters": [ <list-of-token-filters> ]
  }
]

Attributes

A custom analyzer has the following attributes:

Built-in Custom Analyzer Templates

The Atlas UI Visual Editor includes the option to choose between the following common-use templates to help you get started with building your custom analyzer:

• Email Parser - Use this to tokenize email addresses up to 200 characters using the [uaxUrlEmail](https://www.mongodb.com/docs/search/indexes/analyzers/tokenizers.md#std-label-uaxUrlEmail-tokenizer-ref tokenizer. For example, you can apply this analyzer on the page_updated_by.email field in the [Example Collection.](https://www.mongodb.com/docs/search/indexes/analyzers/custom.md#std-label-custom-analyzers-eg-coll

• Phone Numbers - Use this to create a single token from a US-formatted phone number using the [regexCaptureGroup](https://www.mongodb.com/docs/search/indexes/analyzers/tokenizers.md#std-label-regexCaptureGroup-tokenizer-ref tokenizer. For example, you can apply this analyzer on the page_updated_by.phone field in the [Example Collection.](https://www.mongodb.com/docs/search/indexes/analyzers/custom.md#std-label-custom-analyzers-eg-coll

• Dash-Separated IDs - Use this to create tokens from hyphen-delimited text using the [regexSplit](https://www.mongodb.com/docs/search/indexes/analyzers/tokenizers.md#std-label-regexSplit-tokenizer-ref tokenizer. For example, you can apply this analyzer on the message field in the [Example Collection.](https://www.mongodb.com/docs/search/indexes/analyzers/custom.md#std-label-custom-analyzers-eg-coll

You can use these built-in custom analyzers or create your own custom analyzer using the MongoDB Search Visual Editor or JSON (Javascript Object Notation) Editor.

Example Collection

The [Character Filters](https://www.mongodb.com/docs/search/indexes/analyzers/character-filters.md#std-label-character-filters, [Tokenizers for Custom Search Analyzers](https://www.mongodb.com/docs/search/indexes/analyzers/tokenizers.md#std-label-tokenizers-ref, and [Token Filters for Custom Analyzers](https://www.mongodb.com/docs/search/indexes/analyzers/token-filters.md#std-label-token-filters-ref pages contain sample index definitions and query examples for character filters, tokenizers, and token filters. These examples use a sample minutes collection with the following documents:

{
  "_id": 1,
  "page_updated_by": {
    "last_name": "AUERBACH",
    "first_name": "Siân",
    "email": "auerbach@example.com",
    "phone": "(123)-456-7890"
  },
  "title": "The team's weekly meeting",
  "message": "try to siGn-In",
  "text": {
    "en_US": "<head> This page deals with department meetings.</head>",
    "sv_FI": "Den här sidan behandlar avdelningsmöten",
    "fr_CA": "Cette page traite des réunions de département"
  }
}

{
  "_id": 2,
  "page_updated_by": {
    "last_name": "OHRBACH",
    "first_name": "Noël",
    "email": "ohrbach@example.com",
    "phone": "(123) 456 0987"
  },
  "title": "The check-in with sales team",
  "message": "do not forget to SIGN-IN. See ① for details.",
  "text" : {
    "en_US": "The head of the sales department spoke first.",
    "fa_IR": "ابتدا رئیس بخش فروش صحبت کرد",
    "sv_FI": "Först talade chefen för försäljningsavdelningen"
  }
}

{
  "_id": 3,
  "page_updated_by": {
    "last_name": "LEWINSKY",
    "first_name": "Brièle",
    "email": "lewinsky@example.com",
    "phone": "(123).456.9870"
  },
  "title": "The regular board meeting",
  "message": "try to sign-in",
  "text" : {
    "en_US": "<body>We'll head out to the conference room by noon.</body>"
  }
}

{
  "_id": 4,
  "page_updated_by": {
    "last_name": "LEVINSKI",
    "first_name": "François",
    "email": "levinski@example.com",
    "phone": "123-456-8907"
  },
  "title": "The daily huddle on tHe StandUpApp2",
  "message": "write down your signature or phone №",
  "text" : {
    "en_US": "<body>This page has been updated with the items on the agenda.</body>" ,
    "es_MX": "La página ha sido actualizada con los puntos de la agenda.",
    "pl_PL": "Strona została zaktualizowana o punkty porządku obrad."
  }
}

Learn More

To learn more about creating your own custom analyzers, see the following reference pages:

• [Character Filters](https://www.mongodb.com/docs/search/indexes/analyzers/character-filters.md#std-label-char-filters-ref

• [Tokenizers for Custom Search Analyzers](https://www.mongodb.com/docs/search/indexes/analyzers/tokenizers.md#std-label-tokenizers-ref

• [Token Filters for Custom Analyzers](https://www.mongodb.com/docs/search/indexes/analyzers/token-filters.md#std-label-token-filters-ref

Note:

When you add a custom analyzer using the Visual Editor in the Atlas UI, the Atlas UI displays the following details about the analyzer in the Custom Analyzers section.