Class VectorSearchOptions<TDocument>

Namespace: MongoDB.Driver

Assembly: MongoDB.Driver.dll

Vector search options.

public sealed class VectorSearchOptions<TDocument>

Type Parameters

TDocument: The type of the document.

Inheritance: object

VectorSearchOptions<TDocument>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AutoEmbeddingModelName: The model to for auto-embedding in the query. Must be compatible with the model used to create the index.

EmbeddedScoreMode: Gets or sets the function to use when scoring results from a search on embedded documents.

Exact: Gets or sets a value indicating if exact nearest neighbor (ENN) is to be used, false by default. If false, approximate nearest neighbor (ANN) is used.

Filter: Gets or sets the filter.

IndexName: Gets or sets the name of the index.

NestedFilter: Gets or sets the nested filter. This can only be used when the vector search is performed on a nested document, in which case this filter can be used as an additional filter on the nested documents.

NumberOfCandidates: Gets or sets the number of candidates.

ReturnStoredSource: Gets or sets a flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.