ChatResponseMessage Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

ChatResponseMessage.cs

A representation of a chat message as received in a response.

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

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

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

Inheritance

Object

ChatResponseMessage

Implements

IJsonModel<ChatResponseMessage> IPersistableModel<ChatResponseMessage> IPersistableModel<T>

Properties

AzureExtensionsContext	If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request.
Content	The content of the message.
FunctionCall	The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.
Role	The chat role associated with the message.
ToolCalls	The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured. Please note ChatCompletionsToolCall 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 ChatCompletionsFunctionToolCall.

Explicit Interface Implementations

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