ChatRequestToolMessage Class

Definition

A request chat message representing requested output from a configured tool.

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

Constructors

ChatRequestToolMessage(String, String)

Initializes a new instance of ChatRequestToolMessage.

Properties

Content

The content of the message.

Role

The chat role associated with this message.

(Inherited from ChatRequestMessage)
ToolCallId

The ID of the tool call resolved by the provided content.

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<ChatRequestToolMessage>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ChatRequestToolMessage>.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<ChatRequestToolMessage>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ChatRequestToolMessage>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ChatRequestToolMessage>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to