Skip to content

Commit fcb6e91

Browse files
DOCSP-48357-incorrect-vs-type (#741)
* DOCSP-48357-incorrect-vs-type * reviewer feedback * feedback * .
1 parent bdc04e5 commit fcb6e91

File tree

1 file changed

+4
-54
lines changed

1 file changed

+4
-54
lines changed

source/indexes/create-vector-search-index.txt

Lines changed: 4 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -56,60 +56,10 @@ Steps
5656

5757
.. step:: Provide the Atlas Vector Search Index configurations
5858

59-
You must initially provide the following default vector search index
60-
configurations. You can modify the configurations later.
61-
62-
.. list-table::
63-
:header-rows: 1
64-
:widths: 20 10 70
65-
66-
* - Field
67-
- Type
68-
- Description
69-
70-
* - ``type``
71-
- string
72-
- Human-readable label that identifies the type of index. The value must
73-
be ``vector`` to perform a vector search against the indexed fields. If
74-
omitted, it defaults to ``search``, which only supports full-text search.
75-
76-
* - ``path``
77-
- string
78-
- The field name to index.
79-
80-
* - ``numDimensions``
81-
- int
82-
- The number of vector dimensions, which Atlas Search enforces at index- and
83-
query-time. This value can't be greater than 4096.
84-
85-
* - ``similarity``
86-
- string
87-
- The vector similarity function used to search for the top K-nearest neighbors.
88-
Select from the following functions:
89-
90-
.. list-table::
91-
:header-rows: 1
92-
:widths: 50 50
93-
94-
* - Function
95-
- Description
96-
97-
* - ``euclidean``
98-
- A function that measures the distance between ends of vectors. This function
99-
allows you to measure similarity based on varying dimensions.
100-
101-
* - ``cosine``
102-
- A function that measures similarity based on the angle between vectors. This
103-
function allows you to measure similarity that isn't scaled by magnitude.
104-
105-
You can't use zero magnitude vectors with cosine. To measure cosine similarity,
106-
we recommend that you normalize your vectors and use dotProduct instead.
107-
108-
* - ``dotProduct``
109-
- A function that measures similarly to cosine, but takes into account the
110-
magnitude of the vector. This function allows you to efficiently measure
111-
similarity based on both angle and magnitude. To use dotProduct, you must
112-
normalize the vector to unit length at index- and query-time.
59+
You must provide all required fields for your vector search index
60+
configuration. You can modify the configurations later.
61+
For more information on required fields in vector search index
62+
configurations, see :ref:`avs-types-vector-search-options`.
11363

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

0 commit comments

Comments
 (0)