Share via


ResponsesMessageItemResource Class

Definition

A response message resource item, representing a role and content, as provided on service responses. Please note ResponsesMessageItemResource 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 ResponsesAssistantMessageItemResource, ResponsesDeveloperMessageItemResource, ResponsesSystemMessageItemResource and ResponsesUserMessageItemResource.

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

Constructors

Name Description
ResponsesMessageItemResource()

Initializes a new instance of ResponsesMessageItemResource for deserialization.

ResponsesMessageItemResource(ItemType, String, CreatedBy, IDictionary<String,BinaryData>, ResponsesMessageItemResourceStatus, ResponsesMessageRole)

Initializes a new instance of ResponsesMessageItemResource.

ResponsesMessageItemResource(String, ResponsesMessageItemResourceStatus)

Initializes a new instance of ResponsesMessageItemResource.

Properties

Name Description
CreatedBy

The information about the creator of the item.

(Inherited from ItemResource)
Id

Gets the id.

(Inherited from ItemResource)
Role

The role associated with the message.

Status

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Type

Gets or sets the type.

(Inherited from ItemResource)

Methods

Name Description
DeserializeResponsesMessageItemResource(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<ItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemResource)
IJsonModel<ResponsesMessageItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ResponsesMessageItemResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ItemResource)
IPersistableModel<ResponsesMessageItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponsesMessageItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponsesMessageItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to