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

Operators

Explicit(ClientResult to ChatMessageContext)

Declaration

public static explicit operator Azure.AI.OpenAI.Chat.ChatMessageContext (System.ClientModel.ClientResult result);

Parameters

System.ClientModel.ClientResult result The System.ClientModel.ClientResult to deserialize the ChatMessageContext from.

Returns

ChatMessageContext

Implicit(ChatMessageContext to BinaryContent)

Declaration

public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.ChatMessageContext chatMessageContext);

Parameters

ChatMessageContext chatMessageContext The ChatMessageContext to serialize into System.ClientModel.BinaryContent.

Returns

System.ClientModel.BinaryContent

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.

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 System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

ChatMessageContext A T representation of the JSON value.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<ChatMessageContext>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

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

Parameters

System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ChatMessageContext>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

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

Parameters

System.BinaryData data The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

ChatMessageContext A T representation of the data.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ChatMessageContext>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration

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

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns

System.String The format that the model uses when communicating with the serivce.

IPersistableModel<ChatMessageContext>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

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

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

System.BinaryData A binary representation of the written model.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.