StructuredOutputsOutputItem 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:
StructuredOutputsOutputItem.cs

The StructuredOutputsOutputItem.

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

Constructors

Name Description
StructuredOutputsOutputItem(BinaryData, String)

Initializes a new instance of StructuredOutputsOutputItem.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
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

Gets or sets the Id.
Output

The structured output captured during the response.

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).

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

ResponseId

The response on which the item is created.

(Inherited from OutputItem)

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<StructuredOutputsOutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<StructuredOutputsOutputItem>.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<StructuredOutputsOutputItem>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<StructuredOutputsOutputItem>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<StructuredOutputsOutputItem>.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