Share via


ResponsesSystemMessageItemResource Class

Definition

A message resource item with the system role.

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

Constructors

Name Description
ResponsesSystemMessageItemResource()

Initializes a new instance of ResponsesSystemMessageItemResource for deserialization.

ResponsesSystemMessageItemResource(ItemType, String, CreatedBy, IDictionary<String,BinaryData>, ResponsesMessageItemResourceStatus, ResponsesMessageRole, IReadOnlyList<ItemContent>)

Initializes a new instance of ResponsesSystemMessageItemResource.

ResponsesSystemMessageItemResource(String, ResponsesMessageItemResourceStatus, IEnumerable<ItemContent>, CreatedBy)

Initializes a new instance of ResponsesSystemMessageItemResource.

Properties

Name Description
Content

The content associated with the message. Please note ItemContent 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 ItemContentInputAudio, ItemContentInputFile, ItemContentInputImage, ItemContentInputText, ItemContentOutputAudio, ItemContentOutputText and ItemContentRefusal.

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.

(Inherited from ResponsesMessageItemResource)
Status

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

(Inherited from ResponsesMessageItemResource)
Type

Gets or sets the type.

(Inherited from ItemResource)

Methods

Name Description
DeserializeResponsesSystemMessageItemResource(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.

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

Writes the model to the provided Utf8JsonWriter.

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

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

IJsonModel<ResponsesSystemMessageItemResource>.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.

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

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

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

Writes the model into a BinaryData.

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

Converts the provided BinaryData into a model.

IPersistableModel<ResponsesSystemMessageItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponsesSystemMessageItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to