Partager via

ChatMessageContext Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Chat
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v2.1.0
Package:
Azure.AI.OpenAI v2.1.0-beta.2
Source:
ChatMessageContext.cs
Source:
ChatMessageContext.cs

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.

public class ChatMessageContext : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.ChatMessageContext>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.ChatMessageContext>
type ChatMessageContext = class
    interface IJsonModel<ChatMessageContext>
    interface IPersistableModel<ChatMessageContext>
Public Class ChatMessageContext
Implements IJsonModel(Of ChatMessageContext), IPersistableModel(Of ChatMessageContext)
Inheritance
Object
ChatMessageContext
Implements
IJsonModel<ChatMessageContext> IPersistableModel<ChatMessageContext> IPersistableModel<T>

Properties

Citations

The citations produced by the data retrieval.
Intent

The detected intent from the chat history, which is used to carry conversation context between interactions.
RetrievedDocuments

Summary information about documents retrieved by the data retrieval operation.

Explicit Interface Implementations

IJsonModel<ChatMessageContext>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

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

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

Writes the model into a BinaryData.

Applies to