"stream": true untuk melakukan streaming respons secara bertahap menggunakan server-sent events (SSE).
Streaming dengan SDK
SDK Python dan TypeScript kami menawarkan berbagai cara untuk streaming. SDK Python memungkinkan stream sync dan async. Lihat dokumentasi di setiap SDK untuk detailnya.Jenis event
Setiap server-sent event mencakup jenis event bernama dan data JSON terkait. Setiap event akan menggunakan nama event SSE (misalnyaevent: message_stop), dan menyertakan type event yang cocok dalam datanya.
Setiap stream menggunakan alur event berikut:
message_start: berisi objekMessagedengancontentkosong.- Serangkaian blok konten, yang masing-masing memiliki
content_block_start, satu atau lebih eventcontent_block_delta, dan eventcontent_block_stop. Setiap blok konten akan memilikiindexyang sesuai dengan indeksnya dalam arraycontentMessage akhir. - Satu atau lebih event
message_delta, yang menunjukkan perubahan tingkat atas pada objekMessageakhir. - Event
message_stopterakhir.
Jumlah token yang ditampilkan dalam field
usage dari event message_delta adalah kumulatif.Event ping
Stream event juga dapat mencakup sejumlah eventping.
Event error
Kami terkadang dapat mengirim errors dalam stream event. Misalnya, selama periode penggunaan tinggi, Anda mungkin menerimaoverloaded_error, yang biasanya sesuai dengan HTTP 529 dalam konteks non-streaming:
Example error
Event lainnya
Sesuai dengan kebijakan versioning kami, kami dapat menambahkan jenis event baru, dan kode Anda harus menangani jenis event yang tidak dikenal dengan baik.Jenis delta blok konten
Setiap eventcontent_block_delta berisi delta dari jenis yang memperbarui blok content pada index tertentu.
Delta teks
Delta blok kontentext terlihat seperti:
Text delta
Delta JSON input
Delta untuk blok kontentool_use sesuai dengan pembaruan untuk field input dari blok tersebut. Untuk mendukung granularitas maksimum, delta adalah string JSON parsial, sedangkan tool_use.input akhir selalu berupa objek.
Anda dapat mengakumulasi delta string dan mem-parse JSON setelah menerima event content_block_stop, dengan menggunakan library seperti Pydantic untuk melakukan parsing JSON parsial, atau dengan menggunakan SDK kami, yang menyediakan helper untuk mengakses nilai incremental yang di-parse.
Delta blok konten tool_use terlihat seperti:
Input JSON delta
input pada satu waktu. Dengan demikian, saat menggunakan tools, mungkin ada penundaan antara event streaming saat model sedang bekerja. Setelah kunci dan nilai input terakumulasi, kami mengeluarkannya sebagai beberapa event content_block_delta dengan json parsial yang dipotong sehingga format dapat secara otomatis mendukung granularitas yang lebih halus dalam model masa depan.
Delta thinking
Saat menggunakan extended thinking dengan streaming diaktifkan, Anda akan menerima konten thinking melalui eventthinking_delta. Delta ini sesuai dengan field thinking dari blok konten thinking.
Untuk konten thinking, event signature_delta khusus dikirim tepat sebelum event content_block_stop. Tanda tangan ini digunakan untuk memverifikasi integritas blok thinking.
Delta thinking tipikal terlihat seperti:
Thinking delta
Signature delta
Respons HTTP Stream lengkap
Kami sangat merekomendasikan agar Anda menggunakan client SDK kami saat menggunakan mode streaming. Namun, jika Anda membangun integrasi API langsung, Anda perlu menangani event ini sendiri. Respons stream terdiri dari:- Event
message_start - Berpotensi beberapa blok konten, yang masing-masing berisi:
- Event
content_block_start - Berpotensi beberapa event
content_block_delta - Event
content_block_stop
- Event
- Event
message_delta - Event
message_stop
ping yang tersebar di seluruh respons juga. Lihat Jenis event untuk detail lebih lanjut tentang formatnya.
Request streaming dasar
Response
Request streaming dengan penggunaan tool
Penggunaan tool sekarang mendukung streaming berbutir halus untuk nilai parameter sebagai fitur beta. Untuk detail lebih lanjut, lihat Fine-grained tool streaming.
Response
Request streaming dengan extended thinking
Dalam request ini, kami mengaktifkan extended thinking dengan streaming untuk melihat penalaran langkah demi langkah Claude.Response
Request streaming dengan penggunaan tool pencarian web
Dalam request ini, kami meminta Claude untuk mencari web untuk informasi cuaca terkini.Response
Pemulihan error
Ketika request streaming terganggu karena masalah jaringan, timeout, atau error lainnya, Anda dapat pulih dengan melanjutkan dari tempat stream terganggu. Pendekatan ini menghemat Anda dari memproses ulang seluruh respons. Strategi pemulihan dasar melibatkan:- Tangkap respons parsial: Simpan semua konten yang berhasil diterima sebelum error terjadi
- Buat request lanjutan: Buat request API baru yang menyertakan respons assistant parsial sebagai awal dari pesan assistant baru
- Lanjutkan streaming: Terus menerima sisa respons dari tempat terganggu
Praktik terbaik pemulihan error
- Gunakan fitur SDK: Manfaatkan kemampuan akumulasi pesan dan penanganan error bawaan SDK
- Tangani jenis konten: Sadari bahwa pesan dapat berisi beberapa blok konten (
text,tool_use,thinking). Blok penggunaan tool dan extended thinking tidak dapat dipulihkan sebagian. Anda dapat melanjutkan streaming dari blok teks terbaru.