Package com.azure.ai.openai.models

Class AzureChatExtensionConfiguration

java.lang.Object
com.azure.ai.openai.models.AzureChatExtensionConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureChatExtensionConfiguration>
Direct Known Subclasses:
AzureCosmosDBChatExtensionConfiguration, AzureMachineLearningIndexChatExtensionConfiguration, AzureSearchChatExtensionConfiguration, ElasticsearchChatExtensionConfiguration, PineconeChatExtensionConfiguration
public class AzureChatExtensionConfiguration extends Object implements com.azure.json.JsonSerializable<AzureChatExtensionConfiguration>
A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI chat extensions to augment the response behavior. The use of this configuration is compatible only with Azure OpenAI.

  • Constructor Details

    • AzureChatExtensionConfiguration

      public AzureChatExtensionConfiguration()
      Creates an instance of AzureChatExtensionConfiguration class.

  • Method Details

    • getType

      public AzureChatExtensionType getType()
      Get the type property: The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource. Azure chat extensions are only compatible with Azure OpenAI.
      Returns:
      the type value.

    • toJson

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

    • fromJson

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