TextResponseFormatJsonSchema interface

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas. Aprende más sobre Structured Outputs.

Extends

Propiedades

description

Descripción del formato de respuesta que usa el modelo para determinar cómo responder en el formato.

name

Nombre del formato de respuesta. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.

schema

El esquema JSON que define la estructura requerida de la salida del modelo.

strict

Si la salida generada por el modelo debe ajustarse estrictamente al esquema JSON suministrado.

type

Tipo de formato de respuesta que se va a definir. Siempre json_schema.

Detalles de las propiedades

description

Descripción del formato de respuesta que usa el modelo para determinar cómo responder en el formato.

description?: string

Valor de propiedad

string

name

Nombre del formato de respuesta. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.

name: string

Valor de propiedad

string

schema

El esquema JSON que define la estructura requerida de la salida del modelo.

schema: Record<string, unknown>

Valor de propiedad

Record<string, unknown>

strict

Si la salida generada por el modelo debe ajustarse estrictamente al esquema JSON suministrado.

strict?: boolean

Valor de propiedad

boolean

type

Tipo de formato de respuesta que se va a definir. Siempre json_schema.

type: "json_schema"

Valor de propiedad

"json_schema"