autocomplete Operator

Definition

autocomplete

The autocomplete operator performs a search for a word or phrase that contains a sequence of characters from an incomplete input string. The fields that you intend to query with the autocomplete operator must be indexed with the autocomplete data type in the collection's index definition. To learn how to configure your index for autocompletion, see How to Index Fields for Autocompletion.

Sample Use Cases

You can use the autocomplete operator with search-as-you-type applications to predict words with increasing accuracy as characters are entered in your application's search field. autocomplete returns results that contain predicted words based on the tokenization strategy specified in the index definition for autocompletion.

If you want to build suggestions or dropdowns using the MongoDB Search autocomplete operator, we recommend that you query a collection of suggested search terms or use past search terms to populate the dropdown. If you create a separate collection of suggested search terms, you can define synonym mappings in your MongoDB Search index to search your collection for the exact or alternative words.

Syntax

autocomplete has the following syntax:

1
{
2
  $search: {
3
    "index": "<index name>", // optional, defaults to "default"
4
    "autocomplete": {
5
      "query": "<search-string>",
6
      "path": "<field-to-search>",
7
      "tokenOrder": "any|sequential",
8
      "fuzzy": <options>,
9
      "score": <options>
10
    }
11
  }
12
}

Options

Scoring Behavior

By default, the text operator uses the bm25 similarity algorithm to score documents depending on their relevance to the query.

You can change which similarity algorithm is used by specifying a different similarity algorithm in the similarity.type property for the autocomplete fields in your MongoDB Search index definition. To learn how to configure a MongoDB Search index for the autocomplete type, see How to Index String Fields.

To learn more about the supported similarity algorithms, see Score Details.

The autocomplete operator query results that are exact matches receive a lower score than results that aren't exact matches. MongoDB Search can't determine if a query string is an exact match for an indexed text if you specify just the autocomplete-indexed token substrings. To score exact matches higher, try the following workaround:

1. Index the field as both autocomplete and string types.

   MongoDB Search autocomplete boosts exact matches when an autocomplete field is also indexed as a string, thereby increasing the score of exact matches.

2. Query using the compound operator.

For a demonstration of this workaround, see Search Across Multiple Fields.

Examples

1
{
2
  "mappings": {
3
    "dynamic": false,
4
    "fields": {
5
      "title": [
6
        {
7
          "type": "token"
8
        },
9
        {
10
          "type": "string"
11
        },
12
        {
13
          "foldDiacritics": false,
14
          "maxGrams": 7,
15
          "minGrams": 3,
16
          "tokenization": "edgeGram",
17
          "type": "autocomplete"
18
        }
19
      ],
20
      "plot": [
21
        {
22
          "type": "autocomplete",
23
          "tokenization": "edgeGram",
24
          "minGrams": 2,
25
          "maxGrams": 15,
26
          "foldDiacritics": true
27
        }
28
      ]
29
    }
30
  }
31
}

1
{
2
  "mappings": {
3
    "dynamic": false,
4
    "fields": {
5
      "title": [
6
        {
7
          "type": "token"
8
        },
9
        {
10
          "type": "string"
11
        },
12
        {
13
          "foldDiacritics": false,
14
          "maxGrams": 7,
15
          "minGrams": 3,
16
          "tokenization": "rightEdgeGram",
17
          "type": "autocomplete"
18
        }
19
      ],
20
      "plot": [
21
        {
22
          "type": "autocomplete",
23
          "tokenization": "rightEdgeGram",
24
          "minGrams": 2,
25
          "maxGrams": 15,
26
          "foldDiacritics": true
27
        }
28
      ]
29
    }
30
  }
31
}

1
{
2
  "mappings": {
3
    "dynamic": false,
4
    "fields": {
5
      "title": [
6
        {
7
          "type": "token"
8
        },
9
        {
10
          "type": "string"
11
        },
12
        {
13
          "foldDiacritics": false,
14
          "maxGrams": 7,
15
          "minGrams": 3,
16
          "tokenization": "nGram",
17
          "type": "autocomplete"
18
        }
19
      ],
20
      "plot": [
21
        {
22
          "type": "autocomplete",
23
          "tokenization": "nGram",
24
          "minGrams": 2,
25
          "maxGrams": 15,
26
          "foldDiacritics": true
27
        }
28
      ]
29
    }
30
  }
31
}

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "title": [
      {
        "type": "token"
      },
      {
         "type": "string"
      },
      {
        "foldDiacritics": true,
        "maxGrams": 7,
        "minGrams": 3,
        "analyzer": "lucene.keyword",
        "tokenization": "edgeGram",
        "type": "autocomplete"
      }]
    }
  }
}

Learn More

To learn more, see How to Run Autocomplete and Partial Match MongoDB Search Queries.