VectorIndex Constructors

Definition

Namespace:

Microsoft.Azure.Management.CosmosDB.Models

Assembly:

Microsoft.Azure.PowerShell.CosmosDB.Management.Sdk.dll

Overloads

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()

Initializes a new instance of the VectorIndex class.

public VectorIndex();

Public Sub New ()

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

Initializes a new instance of the VectorIndex class.

public VectorIndex(string path, string type, long? quantizationByteSize = default, long? indexingSearchListSize = default, System.Collections.Generic.IList<string> vectorIndexShardKey = default);

new Microsoft.Azure.Management.CosmosDB.Models.VectorIndex : string * string * Nullable<int64> * Nullable<int64> * System.Collections.Generic.IList<string> -> Microsoft.Azure.Management.CosmosDB.Models.VectorIndex

Public Sub New (path As String, type As String, Optional quantizationByteSize As Nullable(Of Long) = Nothing, Optional indexingSearchListSize As Nullable(Of Long) = Nothing, Optional vectorIndexShardKey As IList(Of String) = Nothing)

Parameters

path

String

The path to the vector field in the document.

type

String

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

quantizationByteSize

Nullable<Int64>

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.

indexingSearchListSize

Nullable<Int64>

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.

vectorIndexShardKey

IList<String>

Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.