Share via


ResponsesMessageItemParam Class

Definition

A response message item, representing a role and content, as provided as client request parameters. Please note ResponsesMessageItemParam 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 ResponsesAssistantMessageItemParam, ResponsesDeveloperMessageItemParam, ResponsesSystemMessageItemParam and ResponsesUserMessageItemParam.

public class ResponsesMessageItemParam : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemParam, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponsesMessageItemParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponsesMessageItemParam>
type ResponsesMessageItemParam = class
    inherit ItemParam
    interface IUtf8JsonSerializable
    interface IJsonModel<ResponsesMessageItemParam>
    interface IPersistableModel<ResponsesMessageItemParam>
Public Class ResponsesMessageItemParam
Inherits ItemParam
Implements IJsonModel(Of ResponsesMessageItemParam), IPersistableModel(Of ResponsesMessageItemParam)
Inheritance
ResponsesMessageItemParam
Derived
Implements

Constructors

Name Description
ResponsesMessageItemParam()

Initializes a new instance of ResponsesMessageItemParam.

ResponsesMessageItemParam(ItemType, IDictionary<String,BinaryData>, ResponsesMessageRole)

Initializes a new instance of ResponsesMessageItemParam.

Properties

Name Description
Role

The role associated with the message.

SerializedAdditionalRawData (Inherited from ItemParam)
Type

Gets or sets the type.

(Inherited from ItemParam)

Methods

Name Description
DeserializeResponsesMessageItemParam(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemParam)
IJsonModel<ResponsesMessageItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ResponsesMessageItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ItemParam)
IPersistableModel<ResponsesMessageItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponsesMessageItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponsesMessageItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to