Interface ChatsJSONSchema

Custom schema used to generate structures JSON responses.

interface ChatsJSONSchema {
    description?: string;
    name: string;
    schema?: JSONObject;
    strict?: boolean;
}

Properties

description? name schema? strict?

Properties

Optional description

description?: string

Description of what the response format is for. Used by the model to determine how to respond in the format.

name

name: string

Name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Optional schema

schema?: JSONObject

Schema for the response format, described as a JSON Schema object.

See JSON Schema for more information.

Optional strict

strict?: boolean

Indicates whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.

Settings

Member Visibility

Theme

On This Page

descriptionnameschemastrict