cicora.ai
Spécification de l’APISortie conforme au schéma

Sorties structurées

Demandez un objet JSON ou un JSON Schema lorsque la réponse sera utilisée par un logiciel plutôt que par une personne.

Référence d’intégration : choisissez les paramètres et les capacités disponibles dans les réglages de l’API de votre compte et dans le catalogue de modèles de votre environnement.

Définir response_format

Le mode JSON est utile pour un objet simple. JSON Schema ajoute un nom de schéma, une structure de champs, des propriétés obligatoires et un moyen de rejeter les propriétés supplémentaires.

Un schéma strict réduit la nécessité d’une analyse défensive, mais ne remplace jamais la validation côté application.

Format de réponse 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
      }
    }
  }
}

Concevoir le schéma

  • Gardez les champs et les descriptions concis et propres au domaine.
  • Définissez additionalProperties: false lorsque les champs inconnus ne sont pas acceptables.
  • Versionnez les schémas dans votre propre code au lieu de modifier de manière invisible le contrat sur lequel s’appuient les systèmes qui l’utilisent.

Traiter le résultat

Validez le JSON renvoyé avec le même validateur que celui utilisé par votre API ou votre base de données.

Si un modèle ou une route n’accepte pas le format demandé, affichez une erreur contrôlée et sélectionnez une option compatible dans le catalogue de modèles.