Removed binary break.

Author: ajcvickers

src/MongoDB.Driver/CreateSearchIndexModel.cs

@@ -21,15 +21,19 @@ namespace MongoDB.Driver
     /// Defines a vector search index model using a <see cref="BsonDocument"/> definition. Consider using
     /// <see cref="CreateVectorIndexModel{TDocument}"/> to build Atlas indexes without specifying the BSON directly.
     /// </summary>
-    public sealed class CreateSearchIndexModel : CreateSearchIndexModelBase
+    public class CreateSearchIndexModel
     {
+        /// <summary>Gets the index name.</summary>
+        /// <value>The index name.</value>
+        public string Name { get; }
+
         /// <summary>Gets the index type.</summary>
         /// <value>The index type.</value>
-        public override SearchIndexType? Type { get; }
+        public SearchIndexType? Type { get; }
 
         /// <summary>Gets the index definition.</summary>
         /// <value>The definition.</value>
-        public BsonDocument Definition { get; }
+        public virtual BsonDocument Definition { get; }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="CreateSearchIndexModel"/> class, passing the index
@@ -58,10 +62,22 @@ public CreateSearchIndexModel(string name, BsonDocument definition)
         /// <param name="type">The index type.</param>
         /// <param name="definition">The index definition.</param>
         public CreateSearchIndexModel(string name, SearchIndexType? type, BsonDocument definition)
-            : base(name)
         {
+            Name = name;
             Type = type;
             Definition = definition;
+
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CreateSearchIndexModel"/> class.
+        /// </summary>
+        /// <param name="name">The index name.</param>
+        /// <param name="type">The index type.</param>
+        protected CreateSearchIndexModel(string name, SearchIndexType? type)
+        {
+            Name = name;
+            Type = type;
         }
     }
 }

src/MongoDB.Driver/CreateSearchIndexModelBase.cs

@@ -24,8 +24,51 @@ namespace MongoDB.Driver;
 /// <summary>
 /// Defines a vector index model using strongly-typed C# APIs.
 /// </summary>
-public sealed class CreateVectorIndexModel<TDocument> : CreateSearchIndexModelBase
+public sealed class CreateVectorIndexModel<TDocument> : CreateSearchIndexModel
 {
+    /// <summary>
+    /// The field containing the vectors to index.
+    /// </summary>
+    public FieldDefinition<TDocument> Field { get; }
+
+    /// <summary>
+    /// The <see cref="VectorSimilarity"/> to use to search for top K-nearest neighbors.
+    /// </summary>
+    public VectorSimilarity Similarity { get; }
+
+    /// <summary>
+    /// Number of vector dimensions that vector search enforces at index-time and query-time.
+    /// </summary>
+    public int Dimensions { get; }
+
+    /// <summary>
+    /// Fields that may be used as filters in the vector query.
+    /// </summary>
+    public IReadOnlyList<FieldDefinition<TDocument>> FilterFields { get; }
+
+    /// <summary>
+    /// Type of automatic vector quantization for your vectors.
+    /// </summary>
+    public VectorQuantization? Quantization { get; init; }
+
+    /// <summary>
+    /// Maximum number of edges (or connections) that a node can have in the Hierarchical Navigable Small Worlds graph.
+    /// </summary>
+    public int? HnswMaxEdges { get; init; }
+
+    /// <summary>
+    /// Analogous to numCandidates at query-time, this parameter controls the maximum number of nodes to evaluate to find the closest neighbors to connect to a new node.
+    /// </summary>
+    public int? HnswNumEdgeCandidates { get; init; }
+
+    /// <summary>
+    /// This method should not be called on this subtype. Instead, call <see cref="Render"/> to create a BSON
+    /// document for the index model.
+    /// </summary>
+    public override BsonDocument Definition
+        => throw new NotSupportedException(
+            "This method should not be called on this subtype. Instead, call 'Render' to create a BSON document for the index model.");
+
     /// <summary>
     /// Initializes a new instance of the <see cref="CreateVectorIndexModel{TDocument}"/> class, passing the
     /// required options for <see cref="VectorSimilarity"/> and the number of vector dimensions to the constructor.
@@ -41,7 +84,7 @@ public CreateVectorIndexModel(
         VectorSimilarity similarity,
         int dimensions,
         params FieldDefinition<TDocument>[] filterFields)
-        : base(name)
+        : base(name, SearchIndexType.VectorSearch)
     {
         Field = field;
         Similarity = similarity;
@@ -75,44 +118,6 @@ public CreateVectorIndexModel(
     {
     }
 
-    /// <summary>
-    /// The field containing the vectors to index.
-    /// </summary>
-    public FieldDefinition<TDocument> Field { get; }
-
-    /// <summary>
-    /// The <see cref="VectorSimilarity"/> to use to search for top K-nearest neighbors.
-    /// </summary>
-    public VectorSimilarity Similarity { get; }
-
-    /// <summary>
-    /// Number of vector dimensions that vector search enforces at index-time and query-time.
-    /// </summary>
-    public int Dimensions { get; }
-
-    /// <summary>
-    /// Fields that may be used as filters in the vector query.
-    /// </summary>
-    public IReadOnlyList<FieldDefinition<TDocument>> FilterFields { get; }
-
-    /// <summary>
-    /// Type of automatic vector quantization for your vectors.
-    /// </summary>
-    public VectorQuantization? Quantization { get; init; }
-
-    /// <summary>
-    /// Maximum number of edges (or connections) that a node can have in the Hierarchical Navigable Small Worlds graph.
-    /// </summary>
-    public int? HnswMaxEdges { get; init; }
-
-    /// <summary>
-    /// Analogous to numCandidates at query-time, this parameter controls the maximum number of nodes to evaluate to find the closest neighbors to connect to a new node.
-    /// </summary>
-    public int? HnswNumEdgeCandidates { get; init; }
-
-    /// <inheritdoc/>
-    public override SearchIndexType? Type => SearchIndexType.VectorSearch;
-
     /// <summary>
     /// Renders the index model to a <see cref="BsonDocument"/>.
     /// </summary>

src/MongoDB.Driver/CreateVectorIndexModel.cs

@@ -1655,7 +1655,7 @@ public MongoSearchIndexManager(MongoCollectionImpl<TDocument> collection)
                 _collection = Ensure.IsNotNull(collection, nameof(collection));
             }
 
-            public IEnumerable<string> CreateMany(IEnumerable<CreateSearchIndexModelBase> models, CancellationToken cancellationToken = default)
+            public IEnumerable<string> CreateMany(IEnumerable<CreateSearchIndexModel> models, CancellationToken cancellationToken = default)
             {
                 using var session = _collection._operationExecutor.StartImplicitSession();
                 var operation = CreateCreateIndexesOperation(models);
@@ -1664,7 +1664,7 @@ public IEnumerable<string> CreateMany(IEnumerable<CreateSearchIndexModelBase> mo
                 return GetIndexNames(result);
             }
 
-            public async Task<IEnumerable<string>> CreateManyAsync(IEnumerable<CreateSearchIndexModelBase> models, CancellationToken cancellationToken = default)
+            public async Task<IEnumerable<string>> CreateManyAsync(IEnumerable<CreateSearchIndexModel> models, CancellationToken cancellationToken = default)
             {
                 using var session = _collection._operationExecutor.StartImplicitSession();
                 var operation = CreateCreateIndexesOperation(models);
@@ -1676,7 +1676,7 @@ public async Task<IEnumerable<string>> CreateManyAsync(IEnumerable<CreateSearchI
             public string CreateOne(BsonDocument definition, string name = null, CancellationToken cancellationToken = default) =>
                 CreateOne(new CreateSearchIndexModel(name, definition), cancellationToken);
 
-            public string CreateOne(CreateSearchIndexModelBase model, CancellationToken cancellationToken = default)
+            public string CreateOne(CreateSearchIndexModel model, CancellationToken cancellationToken = default)
             {
                 var result = CreateMany(new[] { model }, cancellationToken);
                 return result.Single();
@@ -1685,7 +1685,7 @@ public string CreateOne(CreateSearchIndexModelBase model, CancellationToken canc
             public Task<string> CreateOneAsync(BsonDocument definition, string name = null, CancellationToken cancellationToken = default) =>
                 CreateOneAsync(new CreateSearchIndexModel(name, definition), cancellationToken);
 
-            public async Task<string> CreateOneAsync(CreateSearchIndexModelBase model, CancellationToken cancellationToken = default)
+            public async Task<string> CreateOneAsync(CreateSearchIndexModel model, CancellationToken cancellationToken = default)
             {
                 var result = await CreateManyAsync(new[] { model }, cancellationToken).ConfigureAwait(false);
                 return result.Single();
@@ -1742,7 +1742,7 @@ private PipelineDefinition<TDocument, BsonDocument> CreateListIndexesStage(strin
             }
 
             private CreateSearchIndexesOperation CreateCreateIndexesOperation(
-                IEnumerable<CreateSearchIndexModelBase> models)
+                IEnumerable<CreateSearchIndexModel> models)
             {
                 var renderArgs = _collection.GetRenderArgs();
 
@@ -1752,15 +1752,9 @@ private CreateSearchIndexesOperation CreateCreateIndexesOperation(
                         => new CreateSearchIndexRequest(
                             model.Name,
                             model.Type,
-                            model switch
-                            {
-                                CreateSearchIndexModel createSearchIndexModel
-                                    => createSearchIndexModel.Definition,
-                                CreateVectorIndexModel<TDocument> createAtlasVectorIndexModel
-                                    => createAtlasVectorIndexModel.Render(renderArgs),
-                                _ => throw new NotSupportedException(
-                                    $"'{model.GetType().Name}' is not a supported index model type.")
-                            })),
+                            model is CreateVectorIndexModel<TDocument> createVectorIndexModel
+                                ? createVectorIndexModel.Render(renderArgs)
+                                : model.Definition)),
                     _collection._messageEncoderSettings);
             }
 

src/MongoDB.Driver/MongoCollectionImpl.cs

@@ -33,7 +33,7 @@ public interface IMongoSearchIndexManager
         /// <returns>
         /// An <see cref="IEnumerable{String}" /> of the names of the indexes that were created.
         /// </returns>
-        IEnumerable<string> CreateMany(IEnumerable<CreateSearchIndexModelBase> models, CancellationToken cancellationToken = default);
+        IEnumerable<string> CreateMany(IEnumerable<CreateSearchIndexModel> models, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Creates multiple indexes.
@@ -43,7 +43,7 @@ public interface IMongoSearchIndexManager
         /// <returns>
         /// A Task whose result is an <see cref="IEnumerable{String}" /> of the names of the indexes that were created.
         /// </returns>
-        Task<IEnumerable<string>> CreateManyAsync(IEnumerable<CreateSearchIndexModelBase> models, CancellationToken cancellationToken = default);
+        Task<IEnumerable<string>> CreateManyAsync(IEnumerable<CreateSearchIndexModel> models, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Creates a search index.
@@ -64,7 +64,7 @@ public interface IMongoSearchIndexManager
         /// <returns>
         /// The name of the index that was created.
         /// </returns>
-        string CreateOne(CreateSearchIndexModelBase model, CancellationToken cancellationToken = default);
+        string CreateOne(CreateSearchIndexModel model, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Creates a search index.
@@ -85,7 +85,7 @@ public interface IMongoSearchIndexManager
         /// <returns>
         /// A Task whose result is the name of the index that was created.
         /// </returns>
-        Task<string> CreateOneAsync(CreateSearchIndexModelBase model, CancellationToken cancellationToken = default);
+        Task<string> CreateOneAsync(CreateSearchIndexModel model, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Drops an index by its name.

src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs

@@ -33,7 +33,7 @@ public enum VectorSimilarity
     Cosine,
 
     /// <summary>
-    /// mMasures similarity like cosine, but takes into account the magnitude of the vector.
+    /// Measures similarity like cosine, but takes into account the magnitude of the vector.
     /// </summary>
     DotProduct,
 }