Skip to content

Commit dd6ed4c

Browse files
DOCSP-34057 add doc for $vectorSearch pipeline stage (#5503)
* DOCSP-34057 add doc for vectorSearch pipeline stage * DOCSP-34057 updates for copy feedback * DOCSP-34057 fix for broken links * DOCSP-34057 updates for AB's feedback * DOCSP-34057 updates for AB's feedback
1 parent e427435 commit dd6ed4c

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

source/reference/operator/aggregation-pipeline.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,4 @@ For the updates, the pipeline can consist of the following stages:
116116
/reference/operator/aggregation/unionWith
117117
/reference/operator/aggregation/unset
118118
/reference/operator/aggregation/unwind
119+
/reference/operator/aggregation/vectorSearch
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
===========================
2+
$vectorSearch (aggregation)
3+
===========================
4+
5+
.. default-domain:: mongodb
6+
7+
``$vectorSearch`` performs a semantic search on data in your Atlas
8+
cluster. If you store vector embeddings that are less than or equal to
9+
2048 dimensions in width for any kind of data along with other data in
10+
your collection on the Atlas cluster, you can seamlessly index the
11+
vector data along with your other data. You can then use the
12+
:pipeline:`$vectorSearch` stage to pre-filter your data and perform
13+
semantic search against the indexed fields.
14+
15+
.. important::
16+
17+
The ``$vectorSearch`` aggregation pipeline stage is only available
18+
for collections hosted on :atlas:`MongoDB Atlas </>` cluster tiers
19+
running MongoDB version 6.0.11 or later. To learn more, see
20+
:atlas:`Atlas Vector Search
21+
</atlas-vector-search/vector-search-overview/>`.
22+
23+
Learn More
24+
----------
25+
26+
- To learn more about creating Atlas Vector Search indexes, see
27+
:atlas:`Index Vector Embeddings
28+
</atlas-vector-search/vector-search-type/>`.
29+
30+
- To learn more about :pipeline:`$vectorSearch` pipeline stage syntax
31+
and usage, see :atlas:`Vector Search Queries
32+
</atlas-vector-search/vector-search-stage/>`.

0 commit comments

Comments
 (0)