Skip to content

Создание структурированного вывода

POST
/v1/messages
    - Эндпоинт **Structured Outputs** (структурированный вывод) Anthropic Messages API
    - Используйте `output_format` с `json_schema`, чтобы модель возвращала JSON, соответствующий схеме
    - Заголовок запроса `anthropic-beta: structured-outputs-2025-11-13` включает эту возможность
    - Официальная документация: [Structured Outputs](https://docs.anthropic.com/en/docs/build-with-claude/structured-outputs)

Authorizations

bearer
Type
HTTP (bearer)

Request Body

application/json
object

ID используемой модели. См. таблицу совместимости эндпоинтов моделей для Chat API.

object[]
Required

Список сообщений диалога. Пример кода на Python.

Температура выборки от 0 до 2. Более высокие значения (напр. 0,8) делают вывод случайнее, низкие (напр. 0,2) — более сфокусированным. Рекомендуется менять либо это, либо top_p.

Ядерная выборка вместо temperature. Модель учитывает токены в пределах top_p вероятностной массы. 0,1 означает только верхние 10% вероятностной массы. Рекомендуется менять либо это, либо temperature.

По умолчанию 1
Сколько вариантов завершения чата генерировать для каждого входного сообщения.

По умолчанию false. При true частичные дельты сообщений отправляются через SSE, как в ChatGPT, до data: [DONE]. Пример кода на Python.

По умолчанию null. До 4 последовательностей, после которых API прекращает генерацию токенов.

По умолчанию inf
Максимальное число токенов в завершении чата.

Суммарная длина входных и сгенерированных токенов ограничена контекстом модели. Пример подсчёта токенов на Python.

Число от -2,0 до 2,0. Положительные значения штрафуют новые токены за уже встречавшиеся в тексте, повышая вероятность новых тем. Подробнее о штрафах

По умолчанию 0. Число от -2,0 до 2,0. Положительные значения снижают повторения по частоте появления в тексте. Подробнее о штрафах частоты и присутствия.

Изменяет вероятность появления указанных токенов в завершении. Принимает JSON-объект с ID токенов (из токенизатора) и смещениями от -100 до 100. Смещение добавляется к logit перед выборкой; эффект зависит от модели. Значения от -1 до 1 снижают или повышают вероятность выбора; -100 или 100 должны отключить или исключительно выбрать токен.

Уникальный идентификатор конечного пользователя. Помогает OpenAI отслеживать злоупотребления. Подробнее

Объект формата вывода модели. { "type": "json_object" } включает JSON-режим. Важно: в JSON-режиме также укажите модели генерировать JSON в system или user; иначе возможен поток пробелов до лимита токенов. При finish_reason="length" содержимое может обрезаться при превышении max_tokens или контекста.

Бета-функция. При указании система стремится к детерминированной выборке при повторных запросах с тем же seed и параметрами. Детерминизм не гарантирован; используйте system_fingerprint для мониторинга изменений бэкенда.

Список инструментов, которые может вызывать модель. Сейчас поддерживаются только функции. Укажите функции, для которых модель может сгенерировать JSON-ввод.

Управляет вызовом функции. none — без вызова, только сообщение; auto — выбор между сообщением и функцией; принудительно: {"type": "function", "function": {"name": "my_function"}}. По умолчанию none без функций, auto при наличии функций.

object

Конфигурация структурированного вывода; при type равном json_schema поле schema ограничивает возвращаемый JSON.

Responses

application/json
object
object[]
Required
object
Required

Playground

Authorization
Body

Samples