Skip to content

AzureCosmosDBMongoDBIndexOptions

AzureCosmosDBMongoDBIndexOptions = object

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:29

Azure Cosmos DB for MongoDB vCore Index Options.

readonly optional indexType: "ivf" | "hnsw" | "diskann"

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:30


readonly optional numLists: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:32

Number of clusters that the inverted file (IVF) index uses to group the vector data.


readonly optional dimensions: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:34

Number of dimensions for vector similarity.


readonly optional similarity: AzureCosmosDBMongoDBSimilarityType

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:36

Similarity metric to use with the IVF index.


readonly optional m: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:38

The max number of connections per layer with the HNSW index.


readonly optional efConstruction: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:40

The size of the dynamic candidate list for constructing the graph with the HNSW index.


readonly optional maxDegree: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:42

Max number of neighbors withe the Diskann idnex


readonly optional lBuild: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:44

L value for index building withe the Diskann idnex


readonly optional compression: "half" | "pq"

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:46

Compression value for type of vector index compression


readonly optional pqCompressedDims: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:48

PqCompressedDims value for dimensions after PQ compression


readonly optional pqSampleSize: number

Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:50

PqSampleSize value for number of sample vectors for PQ centroid training