Sdílet prostřednictvím


Azure.AI.OpenAI.Chat Namespace

Classes

AzureChatCitation

The AzureChatMessageContextCitation.

AzureChatDataSource

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 AzureChatDataSource 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 AzureCosmosDBChatDataSource, AzureMachineLearningIndexChatDataSource, AzureSearchChatDataSource, ElasticsearchChatDataSource and PineconeChatDataSource.

AzureChatMessageContext

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.

AzureChatRetrievedDocument

The AzureChatMessageContextAllRetrievedDocuments.

AzureCosmosDBChatDataSource

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

AzureMachineLearningIndexChatDataSource

Represents a data source configuration that will use an Azure Machine Learning vector index.

AzureSearchChatDataSource

Represents a data source configuration that will use an Azure Search 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..

ElasticsearchChatDataSource

The ElasticsearchChatDataSource.

PineconeChatDataSource

The PineconeChatDataSource.

Structs

AzureChatRetrievedDocumentFilterReason

Enum for filter_reason in AzureChatRetrievedDocument.

DataSourceQueryType

Enum for query_type in InternalAzureSearchChatDataSourceParameters.

Enums

DataSourceOutputContextFlags

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