AzureCosmosDBMongoDBIndexOptions
AzureCosmosDBMongoDBIndexOptions =
object
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:29
Azure Cosmos DB for MongoDB vCore Index Options.
Properties
Section titled “Properties”indexType?
Section titled “indexType?”
readonlyoptionalindexType:"ivf"|"hnsw"|"diskann"
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:30
numLists?
Section titled “numLists?”
readonlyoptionalnumLists: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.
dimensions?
Section titled “dimensions?”
readonlyoptionaldimensions:number
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:34
Number of dimensions for vector similarity.
similarity?
Section titled “similarity?”
readonlyoptionalsimilarity:AzureCosmosDBMongoDBSimilarityType
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:36
Similarity metric to use with the IVF index.
readonlyoptionalm: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.
efConstruction?
Section titled “efConstruction?”
readonlyoptionalefConstruction: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.
maxDegree?
Section titled “maxDegree?”
readonlyoptionalmaxDegree:number
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:42
Max number of neighbors withe the Diskann idnex
lBuild?
Section titled “lBuild?”
readonlyoptionallBuild:number
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:44
L value for index building withe the Diskann idnex
compression?
Section titled “compression?”
readonlyoptionalcompression:"half"|"pq"
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:46
Compression value for type of vector index compression
pqCompressedDims?
Section titled “pqCompressedDims?”
readonlyoptionalpqCompressedDims:number
Defined in: .build/typescript/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts:48
PqCompressedDims value for dimensions after PQ compression
pqSampleSize?
Section titled “pqSampleSize?”
readonlyoptionalpqSampleSize: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