SharedResponseFormatJsonSchemaJsonSchemaParam

SharedResponseFormatJsonSchemaJsonSchemaParam = object

Defined in: src/client/types.gen.ts:3882 

Structured Outputs configuration options, including a JSON Schema.

Properties

any?

optional any: unknown

Defined in: src/client/types.gen.ts:3883 

description?

optional description: ParamOptString

Defined in: src/client/types.gen.ts:3884 

name?

optional name: string

Defined in: src/client/types.gen.ts:3889 

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?

optional schema: unknown

Defined in: src/client/types.gen.ts:3894 

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

strict?

optional strict: ParamOptBool

Defined in: src/client/types.gen.ts:3895