דילוג לתוכן
NotHolyתיעוד

מדריכים

סטרימינג

קבלת טוקנים בזמן שהם נוצרים, עם server-sent events, בכל פורמטי ה-API.

להציג כ-Markdown

מגדירים stream: true. התגובה היא text/event-stream. האירועים נשלחים אחד אחרי השני, בלי אגירה.

curl -N https://api.notholy.com/v1/chat/completions \
  -H "Authorization: Bearer $NOTHOLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "notholy-specter", "stream": true, "stream_options": {"include_usage": true}, "messages": [{"role": "user", "content": "Define XSS."}]}'

מה מקבלים

  • Chat completions ו-text completions מסתיימים באירוע data: [DONE]. המקטע שלפניו תמיד מכיל את usage, עם include_usage או בלעדיו.
  • Responses מסתיים באירוע response.completed (או response.incomplete כשמגיעים למגבלת הפלט). Messages מסתיים באירוע message_delta ואחריו message_stop. אף אחד מהם לא שולח [DONE].
  • בהפסקות ארוכות נשלחות הערות keep-alive (בפורמטים של OpenAI) או אירועי ping (ב-Messages).
  • אם הסטרים נקטע, משלמים רק על הטוקנים שנוצרו לפני הניתוק.
  • שגיאות שמתגלות לפני שהסטרים מתחיל (מפתח, קרדיטים, מגבלות) חוזרות כשגיאת JSON רגילה עם סטטוס ה-HTTP שלהן. כשל אחרי שהסטרים התחיל מגיע כאירוע שגיאה באותו פורמט: data: {"error": ...}, response.failed או אירוע error.

הבא