TextResponseFormatJsonSchema interface
Formato de resposta do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.
- Extends
Propriedades
| description | Uma descrição do propósito do formato de resposta, utilizada pelo modelo para determinar como responder nesse formato. |
| name | O nome do formato de resposta. Deve ser a-z, A-Z, 0-9, ou conter sublinhados e traços, com um comprimento máximo de 64. |
| schema | O Esquema JSON que define a estrutura necessária da saída do modelo. |
| strict | Se a saída gerada pelo modelo deve estar estritamente em conformidade com o Esquema JSON fornecido. |
| type | O tipo de formato de resposta que está sendo definido. Sempre |
Detalhes de Propriedade
description
Uma descrição do propósito do formato de resposta, utilizada pelo modelo para determinar como responder nesse formato.
description?: stringValor de Propriedade
string
name
O nome do formato de resposta. Deve ser a-z, A-Z, 0-9, ou conter sublinhados e traços, com um comprimento máximo de 64.
name: stringValor de Propriedade
string
schema
O Esquema JSON que define a estrutura necessária da saída do modelo.
schema: Record<string, unknown>Valor de Propriedade
Record<string, unknown>
strict
Se a saída gerada pelo modelo deve estar estritamente em conformidade com o Esquema JSON fornecido.
strict?: booleanValor de Propriedade
boolean
type
O tipo de formato de resposta que está sendo definido. Sempre json_schema.
type: "json_schema"Valor de Propriedade
"json_schema"