StructuredOutputsItemResource 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:: StructuredOutputsItemResource.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.

The StructuredOutputsItemResource.

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

type StructuredOutputsItemResource = class
    inherit ItemResource
    interface IUtf8JsonSerializable
    interface IJsonModel<StructuredOutputsItemResource>
    interface IPersistableModel<StructuredOutputsItemResource>

Public Class StructuredOutputsItemResource
Inherits ItemResource
Implements IJsonModel(Of StructuredOutputsItemResource), IPersistableModel(Of StructuredOutputsItemResource)

Inheritance: Object

ItemResource
StructuredOutputsItemResource

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

Constructors

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

Properties

Name	Description
CreatedBy	The information about the creator of the item. (Inherited from ItemResource)
Id	Gets the id. (Inherited from ItemResource)
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" }.
Type	Gets or sets the type. (Inherited from ItemResource)

Methods

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

Applies to

Feedback

Was this page helpful?