Package com.azure.cosmos.models

Class CosmosVectorIndexSpec

java.lang.Object
com.azure.cosmos.models.CosmosVectorIndexSpec
public final class CosmosVectorIndexSpec extends Object
Vector Indexes spec for Azure CosmosDB service.

  • Constructor Details

    • CosmosVectorIndexSpec

      public CosmosVectorIndexSpec()
      Constructor

  • Method Details

    • getPath

      public String getPath()
      Gets path.
      Returns:
      the path.

    • setPath

      public CosmosVectorIndexSpec setPath(String path)
      Sets path.
      Parameters:
      path - the path.
      Returns:
      the SpatialSpec.

    • getType

      public String getType()
      Gets the vector index type for the vector index
      Returns:
      the vector index type

    • setType

      public CosmosVectorIndexSpec setType(String type)
      Sets the vector index type for the vector index
      Parameters:
      type - the vector index type
      Returns:
      the VectorIndexSpec

    • getQuantizationSizeInBytes

      public Integer getQuantizationSizeInBytes()
      Gets the quantization byte size
      Returns:
      quantizationByteSize 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 applies to index types DiskANN and quantizedFlat. The allowed range for this parameter is between 1 and 3.

    • setQuantizationSizeInBytes

      public CosmosVectorIndexSpec setQuantizationSizeInBytes(Integer quantizationByteSize)
      Sets the quantization byte size
      Parameters:
      quantizationByteSize - 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 applies to index types DiskANN and quantizedFlat. The allowed range for this parameter is between 1 and min(Dimensions, 512). The default value would be 64.
      Returns:
      CosmosVectorIndexSpec

    • getIndexingSearchListSize

      public Integer getIndexingSearchListSize()
      Gets the indexing search list size
      Returns:
      indexingSearchListSize which represents the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. The allowed range for this parameter is between 25 and 500.

    • setIndexingSearchListSize

      public CosmosVectorIndexSpec setIndexingSearchListSize(Integer indexingSearchListSize)
      Sets the indexing search list size
      Parameters:
      indexingSearchListSize - indexingSearchListSize which represents the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. The allowed range for this parameter is between 25 and 500.
      Returns:
      CosmosVectorIndexSpec