Share via

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

A structured output that can be produced by the agent.

public class StructuredOutputDefinition : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.StructuredOutputDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.StructuredOutputDefinition>
type StructuredOutputDefinition = class
    interface IUtf8JsonSerializable
    interface IJsonModel<StructuredOutputDefinition>
    interface IPersistableModel<StructuredOutputDefinition>
Public Class StructuredOutputDefinition
Implements IJsonModel(Of StructuredOutputDefinition), IPersistableModel(Of StructuredOutputDefinition), IUtf8JsonSerializable
Inheritance
Object
StructuredOutputDefinition
Implements
IUtf8JsonSerializable IJsonModel<StructuredOutputDefinition> IPersistableModel<StructuredOutputDefinition> IPersistableModel<T>

Constructors

Name Description
StructuredOutputDefinition()

Initializes a new instance of StructuredOutputDefinition for deserialization.
StructuredOutputDefinition(String, String, IDictionary<String,BinaryData>, Nullable<Boolean>, IDictionary<String,BinaryData>)

Initializes a new instance of StructuredOutputDefinition.
StructuredOutputDefinition(String, String, IDictionary<String,BinaryData>, Nullable<Boolean>)

Initializes a new instance of StructuredOutputDefinition.

Properties

Name Description
Description

A description of the output to emit. Used by the model to determine when to emit the output.
Name

The name of the structured output.
Schema

The JSON schema for the structured output.

To assign an object to the value of 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" }.
Strict

Whether to enforce strict validation. Default true.

Methods

Name Description
DeserializeStructuredOutputDefinition(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<StructuredOutputDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<StructuredOutputDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<StructuredOutputDefinition>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<StructuredOutputDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<StructuredOutputDefinition>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to