Class KnowledgeSourceAzureOpenAIVectorizer

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

  • Constructor Details

    • KnowledgeSourceAzureOpenAIVectorizer

      public KnowledgeSourceAzureOpenAIVectorizer()
      Creates an instance of KnowledgeSourceAzureOpenAIVectorizer class.

  • 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 KnowledgeSourceVectorizer
      Returns:
      the kind value.

    • getAzureOpenAIParameters

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

    • setAzureOpenAIParameters

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

    • fromJson

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