-
Couldn't load subscription status.
- Fork 81
DOCSP-48357-incorrect-vs-type #741
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.
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
amalhotra-mdb
merged 4 commits into
mongodb:master
from
amalhotra-mdb:DOCSP-48357-incorrect-vs-type
Apr 17, 2025
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -54,59 +54,8 @@ Steps | |||||||||
| .. step:: Provide the Atlas Vector Search Index configurations | ||||||||||
|
|
||||||||||
| You must initially provide the following default vector search index | ||||||||||
| configurations. You can modify the configurations later. | ||||||||||
|
|
||||||||||
| .. list-table:: | ||||||||||
| :header-rows: 1 | ||||||||||
| :widths: 20 10 70 | ||||||||||
|
|
||||||||||
| * - Field | ||||||||||
| - Type | ||||||||||
| - Description | ||||||||||
|
|
||||||||||
| * - ``type`` | ||||||||||
| - string | ||||||||||
| - Human-readable label that identifies the type of index. The value must | ||||||||||
| be ``vector`` to perform a vector search against the indexed fields. If | ||||||||||
| omitted, it defaults to ``search``, which only supports full-text search. | ||||||||||
|
|
||||||||||
| * - ``path`` | ||||||||||
| - string | ||||||||||
| - The field name to index. | ||||||||||
|
|
||||||||||
| * - ``numDimensions`` | ||||||||||
| - int | ||||||||||
| - The number of vector dimensions, which Atlas Search enforces at index- and | ||||||||||
| query-time. This value can't be greater than 4096. | ||||||||||
|
|
||||||||||
| * - ``similarity`` | ||||||||||
| - string | ||||||||||
| - The vector similarity function used to search for the top K-nearest neighbors. | ||||||||||
| Select from the following functions: | ||||||||||
|
|
||||||||||
| .. list-table:: | ||||||||||
| :header-rows: 1 | ||||||||||
| :widths: 50 50 | ||||||||||
|
|
||||||||||
| * - Function | ||||||||||
| - Description | ||||||||||
|
|
||||||||||
| * - ``euclidean`` | ||||||||||
| - A function that measures the distance between ends of vectors. This function | ||||||||||
| allows you to measure similarity based on varying dimensions. | ||||||||||
|
|
||||||||||
| * - ``cosine`` | ||||||||||
| - A function that measures similarity based on the angle between vectors. This | ||||||||||
| function allows you to measure similarity that isn't scaled by magnitude. | ||||||||||
|
|
||||||||||
| You can't use zero magnitude vectors with cosine. To measure cosine similarity, | ||||||||||
| we recommend that you normalize your vectors and use dotProduct instead. | ||||||||||
|
|
||||||||||
| * - ``dotProduct`` | ||||||||||
| - A function that measures similarly to cosine, but takes into account the | ||||||||||
| magnitude of the vector. This function allows you to efficiently measure | ||||||||||
| similarity based on both angle and magnitude. To use dotProduct, you must | ||||||||||
| normalize the vector to unit length at index- and query-time. | ||||||||||
| configurations. You can modify the configurations later. To learn more, | ||||||||||
| see :ref:`avs-types-vector-search-options`. | ||||||||||
|
||||||||||
| configurations. You can modify the configurations later. To learn more, | |
| see :ref:`avs-types-vector-search-options`. | |
| configurations. You can modify the configurations later. For more information on required fields | |
| in vector search index configurations, see :ref:`avs-types-vector-search-options`. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first sentence in this paragraph mentions "the following". Can we update the wording here to something like:
You must provide all required fields for your vector search index configuration.