VectorIndex interface

Package:

@azure/cosmos

Represents a vector index in the Azure Cosmos DB service. A vector index is used to index vector fields in the documents.

Properties

indexingSearchListSize	The size of the candidate list of approximate neighbors stored while building the diskANN index as part of the optimization processes. This is an optional parameter and applies to index type DiskANN only. The allowed range is between 25 and 500.
path	The path to the vector field in the document. for example, path: "/path/to/vector".
quantizationByteSize	The number of bytes used in product quantization of the vectors. This is an optional parameter and applies to index types DiskANN and quantizedFlat. The allowed range for this parameter is between 1 and min(Dimensions, 512).
type	The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
vectorIndexShardKey	The list of string containing the shard keys used for partitioning the vector indexes. This is an optional parameter and applies to index types DiskANN and quantizedFlat.

Property Details

indexingSearchListSize

The size of the candidate list of approximate neighbors stored while building the diskANN index as part of the optimization processes. This is an optional parameter and applies to index type DiskANN only. The allowed range is between 25 and 500.

indexingSearchListSize?: number

Property Value

number

path

The path to the vector field in the document. for example, path: "/path/to/vector".

path: string

Property Value

string

quantizationByteSize

The number of bytes used in product quantization of the vectors. This is an optional parameter and applies to index types DiskANN and quantizedFlat. The allowed range for this parameter is between 1 and min(Dimensions, 512).

quantizationByteSize?: number

Property Value

number

type

The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

type: VectorIndexType

Property Value

VectorIndexType

vectorIndexShardKey

The list of string containing the shard keys used for partitioning the vector indexes. This is an optional parameter and applies to index types DiskANN and quantizedFlat.

vectorIndexShardKey?: string[]

Property Value

string[]