مرجع توسعه‌دهندگان

EFARS API

Streaming در Claude

پاسخ تدریجی با SSE، تجمیع متن و مدیریت پایان یا قطع جریان.

راهنمای اتصال مشتریان
curl · Python · JavaScript

فعال‌کردن جریان

HTTP

POST https://efars.com/claude/v1/messages
x-api-key: YOUR_EFARS_API_KEY
anthropic-version: 2023-06-01
Content-Type: application/json

در همان مسیر عادی، stream را true قرار دهید. به جای یک سند JSON کامل، رویدادهای text/event-stream دریافت می‌کنید.

نمونه‌ها آموزشی‌اند و حاصل اجرای زنده نیستند. YOUR_EFARS_API_KEY و نام‌های ختم‌شونده به MODEL_NAME جای‌نگهدارند؛ پیش از اجرا، کلید ای‌فارس و مدل مجاز حساب خود را جایگزین کنید. مقادیر شناسه و مصرف در پاسخ‌های نمونه، گزارش مصرف واقعی نیستند.

رویدادها و استخراج متن

چرخه message_start، content_block_start، content_block_delta، content_block_stop، message_delta و message_stop را دنبال کنید. متن در delta.text و آمار در رویدادهای usage است. ping را نادیده بگیرید؛ رویداد error و بلوک‌های tool_use یا thinking را جدا پردازش کنید. پایان استاندارد message_stop است، نه [DONE].

SSE · توالی نمایشی، نه خروجی زنده

event: message_start
data: {"type":"message_start","message":{"id":"msg-example","type":"message","role":"assistant","model":"CLAUDE_MODEL_NAME","content":[],"usage":{"input_tokens":0,"output_tokens":0}}}

event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}

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: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"end_turn"},"usage":{"output_tokens":0}}

event: message_stop
data: {"type":"message_stop"}

نمونه کد Streaming

curl

# مدل جای‌نگهدار را با مدل مجاز حساب خود جایگزین کنید.
curl -N --fail-with-body 'https://efars.com/claude/v1/messages' \
  -H "x-api-key: ${EFARS_API_KEY}" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  --data '{
  "model": "CLAUDE_MODEL_NAME",
  "max_tokens": 256,
  "messages": [
    {
      "role": "user",
      "content": "سلام! لطفاً خودت را معرفی کن."
    }
  ],
  "stream": true
}'

قطع اتصال و تکمیل پاسخ

  • پیش از بازکردن parser، HTTP status و Content-Type را بررسی کنید؛ خطا ممکن است JSON عادی باشد.
  • مرز chunk شبکه با مرز رویداد یکی نیست. data چندخطی، UTF-8 و فاصله بین رویدادها را درست پردازش کنید.
  • پایان مورد انتظار پروتکل را ثبت کنید؛ EOF یا متن دریافت‌شده به‌تنهایی تضمین تکمیل پاسخ نیست.
  • رویداد error، timeout و انصراف کاربر را از پایان عادی جدا کنید. پاسخ ناقص را کامل معرفی نکنید.
  • با قطع جریان ممکن است مصرف انجام‌شده ثبت شود. retry خودکار می‌تواند درخواست و هزینه جدید ایجاد کند.

نمونه‌های Python و JavaScript این صفحه متن delta را نمایش می‌دهند. برای کاربرد تولیدی، ثبت وضعیت پایان، usage، بلوک‌های ابزار، لغو درخواست و سیاست retry متناسب با برنامه را اضافه کنید. timeout نمونه ۶۰ ثانیه است و تضمین زمان پاسخ سرویس نیست.