cicora.ai
Špecifikácia APIVýstup bezpečný podľa schémy

Štruktúrované výstupy

Keď odpoveď bude spracúvať softvér, nie človek, vyžiadajte si objekt JSON alebo JSON Schema.

Referenčná dokumentácia integrácie: parametre a dostupné funkcie vyberte z nastavení API účtu a katalógu modelov pre svoje prostredie.

Nastavte response_format

Režim JSON je užitočný pre jednoduchý objekt. JSON Schema pridáva názov schémy, štruktúru polí, povinné vlastnosti a spôsob odmietnutia nadbytočných vlastností.

Prísna schéma znižuje potrebu obranného spracovania, nikdy však nenahrádza overenie na strane aplikácie.

Formát odpovede JSON Schema
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
      }
    }
  }
}

Navrhnite schému

  • Polia a opisy udržiavajte stručné a špecifické pre danú oblasť.
  • Tam, kde neznáme polia nie sú prijateľné, nastavte additionalProperties: false.
  • Schémy verzujte vo vlastnom kóde namiesto nepozorovanej zmeny zmluvy s konzumentom.

Spracujte výsledok

Vrátený JSON overte rovnakým validátorom, aký používa vaše API alebo databáza.

Ak model alebo trasa neprijíma požadovaný formát, zobrazte riadenú chybu a prostredníctvom katalógu modelov vyberte kompatibilnú možnosť.