Share via


AgentStructuredOutputsResponseItem Class

Definition

The AgentStructuredOutputsResponseItem.

public class AgentStructuredOutputsResponseItem : Azure.AI.Projects.OpenAI.AgentResponseItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.OpenAI.AgentStructuredOutputsResponseItem>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.OpenAI.AgentStructuredOutputsResponseItem>
type AgentStructuredOutputsResponseItem = class
    inherit AgentResponseItem
    interface IJsonModel<AgentStructuredOutputsResponseItem>
    interface IPersistableModel<AgentStructuredOutputsResponseItem>
Public Class AgentStructuredOutputsResponseItem
Inherits AgentResponseItem
Implements IJsonModel(Of AgentStructuredOutputsResponseItem), IPersistableModel(Of AgentStructuredOutputsResponseItem)
Inheritance
AgentStructuredOutputsResponseItem
Implements

Constructors

Name Description
AgentStructuredOutputsResponseItem(BinaryData)

Properties

Name Description
CreatedBy

The information about the creator of the item.

(Inherited from AgentResponseItem)
Id

Gets the Id.

(Inherited from AgentResponseItem)
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" }.

Methods

Name Description
AsOpenAIResponseItem() (Inherited from AgentResponseItem)
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to