Skip to content

Commit b0ee587

Browse files
committed
edits
1 parent 0f45c4a commit b0ee587

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

source/model-data/indexes.txt

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ Vector Search Indexes
247247
~~~~~~~~~~~~~~~~~~~~~
248248

249249
Vector Search indexes specify the behavior of an Atlas Vector Search, which allows
250-
you to query data based on its semantic meaning rather than only keyword matches.
250+
you to query data based on its semantic meaning rather than by keyword matches.
251251
You can integrate vector search with full-text search queries and AI frameworks to
252252
support a range of use cases.
253253

@@ -257,15 +257,17 @@ To create a Vector Search index, assign the ``indexes`` option in your model's
257257

258258
- ``name``: *(Optional)* The name of your Vector Search index. If you do not
259259
specify this argument, {+framework+} automatically generates an index name.
260-
- ``fields``: The fields you want to index.
260+
- ``fields``: The fields you want to index. At least one must be a vector
261+
field, represented by an array of ``FloatField`` or ``IntegerField`` values and an
262+
array size.
261263
- ``similarities``: The :atlas:`similarity function </atlas-vector-search/vector-search-type/#std-label-avs-similarity-functions>`
262-
to use. You can specify the ``"cosine"``, ``"dotProduct"``, or ``"euclidean"``
263-
similarity function, as a single string value or a list of values that assigns
264-
different functions to individual vector fields.
264+
to use. You can use the ``"cosine"``, ``"dotProduct"``, or ``"euclidean"``
265+
similarity function. Specify the function as a single string value or a list
266+
of values that assigns functions to individual vector fields.
265267

266268
The following example updates the ``Recipe`` model's ``Meta`` class to create
267-
a Vector Search index named ``"vector_search_idx"`` on the ``ratings`` and ``cook_time``
268-
fields:
269+
a Vector Search index named ``"vector_search_idx"`` on the ``ratings`` vector field
270+
and the ``cook_time`` numeric field:
269271

270272
.. literalinclude:: /includes/model-data/indexes.py
271273
:start-after: start-vector-search

0 commit comments

Comments
 (0)