Class KnowledgeBaseAzureOpenAIModel

java.lang.Object
com.azure.search.documents.indexes.models.KnowledgeBaseModel
com.azure.search.documents.indexes.models.KnowledgeBaseAzureOpenAIModel
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeBaseModel>
public final class KnowledgeBaseAzureOpenAIModel extends KnowledgeBaseModel
Specifies the Azure OpenAI resource used to do query planning.

  • Constructor Details

    • KnowledgeBaseAzureOpenAIModel

      public KnowledgeBaseAzureOpenAIModel(AzureOpenAIVectorizerParameters azureOpenAIParameters)
      Creates an instance of KnowledgeBaseAzureOpenAIModel class.
      Parameters:
      azureOpenAIParameters - the azureOpenAIParameters value to set.

  • Method Details

    • getKind

      public KnowledgeBaseModelKind getKind()
      Get the kind property: The type of AI model.
      Overrides:
      getKind in class KnowledgeBaseModel
      Returns:
      the kind value.

    • getAzureOpenAIParameters

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<KnowledgeBaseModel>
      Overrides:
      toJson in class KnowledgeBaseModel
      Throws:
      IOException

    • fromJson

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