Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 2 additions & 53 deletions source/indexes/create-vector-search-index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,59 +54,8 @@ Steps
.. step:: Provide the Atlas Vector Search Index configurations

You must initially provide the following default vector search index
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first sentence in this paragraph mentions "the following". Can we update the wording here to something like:
You must provide all required fields for your vector search index configuration.

configurations. You can modify the configurations later.

.. list-table::
:header-rows: 1
:widths: 20 10 70

* - Field
- Type
- Description

* - ``type``
- string
- Human-readable label that identifies the type of index. The value must
be ``vector`` to perform a vector search against the indexed fields. If
omitted, it defaults to ``search``, which only supports full-text search.

* - ``path``
- string
- The field name to index.

* - ``numDimensions``
- int
- The number of vector dimensions, which Atlas Search enforces at index- and
query-time. This value can't be greater than 4096.

* - ``similarity``
- string
- The vector similarity function used to search for the top K-nearest neighbors.
Select from the following functions:

.. list-table::
:header-rows: 1
:widths: 50 50

* - Function
- Description

* - ``euclidean``
- A function that measures the distance between ends of vectors. This function
allows you to measure similarity based on varying dimensions.

* - ``cosine``
- A function that measures similarity based on the angle between vectors. This
function allows you to measure similarity that isn't scaled by magnitude.

You can't use zero magnitude vectors with cosine. To measure cosine similarity,
we recommend that you normalize your vectors and use dotProduct instead.

* - ``dotProduct``
- A function that measures similarly to cosine, but takes into account the
magnitude of the vector. This function allows you to efficiently measure
similarity based on both angle and magnitude. To use dotProduct, you must
normalize the vector to unit length at index- and query-time.
configurations. You can modify the configurations later. To learn more,
see :ref:`avs-types-vector-search-options`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion]
To make the destination content more clear, maybe we can add a bit to the crosslink sentence

Suggested change
configurations. You can modify the configurations later. To learn more,
see :ref:`avs-types-vector-search-options`.
configurations. You can modify the configurations later. For more information on required fields
in vector search index configurations, see :ref:`avs-types-vector-search-options`.


.. step:: Click :guilabel:`Create Search Index`

Expand Down