VectorIndex Class

Definition

public class VectorIndex
type VectorIndex = class
Public Class VectorIndex
Inheritance
VectorIndex

Constructors

Name Description
VectorIndex()

Initializes a new instance of the VectorIndex class.

VectorIndex(String, String, Nullable<Int64>, Nullable<Int64>, IList<String>)

Initializes a new instance of the VectorIndex class.

VectorIndex(String, String)

Initializes a new instance of the VectorIndex class.

Properties

Name Description
IndexingSearchListSize

Gets or sets this is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.

Path

Gets or sets the path to the vector field in the document.

QuantizationByteSize

Gets or sets the number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.

Type

Gets or sets the index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. Possible values include: 'flat', 'diskANN', 'quantizedFlat'

VectorIndexShardKey

Gets or sets array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.

Methods

Name Description
Validate()

Validate the object.

Applies to