Interface AiStructuredOutputFormat

Structured output format configuration for AI models that support schema-constrained responses.

When used with supported models, this guarantees that responses will strictly conform to the provided JSON schema through constrained decoding - the model cannot generate tokens that violate the schema.

If the model does not support structured output, the response format will default to 'json_object'. Example:

{
  type: 'json_schema',
  schema: {
    type: 'object',
    properties: {
      name: { type: 'string' },
      age: { type: 'number' }
    },
    required: ['name', 'age'],
    additionalProperties: false
  }
}
Copy