From 546cad8e29a9018e16674c84989b632a91f0c6ef Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Tue, 8 Apr 2025 09:31:53 -0400 Subject: [PATCH 1/4] DOCSP-48357-incorrect-vs-type --- source/indexes/create-vector-search-index.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/indexes/create-vector-search-index.txt b/source/indexes/create-vector-search-index.txt index 2dfa60dff..6070118bd 100644 --- a/source/indexes/create-vector-search-index.txt +++ b/source/indexes/create-vector-search-index.txt @@ -68,7 +68,7 @@ Steps - 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. + omitted, it defaults to ``filter``, which only supports full-text search. * - ``path`` - string From 746628d0cc3dd044c44ba23c3d8c3b888f6b9fad Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Wed, 16 Apr 2025 10:27:35 -0400 Subject: [PATCH 2/4] reviewer feedback --- source/indexes/create-vector-search-index.txt | 55 +------------------ 1 file changed, 2 insertions(+), 53 deletions(-) diff --git a/source/indexes/create-vector-search-index.txt b/source/indexes/create-vector-search-index.txt index 6070118bd..37b7de90a 100644 --- a/source/indexes/create-vector-search-index.txt +++ b/source/indexes/create-vector-search-index.txt @@ -54,59 +54,8 @@ Steps .. step:: Provide the Atlas Vector Search Index configurations You must initially provide the following default vector search index - 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 ``filter``, 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`. .. step:: Click :guilabel:`Create Search Index` From 7ba148be653b4cfc280f20a5edc9f30949af0143 Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 17 Apr 2025 10:54:16 -0400 Subject: [PATCH 3/4] feedback --- source/indexes/create-vector-search-index.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/indexes/create-vector-search-index.txt b/source/indexes/create-vector-search-index.txt index 37b7de90a..aa46d2c23 100644 --- a/source/indexes/create-vector-search-index.txt +++ b/source/indexes/create-vector-search-index.txt @@ -53,9 +53,10 @@ Steps .. step:: Provide the Atlas Vector Search Index configurations - You must initially provide the following default vector search index - configurations. You can modify the configurations later. To learn more, - see :ref:`avs-types-vector-search-options`. + You must provide all required fields for your vector search index + configuration. 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` From d3b122fee032668e958597b69dc6e12010e84e0d Mon Sep 17 00:00:00 2001 From: Anika Malhotra Date: Thu, 17 Apr 2025 10:55:52 -0400 Subject: [PATCH 4/4] . --- source/indexes/create-vector-search-index.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/indexes/create-vector-search-index.txt b/source/indexes/create-vector-search-index.txt index aa46d2c23..05528d37b 100644 --- a/source/indexes/create-vector-search-index.txt +++ b/source/indexes/create-vector-search-index.txt @@ -55,8 +55,8 @@ Steps You must provide all required fields for your vector search index configuration. You can modify the configurations later. - For more information on required fields in vector search - index configurations, see :ref:`avs-types-vector-search-options`. + For more information on required fields in vector search index + configurations, see :ref:`avs-types-vector-search-options`. .. step:: Click :guilabel:`Create Search Index`