ResponsesSystemMessageItemParam Class

Definition

Namespace:: Azure.AI.AgentServer.Contracts.Generated.OpenAI

Assembly:: Azure.AI.AgentServer.Contracts.dll

Package:: Azure.AI.AgentServer.Contracts v1.0.0-beta.4

Source:: ResponsesSystemMessageItemParam.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A message parameter item with the system role.

public class ResponsesSystemMessageItemParam : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponsesMessageItemParam, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponsesSystemMessageItemParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponsesSystemMessageItemParam>

type ResponsesSystemMessageItemParam = class
    inherit ResponsesMessageItemParam
    interface IUtf8JsonSerializable
    interface IJsonModel<ResponsesSystemMessageItemParam>
    interface IPersistableModel<ResponsesSystemMessageItemParam>

Public Class ResponsesSystemMessageItemParam
Inherits ResponsesMessageItemParam
Implements IJsonModel(Of ResponsesSystemMessageItemParam), IPersistableModel(Of ResponsesSystemMessageItemParam)

Inheritance: Object

ItemParam

ResponsesMessageItemParam
ResponsesSystemMessageItemParam

Implements: IUtf8JsonSerializable IJsonModel<ResponsesSystemMessageItemParam> IPersistableModel<ResponsesSystemMessageItemParam> IPersistableModel<T>

Constructors

Name	Description
ResponsesSystemMessageItemParam()	Initializes a new instance of ResponsesSystemMessageItemParam for deserialization.
ResponsesSystemMessageItemParam(BinaryData)	Initializes a new instance of ResponsesSystemMessageItemParam.
ResponsesSystemMessageItemParam(ItemType, IDictionary<String,BinaryData>, ResponsesMessageRole, BinaryData)	Initializes a new instance of ResponsesSystemMessageItemParam.

Properties

Name	Description
Content	The content associated with the message. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). <remarks> Supported types: String IList<T> where `T` is of type ItemContent </remarks> Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Role	The role associated with the message. (Inherited from ResponsesMessageItemParam)
SerializedAdditionalRawData	(Inherited from ItemParam)
Type	Gets or sets the type. (Inherited from ItemParam)

Methods

Name	Description
DeserializeResponsesSystemMessageItemParam(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. (Inherited from ResponsesMessageItemParam)
IJsonModel<ResponsesMessageItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from ResponsesMessageItemParam)
IJsonModel<ResponsesSystemMessageItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ResponsesSystemMessageItemParam>.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. (Inherited from ResponsesMessageItemParam)
IPersistableModel<ResponsesMessageItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from ResponsesMessageItemParam)
IPersistableModel<ResponsesMessageItemParam>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from ResponsesMessageItemParam)
IPersistableModel<ResponsesSystemMessageItemParam>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ResponsesSystemMessageItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ResponsesSystemMessageItemParam>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to

Feedback

Was this page helpful?