SSE voogedastus
Sellel lehel
Reaalajas vastused
Tavalises režiimis ootad, kuni mudel on kogu vastuse genereerimise lõpetanud, enne kui selle kätte saad. SSE voogedastuse (Server-Sent Events) puhul saabuvad tokenid genereerimise käigus. See on hädavajalik vestlusliideste jaoks, kus kasutaja soovib vastust järk-järgult ilmuvat näha.
Voogedastuse lubamine
Lisa oma päringusse "stream": true:
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
}'
Vastus saabub SSE voona:
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": {...}}
Sündmuste tüübid
| Sündmus | Kirjeldus |
|---|---|
response.created | Genereerimine algab |
response.output_item.added | Uus element väljundis |
response.content_part.added | Uus sisuosa |
response.output_text.delta | Tekstifragment (kõige sagedasem) |
response.output_text.done | Elemendi täielik tekst |
response.completed | Vastus lõpetatud koos kasutusstatistikaga |
response.failed | Viga genereerimise ajal |
Voogedastus Pythonis
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 sunnib iga fragmendi koheselt kuvama.
Voogedastus tööriistadega
Kui mudel kasutab voogedastusrežiimis tööriistu, saad täiendavaid sündmusi:
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..."}
Kliendi funktsioonikutsete puhul saad argumendid järk-järgult:
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", ...}
Integreerimine front-end’iga
Veebirakenduse jaoks edasta SSE voog serveri lõpp-punkti kaudu brauserile:
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;
}
Voogedastus ja arveldus
Voogedastus ei muuda arveldust. Kulud on identsed, olenemata sellest, kas see on lubatud või mitte – erineb ainult edastamisviis. Täielik usage objekt on saadaval sündmuses response.completed.
Peamised punktid
stream: truelubab SSE voogedastuse – tokenid saabuvad genereerimise käigus- Sündmus
response.output_text.deltasisaldab iga tekstifragmenti - Sündmus
response.completedsisaldab lõplikku vastust koos kasutusmetaandmetega - Voogedastus toimib koos tööriistadega (web_search, functions)
- Kulud on voogedastusega või ilma identsed