Skip to content

Commit 90356b9

Browse files
committed
source constant for AVS
1 parent 2126380 commit 90356b9

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,4 @@ version = "v{+version-number+}"
2828
stable-api = "Stable API"
2929
api-root = "https://www.mongodb.com/docs/ruby-driver/current/api/"
3030
bson-version = "5.0.2"
31+
avs = "Atlas Vector Search"

source/index.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
Indexes </indexes>
2525
Monitor Your Application </monitoring>
2626
Data Aggregation </aggregation>
27-
Atlas Vector Search </vector-search>
27+
{+avs+} </vector-search>
2828
Security </security>
2929
Data Formats </data-formats>
3030
View the Source <https://github.com/mongodb/mongo-ruby-driver>
@@ -93,11 +93,11 @@ Transform Your Data with Aggregation
9393
Learn how to use the {+driver-short+} to perform aggregation operations in the
9494
:ref:`ruby-aggregation` section.
9595

96-
Atlas Vector Search
96+
{+avs+}
9797
-------------------
9898

9999
Learn how to perform similarity searches on vector embeddings by using the
100-
Atlas Vector Search feature. To learn more, see the
100+
{+avs+} feature. To learn more, see the
101101
:ref:`ruby-atlas-vector-search` guide.
102102

103103
Secure Your Data

source/vector-search.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _ruby-atlas-vector-search:
22

33
================================
4-
Run an Atlas Vector Search Query
4+
Run an {+avs+} Query
55
================================
66

77
.. facet::
@@ -22,32 +22,32 @@ Overview
2222
--------
2323

2424
In this guide, you can learn how to perform searches on your documents
25-
by using the Atlas Vector Search feature. The {+driver-short+} allows you to
26-
perform Atlas Vector Search queries by using the aggregation framework.
25+
by using the {+avs+} feature. The {+driver-short+} allows you to
26+
perform {+avs+} queries by using the aggregation framework.
2727
To learn more about performing aggregations, see the
2828
:ref:`ruby-aggregation` guide.
2929

3030
.. note:: Deployment Compatibility
3131

32-
You can use the Atlas Vector Search feature only when
32+
You can use the {+avs+} feature only when
3333
you connect to MongoDB Atlas clusters. This feature is not
3434
available for self-managed deployments.
3535

36-
To learn more about Atlas Vector Search, see the :atlas:`Atlas Vector
37-
Search Overview </atlas-vector-search/vector-search-overview/>` in the
38-
Atlas documentation.
36+
To learn more about {+avs+}, see the :atlas:`{+avs+} Overview
37+
</atlas-vector-search/vector-search-overview/>` in the Atlas
38+
documentation.
3939

4040
.. note:: Atlas Search
4141

4242
To perform advanced full-text search on your documents, you can use the
4343
Atlas Search feature. To learn about this feature, see the
4444
:atlas:`Atlas Search Overview </atlas-search/atlas-search-overview/>`.
4545

46-
Atlas Vector Search Index
46+
{+avs+} Index
4747
~~~~~~~~~~~~~~~~~~~~~~~~~
4848

49-
Before you can perform Atlas Vector Search queries, you must create an
50-
Atlas Vector Search index on your collection. To learn more about
49+
Before you can perform {+avs+} queries, you must create an
50+
{+avs+} index on your collection. To learn more about
5151
creating this index, see the :ref:`ruby-atlas-search-index` guide.
5252

5353
Vector Search Aggregation Stage
@@ -101,9 +101,9 @@ tutorial in the Atlas documentation.
101101
Basic Vector Search Query
102102
~~~~~~~~~~~~~~~~~~~~~~~~~
103103

104-
The following code performs an Atlas Vector Search query on the
105-
``plot_embedding`` vector field by using a query vector that represents
106-
the term *time travel*:
104+
The following code performs an {+avs+} query on the
105+
``plot_embedding`` vector field by using a query vector that is a vector
106+
embedding of the phrase "time travel":
107107

108108
.. io-code-block::
109109
:copyable: true
@@ -115,7 +115,7 @@ the term *time travel*:
115115
:end-before: end-basic-query
116116

117117
.. output::
118-
:language: json
118+
:language: none
119119
:visible: false
120120

121121
{"plot"=>"A reporter, learning of time travelers visiting 20th century disasters, tries to change the history they know by averting upcoming disasters.", "title"=>"Thrill Seekers"}
@@ -142,7 +142,7 @@ field, which describes how well the document matches the query vector:
142142
:emphasize-lines: 15
143143

144144
.. output::
145-
:language: json
145+
:language: none
146146
:visible: false
147147

148148
{"title"=>"Thrill Seekers", "score"=>0.9253387451171875}

0 commit comments

Comments
 (0)