Table of Contents

Struct VectorIndexOptions

Namespace
MongoDB.EntityFrameworkCore.Metadata
Assembly
MongoDB.EntityFrameworkCore.dll

Atlas Vector Search index options. See How to Index Fields for Vector Search for more information.

public readonly record struct VectorIndexOptions : IEquatable<VectorIndexOptions>
Implements
Inherited Members

Constructors

VectorIndexOptions()

Creates an uninitialized Atlas Vector Search index options object.

VectorIndexOptions(VectorSimilarity, int, VectorQuantization?, int?, int?, IReadOnlyList<string>?)

Atlas Vector Search index options. See How to Index Fields for Vector Search for more information.

Properties

Dimensions

Number of vector dimensions that Atlas Vector Search enforces at index-time and query-time.

FilterPaths

Paths to properties that may be used as filters on the entity type or its nested types.

HnswMaxEdges

Maximum number of edges (or connections) that a node can have in the Hierarchical Navigable Small Worlds graph.

HnswNumEdgeCandidates

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.

Quantization

Type of automatic vector quantization for your vectors.

Similarity

The MongoDB.Driver.VectorSimilarity to use to search for top K-nearest neighbors.