Skip to content

DOCSP-48252: autocomplete index link/note #586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 11, 2025
Merged

DOCSP-48252: autocomplete index link/note #586

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ede1e25
DOCSP-48252: autocomplete index link/note
rustagir Apr 10, 2025
ed0c07f
SA small fix
rustagir Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions source/fundamentals/atlas-search.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,18 +88,24 @@ Autocomplete
Use the ``Autocomplete()`` method to search for a word or phrase that contains a
sequence of characters from an incomplete input string.

The following example performs an autocomplete search on the ``guitars``
collection using the string "Gib" in the ``make`` field.
The following example performs an autocomplete query on the ``make``
field for text that starts with the string ``"Gib"``.

.. literalinclude:: /includes/fundamentals/code-examples/atlas-search/AtlasSearchExamples.cs
:start-after: // start-autocomplete-search
:end-before: // end-autocomplete-search
:language: csharp
:dedent:

.. note::
.. note:: Index for Autocomplete Queries

If the field you are searching on is indexed by a search index, you must pass the index name to the ``Autocomplete`` call. If a search index does not exist, the default index is used.
You must create an Atlas Search index that supports autocompletion
to successfully perform autocomplete queries. To learn more, see
:atlas:`How to Index Fields for Autocompletion </atlas-search/field-types/autocomplete-type/>`
in the Atlas documentation.

After you create the Atlas Search index, you must pass the index name to
the ``Autocomplete()`` method, as shown in the preceding code.

The search returns the following document:

Expand Down
Loading