Package com.azure.ai.openai.models

Class AzureSearchChatExtensionConfiguration

java.lang.Object
com.azure.ai.openai.models.AzureChatExtensionConfiguration
com.azure.ai.openai.models.AzureSearchChatExtensionConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureChatExtensionConfiguration>
public final class AzureSearchChatExtensionConfiguration extends AzureChatExtensionConfiguration
A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat extension.

  • Constructor Details

    • AzureSearchChatExtensionConfiguration

      public AzureSearchChatExtensionConfiguration(AzureSearchChatExtensionParameters parameters)
      Creates an instance of AzureSearchChatExtensionConfiguration class.
      Parameters:
      parameters - the parameters value to set.

  • Method Details

    • getParameters

      public AzureSearchChatExtensionParameters getParameters()
      Get the parameters property: The parameters to use when configuring Azure Search.
      Returns:
      the parameters value.

    • 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.
      Overrides:
      getType in class AzureChatExtensionConfiguration
      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>
      Overrides:
      toJson in class AzureChatExtensionConfiguration
      Throws:
      IOException

    • fromJson

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