DOCSP-41555: Atlas vector search (#84)

* DOCSP-41555: Atlas vector search

* edits

* RR feedback

* tech review

(cherry picked from commit 682d093)

Author: norareidy

source/includes/indexes/indexes.c

@@ -149,26 +149,78 @@ main (void)
         // end-create-search-index
     }
     {
-        // start-create-search-indexes
-        bson_t cmd;
-        bson_error_t error;
-        char *cmd_str = bson_strdup_printf (
-            BSON_STR ({
-                "createSearchIndexes" : "%s",
-                "indexes" : [ {"definition" : {"mappings" : {"dynamic" : false}}, "name" : "<first index name>"},
-                              {"definition" : {"mappings" : {"dynamic" : false}}, "name" : "<second index name>"} ]
-            }),
-            "<collection name>");
-        bson_init_from_json (&cmd, cmd_str, -1, &error);
-        bson_free (cmd_str);
+      // start-create-vector-search-index
+      bson_t cmd;
+      bson_error_t error;
+      char * cmd_str = bson_strdup_printf(
+        BSON_STR({
+          "createSearchIndexes": "%s",
+          "indexes": [{
+            "name": "<index name>",
+            "type": "vectorSearch",
+            "definition": {
+              "fields": [{
+                "type": "vector",
+                "path": "plot_embedding",
+                "numDimensions": 1536,
+                "similarity": "euclidean"
+              }]
+            }
+          }]
+        }),
+        "<collection name>"
+      );
+      bson_init_from_json(&cmd, cmd_str, -1, &error);
+      bson_free(cmd_str);
 
-        if (mongoc_collection_command_simple (collection, &cmd, NULL, NULL, &error)) {
-            printf ("Successfully created search indexes\n");
-        } else {
-            fprintf (stderr, "Failed to create search indexes: %s", error.message);
-        }
-        bson_destroy (&cmd);
-        // end-create-search-indexes
+      if (mongoc_collection_command_simple(collection, &cmd, NULL, NULL, &error)) {
+        printf("Successfully created Vector Search index\n");
+      } else {
+        fprintf(stderr, "Failed to create Vector Search index: %s", error.message);
+      }
+      bson_destroy(&cmd);
+      // end-create-vector-search-index
+    }
+    {
+      // start-create-search-indexes
+      bson_t cmd;
+      bson_error_t error;
+      char * cmd_str = bson_strdup_printf(
+        BSON_STR({
+          "createSearchIndexes": "%s",
+          "indexes": [{
+              "definition": {
+                "mappings": {
+                  "dynamic": false
+                }
+              },
+              "name": "<Atlas Search index name>"
+            },
+            {
+              "name": "<Vector Search index name>",
+              "type": "vectorSearch",
+              "definition": {
+                "fields": [{
+                  "type": "vector",
+                  "path": "plot_embedding",
+                  "numDimensions": 1536,
+                  "similarity": "euclidean"
+                }]
+              }
+            }
+          ]
+        }),
+        "<collection name>");
+      bson_init_from_json(&cmd, cmd_str, -1, &error);
+      bson_free(cmd_str);
+
+      if (mongoc_collection_command_simple(collection, &cmd, NULL, NULL, &error)) {
+        printf("Successfully created search indexes\n");
+      } else {
+        fprintf(stderr, "Failed to create search indexes: %s", error.message);
+      }
+      bson_destroy(&cmd);
+      // end-create-search-indexes
     }
     {
         // start-list-search-indexes
@@ -212,6 +264,36 @@ main (void)
         bson_destroy (&cmd);
         // end-update-search-index
     }
+    {
+        // start-update-vector-search-index
+        bson_t cmd;
+        bson_error_t error;
+        char * cmd_str = bson_strdup_printf(
+        BSON_STR({
+            "updateSearchIndex": "%s",
+            "name": "<index name>",
+            "definition": {
+            "fields": [{
+                "type": "vector",
+                "path": "plot_embedding",
+                "numDimensions": 1536,
+                "similarity": "cosine"
+            }]
+            }
+        }),
+        "<collection name>"
+        );
+        bson_init_from_json(&cmd, cmd_str, -1, &error);
+        bson_free(cmd_str);
+
+        if (mongoc_collection_command_simple(collection, &cmd, NULL, NULL, &error)) {
+        printf("Successfully updated search index\n");
+        } else {
+        fprintf(stderr, "Failed to create search index: %s", error.message);
+        }
+        bson_destroy(&cmd);
+        // end-update-vector-search-index
+    }
     {
         // start-drop-search-index
         bson_t cmd;

source/indexes/atlas-search-index.txt

@@ -20,26 +20,30 @@ Atlas Search Indexes
 Overview
 --------
 
-:atlas:`Atlas Search </atlas-search>` enables you to perform full-text searches on
-collections hosted on MongoDB Atlas. Atlas Search indexes specify the behavior of
-the search and which fields to index.
+In this guide, you can learn how to programmatically manage your Atlas
+Search and Atlas Vector Search indexes by using the {+driver-short+}.
+
+The Atlas Search feature enables you to perform full-text searches on
+collections hosted on MongoDB Atlas. To learn more about Atlas Search,
+see the :atlas:`Atlas Search Overview </atlas-search/atlas-search-overview/>`
+in the Atlas documentation.
+
+Atlas Vector Search enables you to perform semantic searches on vector
+embeddings stored in MongoDB Atlas. To learn more about Atlas Vector Search,
+see the :atlas:`Atlas Vector Search Overview </atlas-vector-search/vector-search-overview/>`
+in the Atlas documentation.
 
 The following sections provide code examples that demonstrate how to create, list, update,
-and delete Atlas Search indexes.
+and delete Atlas Search and Vector Search indexes.
 
 .. _c-atlas-search-index-create:
 
 Create a Search Index
 ---------------------
 
-You can pass the ``createSearchIndexes`` command to the ``mongoc_collection_command_simple()``
-function to create one or more Atlas Search indexes.
-
-You can also use this function to create Atlas Vector Search indexes.
-Atlas Vector Search enables you to perform semantic searches on vector
-embeddings stored in MongoDB Atlas. To learn more about this feature,
-see the :atlas:`Atlas Vector Search Overview
-</atlas-vector-search/vector-search-overview/>` in the Atlas documentation.
+To create an Atlas Search or Vector Search index, pass the ``createSearchIndexes``
+command to the ``mongoc_collection_command_simple()`` function. You can use this command
+to create one or multiple indexes.
 
 The following code example shows how to create an Atlas Search index:
 
@@ -49,26 +53,37 @@ The following code example shows how to create an Atlas Search index:
    :end-before: end-create-search-index
    :dedent:
 
-The following code example shows how to create multiple indexes:
+The following code example shows how to create an Atlas Vector Search index:
+
+.. literalinclude:: /includes/indexes/indexes.c
+   :language: c
+   :start-after: start-create-vector-search-index
+   :end-before: end-create-vector-search-index
+   :dedent:
+
+The following code example shows how to create both search indexes in
+one call to the ``mongoc_collection_command_simple()`` function:
 
 .. literalinclude:: /includes/indexes/indexes.c
    :language: c
    :start-after: start-create-search-indexes
    :end-before: end-create-search-indexes
    :dedent:
 
-To learn more about the syntax used to define Atlas Search indexes, see the
-:atlas:`Review Atlas Search Index Syntax </atlas-search/index-definitions>` guide
-in the Atlas documentation.
+To learn more about the syntax used to define each search index, see the
+following guides in the Atlas documentation:
+
+- :atlas:`Review Atlas Search Index Syntax </atlas-search/index-definitions>`
+- :atlas:`How to Index Fields for Vector Search </atlas-vector-search/vector-search-type/>`
 
 .. _c-atlas-search-index-list:
 
 List Search Indexes
 -------------------
 
 You can pass the ``$listSearchIndexes`` aggregation stage to the
-``mongoc_collection_aggregate()`` function to return all Atlas Search indexes in a
-collection.
+``mongoc_collection_aggregate()`` function to return all Atlas Search
+and Vector Search indexes in a collection.
 
 The following code example shows how to print a list of the search indexes in
 a collection:
@@ -85,23 +100,35 @@ Update a Search Index
 ---------------------
 
 You can pass the ``updateSearchIndex`` command to the  ``mongoc_collection_command_simple()``
-function to update an Atlas Search index.
+function to update an Atlas Search or Vector Search index.
 
-The following code shows how to update a search index:
+The following code shows how to update the Atlas Search index
+created in the :ref:`c-atlas-search-index-create` section of this guide
+to use dynamic mappings:
 
 .. literalinclude:: /includes/indexes/indexes.c
    :language: c
    :start-after: start-update-search-index
    :end-before: end-update-search-index
    :dedent:
 
+The following code shows how to update the Atlas Vector Search
+index created in the :ref:`c-atlas-search-index-create` section of this guide
+to use the ``cosine`` similarity function:
+
+.. literalinclude:: /includes/indexes/indexes.c
+   :language: c
+   :start-after: start-update-vector-search-index
+   :end-before: end-update-vector-search-index
+   :dedent:
+
 .. _c-atlas-search-index-drop:
 
 Delete a Search Index
 ---------------------
 
 You can pass the ``dropSearchIndexes`` command to the  ``mongoc_collection_command_simple()``
-function to delete an Atlas Search index.
+function to delete an Atlas Search or Vector Search index.
 
 The following code shows how to delete a search index from a collection:
 
@@ -114,8 +141,11 @@ The following code shows how to delete a search index from a collection:
 Additional Information
 ----------------------
 
-To learn more about MongoDB Atlas Search, see the :atlas:`Atlas Search Indexes </atlas-search/atlas-search-overview/>`
-documentation.
+To learn more about MongoDB Atlas Search, see :atlas:`Atlas Search Indexes </atlas-search/atlas-search-overview/>`
+in the Atlas documentation.
+
+To learn more about MongoDB Atlas Vector Search, see :atlas:`How to Index Fields for Vector Search
+</atlas-vector-search/vector-search-type/>` in the Atlas documentation.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~