@@ -12,11 +12,25 @@ Run Atlas Search Queries
1212 :depth: 1
1313 :class: singlecol
1414
15- You can run Atlas Search :pipeline:`$search` and :pipeline:`$searchMeta`
16- queries from |compass| if you :ref:`created the Atlas Search index
17- <compass-create-search-index>` for data on the Atlas cluster. You can
18- also run :pipeline:`$vectorSearch` queries from |compass| if you have an
19- existing Atlas Vector search index on your data in Atlas.
15+ Atlas Search queries are run as an :ref:`aggregation pipeline stage
16+ <compass-agg-builder>`. If you have an existing Atlas Search Index for data on
17+ your Atlas cluster, you can run :pipeline:`$search` and :pipeline:`$searchMeta`
18+ queries. If you have an existing Atlas Vector search index on your data in
19+ Atlas, you can also run :pipeline:`$vectorSearch` queries.
20+
21+ Before You Begin
22+ ----------------
23+
24+ Create an :ref:`Atlas Search index <compass-create-search-index>` or an
25+ :ref:`Atlas Vector Search index <compass-create-vector-search>`.
26+
27+ .. note::
28+
29+ Atlas Search index management in the |compass-short| UI is available only
30+ for:
31+
32+ - Atlas local deployments.
33+ - Deployments running MongoDB 7.0 or later.
2034
2135Steps
2236-----
@@ -25,32 +39,28 @@ Steps
2539 :style: normal
2640
2741 .. step:: Find the index you want to use in your query
28-
29- a. From the :guilabel:`Indexes` tab, click :guilabel:`Search Indexes`.
30- #. Hover over the index you want to use in your query.
3142
32- .. step:: Run the query
43+ From the :guilabel:`Indexes` tab, click :guilabel:`Search Indexes`.
44+ Hover over the search index you want to use in your query.
3345
34- a. Click the :guilabel:`Aggregate` button.
35-
36- |compass| switches to the :guilabel:`Aggregations` tab where you
37- can run your query.
38-
39- #. Construct your query.
46+ .. step:: Open the aggregation pipeline builder
47+
48+ Click the :guilabel:`Aggregate` button that appears when you hover over
49+ your search index.
4050
41- By default, |compass| selects the :pipeline:`$search` stage for
42- your query. You can select the :pipeline:`$searchMeta` stage
43- to use in your query. If you are using a ``vectorSearch`` type
44- index in your query, you can only use the
45- :pipeline:`$vectorSearch` stage in your query.
51+ .. step:: Construct your query
52+
53+ By default, |compass| selects the :pipeline:`$search` stage for your
54+ query. You can also select the :pipeline:`$searchMeta` stage to use in
55+ your query. If you are using a ``vectorSearch`` type index in your query,
56+ you can use the :pipeline:`$vectorSearch` stage.
4657
47- .. note::
58+ .. note::
4859
49- The Atlas Search :pipeline:`$search` and :pipeline:`$searchMeta` and
50- the Atlas Vector Search :pipeline:`$vectorSearch` pipeline stages must
51- be the first stage in your aggregation pipeline.
60+ If you use the ``$search``, ``$searchMeta``, or ``$vectorSearch``
61+ stage, it must be the first stage in your aggregation pipeline.
5262
53- #. Click :guilabel:` Run` to run your query.
63+ .. step:: Run your query
5464
5565Learn More
5666----------
0 commit comments