AzureChatExtensionsMessageContext Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

AzureChatExtensionsMessageContext.cs

A representation of the additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response. This context information is only populated when using an Azure OpenAI request configured to use a matching extension.

public class AzureChatExtensionsMessageContext : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.AzureChatExtensionsMessageContext>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.AzureChatExtensionsMessageContext>

type AzureChatExtensionsMessageContext = class
    interface IJsonModel<AzureChatExtensionsMessageContext>
    interface IPersistableModel<AzureChatExtensionsMessageContext>

Public Class AzureChatExtensionsMessageContext
Implements IJsonModel(Of AzureChatExtensionsMessageContext), IPersistableModel(Of AzureChatExtensionsMessageContext)

Inheritance

Object

AzureChatExtensionsMessageContext

Implements

IJsonModel<AzureChatExtensionsMessageContext> IPersistableModel<AzureChatExtensionsMessageContext> IPersistableModel<T>

Properties

Citations	The contextual information associated with the Azure chat extensions used for a chat completions request. These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat extensions.
Intent	The detected intent from the chat history, used to pass to the next turn to carry over the context.
RequestContentFilterResults
ResponseContentFilterResults

Explicit Interface Implementations

IJsonModel<AzureChatExtensionsMessageContext>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureChatExtensionsMessageContext>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AzureChatExtensionsMessageContext>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AzureChatExtensionsMessageContext>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureChatExtensionsMessageContext>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.