ChatCompletionResponseFormatJsonSchemaProperties interface

Package:

@azure/search-documents

Properties for JSON schema response format.

Properties

description	Description of the json schema the model will adhere to.
name	Name of the json schema the model will adhere to.
schema	The schema definition.
strict	Whether or not the model's response should use structured outputs. Default is true.

Property Details

description

Description of the json schema the model will adhere to.

description?: string

Property Value

string

name

Name of the json schema the model will adhere to.

name?: string

Property Value

string

schema

The schema definition.

schema?: ChatCompletionSchema

Property Value

ChatCompletionSchema

strict

Whether or not the model's response should use structured outputs. Default is true.

strict?: boolean

Property Value

boolean