DOCSP-48385 Make Atlas Vector Search page #1042

shuangela · 2025-03-20T15:58:54Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-48385
Staging - https://deploy-preview-1042--docs-node.netlify.app/atlas-vector-search/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2025-03-20T15:59:16Z

✅ Deploy Preview for docs-node ready!

Name	Link
🔨 Latest commit	`3e491d9`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-node/deploys/67e4353054bc8200088f971e
😎 Deploy Preview	https://deploy-preview-1042--docs-node.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

lindseymoore

Great start! Suggested a few revisions

lindseymoore · 2025-03-20T19:40:49Z

source/atlas-vector-search.txt

+</atlas-vector-search/vector-search-overview/>` feature
+in the {+driver-short+}. 
+
+You can use {+vector-search+} to perform vector search on your data stored in


Suggested change

You can use {+vector-search+} to perform vector search on your data stored in

You can use {+vector-search+} to perform a vector search on your data stored in

lindseymoore · 2025-03-20T19:42:43Z

source/atlas-vector-search.txt

+.. _node-atlas-vector-search:
+
+===================
+Atlas Vector Search


Suggested change

Atlas Vector Search

Run an Atlas Vector Search Query

S: Too make the title a bit more descriptive

I'm leaning towards keeping the title the same for consistency: this page is the one after the Atlas Search page already merged in: 9e31836 which is just called Atlas Search, and in our other docs that have avs pages they are all just titled atlas vector search https://www.mongodb.com/docs/drivers/kotlin/coroutine/current/fundamentals/builders/vector-search/, https://www.mongodb.com/docs/drivers/csharp/current/fundamentals/atlas-vector-search/

Titles should be between 30-60 characters (maintenance wiki). I'm going to add a check to the PR Checklist next week to make sure we check for title length!
Also, this page aligns with the content on the "Run Vector Search Queries" page of the Atlas docs, so I think it makes sense to have a similar title. Let me know what you think!

Ok, sounds good, I'm good with following the title guidelines!

lindseymoore · 2025-03-20T19:52:30Z

source/atlas-vector-search.txt

+You can use {+vector-search+} to perform vector search on your data stored in
+Atlas. Vector search allows you to query your data based on semantic meaning
+rather than just keyword matches, which helps you retrieve more relevant search
+results. It enables your AI-powered applications to support use cases such as
+semantic search, hybrid search, and generative search, including
+Retrieval-Augmented Generation (RAG).
+
+By using Atlas as a vector database, you can seamlessly index vector data along
+with your other data in Atlas. This allows you to filter on fields in your
+collection and perform vector search queries against vector data. You can also
+combine vector search with full-text search queries to return the most relevant
+results for your use case. You can integrate {+vector-search+} with popular AI
+frameworks and services to implement vector search in your applications.


S: I would include only one paragraph of background text. The link to the Atlas Vector Search will be useful for those who want to learn more. I would keep the first paragraph and remove the 2nd paragraph entirely, or integrate some of the content from the 2nd paragraph into the first if you think necessary.

lindseymoore · 2025-03-20T19:55:26Z

source/atlas-vector-search.txt

+:atlas:`How to Index Vector Embeddings for Vector Search
+</atlas-search/field-types/knn-vector/>` in the Atlas documentation.


I: It seems like this page has deprecated info now. This is the relevant embedding page for Atlas Vector Search: https://www.mongodb.com/docs/atlas/atlas-vector-search/create-embeddings/

lindseymoore · 2025-03-20T20:00:09Z

source/atlas-vector-search.txt

+
+To use this feature, you must create a vector search index and index your
+vector embeddings. To learn about how to programmatically create a
+vector search index, see the :ref:`node-indexes` section in the


I: There is currently no documentation for creating AVS indexes in the Node.js docs on the linked page. Something like this section in the Go docs should be created: https://www.mongodb.com/docs/drivers/go/current/fundamentals/indexes/#atlas-search-and-atlas-vector-search-indexes.
You can add it as part of this ticket or create another ticket in the CC epic if it is more convenient (I normally lean towards creating another ticket)!

If you choose to create another ticket for adding the section to the indexes page, I would link to this section on creating AVS indexes in the Atlas docs: https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-type/#create-an-atlas-vector-search-index

I'll create a new ticket!

You can drop a link here when you do!

https://jira.mongodb.org/browse/DOCSP-48608

lindseymoore · 2025-03-20T21:02:21Z

source/includes/aggregation/atlas-vector-search-example.js

@@ -0,0 +1,49 @@
+const { MongoClient } = require("mongodb");
+
+// connect to your Atlas cluster


Suggested change

// connect to your Atlas cluster

// Replace with the connection string to your Atlas cluster to connect

lindseymoore · 2025-03-20T21:02:39Z

source/includes/aggregation/atlas-vector-search-example.js

+              }
+            }
+          ];
+        // run pipeline


Suggested change

// run pipeline

// Runs the pipeline

lindseymoore · 2025-03-20T21:02:49Z

source/includes/aggregation/atlas-vector-search-example.js

+        // run pipeline
+        const result = coll.aggregate(agg);
+
+        // print results


Suggested change

// print results

// Prints results

lindseymoore · 2025-03-20T21:03:28Z

source/includes/aggregation/atlas-vector-search-example.js

+    try {
+        await client.connect();
+
+        // set namespace


Suggested change

// set namespace

// Sets the namespace

lindseymoore · 2025-03-20T21:03:38Z

source/includes/aggregation/atlas-vector-search-example.js

+        const database = client.db("sample_mflix");
+        const coll = database.collection("embedded_movies");
+
+        // define pipeline


Suggested change

// define pipeline

// Defines the pipeline

lindseymoore

Great job revising! A few more small changes

lindseymoore · 2025-03-21T21:07:52Z

source/atlas-vector-search.txt

+.. _node-atlas-vector-search:
+
+===================
+Atlas Vector Search


Titles should be between 30-60 characters (maintenance wiki). I'm going to add a check to the PR Checklist next week to make sure we check for title length!
Also, this page aligns with the content on the "Run Vector Search Queries" page of the Atlas docs, so I think it makes sense to have a similar title. Let me know what you think!

lindseymoore · 2025-03-21T21:12:40Z

source/atlas-vector-search.txt

+following section.
+
+Sample Data
+-----------


Suggested change

-----------

~~~~~~~~~~~

Should be a subheading

lindseymoore · 2025-03-21T21:14:26Z

source/atlas-vector-search.txt

+search on a collection, you must first have a collection with a field that contains
+vector embeddings and a vector search index that covers that field. 
+
+The aggregation pipeline searches  the ``plot``  field of each document in the collection


Suggested change

The aggregation pipeline searches the ``plot`` field of each document in the collection

In the following example, the aggregation pipeline searches the ``plot`` field of each document in the collection

lindseymoore · 2025-03-21T21:21:26Z

source/atlas-vector-search.txt

+- Search for the specified term in the ``plot_embedding`` field
+
+- Set the number of nearest neighbors used in the search to 150 by using the ``numCandidates`` option
+


Suggested change

- Return 10 documents by using the ``limit`` option

S: Add a description of what limit does

lindseymoore · 2025-03-21T21:22:09Z

source/atlas-vector-search.txt

+
+It uses the ``$project`` stage to:
+
+- Only include the movie ``plot`` and ``title`` fields in the results.


Suggested change

- Only include the movie ``plot`` and ``title`` fields in the results.

- Only include the movie ``plot`` and ``title`` fields in the results

S: Be consistent with period use. I would consider these fragments, so it doesn't need a period.

lindseymoore · 2025-03-21T21:22:22Z

source/atlas-vector-search.txt

+
+- Only include the movie ``plot`` and ``title`` fields in the results.
+
+- Add a ``score`` field to show the relevance of each result to the search term.


Suggested change

- Add a ``score`` field to show the relevance of each result to the search term.

- Add a ``score`` field to show the relevance of each result to the search term

Same as above

lindseymoore · 2025-03-21T21:31:00Z

source/atlas-vector-search.txt

+To find more tutorials on using the {+driver-short+} to perform Atlas
+Vector Searches, see the :atlas:`Atlas Vector Search tutorials </atlas-vector-search/tutorials/>` 


Suggested change

To find more tutorials on using the {+driver-short+} to perform Atlas

Vector Searches, see the :atlas:`Atlas Vector Search tutorials </atlas-vector-search/tutorials/>`

To find more Atlas Vector Search tutorials for the {+driver-short+}, see the :atlas:`Atlas Vector Search Tutorials </atlas-vector-search/tutorials/>`

S: Reword and capitalize tutorials

lindseymoore · 2025-03-21T21:31:57Z

source/atlas-vector-search.txt

+Vector Searches, see the :atlas:`Atlas Vector Search tutorials </atlas-vector-search/tutorials/>` 
+in the Atlas documentation.
+
+To learn more about Atlas Vector Search, see :atlas:`Atlas Vector Search </atlas-vector-search/>`


Suggested change

To learn more about Atlas Vector Search, see :atlas:`Atlas Vector Search </atlas-vector-search/>`

To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector Search </atlas-vector-search/>` guides

lindseymoore · 2025-03-21T21:34:59Z

source/atlas-vector-search.txt

+To learn more about the ``aggregate()`` method, see the
+`API documentation <{+api+}/classes/Collection.html#aggregate>`__.


Suggested change

To learn more about the ``aggregate()`` method, see the

`API documentation <{+api+}/classes/Collection.html#aggregate>`__.

To learn more about the ``aggregate()`` method, see `aggregate() <{+api+}/classes/Collection.html#aggregate>`__ in the API documentation.

S: Be specific in your hypertext links

lindseymoore

Small fixes, otherwise LGTM! Let me know if you'd like another look

lindseymoore · 2025-03-25T17:31:06Z

source/atlas-vector-search.txt

+
+After you create a vector search index on your vector embeddings, you
+can reference this index in your pipeline stage, as shown in the
+following section.


Suggested change

following section.

following example.

Since Sample Data is now the next section

lindseymoore · 2025-03-25T17:38:21Z

source/atlas-vector-search.txt

+~~~~~~~~~~~
+
+The example on this page shows how to build an aggregation pipeline that uses the
+``$vectorSearch`` stage to perform an exact vector search on the


Suggested change

``$vectorSearch`` stage to perform an exact vector search on the

``$vectorSearch`` stage to perform a vector search on the

The example is an ANN rather than an ENN search. Here's the documentation: https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/#fields
I think it makes sense to mention the type of search at the bottom rather than here, so I'll leave a comment in the search specs!

lindseymoore · 2025-03-25T17:39:09Z

source/atlas-vector-search.txt

+To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector Search </atlas-vector-search/>`
+guides in the Atlas documentation.


Suggested change

To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector Search </atlas-vector-search/>`

guides in the Atlas documentation.

To learn more about the syntax of the ``$vectorSearch`` pipeline stage,

see the Syntax and Fields sections of the

:atlas:`Create and Run Queries </atlas-vector-search/vector-search-stage/#syntax>`

guide in the Atlas Vector Search section of the MongoDB Atlas documentation.

I would remove the link to the general AVS docs since there is already one above and add this link for the syntax documentation instead

lindseymoore · 2025-03-25T17:40:07Z

source/includes/aggregation/atlas-vector-search-example.js

+    try {
+        await client.connect();
+
+        // Set the namespace


Suggested change

// Set the namespace

// Sets the namespace

lindseymoore · 2025-03-25T17:42:32Z

source/atlas-vector-search.txt

+      '{"plot":"A dimension-traveling wizard gets stuck in the 21st century because cell-phone radiation interferes with his magic. With his home world on the brink of war, he seeks help from a jaded ...","title":"The Portal","score":0.7640786170959473}'
+
+This query uses the ``$vectorSearch`` stage to:
+


Suggested change

- Perform an Approximate Nearest Neighbor (ANN) vector search

Include the type of search

lindseymoore · 2025-03-25T17:45:05Z

source/atlas-vector-search.txt

+In this guide, you can learn how to use the :atlas:`Atlas Vector Search
+</atlas-vector-search/vector-search-overview/>` feature


Suggested change

In this guide, you can learn how to use the :atlas:`Atlas Vector Search

</atlas-vector-search/vector-search-overview/>` feature

In this guide, you can learn how to use the Atlas Vector Search feature

Remove the link here since there is a "learn more" at bottom of the section

lindseymoore · 2025-03-25T17:45:24Z

source/atlas-vector-search.txt

+Retrieval-Augmented Generation (RAG).
+
+To learn more about {+vector-search+}, see the :atlas:`{+vector-search+}
+</atlas-vector-search/vector-search-overview/>` guide in the MongoDB Atlas


Suggested change

</atlas-vector-search/vector-search-overview/>` guide in the MongoDB Atlas

</atlas-vector-search/vector-search-overview/>` guides in the MongoDB Atlas

lindseymoore · 2025-03-25T17:46:08Z

source/atlas-vector-search.txt

+
+To use this feature, you must create a vector search index and index your
+vector embeddings. To learn about how to programmatically create a
+vector search index, see the :atlas:`Create an Atlas Vector Search index


Suggested change

vector search index, see the :atlas:`Create an Atlas Vector Search index

vector search index, see the :atlas:`Create an Atlas Vector Search Index

Capitalize title

source/includes/aggregation/atlas-vector-search-example.js

source/atlas-vector-search.txt

* make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback

* DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]>

* DOCSP-48375 ToC reorg part one (mongodb#1035) * DOCSP-48376: Get Started edits (mongodb#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (mongodb#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (mongodb#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (mongodb#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (mongodb#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (mongodb#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (mongodb#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (mongodb#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (mongodb#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (mongodb#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (mongodb#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (mongodb#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (mongodb#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (mongodb#1046) * DOCSP-48683 Refine Connection Pools page (mongodb#1067) * DOCSP-48501 add casual consistency section (mongodb#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (mongodb#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (mongodb#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (mongodb#1071) * DOCSP-48389 Connection Troubleshooting Revisions (mongodb#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (mongodb#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (mongodb#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (mongodb#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]> (cherry picked from commit 1e62fc0)

* Node CC merge comp-cov branch (#1096) * DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]> (cherry picked from commit 1e62fc0) * Backport v6.16 NodeCC * fix redirect --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]>

make page

de35100

shuangela added 7 commits March 20, 2025 12:01

fix vale

16b076f

remove extra space

ad02335

add to index

d0861ae

fix link

eb3d638

fix link

352b609

fix quotes

5a9c66b

fix quotes

4c70a5a

lindseymoore requested changes Mar 20, 2025

View reviewed changes

shuangela added 7 commits March 21, 2025 11:17

lm feedback

7031ae8

fix spacing

c8547d5

remove extra code

bab15fc

fix spacing

7518048

fix link

0cb7f04

fix link title

75c9ecb

change copy

b1481a4

shuangela requested a review from lindseymoore March 21, 2025 15:53

lindseymoore requested changes Mar 21, 2025

View reviewed changes

shuangela added 2 commits March 24, 2025 10:27

lm review

d0d6e7d

change spacing

ddff046

shuangela requested a review from lindseymoore March 24, 2025 14:58

lindseymoore approved these changes Mar 25, 2025

View reviewed changes

shuangela added 2 commits March 25, 2025 15:01

lm edits

d0627a6

remove extra words

9489bdf

nbbeeken requested changes Mar 25, 2025

View reviewed changes

source/includes/aggregation/atlas-vector-search-example.js Outdated Show resolved Hide resolved

source/includes/aggregation/atlas-vector-search-example.js Outdated Show resolved Hide resolved

shuangela added 4 commits March 25, 2025 16:43

nb edits

a592593

remove extra quotes

2a8876d

fix quotes

4533009

add quote

a593d9d

change quote

2598b4e

shuangela requested a review from nbbeeken March 25, 2025 21:13

nbbeeken requested changes Mar 26, 2025

View reviewed changes

source/atlas-vector-search.txt Outdated Show resolved Hide resolved

source/atlas-vector-search.txt Outdated Show resolved Hide resolved

source/atlas-vector-search.txt Outdated Show resolved Hide resolved

nbbeeken requested changes Mar 26, 2025

View reviewed changes

source/atlas-vector-search.txt Outdated Show resolved Hide resolved

nb feedback

5738a01

shuangela requested a review from nbbeeken March 26, 2025 16:17

nbbeeken approved these changes Mar 26, 2025

View reviewed changes

Merge branch 'comp-cov' into DOCSP-48385-avs-page

3e491d9

shuangela merged commit 68f85df into mongodb:comp-cov Mar 26, 2025
4 of 5 checks passed

	You can use {+vector-search+} to perform vector search on your data stored in
	You can use {+vector-search+} to perform a vector search on your data stored in

		:atlas:`How to Index Vector Embeddings for Vector Search
		</atlas-search/field-types/knn-vector/>` in the Atlas documentation.

		@@ -0,0 +1,49 @@
		const { MongoClient } = require("mongodb");

		// connect to your Atlas cluster

	// connect to your Atlas cluster
	// Replace with the connection string to your Atlas cluster to connect

	The aggregation pipeline searches the ``plot`` field of each document in the collection
	In the following example, the aggregation pipeline searches the ``plot`` field of each document in the collection

		- Search for the specified term in the ``plot_embedding`` field

		- Set the number of nearest neighbors used in the search to 150 by using the ``numCandidates`` option


		It uses the ``$project`` stage to:

		- Only include the movie ``plot`` and ``title`` fields in the results.


		- Only include the movie ``plot`` and ``title`` fields in the results.

		- Add a ``score`` field to show the relevance of each result to the search term.

		To find more tutorials on using the {+driver-short+} to perform Atlas
		Vector Searches, see the :atlas:`Atlas Vector Search tutorials </atlas-vector-search/tutorials/>`

	To find more tutorials on using the {+driver-short+} to perform Atlas
	Vector Searches, see the :atlas:`Atlas Vector Search tutorials </atlas-vector-search/tutorials/>`
	To find more Atlas Vector Search tutorials for the {+driver-short+}, see the :atlas:`Atlas Vector Search Tutorials </atlas-vector-search/tutorials/>`

	To learn more about Atlas Vector Search, see :atlas:`Atlas Vector Search </atlas-vector-search/>`
	To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector Search </atlas-vector-search/>` guides

		To learn more about the ``aggregate()`` method, see the
		`API documentation <{+api+}/classes/Collection.html#aggregate>`__.

	``$vectorSearch`` stage to perform an exact vector search on the
	``$vectorSearch`` stage to perform a vector search on the

		To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector Search </atlas-vector-search/>`
		guides in the Atlas documentation.

-To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector Search </atlas-vector-search/>`
-guides in the Atlas documentation.
+To learn more about the syntax of the ``$vectorSearch`` pipeline stage,
+see the Syntax and Fields sections of the
+:atlas:`Create and Run Queries </atlas-vector-search/vector-search-stage/#syntax>`
+guide in the Atlas Vector Search section of the MongoDB Atlas documentation.

		'{"plot":"A dimension-traveling wizard gets stuck in the 21st century because cell-phone radiation interferes with his magic. With his home world on the brink of war, he seeks help from a jaded ...","title":"The Portal","score":0.7640786170959473}'

		This query uses the ``$vectorSearch`` stage to:


	- Perform an Approximate Nearest Neighbor (ANN) vector search

		In this guide, you can learn how to use the :atlas:`Atlas Vector Search
		</atlas-vector-search/vector-search-overview/>` feature

	vector search index, see the :atlas:`Create an Atlas Vector Search index
	vector search index, see the :atlas:`Create an Atlas Vector Search Index

DOCSP-48385 Make Atlas Vector Search page #1042

DOCSP-48385 Make Atlas Vector Search page #1042

Uh oh!

Conversation

shuangela commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

netlify bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-node ready!

Uh oh!

lindseymoore left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lindseymoore left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lindseymoore left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shuangela commented Mar 20, 2025 •

edited

Loading

netlify bot commented Mar 20, 2025 •

edited

Loading