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

Class AzureOpenAIVectorizer

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchVectorizer
com.azure.search.documents.indexes.models.AzureOpenAIVectorizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchVectorizer>
public final class AzureOpenAIVectorizer extends VectorSearchVectorizer
Specifies the Azure OpenAI resource used to vectorize a query string.

  • Constructor Details

    • AzureOpenAIVectorizer

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

  • Method Details

    • getKind

      public VectorSearchVectorizerKind getKind()
      Get the kind property: The name of the kind of vectorization method being configured for use with vector search.
      Overrides:
      getKind in class VectorSearchVectorizer
      Returns:
      the kind value.

    • getParameters

      public AzureOpenAIVectorizerParameters getParameters()
      Get the parameters property: Contains the parameters specific to Azure OpenAI embedding vectorization.
      Returns:
      the parameters value.

    • setParameters

      public AzureOpenAIVectorizer setParameters(AzureOpenAIVectorizerParameters parameters)
      Set the parameters property: Contains the parameters specific to Azure OpenAI embedding vectorization.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the AzureOpenAIVectorizer 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<VectorSearchVectorizer>
      Overrides:
      toJson in class VectorSearchVectorizer
      Throws:
      IOException

    • fromJson

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