ChatRequestMessage Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

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

Source:: ChatRequestMessage.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An abstract representation of a chat message as provided in a request. Please note ChatRequestMessage 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 ChatRequestAssistantMessage, ChatRequestFunctionMessage, ChatRequestSystemMessage, ChatRequestToolMessage and ChatRequestUserMessage.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.UnknownChatRequestMessage))]
public abstract class ChatRequestMessage : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatRequestMessage>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatRequestMessage>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.UnknownChatRequestMessage))>]
type ChatRequestMessage = class
    interface IJsonModel<ChatRequestMessage>
    interface IPersistableModel<ChatRequestMessage>

Public MustInherit Class ChatRequestMessage
Implements IJsonModel(Of ChatRequestMessage), IPersistableModel(Of ChatRequestMessage)

Inheritance: Object
ChatRequestMessage

Derived: Azure.AI.OpenAI.ChatRequestAssistantMessage

Azure.AI.OpenAI.ChatRequestFunctionMessage

Azure.AI.OpenAI.ChatRequestSystemMessage

Azure.AI.OpenAI.ChatRequestToolMessage

Azure.AI.OpenAI.ChatRequestUserMessage

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<ChatRequestMessage> IPersistableModel<ChatRequestMessage> IPersistableModel<T>

Constructors

ChatRequestMessage()

Initializes a new instance of ChatRequestMessage.

Properties

Role	The chat role associated with this message.

Explicit Interface Implementations

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

Applies to