Add 'type' field support for Search Index creation.

driver-core/src/main/com/mongodb/client/model/SearchIndexModel.java

@@ -31,6 +31,8 @@ public final class SearchIndexModel {
     @Nullable
     private final String name;
     private final Bson definition;
+    @Nullable
+    private final SearchIndexType type;
 
     /**
      * Construct an instance with the given Atlas Search index mapping definition.
@@ -44,6 +46,24 @@ public final class SearchIndexModel {
     public SearchIndexModel(final Bson definition) {
         this.definition = notNull("definition", definition);
         this.name = null;
+        this.type = null;
+    }
+
+    /**
+     * Construct an instance with the given Atlas Search index mapping definition.
+     *
+     * <p>After calling this constructor, the {@code name} field will be {@code null}. In that case, when passing this
+     * {@code SearchIndexModel} to the {@code createSearchIndexes} method, the default search index name 'default'
+     * will be used to create the search index.</p>
+     *
+     * @param definition the search index mapping definition.
+     * @param type       the search index type.
+     * @since 5.2
+     */
+    public SearchIndexModel(final Bson definition, final SearchIndexType type) {
+        this.definition = notNull("definition", definition);
+        this.type = notNull("type", type);
+        this.name = null;
     }
 
     /**
@@ -55,6 +75,21 @@ public SearchIndexModel(final Bson definition) {
     public SearchIndexModel(final String name, final Bson definition) {
         this.definition = notNull("definition", definition);
         this.name = notNull("name", name);
+        this.type = null;
+    }
+
+    /**
+     * Construct an instance with the given Atlas Search name, index definition, and type.
+     *
+     * @param name       the search index name.
+     * @param definition the search index mapping definition.
+     * @param type the search index type.
+     * @since 5.2
+     */
+    public SearchIndexModel(final String name, final Bson definition, final SearchIndexType type) {
+        this.definition = notNull("definition", definition);
+        this.name = notNull("name", name);
+        this.type = notNull("type", type);
     }
 
     /**
@@ -76,11 +111,22 @@ public String getName() {
         return name;
     }
 
+    /**
+     * Get the Atlas Search index type.
+     *
+     * @return the search index type.
+     */
+    @Nullable
+    public SearchIndexType getType() {
+        return type;
+    }
+
     @Override
     public String toString() {
         return "SearchIndexModel{"
                 + "name=" + name
                 + ", definition=" + definition
+                + ", type=" + (type == null ? "null" : type.toBsonValue())
                 + '}';
     }
 }

driver-core/src/main/com/mongodb/client/model/SearchIndexType.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb.client.model;
+
+import com.mongodb.annotations.Sealed;
+import org.bson.BsonString;
+import org.bson.BsonValue;
+
+import static com.mongodb.assertions.Assertions.notNull;
+
+/**
+ * This interface represents an Atlas Search Index type, which is utilized for creating specific types of indexes.
+ * <p>
+ * It provides methods for creating and converting Atlas Search Index types to {@link BsonValue}.
+ * </p>
+ *
+ * @mongodb.server.release 7.0
+ * @see SearchIndexModel The model class that utilizes this index type.
+ * @since 5.2
+ */
+@Sealed
+public interface SearchIndexType {
+
+    /**
+     * Returns a {@link SearchIndexType} instance representing the "search" index type.
+     *
+     * @return The requested {@link SearchIndexType}.
+     */
+    static SearchIndexType search() {
+        return new SearchIndexTypeBson(new BsonString("search"));
+    }
+
+    /**
+     * Returns a {@link SearchIndexType} instance representing the "verctorSearch" index type.
+     *
+     * @return The requested {@link SearchIndexType}.
+     */
+    static SearchIndexType vectorSearch() {
+        return new SearchIndexTypeBson(new BsonString("vectorSearch"));
+    }
+
+    /**
+     * Creates a {@link SearchIndexType} from a {@link BsonValue} in situations when there is no builder method
+     * that better satisfies your needs.
+     * This method cannot be used to validate the syntax.
+     * <p>
+     * <i>Example</i><br>
+     * The following code creates two functionally equivalent {@link SearchIndexType}s,
+     * though they may not be {@linkplain Object#equals(Object) equal}.
+     * <pre>{@code
+     *  SearchIndexType method1 = SearchIndexType.vectorSearch();
+     *  SearchIndexType method2 = SearchIndexType.of(new BsonString("vectorSearch"));
+     * }</pre>
+     *
+     * @param indexType A {@link BsonValue} representing the required {@link SearchIndexType}.
+     * @return The requested {@link SearchIndexType}.
+     */
+    static SearchIndexType of(final BsonValue indexType) {
+        notNull("indexType", indexType);
+        return new SearchIndexTypeBson(indexType);
+    }
+
+    /**
+     * Converts this object to {@link BsonValue}.
+     *
+     * @return A {@link BsonValue} representing this {@link SearchIndexType}.
+     */
+    BsonValue toBsonValue();
+}

driver-core/src/main/com/mongodb/client/model/SearchIndexTypeBson.java

@@ -0,0 +1,52 @@
+package com.mongodb.client.model;
+
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.bson.BsonValue;
+
+import java.util.Objects;
+
+final class SearchIndexTypeBson implements SearchIndexType {
+    private final BsonValue bsonValue;
+
+    SearchIndexTypeBson(final BsonValue bsonValue) {
+        this.bsonValue = bsonValue;
+    }
+
+    @Override
+    public BsonValue toBsonValue() {
+        return bsonValue;
+    }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        SearchIndexTypeBson that = (SearchIndexTypeBson) o;
+        return Objects.equals(bsonValue, that.bsonValue);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(bsonValue);
+    }
+}
+

driver-core/src/main/com/mongodb/internal/operation/CreateSearchIndexesOperation.java

@@ -17,6 +17,7 @@
 package com.mongodb.internal.operation;
 
 import com.mongodb.MongoNamespace;
+import com.mongodb.client.model.SearchIndexType;
 import org.bson.BsonArray;
 import org.bson.BsonDocument;
 import org.bson.BsonString;
@@ -52,6 +53,10 @@ private static BsonDocument convert(final SearchIndexRequest request) {
         if (searchIndexName != null) {
             bsonIndexRequest.append("name", new BsonString(searchIndexName));
         }
+        SearchIndexType searchIndexType = request.getSearchIndexType();
+        if (searchIndexType != null) {
+            bsonIndexRequest.append("type", searchIndexType.toBsonValue());
+        }
         bsonIndexRequest.append("definition", request.getDefinition());
         return bsonIndexRequest;
     }

driver-core/src/main/com/mongodb/internal/operation/Operations.java

@@ -47,6 +47,7 @@
 import com.mongodb.client.model.ReplaceOptions;
 import com.mongodb.client.model.ReturnDocument;
 import com.mongodb.client.model.SearchIndexModel;
+import com.mongodb.client.model.SearchIndexType;
 import com.mongodb.client.model.UpdateManyModel;
 import com.mongodb.client.model.UpdateOneModel;
 import com.mongodb.client.model.UpdateOptions;
@@ -772,8 +773,8 @@ private List<BsonDocument> toBsonDocumentList(@Nullable final List<? extends Bso
     private SearchIndexRequest createSearchIndexRequest(final SearchIndexModel model) {
         BsonDocument definition = assertNotNull(toBsonDocument(model.getDefinition()));
         String indexName = model.getName();
+        SearchIndexType searchIndexType = model.getType();
 
-        SearchIndexRequest indexRequest = new SearchIndexRequest(definition, indexName);
-        return indexRequest;
+        return new SearchIndexRequest(definition, indexName, searchIndexType);
     }
 }

driver-core/src/main/com/mongodb/internal/operation/SearchIndexRequest.java

@@ -16,6 +16,7 @@
 
 package com.mongodb.internal.operation;
 
+import com.mongodb.client.model.SearchIndexType;
 import com.mongodb.lang.Nullable;
 import org.bson.BsonDocument;
 
@@ -34,11 +35,21 @@ final class SearchIndexRequest {
     private final BsonDocument definition;
     @Nullable
     private final String indexName;
+    @Nullable
+    private final SearchIndexType searchIndexType;
+
+    SearchIndexRequest(final BsonDocument definition, @Nullable final String indexName, final SearchIndexType searchIndexType) {
+        assertNotNull(definition);
+        this.definition = definition;
+        this.indexName = indexName;
+        this.searchIndexType = searchIndexType;
+    }
 
     SearchIndexRequest(final BsonDocument definition, @Nullable final String indexName) {
         assertNotNull(definition);
         this.definition = definition;
         this.indexName = indexName;
+        this.searchIndexType = null;
     }
 
     public BsonDocument getDefinition() {
@@ -49,4 +60,9 @@ public BsonDocument getDefinition() {
     public String getIndexName() {
         return indexName;
     }
+    @Nullable
+    public SearchIndexType getSearchIndexType() {
+        return searchIndexType;
+    }
+
 }

driver-core/src/test/resources/unified-test-format/index-management/createSearchIndex.json

@@ -50,7 +50,8 @@
                 "mappings": {
                   "dynamic": true
                 }
-              }
+              },
+              "type": "search"
             }
           },
           "expectError": {
@@ -73,7 +74,8 @@
                         "mappings": {
                           "dynamic": true
                         }
-                      }
+                      },
+                      "type": "search"
                     }
                   ],
                   "$db": "database0"
@@ -97,7 +99,8 @@
                   "dynamic": true
                 }
               },
-              "name": "test index"
+              "name": "test index",
+              "type": "search"
             }
           },
           "expectError": {
@@ -121,7 +124,68 @@
                           "dynamic": true
                         }
                       },
-                      "name": "test index"
+                      "name": "test index",
+                      "type": "search"
+                    }
+                  ],
+                  "$db": "database0"
+                }
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "description": "create a vector search index",
+      "operations": [
+        {
+          "name": "createSearchIndex",
+          "object": "collection0",
+          "arguments": {
+            "model": {
+              "definition": {
+                "fields": [
+                  {
+                    "type": "vector",
+                    "path": "plot_embedding",
+                    "numDimensions": 1536,
+                    "similarity": "euclidean"
+                  }
+                ]
+              },
+              "name": "test index",
+              "type": "vectorSearch"
+            }
+          },
+          "expectError": {
+            "isError": true,
+            "errorContains": "Atlas"
+          }
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "createSearchIndexes": "collection0",
+                  "indexes": [
+                    {
+                      "definition": {
+                        "fields": [
+                          {
+                            "type": "vector",
+                            "path": "plot_embedding",
+                            "numDimensions": 1536,
+                            "similarity": "euclidean"
+                          }
+                        ]
+                      },
+                      "name": "test index",
+                      "type": "vectorSearch"
                     }
                   ],
                   "$db": "database0"