Class HnswAlgorithmConfiguration

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration
com.azure.search.documents.indexes.models.HnswAlgorithmConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchAlgorithmConfiguration>
public final class HnswAlgorithmConfiguration extends VectorSearchAlgorithmConfiguration
Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy.

  • Constructor Details

    • HnswAlgorithmConfiguration

      public HnswAlgorithmConfiguration(String name)
      Creates an instance of HnswAlgorithmConfiguration class.
      Parameters:
      name - the name value to set.

  • Method Details

    • getKind

      public VectorSearchAlgorithmKind getKind()
      Get the kind property: The name of the kind of algorithm being configured for use with vector search.
      Overrides:
      getKind in class VectorSearchAlgorithmConfiguration
      Returns:
      the kind value.

    • getParameters

      public HnswParameters getParameters()
      Get the parameters property: Contains the parameters specific to HNSW algorithm.
      Returns:
      the parameters value.

    • setParameters

      public HnswAlgorithmConfiguration setParameters(HnswParameters parameters)
      Set the parameters property: Contains the parameters specific to HNSW algorithm.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the HnswAlgorithmConfiguration object itself.

    • toJson

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

    • fromJson

      public static HnswAlgorithmConfiguration fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of HnswAlgorithmConfiguration from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of HnswAlgorithmConfiguration 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 HnswAlgorithmConfiguration.