Class 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.

Inheritance

System.Object

ChatMessageContext

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.OpenAI.dll

Syntax

[OpenAI.CodeGenType("AzureChatMessageContext")]
public class ChatMessageContext : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.ChatMessageContext>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.ChatMessageContext>

Properties

Citations

The citations produced by the data retrieval.

Declaration

public System.Collections.Generic.IList<Azure.AI.OpenAI.Chat.ChatCitation> Citations { get; }

Property Value

System.Collections.Generic.IList<ChatCitation>

Intent

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

Declaration

public string Intent { get; }

Property Value

System.String

RetrievedDocuments

Summary information about documents retrieved by the data retrieval operation.

Declaration

[OpenAI.CodeGenMember("AllRetrievedDocuments")]
public Azure.AI.OpenAI.Chat.ChatRetrievedDocument RetrievedDocuments { get; }

Property Value

ChatRetrievedDocument

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.ChatMessageContext JsonModelCreateCore (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The JSON reader.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

ChatMessageContext

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.ChatMessageContext PersistableModelCreateCore (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The data to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

ChatMessageContext

PersistableModelWriteCore(ModelReaderWriterOptions)

Declaration

protected virtual BinaryData PersistableModelWriteCore (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

System.BinaryData

Explicit Interface Implementations

IJsonModel<ChatMessageContext>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Declaration

Azure.AI.OpenAI.Chat.ChatMessageContext IJsonModel<ChatMessageContext>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The JSON reader.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

ChatMessageContext

IJsonModel<ChatMessageContext>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

void IJsonModel<ChatMessageContext>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

IPersistableModel<ChatMessageContext>.Create(BinaryData, ModelReaderWriterOptions)

Declaration

Azure.AI.OpenAI.Chat.ChatMessageContext IPersistableModel<ChatMessageContext>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The data to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

ChatMessageContext

IPersistableModel<ChatMessageContext>.GetFormatFromOptions(ModelReaderWriterOptions)

Declaration

string IPersistableModel<ChatMessageContext>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

System.String

IPersistableModel<ChatMessageContext>.Write(ModelReaderWriterOptions)

Declaration

BinaryData IPersistableModel<ChatMessageContext>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

System.BinaryData