ResponsesStructuredOutputDefinition Constructor

Definition

Namespace:
Azure.AI.Extensions.OpenAI
Assembly:
Azure.AI.Extensions.OpenAI.dll
Package:
Azure.AI.Extensions.OpenAI v2.1.0-beta.3
Source:
ResponsesStructuredOutputDefinition.cs

Initializes a new instance of ResponsesStructuredOutputDefinition.

public ResponsesStructuredOutputDefinition(string name, string description, System.Collections.Generic.IDictionary<string,BinaryData> schema, bool? isStrict);
new Azure.AI.Extensions.OpenAI.ResponsesStructuredOutputDefinition : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * Nullable<bool> -> Azure.AI.Extensions.OpenAI.ResponsesStructuredOutputDefinition
Public Sub New (name As String, description As String, schema As IDictionary(Of String, BinaryData), isStrict As Nullable(Of Boolean))

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.

Exceptions

ArgumentNullException

name, description or schema is null.

Applies to