При создании сообщения вы можете установить "stream": true
для пошаговой потоковой передачи ответа с использованием событий, отправляемых сервером (SSE).
Потоковая передача с помощью SDK
Наши SDK для Python и TypeScript предлагают несколько способов потоковой передачи. SDK для Python поддерживает как синхронные, так и асинхронные потоки. Подробности смотрите в документации к каждому SDK.
Типы событий
Каждое событие, отправляемое сервером, включает именованный тип события и связанные с ним данные JSON. Каждое событие будет использовать имя события SSE (например, event: message_stop
) и включать соответствующий type
события в своих данных.
Каждый поток использует следующую последовательность событий:
message_start
: содержит объект Message
с пустым полем content
.
- Серия блоков контента, каждый из которых имеет события
content_block_start
, одно или несколько событий content_block_delta
и событие content_block_stop
. Каждый блок контента будет иметь index
, соответствующий его индексу в финальном массиве content
сообщения.
- Одно или несколько событий
message_delta
, указывающих на изменения верхнего уровня в финальном объекте Message
.
- Финальное событие
message_stop
.
События ping
Потоки событий также могут включать любое количество событий ping
.
События ошибок
Иногда мы можем отправлять ошибки в потоке событий. Например, в периоды высокой нагрузки вы можете получить overloaded_error
, что обычно соответствует HTTP 529 в контексте без потоковой передачи:
Другие события
В соответствии с нашей политикой версионирования, мы можем добавлять новые типы событий, и ваш код должен корректно обрабатывать неизвестные типы событий.
Типы дельт
Каждое событие content_block_delta
содержит delta
определенного типа, которая обновляет блок content
по указанному index
.
Текстовая дельта
Дельта контента типа text
выглядит так:
Дельта входного JSON
Дельты для блоков контента tool_use
соответствуют обновлениям поля input
блока. Для обеспечения максимальной детализации дельты представляют собой частичные строки JSON, тогда как финальный tool_use.input
всегда является объектом.
Вы можете накапливать строковые дельты и разбирать JSON после получения события content_block_stop
, используя библиотеку вроде Pydantic для частичного разбора JSON, или используя наши SDK, которые предоставляют вспомогательные функции для доступа к разобранным инкрементальным значениям.
Дельта блока контента tool_use
выглядит так:
Примечание: Наши текущие модели поддерживают только выдачу одного полного свойства ключа и значения из input
за раз. Таким образом, при использовании инструментов между событиями потоковой передачи могут быть задержки, пока модель работает. Как только ключ и значение input
накоплены, мы выдаем их как несколько событий content_block_delta
с частичным JSON, чтобы формат автоматически поддерживал более тонкую детализацию в будущих моделях.
Дельта размышления
При использовании расширенного размышления с включенной потоковой передачей вы будете получать контент размышления через события thinking_delta
. Эти дельты соответствуют полю thinking
блоков контента thinking
.
Для контента размышления специальное событие signature_delta
отправляется непосредственно перед событием content_block_stop
. Эта подпись используется для проверки целостности блока размышления.
Типичная дельта размышления выглядит так:
Дельта подписи выглядит так:
Необработанный HTTP-ответ потока
Мы настоятельно рекомендуем использовать наши клиентские SDK при использовании режима потоковой передачи. Однако если вы создаете прямую интеграцию с API, вам нужно будет обрабатывать эти события самостоятельно.
Ответ потока состоит из:
- События
message_start
- Потенциально нескольких блоков контента, каждый из которых содержит:
a. Событие
content_block_start
b. Потенциально несколько событий content_block_delta
c. Событие content_block_stop
- События
message_delta
- События
message_stop
Также в ответе могут быть рассеяны события ping
. Подробнее о формате см. в разделе Типы событий.
Базовый запрос потоковой передачи
Запрос потоковой передачи с использованием инструмента
В этом запросе мы просим Claude использовать инструмент, чтобы узнать погоду.
event: message_start
data: {"type":"message_start","message":{"id":"msg_014p7gG3wDgGV9EUtLvnow3U","type":"message","role":"assistant","model":"claude-3-haiku-20240307","stop_sequence":null,"usage":{"input_tokens":472,"output_tokens":2},"content":[],"stop_reason":null}}
event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}
event: ping
data: {"type": "ping"}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"Хорошо"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":","}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" давайте"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" проверим"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" погоду"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" в"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" San"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" Francisco"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":","}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" CA"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":":"}}
event: content_block_stop
data: {"type":"content_block_stop","index":0}
event: content_block_start
data: {"type":"content_block_start","index":1,"content_block":{"type":"tool_use","id":"toolu_01T1x1fJ34qAmk2tNTrN7Up6","name":"get_weather","input":{}}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":""}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":"{\"location\":"}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":" \"San"}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":" Francisc"}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":"o,"}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":" CA\""}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":", "}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":"\"unit\": \"fah"}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":"renheit\"}"}}
event: content_block_stop
data: {"type":"content_block_stop","index":1}
event: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"tool_use","stop_sequence":null},"usage":{"output_tokens":89}}
event: message_stop
data: {"type":"message_stop"}
Запрос потоковой передачи с расширенным размышлением
В этом запросе мы включаем расширенное размышление с потоковой передачей, чтобы увидеть пошаговые рассуждения Claude.
event: message_start
data: {"type": "message_start", "message": {"id": "msg_01...", "type": "message", "role": "assistant", "content": [], "model": "claude-3-7-sonnet-20250219", "stop_reason": null, "stop_sequence": null}}
event: content_block_start
data: {"type": "content_block_start", "index": 0, "content_block": {"type": "thinking", "thinking": ""}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "thinking_delta", "thinking": "Давайте решим это пошагово:\n\n1. Сначала разложим 27 * 453"}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "thinking_delta", "thinking": "\n2. 453 = 400 + 50 + 3"}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "thinking_delta", "thinking": "\n3. 27 * 400 = 10 800"}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "thinking_delta", "thinking": "\n4. 27 * 50 = 1 350"}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "thinking_delta", "thinking": "\n5. 27 * 3 = 81"}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "thinking_delta", "thinking": "\n6. 10 800 + 1 350 + 81 = 12 231"}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 0, "delta": {"type": "signature_delta", "signature": "EqQBCgIYAhIM1gbcDa9GJwZA2b3hGgxBdjrkzLoky3dl1pkiMOYds..."}}
event: content_block_stop
data: {"type": "content_block_stop", "index": 0}
event: content_block_start
data: {"type": "content_block_start", "index": 1, "content_block": {"type": "text", "text": ""}}
event: content_block_delta
data: {"type": "content_block_delta", "index": 1, "delta": {"type": "text_delta", "text": "27 * 453 = 12 231"}}
event: content_block_stop
data: {"type": "content_block_stop", "index": 1}
event: message_delta
data: {"type": "message_delta", "delta": {"stop_reason": "end_turn", "stop_sequence": null}}
event: message_stop
data: {"type": "message_stop"}