(DOCSP-34890): Add vector search index type for Atlas Search management commands (#5747) (#6328)

* WIP

* (DOCSP-34890): Add vector search index type for Atlas Search management commands

* fix pluralization

* add taxonomy info

* tweak vector syntax

* add Learn More section

* formatting fix

* fix formatting

* remove comma

* fix code block formatting

* address review feedback

* consistent wording

* remove word

* tweak example explanation

Author: jeff-allen-mongo

source/includes/atlas-search-commands/field-definitions/type.rst

@@ -0,0 +1,6 @@
+Type of search index to create. You can specify either:
+
+- ``search``
+- ``vectorSearch``
+
+If you omit the ``type`` field, the index type is ``search``.

source/includes/atlas-search-commands/vector-search-index-definition-fields.rst

@@ -0,0 +1,17 @@
+The vector search index definition takes the following fields:
+
+.. code-block:: javascript
+
+   {
+     "fields": [ 
+       {
+         "type": "vector" | "filter",
+         "path": "<field-to-index>",
+         "numDimensions": <number-of-dimensions>,
+         "similarity": "euclidean" | "cosine" | "dotProduct"
+       }
+     ]
+   }
+
+For explanations of vector search index definition fields, see
+:ref:`avs-types-vector-search`.

source/reference/command/createSearchIndexes.txt

@@ -4,6 +4,9 @@ createSearchIndexes
 
 .. default-domain:: mongodb
 
+.. meta::
+   :keywords: atlas search
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -17,7 +20,7 @@ Definition
 
 .. versionadded:: 7.0 (*Also available starting in 6.0.7*)
 
-.. |fts-indexes| replace:: :atlas:`{+fts+} indexes </atlas-search/atlas-search-overview/#fts-indexes>`
+.. |fts-indexes| replace:: :atlas:`{+fts+} indexes </atlas-search/atlas-search-overview/#fts-indexes>` or :atlas:`Vector Search indexes </atlas-vector-search/vector-search-overview/>`
 
 .. include:: /includes/atlas-search-commands/command-descriptions/createSearchIndexes-description.rst
 
@@ -39,6 +42,7 @@ Command syntax:
          indexes: [
             {
                name: "<index name>",
+               type: "<search index type>",
                definition: {
                   /* search index definition fields */
                } 
@@ -82,11 +86,20 @@ The ``createSearchIndexes`` command takes the following fields:
 
       If you do not specify a ``name``, the index is named ``default``.
 
+  * - ``indexes.type``
+    - string
+    - Optional
+    - .. include:: /includes/atlas-search-commands/field-definitions/type.rst
+
   * - ``indexes.definition``
     - document
     - Required
-    - Document describing the index to create. For details on
-      ``definition`` syntax, see :ref:`search-index-definition-create`.
+    - Document describing the index to create. The ``definition`` syntax
+      depends on whether you create a standard search index or a Vector
+      Search index. For the ``definition`` syntax, see:
+      
+      - :ref:`search-index-definition-create`
+      - :ref:`vector-search-index-definition-create`
 
 .. _search-index-definition-create:
 
@@ -95,6 +108,13 @@ Search Index Definition Syntax
 
 .. include:: /includes/atlas-search-commands/search-index-definition-fields.rst
 
+.. _vector-search-index-definition-create:
+
+Vector Search Index Definition Syntax
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/atlas-search-commands/vector-search-index-definition-fields.rst
+
 Behavior
 --------
 
@@ -241,3 +261,43 @@ or digits.
 ``searchIndex03`` uses a dynamic field mapping, meaning the index
 contains all fields in the collection that have :ref:`supported data
 types <bson-data-chart>`.
+
+Create a Vector Search Index
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example creates a vector search index named
+``vectorSearchIndex01`` on the ``movies`` collection:
+
+.. code-block:: javascript
+
+   db.runCommand( {
+      createSearchIndexes: "movies",
+      indexes: [
+         {
+            name: "vectorSearchIndex01",
+            type: "vectorSearch",
+            definition: {
+               fields: [
+                  {
+                     type: "vector",
+                     numDimensions: 1,
+                     path: "genre",
+                     similarity: "cosine"
+                  }
+               ]
+            }
+         }
+      ]
+   } )
+
+The vector search index contains one dimension and indexes the
+``genre`` field.
+
+Learn More
+----------
+
+- :pipeline:`$vectorSearch` aggregation stage
+
+- :ref:`Tutorial: Semantic Search <vector-search--tutorial>`
+
+- :atlas:`Atlas Vector Search Changelog </atlas-vector-search/changelog/>`

source/reference/method/db.collection.createSearchIndex.txt

@@ -4,6 +4,9 @@ db.collection.createSearchIndex()
 
 .. default-domain:: mongodb
 
+.. meta::
+   :keywords: atlas search
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -17,7 +20,7 @@ Definition
 
 .. versionadded:: 7.0 (*Also available starting in 6.0.7*)
 
-.. |fts-index| replace:: :atlas:`{+fts+} index </atlas-search/atlas-search-overview/#fts-indexes>`
+.. |fts-index| replace:: :atlas:`{+fts+} index </atlas-search/atlas-search-overview/#fts-indexes>` or :atlas:`Vector Search index </atlas-vector-search/vector-search-overview/>`
 
 .. include:: /includes/atlas-search-commands/command-descriptions/createSearchIndex-method.rst
 
@@ -36,6 +39,7 @@ Command syntax:
 
    db.<collection>.createSearchIndex(
       <name>,
+      <type>,
       {
          <definition>
       }
@@ -65,12 +69,20 @@ Command Fields
 
       If you do not specify a ``name``, the index is named ``default``.
 
+  * - ``type``
+    - string
+    - Optional
+    - .. include:: /includes/atlas-search-commands/field-definitions/type.rst
+  
   * - ``definition``
     - document
     - Required
-    - Document describing the index to create. For details on
-      ``definition`` syntax, see
-      :ref:`search-index-definition-create-mongosh`.
+    - Document describing the index to create. The ``definition`` syntax
+      depends on whether you create a standard search index or a Vector
+      Search index. For the ``definition`` syntax, see:
+      
+      - :ref:`search-index-definition-create-mongosh`
+      - :ref:`vector-search-index-definition-create-mongosh`
 
 .. _search-index-definition-create-mongosh:
 
@@ -79,6 +91,13 @@ Search Index Definition Syntax
 
 .. include:: /includes/atlas-search-commands/search-index-definition-fields.rst
 
+.. _vector-search-index-definition-create-mongosh:
+
+Vector Search Index Definition Syntax
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/atlas-search-commands/vector-search-index-definition-fields.rst
+
 Behavior
 --------
 
@@ -166,3 +185,38 @@ with the name ``default`` on the ``food`` collection:
          }
       }
    )
+
+Create a Vector Search Index
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example creates a vector search index named
+``vectorSearchIndex01`` on the ``movies`` collection:
+
+.. code-block:: javascript
+
+   db.movies.createSearchIndex(
+      "vectorSearchIndex01",
+      "vectorSearch",
+      {
+         fields: [
+            {
+               type: "vector",
+               numDimensions: 1,
+               path: "genre",
+               similarity: "cosine"
+            }
+         ]
+      }
+   )
+
+The vector search index contains one dimension and indexes the ``genre``
+field.
+
+Learn More
+----------
+
+- :pipeline:`$vectorSearch` aggregation stage
+
+- :ref:`Tutorial: Semantic Search <vector-search--tutorial>`
+
+- :atlas:`Atlas Vector Search Changelog </atlas-vector-search/changelog/>`