Package com.azure.resourcemanager.cosmos.models

Class VectorIndex

java.lang.Object
com.azure.resourcemanager.cosmos.models.VectorIndex
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorIndex>
public final class VectorIndex extends Object implements com.azure.json.JsonSerializable<VectorIndex>
The VectorIndex model.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VectorIndex()
    Creates an instance of VectorIndex class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VectorIndex
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of VectorIndex from the JsonReader.
    String
    path()
    Get the path property: The path to the vector field in the document.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    VectorIndexType
    type()
    Get the type property: The index type of the vector.
    void
    validate()
    Validates the instance.
    VectorIndex
    withPath(String path)
    Set the path property: The path to the vector field in the document.
    VectorIndex
    withType(VectorIndexType type)
    Set the type property: The index type of the vector.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • VectorIndex

      public VectorIndex()
      Creates an instance of VectorIndex class.

  • Method Details

    • path

      public String path()
      Get the path property: The path to the vector field in the document.
      Returns:
      the path value.

    • withPath

      public VectorIndex withPath(String path)
      Set the path property: The path to the vector field in the document.
      Parameters:
      path - the path value to set.
      Returns:
      the VectorIndex object itself.

    • type

      public VectorIndexType type()
      Get the type property: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
      Returns:
      the type value.

    • withType

      public VectorIndex withType(VectorIndexType type)
      Set the type property: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
      Parameters:
      type - the type value to set.
      Returns:
      the VectorIndex object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<VectorIndex>
      Throws:
      IOException

    • fromJson

      public static VectorIndex fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VectorIndex from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VectorIndex if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the VectorIndex.