Package com.azure.ai.openai.models

Class AzureChatExtensionConfiguration

java.lang.Object

com.azure.ai.openai.models.AzureChatExtensionConfiguration

public final class AzureChatExtensionConfiguration
extends Object

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 Summary

Constructors

Constructor	Description
AzureChatExtensionConfiguration(AzureChatExtensionType type, Object parameters)	Creates an instance of AzureChatExtensionConfiguration class.

Method Summary

Modifier and Type	Method	Description
Object	getParameters()	Get the parameters property: The configuration payload used for the Azure chat extension.
AzureChatExtensionType	getType()	Get the type property: The label for the type of an Azure chat extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AzureChatExtensionConfiguration

public AzureChatExtensionConfiguration(AzureChatExtensionType type,
 Object parameters)

Creates an instance of AzureChatExtensionConfiguration class.

Parameters:

type - the type value to set.

parameters - the parameters value to set.

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.

getParameters

public Object getParameters()

Get the parameters property: The configuration payload used for the Azure chat extension. The structure payload details are specific to the extension being configured. Azure chat extensions are only compatible with Azure OpenAI.

Returns:

the parameters value.