ChatRequestUserMessage Class

Definition

A request chat message representing user input to the assistant.

public class ChatRequestUserMessage : Azure.AI.OpenAI.ChatRequestMessage, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatRequestUserMessage>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatRequestUserMessage>
type ChatRequestUserMessage = class
    inherit ChatRequestMessage
    interface IJsonModel<ChatRequestUserMessage>
    interface IPersistableModel<ChatRequestUserMessage>
Public Class ChatRequestUserMessage
Inherits ChatRequestMessage
Implements IJsonModel(Of ChatRequestUserMessage), IPersistableModel(Of ChatRequestUserMessage)
Inheritance
ChatRequestUserMessage
Implements

Constructors

ChatRequestUserMessage(ChatMessageContentItem[])

Creates a new instance of ChatRequestUserMessage using a collection of structured content.

ChatRequestUserMessage(IEnumerable<ChatMessageContentItem>)

Creates a new instance of ChatRequestUserMessage using a collection of structured content.

ChatRequestUserMessage(String)

Creates a new instance of ChatRequestUserMessage using plain text content.

Properties

Content

Gets the plain text content associated with this message. Null if the message was instantiated using a multimodal content item collection.

MultimodalContentItems

Gets the multimodal content item content associated with this message. Null if the message was instantiated using a plain text content.

Name

An optional name for the participant.

Role

The chat role associated with this message.

(Inherited from ChatRequestMessage)

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.

(Inherited from ChatRequestMessage)
IJsonModel<ChatRequestMessage>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ChatRequestMessage)
IJsonModel<ChatRequestUserMessage>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ChatRequestUserMessage>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ChatRequestMessage>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ChatRequestMessage)
IPersistableModel<ChatRequestMessage>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from ChatRequestMessage)
IPersistableModel<ChatRequestMessage>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ChatRequestMessage)
IPersistableModel<ChatRequestUserMessage>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ChatRequestUserMessage>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ChatRequestUserMessage>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to