DRIVERS-2768 [Vector Search GA] Add support for types in search index creation

source/index-management/index-management.md

@@ -664,6 +664,15 @@ interface IndexOptions {
    * @example For an index of name: 1, age: -1, the generated name would be "name_1_age_-1".
    */
   name: String;
+
+  /**
+   * Optionally specify a type for the index. Defaults to "search" if not provided.
+   * Either "search" for regular search indexes or "vectorSearch" for vector search indexes.
+   *
+   * Note that to create a vector search index using a helper method, the type "vectorSearch" must be provided.
+   *
+   */
+  type: String;
 
   /**
    * Optionally tells the index to only reference documents with the specified field in

source/index-management/index-management.rst

@@ -693,6 +693,16 @@ Common API Components
      */
     name: String;
 
+    /**
+     * Optionally specify a type for the index. Defaults to "search" if not provided.
+     * Either "search" for regular search indexes or "vectorSearch" for vector search indexes.
+     *
+     * Note that to create a vector search index using a helper method, the type "vectorSearch" must be provided.
+     *
+     */
+    type: String;
+
+
     /**
      * Optionally tells the index to only reference documents with the specified field in
      * the index.
@@ -1149,3 +1159,4 @@ Changelog
 :2023-07-27: Add search index management clarifications.
 :2023-11-08: Clarify that ``readConcern`` and ``writeConcern`` must not be
              applied to search index management commands.
+:2024-03-06: Update tests to include search index typing.

source/index-management/tests/README.md

@@ -231,3 +231,97 @@ This test fails if it times out waiting for the deletion to succeed.
      of `true`.
 
 6. Assert that `index` has a property `latestDefinition` whose value is `{ 'mappings': { 'dynamic': false } }`
+
+#### Case 7: Driver can successfully handle search index types when creating indexes
+
+1. Create a collection with the "create" command using a randomly generated name (referred to as ``coll0``).
+
+2. Create a new search index on ``coll0`` with the ``createSearchIndex`` helper. Use the following definition:
+
+   ```typescript
+
+     {
+       name: 'test-search-index-case7-implicit',
+       definition: {
+         mappings: { dynamic: false }
+       }
+     }
+   ```
+
+3. Assert that the command returns the name of the index: ``"test-search-index-case7-implicit"``.
+
+4. Run ``coll0.listSearchIndexes('test-search-index-case7-implicit')`` repeatedly every 5 seconds until the following condition is satisfied and store the value in a variable ``index1``:
+
+   - An index with the ``name`` of ``test-search-index-case7-implicit`` is present and the index has a field ``queryable`` with a value of ``true``.
+
+5. Assert that ``index1`` has a property ``type`` whose value is ``search``
+
+6. Create a new search index on ``coll0`` with the ``createSearchIndex`` helper. Use the following definition:
+
+   ```typescript
+
+     {
+       name: 'test-search-index-case7-explicit',
+       type: 'search',
+       definition: {
+         mappings: { dynamic: false }
+       }
+     }
+   ```
+
+7. Assert that the command returns the name of the index: ``"test-search-index-case7-explicit"``.
+
+8. Run ``coll0.listSearchIndexes('test-search-index-case7-explicit')`` repeatedly every 5 seconds until the following condition is satisfied and store the value in a variable ``index2``:
+
+   - An index with the ``name`` of ``test-search-index-case7-explicit`` is present and the index has a field ``queryable`` with a value of ``true``.
+
+9. Assert that ``index2`` has a property ``type`` whose value is ``search``
+
+10. Create a new vector search index on ``coll0`` with the ``createSearchIndex`` helper. Use the following definition:
+
+   ```typescript
+
+     {
+       name: 'test-search-index-case7-vector',
+       type: 'vectorSearch',
+       definition: {
+         "fields": [
+            {
+                "type": "vector",
+                "path": "plot_embedding",
+                "numDimensions": 1536,
+                "similarity": "euclidean",
+            },
+         ]
+       }
+     }
+   ```
+
+11. Assert that the command returns the name of the index: ``"test-search-index-case7-vector"``.
+
+12. Run ``coll0.listSearchIndexes('test-search-index-case7-vector')`` repeatedly every 5 seconds until the following condition is satisfied and store the value in a variable ``index3``:
+
+    - An index with the ``name`` of ``test-search-index-case7-vector`` is present and the index has a field ``queryable`` with a value of ``true``.
+
+13. Assert that ``index3`` has a property ``type`` whose value is ``vectorSearch``
+
+14. Create a new vector search index on ``coll0`` with the ``createSearchIndex`` helper. Use the following definition:
+
+   ```typescript
+
+     {
+       name: 'test-search-index-case7-error',
+       definition: {
+         "fields": [
+            {
+                "type": "vector",
+                "path": "plot_embedding",
+                "numDimensions": 1536,
+                "similarity": "euclidean",
+            },
+         ]
+       }
+     }
+   ```
+
+15. Assert that the command throws an exception due to the ``mappings`` field missing.

source/index-management/tests/createSearchIndex.yml

@@ -26,7 +26,7 @@ tests:
       - name: createSearchIndex
         object: *collection0
         arguments:
-          model: { definition: &definition { mappings: { dynamic: true } } }
+          model: { definition: &definition { mappings: { dynamic: true } } , type: 'search' }
         expectError:
           # This test always errors in a non-Atlas environment.  The test functions as a unit test  by asserting
           # that the driver constructs and sends the correct command.
@@ -39,15 +39,15 @@ tests:
           - commandStartedEvent:
               command:
                 createSearchIndexes: *collection0
-                indexes: [ { definition: *definition } ]
+                indexes: [ { definition: *definition, type: 'search'} ]
                 $db: *database0
 
   - description: "name provided for an index definition"
     operations:
       - name: createSearchIndex
         object: *collection0
         arguments: 
-          model: { definition: &definition { mappings: { dynamic: true } } , name: 'test index' }
+          model: { definition: &definition { mappings: { dynamic: true } } , name: 'test index', type: 'search' }
         expectError:
           # This test always errors in a non-Atlas environment.  The test functions as a unit test  by asserting
           # that the driver constructs and sends the correct command.
@@ -60,5 +60,5 @@ tests:
           - commandStartedEvent:
               command:
                 createSearchIndexes: *collection0
-                indexes: [ { definition: *definition, name: 'test index' } ]
+                indexes: [ { definition: *definition, name: 'test index', type: 'search' } ]
                 $db: *database0

source/index-management/tests/createSearchIndexes.yml

@@ -48,7 +48,7 @@ tests:
       - name: createSearchIndexes
         object: *collection0
         arguments:
-          models: [ { definition: &definition { mappings: { dynamic: true } } } ]
+          models: [ { definition: &definition { mappings: { dynamic: true } } , type: 'search' } ]
         expectError:
           # This test always errors in a non-Atlas environment.  The test functions as a unit test  by asserting
           # that the driver constructs and sends the correct command.
@@ -69,7 +69,7 @@ tests:
       - name: createSearchIndexes
         object: *collection0
         arguments: 
-          models: [ { definition: &definition { mappings: { dynamic: true } } , name: 'test index' } ]
+          models: [ { definition: &definition { mappings: { dynamic: true } } , name: 'test index' , type: 'search' } ]
         expectError:
           # This test always errors in a non-Atlas environment.  The test functions as a unit test  by asserting
           # that the driver constructs and sends the correct command.
@@ -82,5 +82,5 @@ tests:
           - commandStartedEvent:
               command:
                 createSearchIndexes: *collection0
-                indexes: [ { definition: *definition, name: 'test index' } ]
+                indexes: [ { definition: *definition, name: 'test index', type: 'search' } ]
                 $db: *database0