Package com.azure.search.documents.indexes.models

Class ExhaustiveKnnAlgorithmConfiguration

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration
com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchAlgorithmConfiguration>
public final class ExhaustiveKnnAlgorithmConfiguration extends VectorSearchAlgorithmConfiguration
Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index.

  • Constructor Details

    • ExhaustiveKnnAlgorithmConfiguration

      public ExhaustiveKnnAlgorithmConfiguration(String name)
      Creates an instance of ExhaustiveKnnAlgorithmConfiguration 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 ExhaustiveKnnParameters getParameters()
      Get the parameters property: Contains the parameters specific to exhaustive KNN algorithm.
      Returns:
      the parameters value.

    • setParameters

      public ExhaustiveKnnAlgorithmConfiguration setParameters(ExhaustiveKnnParameters parameters)
      Set the parameters property: Contains the parameters specific to exhaustive KNN algorithm.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the ExhaustiveKnnAlgorithmConfiguration 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 ExhaustiveKnnAlgorithmConfiguration fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ExhaustiveKnnAlgorithmConfiguration from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ExhaustiveKnnAlgorithmConfiguration 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 ExhaustiveKnnAlgorithmConfiguration.