@@ -12,45 +12,49 @@ 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+ If you have an existing Atlas Search Index for data on your Atlas cluster, you
16+ can run :pipeline:`$search` and :pipeline:`$searchMeta` queries. If you have an
17+ existing Atlas Vector search index on your data in Atlas, you can also run
18+ :pipeline:`$vectorSearch` queries.
19+
20+ Before You Begin
21+ ----------------
22+
23+ Create an :ref:`Atlas Search index <compass-create-search-index>` or an
24+ :ref:`Atlas Vector Search index <compass-create-vector-search>`.
25+
26+ .. note::
27+
28+ You can manage Atlas Search indexes in the |compass-short| UI if your
29+ deployment is local, has an Atlas cluster tier of M10 or larger, and runs
30+ MongoDB 7.0 or later.
2031
2132Steps
2233-----
2334
2435.. procedure::
2536 :style: normal
26-
37+
2738 .. 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.
31-
32- .. step:: Run the query
33-
34- a. Click the :guilabel:`Aggregate` button.
3539
36- |compass| switches to the :guilabel:`Aggregations ` tab where you
37- can run your query.
38-
39- #. Construct your query .
40+ From the :guilabel:`Indexes ` tab, click :guilabel:`Search Indexes`.
41+ Hover over the search index you want to use in your query. Click the
42+ :guilabel:`Aggregate` button that appears to open the aggregation
43+ pipeline builder .
4044
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.
45+ .. step:: Construct your query
46+
47+ If you have an Atlas Search index, add the ``$search `` or
48+ ``$searchMeta`` stage to your aggregation pipeline. If you have an
49+ Atlas Vector Search index, add the `` $vectorSearch`` stage.
4650
47- .. note::
51+ .. note::
4852
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.
53+ The Atlas Search `` $search`` and `` $searchMeta` ` and
54+ the Atlas Vector Search `` $vectorSearch` ` pipeline stages must
55+ be the first stage in your aggregation pipeline.
5256
53- #. Click :guilabel:` Run` to run your query.
57+ .. step:: Run your query
5458
5559Learn More
5660----------
0 commit comments