Interface ResponseFormatTextJSONSchemaConfig

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

interface ResponseFormatTextJSONSchemaConfig {
    description?: string;
    name: string;
    schema: Record<string, unknown>;
    strict?: null | boolean;
    type: "json_schema";
}

Properties

description? name schema strict? type

Properties

Optionaldescription

description?: string

A description of what the response format is for, used by the model to determine how to respond in the format.

name

name: string

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

schema

schema: Record<string, unknown>

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

Optionalstrict

strict?: null | boolean

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. To learn more, read the Structured Outputs guide.

type

type: "json_schema"

The type of response format being defined. Always json_schema.

Settings

Member Visibility

On This Page

Properties