OutputItemMessage Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
OutputItemMessage.cs

Message.

public class OutputItemMessage : Azure.AI.AgentServer.Responses.Models.OutputItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.OutputItemMessage>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.OutputItemMessage>
type OutputItemMessage = class
    inherit OutputItem
    interface IJsonModel<OutputItemMessage>
    interface IPersistableModel<OutputItemMessage>
Public Class OutputItemMessage
Inherits OutputItem
Implements IJsonModel(Of OutputItemMessage), IPersistableModel(Of OutputItemMessage)
Inheritance
Object
OutputItem
OutputItemMessage
Implements
IJsonModel<OutputItemMessage> IPersistableModel<OutputItemMessage> IPersistableModel<T>

Constructors

Name Description
OutputItemMessage(String, MessageStatus, IEnumerable<MessageContent>)

Creates an OutputItemMessage with the role defaulted to Assistant.
OutputItemMessage(String, MessageStatus, MessageRole, IEnumerable<MessageContent>)

Initializes a new instance of OutputItemMessage.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
Content

The content of the message.
CreatedBy

The information about the creator of the item

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:

</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" }.

(Inherited from OutputItem)
Id

The unique ID of the message.
Phase

Gets or sets the Phase.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Role

The role of the message. One of unknown, user, assistant, system, critic, discriminator, developer, or tool.
Status

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<OutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItemMessage>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemMessage>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OutputItem>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.Write(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItemMessage>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemMessage>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemMessage>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
GetId(OutputItem)

Gets the Id property from an OutputItem. Uses direct type checks for known subclasses; falls back to JSON serialization for unrecognized types.

Applies to