Package version:

Interface ChatCompletionResponseFormatJsonSchemaProperties

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

interface ChatCompletionResponseFormatJsonSchemaProperties {
    description?: string;
    name?: string;
    schema?: ChatCompletionSchema;
    strict?: boolean;
}

Properties

description?: string

Description of the json schema the model will adhere to.

name?: string

Name of the json schema the model will adhere to

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

strict?: boolean

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