DOCSP-45048 - Vector search params #517
Conversation
✅ Deploy Preview for docs-csharp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| **Default**: ``null`` | ||
|
|
||
| * - ``IndexName`` | ||
| - The index to perform the vector search on. |
There was a problem hiding this comment.
Question for tech reviewer: What index is used if this param is empty?
There was a problem hiding this comment.
It defaults to "default".
| * - ``queryVector`` | ||
| - The encoded vector that will be matched with values from the database. | ||
| Although the data type of this parameter is ``QueryVector``, you can also pass an | ||
| array of floating-point numbers. |
There was a problem hiding this comment.
| array of floating-point numbers. | |
| array of ``float`` numbers |
S: Helpful to say the data type explicitly.
mongoKart
requested review from
a team and
JamesKovacs
and removed request for
a team
source/fundamentals/builders.txt
Outdated
| perform the following operations: | ||
|
|
||
| - Performs a vector search on the Atlas Vector Search index of the ``plot_embedding`` field using vector embeddings for the string ``"time travel"`` | ||
| - Performs a vector search on the Atlas Vector Search index of the ``plot_embedding`` |
There was a problem hiding this comment.
It might be misleading to use plot_embedding here and m => m.Embedding in the code.
Maybe worth adding the EmbeddedMovie model for clarity.
| **Default**: ``null`` | ||
|
|
||
| * - ``IndexName`` | ||
| - The index to perform the vector search on. |
There was a problem hiding this comment.
It defaults to "default".
| - The index to perform the vector search on. | ||
|
|
||
| | **Data type**: {+string-data-type+} | ||
| | **Default**: ``"default"`` |
There was a problem hiding this comment.
Sorry I wasn't entirely clear:
The default value for the property is null (default "default" might mean that the actual value is "default" if unchanged).
When IndexName == null, "default" is sent to the server.
There was a problem hiding this comment.
makes sense. Do you know which index this search is run on if one isn't specified?
There was a problem hiding this comment.
I don't remember what exactly happens when the string "default" is sent to the server.
Maybe the default index on the server is called "default".
source/fundamentals/linq.txt
Outdated
|
|
||
| The following example shows how to generate a ``$vectorSearch`` stage to search | ||
| the ``plot_embedding`` field using vector embeddings for the string ``"time travel"``: | ||
| the ``plot_embedding`` field by using vector embeddings for the string ``"time travel"``: |
There was a problem hiding this comment.
minor: consider having the same wording as in builders for consistency:
Perform a vector search on the Atlas Vector Search index of the plot_embedding field using vector embeddings for the string "time travel"
Fetch the Title and Plot fields from documents found in the vector search
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d) Co-authored-by: Mike Woofter <[email protected]>
(cherry picked from commit 78c9a0d) Co-authored-by: Mike Woofter <[email protected]>
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d)
(cherry picked from commit 78c9a0d)
3 participants
Exactproperty will be backported only back to v3.1.Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45048
Staging Links
Self-Review Checklist