Dela via


Azure.AI.OpenAI.Chat Namespace

Classes

AzureChatExtensions
AzureSearchChatDataSource

Represents a data source configuration that will use an Azure Search resource.

ChatCitation

The AzureChatMessageContextCitation.

ChatDataSource

A representation of configuration data for a single Azure OpenAI chat data source. 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 ChatDataSource 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 CosmosChatDataSource, AzureSearchChatDataSource, Azure.AI.OpenAI.Chat.ElasticsearchChatDataSource, Azure.AI.OpenAI.Chat.MongoDBChatDataSource and Azure.AI.OpenAI.Chat.PineconeChatDataSource.

ChatMessageContext

An additional property, added to chat completion response messages, produced by the Azure OpenAI service when using extension behavior. This includes intent and citation information from the On Your Data feature.

ChatRetrievedDocument

The AzureChatMessageContextAllRetrievedDocuments.

CosmosChatDataSource

Represents a data source configuration that will use an Azure CosmosDB resource.

DataSourceAuthentication

The AzureChatDataSourceAuthenticationOptions. Please note DataSourceAuthentication 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..

DataSourceFieldMappings

The AzureSearchChatDataSourceParametersFieldsMapping.

DataSourceVectorizer

A representation of a data vectorization source usable as an embedding resource with a data source. Please note DataSourceVectorizer 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..

Structs

ChatDocumentFilterReason

The AzureChatMessageContextAllRetrievedDocumentsFilterReason.

DataSourceQueryType

The AzureSearchChatDataSourceParametersQueryType.

Enums

DataSourceOutputContexts

The include_context flags to request for an On Your Data retrieval result, which control what information will be available on ChatMessageContext instances in the response.