StructuredOutputDefinition interface

Package:

@azure/ai-projects

A structured output that can be produced by the agent.

Properties

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.
strict	Whether to enforce strict validation. Default true.

Property Details

description

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

description: string

Property Value

string

name

The name of the structured output.

name: string

Property Value

string

schema

The JSON schema for the structured output.

schema: Record<string, any>

Property Value

Record<string, any>

strict

Whether to enforce strict validation. Default true.

strict: boolean

Property Value

boolean