This tutorial describes how to create an Atlas Search index that enables
autocomplete queries. In the following examples, the index enables
autocomplete operators to query the specified field values.
Both examples take you through the following steps:
Set up an Atlas Search index with autocomplete data type for the
Run Atlas Search queries against the specified fields in the
sample_mflix.moviescollection for an inputted sequence of characters.
Before you begin, ensure that your Atlas cluster meets the requirements described in the Prerequisites.
To create an Atlas Search index, you must have
Project Data Access Admin or higher access to the project.
You can use the Atlas Search
autocomplete type to index text values in
string fields for autocompletion. You can configure an
type to satisfy a variety of use cases. To learn more about the
configuration options available for the
autocomplete type, such as
tokenization strategy and diacritic folding, see
autocomplete Field Properties. You can query fields
autocomplete type only using the autocomplete
In this section, you will create an Atlas Search index that indexes the
plot fields for autocompletion using the
edgeGram tokenization strategy.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
Click your cluster's name.
Click the Atlas Search tab.
In the Index Name field, enter
If you name your index
default, you don't need to specify an
indexparameter when using the $search pipeline stage. Otherwise, you must specify the index name using the
In the Database and Collection section, find the
sample_mflixdatabase, and select the
➤ Use the Select your language drop-down menu to set the language of the example on this page.
The autocomplete operator performs a search
for a word or phrase that contains a sequence of characters from an
incomplete input string. 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
autocomplete returns results that contain predicted words
based on the tokenization strategy specified in the index definition
for autocompletion. 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.
Atlas Search might return inaccurate results for queries with more than three words in a single string.