ChatCompletionResponseFormatJsonSchemaProperties interface

Package:

@azure/search-documents

An open dictionary for extended properties. Required if 'type' == 'json_schema'

Properties

description	Description of the json schema the model will adhere to.
name	Name of the json schema the model will adhere to
schema	Object defining the custom schema the model will use to structure its output.
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

Object defining the custom schema the model will use to structure its output.

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