AzureChatExtensionConfiguration Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v1.0.0-beta.17
Source:
AzureChatExtensionConfiguration.cs

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. Please note AzureChatExtensionConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureCosmosDBChatExtensionConfiguration, AzureMachineLearningIndexChatExtensionConfiguration, AzureSearchChatExtensionConfiguration, ElasticsearchChatExtensionConfiguration and PineconeChatExtensionConfiguration.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.UnknownAzureChatExtensionConfiguration))]
public abstract class AzureChatExtensionConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.AzureChatExtensionConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.AzureChatExtensionConfiguration>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.UnknownAzureChatExtensionConfiguration))>]
type AzureChatExtensionConfiguration = class
    interface IJsonModel<AzureChatExtensionConfiguration>
    interface IPersistableModel<AzureChatExtensionConfiguration>
Public MustInherit Class AzureChatExtensionConfiguration
Implements IJsonModel(Of AzureChatExtensionConfiguration), IPersistableModel(Of AzureChatExtensionConfiguration)
Inheritance
Object
AzureChatExtensionConfiguration
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<AzureChatExtensionConfiguration> IPersistableModel<AzureChatExtensionConfiguration> IPersistableModel<T>

Constructors

AzureChatExtensionConfiguration()

Initializes a new instance of AzureChatExtensionConfiguration.

Explicit Interface Implementations

IJsonModel<AzureChatExtensionConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureChatExtensionConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AzureChatExtensionConfiguration>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<AzureChatExtensionConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureChatExtensionConfiguration>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to