Streaming SSE
Op deze pagina
Real-time antwoorden
In de normale modus wacht u tot het model de volledige reactie heeft gegenereerd voordat u deze ontvangt. Bij SSE-streaming (Server-Sent Events) komen tokens binnen terwijl ze worden gegenereerd. Dit is essentieel voor conversatie-interfaces waarbij gebruikers de reactie geleidelijk willen zien verschijnen.
Streaming inschakelen
Voeg "stream": true toe aan uw verzoek:
curl https://api.x.ai/v1/responses \
-H "Authorization: Bearer $XAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "grok-4.20-0309-reasoning",
"input": "Write a poem about programming.",
"stream": true
}'
Het antwoord komt binnen als een SSE-stream:
data: {"type": "response.created", "response": {...}}
data: {"type": "response.output_item.added", ...}
data: {"type": "response.content_part.added", ...}
data: {"type": "response.output_text.delta", "delta": "La "}
data: {"type": "response.output_text.delta", "delta": "programmation "}
data: {"type": "response.output_text.delta", "delta": "est "}
...
data: {"type": "response.completed", "response": {...}}
Event-types
| Event | Beschrijving |
|---|---|
response.created | Generatie start |
response.output_item.added | Nieuw item in uitvoer |
response.content_part.added | Nieuw inhoudsdeel |
response.output_text.delta | Tekstfragment (meest frequent) |
response.output_text.done | Volledige tekst van een item |
response.completed | Antwoord afgerond met gebruik |
response.failed | Fout tijdens generatie |
Streaming in Python
stream = client.responses.create(
model="grok-4.20-0309-reasoning",
input="Explain how a compiler works.",
stream=True
)
full_text = ""
for event in stream:
if event.type == "response.output_text.delta":
print(event.delta, end="", flush=True)
full_text += event.delta
elif event.type == "response.completed":
usage = event.response.usage
print(f"\n\nTokens: {usage.total_tokens}")
print(f"Cost: {usage.cost_in_nano_usd / 1e9:.6f} USD")
flush=True forceert de onmiddellijke weergave van elk fragment.
Streaming met tools
Wanneer het model tools gebruikt in de streaming-modus, ontvangt u aanvullende events:
data: {"type": "response.output_item.added", "item": {"type": "web_search_call"}}
data: {"type": "response.web_search_call.in_progress", ...}
data: {"type": "response.web_search_call.completed", ...}
data: {"type": "response.output_text.delta", "delta": "Selon les résultats..."}
Voor client-functieaanroepen ontvangt u argumenten geleidelijk:
data: {"type": "response.function_call.arguments.delta", "delta": "{\"city\""}
data: {"type": "response.function_call.arguments.delta", "delta": ": \"Paris\"}"}
data: {"type": "response.function_call.arguments.done", ...}
Frontend-integratie
Voor een webapplicatie stuurt u de SSE-stream via een server-endpoint naar de browser:
const response = await fetch('/api/chat', {
method: 'POST',
body: JSON.stringify({ message: userInput })
});
const reader = response.body.getReader();
const decoder = new TextDecoder();
while (true) {
const { done, value } = await reader.read();
if (done) break;
const text = decoder.decode(value);
outputElement.textContent += text;
}
Streaming en facturatie
Streaming verandert niets aan de facturatie. De kosten zijn identiek, ongeacht of streaming is ingeschakeld of niet; alleen de leveringsmodus verschilt. Het volledige usage-object is beschikbaar in het response.completed-event.
Belangrijkste punten
stream: trueschakelt SSE-streaming in; tokens komen binnen terwijl ze worden gegenereerd- Het
response.output_text.delta-event bevat elk tekstfragment - Het
response.completed-event bevat het definitieve antwoord met gebruiksmetadata - Streaming werkt met tools (web_search, functies)
- De kosten zijn identiek met of zonder streaming