Package version:

Interface VectorIndex

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

interface VectorIndex {
    indexingSearchListSize?: number;
    path: string;
    quantizationByteSize?: number;
    type: VectorIndexType;
    vectorIndexShardKey?: string[];
}

Properties

indexingSearchListSize? path quantizationByteSize? type vectorIndexShardKey?

Properties

OptionalindexingSearchListSize

indexingSearchListSize?: number

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

path: string

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

OptionalquantizationByteSize

quantizationByteSize?: number

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

type: VectorIndexType

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

OptionalvectorIndexShardKey

vectorIndexShardKey?: string[]

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.

Settings

Member Visibility