ExtensionsOpenAIModelFactory.ResponsesStructuredOutputDefinition Method

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v2.1.0-beta.3

Source:

ExtensionsOpenAIModelFactory.cs

A structured output that can be produced by the agent.

public static Azure.AI.Extensions.OpenAI.ResponsesStructuredOutputDefinition ResponsesStructuredOutputDefinition(string name = default, string description = default, System.Collections.Generic.IDictionary<string,BinaryData> schema = default, bool? isStrict = default);

static member ResponsesStructuredOutputDefinition : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * Nullable<bool> -> Azure.AI.Extensions.OpenAI.ResponsesStructuredOutputDefinition

Public Shared Function ResponsesStructuredOutputDefinition (Optional name As String = Nothing, Optional description As String = Nothing, Optional schema As IDictionary(Of String, BinaryData) = Nothing, Optional isStrict As Nullable(Of Boolean) = Nothing) As ResponsesStructuredOutputDefinition

Parameters

name

String

The name of the structured output.

description

String

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

schema

IDictionary<String,BinaryData>

The JSON schema for the structured output.

isStrict

Nullable<Boolean>

Whether to enforce strict validation. Default true.

Returns

ResponsesStructuredOutputDefinition

A new ResponsesStructuredOutputDefinition instance for mocking.