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

Class VectorSearch

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearch
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearch>
public final class VectorSearch extends Object implements com.azure.json.JsonSerializable<VectorSearch>
Contains configuration options related to vector search.

  • Constructor Details

    • VectorSearch

      public VectorSearch()
      Creates an instance of VectorSearch class.

  • Method Details

    • getProfiles

      public List<VectorSearchProfile> getProfiles()
      Get the profiles property: Defines combinations of configurations to use with vector search.
      Returns:
      the profiles value.

    • setProfiles

      public VectorSearch setProfiles(List<VectorSearchProfile> profiles)
      Set the profiles property: Defines combinations of configurations to use with vector search.
      Parameters:
      profiles - the profiles value to set.
      Returns:
      the VectorSearch object itself.

    • getAlgorithms

      public List<VectorSearchAlgorithmConfiguration> getAlgorithms()
      Get the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.
      Returns:
      the algorithms value.

    • setAlgorithms

      public VectorSearch setAlgorithms(List<VectorSearchAlgorithmConfiguration> algorithms)
      Set the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.
      Parameters:
      algorithms - the algorithms value to set.
      Returns:
      the VectorSearch object itself.

    • getVectorizers

      public List<VectorSearchVectorizer> getVectorizers()
      Get the vectorizers property: Contains configuration options on how to vectorize text vector queries.
      Returns:
      the vectorizers value.

    • setVectorizers

      public VectorSearch setVectorizers(List<VectorSearchVectorizer> vectorizers)
      Set the vectorizers property: Contains configuration options on how to vectorize text vector queries.
      Parameters:
      vectorizers - the vectorizers value to set.
      Returns:
      the VectorSearch object itself.

    • getCompressions

      public List<VectorSearchCompression> getCompressions()
      Get the compressions property: Contains configuration options specific to the compression method used during indexing or querying.
      Returns:
      the compressions value.

    • setCompressions

      public VectorSearch setCompressions(List<VectorSearchCompression> compressions)
      Set the compressions property: Contains configuration options specific to the compression method used during indexing or querying.
      Parameters:
      compressions - the compressions value to set.
      Returns:
      the VectorSearch 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<VectorSearch>
      Throws:
      IOException

    • fromJson

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

    • setProfiles

      public VectorSearch setProfiles(VectorSearchProfile... profiles)
      Set the profiles property: Defines combinations of configurations to use with vector search.
      Parameters:
      profiles - the profiles value to set.
      Returns:
      the VectorSearch object itself.

    • setAlgorithms

      public VectorSearch setAlgorithms(VectorSearchAlgorithmConfiguration... algorithms)
      Set the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.
      Parameters:
      algorithms - the algorithms value to set.
      Returns:
      the VectorSearch object itself.

    • setCompressions

      public VectorSearch setCompressions(VectorSearchCompression... compressions)
      Set the compressions property: Contains configuration options specific to the compression method used during indexing or querying.
      Parameters:
      compressions - the compressions value to set.
      Returns:
      the VectorSearch object itself.

    • setVectorizers

      public VectorSearch setVectorizers(VectorSearchVectorizer... vectorizers)
      Set the vectorizers property: Contains configuration options on how to vectorize text vector queries.
      Parameters:
      vectorizers - the vectorizers value to set.
      Returns:
      the VectorSearch object itself.