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

Class VectorSearchProfile

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchProfile
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchProfile>
public final class VectorSearchProfile extends Object implements com.azure.json.JsonSerializable<VectorSearchProfile>
Defines a combination of configurations to use with vector search.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VectorSearchProfile(String name, String algorithmConfigurationName)
    Creates an instance of VectorSearchProfile class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VectorSearchProfile
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of VectorSearchProfile from the JsonReader.
    String
    getAlgorithmConfigurationName()
    Get the algorithmConfigurationName property: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.
    String
    getCompressionName()
    Get the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.
    String
    getName()
    Get the name property: The name to associate with this particular vector search profile.
    String
    getVectorizerName()
    Get the vectorizerName property: The name of the vectorization being configured for use with vector search.
    VectorSearchProfile
    setCompressionName(String compressionName)
    Set the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.
    VectorSearchProfile
    setVectorizerName(String vectorizerName)
    Set the vectorizerName property: The name of the vectorization being configured for use with vector search.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    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

    • VectorSearchProfile

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

  • Method Details

    • getName

      public String getName()
      Get the name property: The name to associate with this particular vector search profile.
      Returns:
      the name value.

    • getAlgorithmConfigurationName

      public String getAlgorithmConfigurationName()
      Get the algorithmConfigurationName property: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.
      Returns:
      the algorithmConfigurationName value.

    • getVectorizerName

      public String getVectorizerName()
      Get the vectorizerName property: The name of the vectorization being configured for use with vector search.
      Returns:
      the vectorizerName value.

    • setVectorizerName

      public VectorSearchProfile setVectorizerName(String vectorizerName)
      Set the vectorizerName property: The name of the vectorization being configured for use with vector search.
      Parameters:
      vectorizerName - the vectorizerName value to set.
      Returns:
      the VectorSearchProfile object itself.

    • getCompressionName

      public String getCompressionName()
      Get the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.
      Returns:
      the compressionName value.

    • setCompressionName

      public VectorSearchProfile setCompressionName(String compressionName)
      Set the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.
      Parameters:
      compressionName - the compressionName value to set.
      Returns:
      the VectorSearchProfile 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<VectorSearchProfile>
      Throws:
      IOException

    • fromJson

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