DOCSP-48422: search index type #170
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-rust ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rustagir
requested review from
a team and
abr-egn
and removed request for
a team
mongoKart
requested changes
Mar 19, 2025
|
|
||
| Before you can perform Atlas Vector Search queries, you must create an | ||
| Atlas Vector Search index on your collection. To learn more about | ||
| creating this index type, see the :ref:`rust-atlas-search-indexes` guide. |
There was a problem hiding this comment.
S:
Suggested change
| creating this index type, see the :ref:`rust-atlas-search-indexes` guide. | |
| creating this index, see the :ref:`rust-atlas-search-indexes` guide. |
Comment on lines
33
to
34
| Atlas Search and Vector Search indexes specify which fields to index, | ||
| how these fields are indexed, and can set other optional configurations. |
There was a problem hiding this comment.
to keep a parallel structure, either the third item should inherit the verb 'specify', like the second item does, or the second item should supply its own verb
Suggested change
| Atlas Search and Vector Search indexes specify which fields to index, | |
| how these fields are indexed, and can set other optional configurations. | |
| Atlas Search and Vector Search indexes specify which fields to index, | |
| specify how these fields are indexed, and can set other optional configurations. |
| database, which is one of the Atlas sample datasets. For instructions on importing | ||
| the Atlas sample data, see :atlas:`Load Sample Data </sample-data>` in the Atlas | ||
| documentation. | ||
| The examples in this guide access the ``embedded_movies`` collection |
There was a problem hiding this comment.
S: i think we say 'use' elsewhere. feels simpler, but not a big deal
Suggested change
| The examples in this guide access the ``embedded_movies`` collection | |
| The examples in this guide use the ``embedded_movies`` collection |
| .. tip:: Atlas Search Field Mappings | ||
| * - ``definition()`` | ||
| - ``Document`` | ||
| - Specifies the index definition. If you exclude this setting, the |
There was a problem hiding this comment.
s:
Suggested change
| - Specifies the index definition. If you exclude this setting, the | |
| - Specifies the index definition. If you omit this setting, the |
applies throughout
| The following example creates specifications for a index named ``example_index`` in a | ||
| ``SearchIndexModel`` instance. The code sets a static mapping to index only the ``body`` | ||
| and ``date`` fields: | ||
| The following example creates specifications for a index named ``search_idx`` in a |
There was a problem hiding this comment.
Suggested change
| The following example creates specifications for a index named ``search_idx`` in a | |
| The following example creates specifications for an index named ``search_idx`` in a |
Comment on lines
104
to
105
| The following example creates specifications for a index named ``search_idx`` in a | ||
| ``SearchIndexModel`` instance. The code sets a static mapping to index only the ``title`` |
There was a problem hiding this comment.
s: maybe ambiguous about the index being created in the instance instead of via it
Suggested change
| The following example creates specifications for a index named ``search_idx`` in a | |
| ``SearchIndexModel`` instance. The code sets a static mapping to index only the ``title`` | |
| The following example uses a ``SearchIndexModel`` instance to create | |
| specifications for a index named ``search_idx``. The code sets a static | |
| mapping to index only the ``title`` |
Comment on lines
114
to
115
| The following example creates specifications for a index named ``vs_idx`` in a | ||
| ``SearchIndexModel`` instance. The code specifies the embedding path as |
There was a problem hiding this comment.
Suggested change
| The following example creates specifications for a index named ``vs_idx`` in a | |
| ``SearchIndexModel`` instance. The code specifies the embedding path as | |
| The following example uses a ``SearchIndexModel`` instance to create specifications | |
| for a index named ``vs_idx``. The code specifies the embedding path as |
| :language: rust | ||
| :dedent: | ||
|
|
||
| The following example creates specifications for a index named ``vs_idx`` in a |
There was a problem hiding this comment.
Suggested change
| The following example creates specifications for a index named ``vs_idx`` in a | |
| The following example creates specifications for an index named ``vs_idx`` in a |
| The following example creates two Atlas Search indexes named ``dynamic_index`` and | ||
| ``static_index`` on the ``posts`` collection. The code creates ``SearchIndexModel`` | ||
| The following example creates an Atlas Search and a Vector Search index | ||
| on the ``embedded_movies`` collection. The code creates ``SearchIndexModel`` |
There was a problem hiding this comment.
S: clarify one instance per index and remove ambiguity
(suggestion spans the next line too): "For each index, the code creates a SearchIndexModel instance that specifies the index name and definition."
There was a problem hiding this comment.
changing to a list of tasks
| The following example accesses information about the Atlas Search and | ||
| Vector Search indexes created in the :ref:`rust-create-search-indexes` | ||
| section of this page. The code calls the ``list_search_indexes()`` | ||
| method and outputs all the Search indexes on the collection: |
There was a problem hiding this comment.
Q: i assume this means 'all the Atlas/Vector Search indexes'. if so, probably worth specifying since there are other types of indexes that are used for searching, and i don't think enough people will catch the use of capital S in Search
mongoKart
approved these changes
Mar 21, 2025
| ``SearchIndexModel`` instance. The code sets a static mapping to index only the ``title`` | ||
| and ``released`` fields: | ||
| The following example creates a ``SearchIndexModel`` instance to provide | ||
| specifications for a index named ``search_idx``. The code specifies static |
There was a problem hiding this comment.
Suggested change
| specifications for a index named ``search_idx``. The code specifies static | |
| specifications for an index named ``search_idx``. The code specifies static |
| ``plot_embedding``, indexes ``1536`` dimensions, and uses the ``"euclidean"`` | ||
| vector similarity function. | ||
| The following example creates a ``SearchIndexModel`` instance to provide | ||
| specifications for a index named ``vs_idx``. The code specifies the |
There was a problem hiding this comment.
Suggested change
| specifications for a index named ``vs_idx``. The code specifies the | |
| specifications for an index named ``vs_idx``. The code specifies the |
rustagir
added a commit
that referenced
this pull request
Mar 24, 2025
(cherry picked from commit ba2f297)
rustagir
added a commit
that referenced
this pull request
Mar 24, 2025
(cherry picked from commit ba2f297)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-48422
Staging -
Self-Review Checklist