cicora.ai
Русский
Спецификация APIСтруктурированные ответы

Структурированные ответы

Запрашивайте JSON-объект или JSON Schema, когда ответ будет потреблять программа, а не человек.

Справочник интеграции: выбирайте параметры и доступные возможности из API-настроек аккаунта и каталога модели для своего окружения.

Задайте response_format

JSON mode полезен для простого объекта. JSON Schema добавляет имя схемы, структуру полей, required и запрет лишних полей.

Строгая схема уменьшает объём защитного парсинга, но не отменяет проверку данных на стороне приложения.

JSON Schema response format
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
      }
    }
  }
}

Спроектируйте схему

  • Делайте поля и описания короткими и предметными.
  • Указывайте additionalProperties: false там, где неизвестные поля недопустимы.
  • Выносите версии схемы в свой код, а не меняйте договорённость незаметно для потребителей.

Обработайте результат

Валидируйте полученный JSON тем же валидатором, который используется вашим API или базой данных.

Если модель или маршрут не принимает требуемый формат, покажите управляемую ошибку и выберите совместимый вариант через каталог модели.

Дальше