cicora.ai
Especificação da APISaída segura segundo o esquema

Saídas estruturadas

Peça um objeto JSON ou um esquema JSON quando a resposta se destinar a software e não a uma pessoa.

Referência de integração: escolha os parâmetros e as capacidades disponíveis nas definições da API da sua conta e no catálogo de modelos do seu ambiente.

Definir response_format

O modo JSON é útil para um objeto simples. O esquema JSON acrescenta nome do esquema, estrutura dos campos, propriedades obrigatórias e uma forma de rejeitar propriedades adicionais.

Um esquema rigoroso reduz a análise defensiva, mas nunca substitui a validação no lado da aplicação.

Formato de resposta segundo esquema JSON
json
{
  "model": "openai/gpt-5.6-sol",
  "messages": [{"role": "user", "content": "Extract an order summary."}],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "order_summary",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {"items": {"type": "array"}, "total": {"type": "number"}},
        "required": ["items", "total"],
        "additionalProperties": false
      }
    }
  }
}

Conceber o esquema

  • Mantenha campos e descrições concisos e específicos do domínio.
  • Defina additionalProperties: false quando não forem aceitáveis campos desconhecidos.
  • Versione os esquemas no seu próprio código, em vez de alterar invisivelmente o contrato de um consumidor.

Tratar o resultado

Valide o JSON devolvido com o mesmo validador utilizado pela sua API ou base de dados.

Se um modelo ou rota não aceitar o formato pedido, apresente um erro controlado e selecione uma opção compatível através do catálogo de modelos.