Preskoči na sadržaj
Streaming

Streaming

Postavite stream na true i odgovor stiže kao server-sent događaji dok ga model piše: prvo razmišljanje, zatim odgovor, a na kraju zadnji chunk s razlogom završetka i usageom. Koristite ga kad god osoba čeka tekst te za duge odgovore.

POST https://api.shannon-ai.com/v1/chat/completions

OpenAI SDK-ovi vam daju chunkove jedan po jedan. Svaki chunk čitajte prema onome što nosi: dio razmišljanja, dio odgovora, poziv alata ili kraj odgovora.

from openai import OpenAI, APIError

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

stream = client.chat.completions.create(
    model="shannon-3",
    messages=[{"role": "user", "content": "Explain server-sent events in three sentences."}],
    stream=True,
)

answer, reasoning, tool_calls = [], [], []
finish_reason = usage = None

try:
    for chunk in stream:
        if chunk.usage:
            usage = chunk.usage
        if not chunk.choices:
            continue
        choice = chunk.choices[0]
        delta = choice.delta

        thought = getattr(delta, "reasoning_content", None)
        if thought:
            reasoning.append(thought)
        if delta.content:
            answer.append(delta.content)
            print(delta.content, end="", flush=True)
        for call in delta.tool_calls or []:
            tool_calls.append((call.id, call.function.name, call.function.arguments))
        if choice.finish_reason:
            finish_reason = choice.finish_reason
except APIError as error:
    # A failure after the stream started arrives as an error chunk.
    print(f"\nstream failed: {error}")

print(f"\n{finish_reason} {usage}")

Kako je stream uokviren

  • Odgovor ima status 200 i zaglavlja content-type: text/event-stream i cache-control: no-cache.
  • Svaki događaj je jedan redak koji počinje s data: i iza kojeg slijedi prazan redak. Tekst iza data: je jedan JSON chunk. Nema redaka event: ni id:.
  • Redak koji počinje dvotočkom, poput : ping, je komentar koji drži vezu otvorenom. Preskočite ga.
  • Stream završava s data: [DONE]. Stream koji stane bez toga je nepotpun.

Chunkovi redom

Svaki chunk je objekt chat.completion.chunk:

JSON
{
  "id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "chat.completion.chunk",
  "created": 1791625200,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "delta": {
        "content": "Server-sent"
      },
      "finish_reason": null
    }
  ]
}

Svi chunkovi jednog streama nose isti id, created i model. choices uvijek sadrži jedan unos. Njegova delta sadrži ono što je novo, a finish_reason je null do zadnjeg chunka.

Ključ u delta Tip Opis Šalje
role string Uvijek assistant. Stiže jednom, na početku streama. Hostirani open-weight modeli, shannon-2-lite, shannon-2-pro
reasoning_content string Dio razmišljanja modela. Spojite dijelove redom. Hostirani open-weight modeli, obitelj Shannon 3, shannon-1.6-pro, shannon-coder-1
content string Dio odgovora. Spojite dijelove redom. Svi modeli
tool_calls array Jedan potpuni poziv alata. Vidi Delte poziva alata. Svi modeli

Prvo dolazi razmišljanje, zatim odgovor, zatim eventualni pozivi alata. Chunk čitajte prema ključevima u njegovoj delta, a ne prema mjestu u streamu: delta može sadržavati role zajedno s prvim dijelom teksta, a zadnja je prazna.

Cijeli stream onako kako putuje. Radi kraćih redaka, id, object, created i model ovdje su izostavljeni iz svakog chunka.

200 text/event-stream
data: {"choices":[{"index":0,"delta":{"reasoning_content":"Three sentences:"},"finish_reason":null}]}

data: {"choices":[{"index":0,"delta":{"reasoning_content":" what it is, how it is framed, why it is used."},"finish_reason":null}]}

: ping

data: {"choices":[{"index":0,"delta":{"content":"Server-sent"},"finish_reason":null}]}

data: {"choices":[{"index":0,"delta":{"content":" events let a server push text to a client over one HTTP reply."},"finish_reason":null}]}

data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{"prompt_tokens":1190,"completion_tokens":84,"total_tokens":1274}}

data: [DONE]

Delte razmišljanja

Model koji razmišlja šalje svoje razmišljanje u delta.reasoning_content prije odgovora. Držite ta dva teksta odvojeno: prikažite razmišljanje kao zaseban dio koji se može sklopiti ili ga izostavite.

Hostirani open-weight modeli ne šalju razmišljanje kada je reasoning_effort off, niti kada zahtjev ima response_format.

shannon-2-lite i shannon-2-pro također razmišljaju prije nego odgovore. Na ovom endpointu dok razmišljaju šalju retke komentara : thinking, a zatim odgovor.

reasoning_content nije u tipiziranim modelima OpenAI SDK-ova. U Pythonu ga čitajte s getattr(delta, "reasoning_content", None); u JavaScriptu delta.reasoning_content radi kakav jest.

Delte poziva alata

Poziv alata stiže cijel: jedan chunk po pozivu, čija delta sadrži poziv s potpunim nizom arguments. index numerira pozive odgovora od 0. Kod koji spaja arguments dio po dio radi nepromijenjen, jer spaja jedan dio.

delta
{
  "tool_calls": [
    {
      "index": 0,
      "id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
      "type": "function",
      "function": {
        "name": "get_weather",
        "arguments": "{\"city\":\"Paris\"}"
      }
    }
  ]
}

Nakon poziva zadnji chunk ima finish_reason tool_calls.

Kada zahtjev ima tools, shannon-1.6-lite, shannon-1.6-pro i shannon-coder-1 šalju tekst odgovora kao jednu deltu na kraju odgovora.

Zadnji chunk

Zadnji chunk prije data: [DONE] ima praznu delta, finish_reason i usage zahtjeva, sve u istom chunku. Svaki stream ga ima; stream_options vam ne treba.

JSON
{
  "id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "chat.completion.chunk",
  "created": 1791625200,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "delta": {},
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1190,
    "completion_tokens": 84,
    "total_tokens": 1274
  }
}

Na hostiranim open-weight modelima usage ima i prompt_tokens_details.cached_tokens i completion_tokens_details.reasoning_tokens.

Nakon zahtjeva s web_search: true čija je pretraga nešto pronašla, zadnji chunk nosi i sources, a jedan chunk prije njega nosi oznake citata kao delta.annotations. Ugrađena web pretraga

finish_reason Opis Šalje
stop Model je završio odgovor ili se pojavio niz stop. Svi modeli
tool_calls Odgovor sadrži jedan ili više poziva alata. Svi modeli
length Odgovor je prekinut na granici izlaza. Obitelj Shannon 3, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1

Polja usage opisana su uz endpoint. Chat Completions

Keep-alive retci

Dok model radi i još nema što poslati, stream nosi retke komentara. Oni ne sadrže podatke. SSE parser ih preskače sam; kod koji čita sirove retke mora preskočiti svaki redak koji počinje dvotočkom.

Redak Šalje Kada
: ping Obitelj Shannon 3, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 Svakih 15 sekundi.
: keepalive Hostirani open-weight modeli Svakih 15 sekundi dok model radi.
: thinking shannon-2-lite, shannon-2-pro Dok model razmišlja.

Greške unutar streama

Kada stream počne, njegov status je 200, pa neuspjeh stiže unutar streama: chunk s članom error na mjestu gdje bi bio choices.

200 text/event-stream
data: {"error":{"message":"The model backend failed to answer. Please retry.","type":"api_error","code":null,"param":null}}

data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{"prompt_tokens":1190,"completion_tokens":12,"total_tokens":1202}}

data: [DONE]

Nakon chunka greške ipak slijede zadnji chunk, s finish_reason i usage, te data: [DONE]. Provjerite svaki chunk na error. Bez te provjere odgovor koji je zakazao na pola puta izgleda potpun.

Tip Kod Poruka Kada
api_error The model backend failed to answer. Please retry. Model je zakazao ili nije napisao ništa. Pošaljite zahtjev ponovno.
rate_limit_error Shannon routes are temporarily busy. Please retry. Model je trenutačno zauzet. Pričekajte nekoliko sekundi i pošaljite zahtjev ponovno.
invalid_request_error context_length_exceeded Razgovor je dulji od kontekstnog prozora modela. Skratite ga prije nego ga ponovno pošaljete. Tekst poruke varira.

Hostirani open-weight modeli šalju član error samo s type i message.

OpenAI SDK-ovi za Python i JavaScript podižu chunk greške kao API grešku dok iterirate, pa petlju omotajte svojim uobičajenim rukovanjem greškama.

Statusni kodovi, tijelo greške i što ponoviti imaju vlastitu stranicu. Upravljanje greškama

Zatvaranje veze

Zatvaranje veze zaustavlja isporuku, a ne zahtjev. Model piše odgovor do kraja i zahtjev se naplaćuje kao da ste ga cijeloga pročitali. Da platite manje, tražite manje: postavite niži max_tokens na modelu koji ga primjenjuje.

Stream se može prekinuti i na putu do vas, na primjer pri prekidu mreže ili dok se poslužitelj ažurira. Tada staje bez zadnjeg chunka i bez data: [DONE]. Takav odgovor smatrajte nepotpunim i pošaljite zahtjev ponovno.

Čitanje streama bez SDK-a

Ispravan čitač radi pet stvari: greške koje stignu prije streama šalje svom rukovanju greškama, dijeli tijelo na retke, preskače retke komentara, staje na data: [DONE] i provjerava svaki chunk na error.

import json
import requests

response = requests.post(
    "https://api.shannon-ai.com/v1/chat/completions",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "model": "shannon-3",
        "messages": [{"role": "user", "content": "Explain server-sent events in three sentences."}],
        "stream": True,
    },
    stream=True,
)

# 1. Errors before the stream are plain JSON with their own status.
if response.status_code != 200:
    raise RuntimeError(f"{response.status_code}: {response.text}")

answer, done = [], False
for raw in response.iter_lines():          # 2. one line at a time
    line = raw.decode("utf-8")
    if not line.startswith("data: "):      # 3. empty lines and ": ping" comments
        continue
    data = line[len("data: "):]
    if data == "[DONE]":                   # 4. the end of the stream
        done = True
        break
    chunk = json.loads(data)
    if "error" in chunk:                   # 5. a failure inside the stream
        raise RuntimeError(chunk["error"]["message"])
    delta = chunk["choices"][0]["delta"]
    if delta.get("content"):
        answer.append(delta["content"])
    if chunk.get("usage"):
        print(chunk["choices"][0]["finish_reason"], chunk["usage"])

if not done:
    raise RuntimeError("the stream ended before [DONE]")
print("".join(answer))

Primjer u Pythonu koristi paket requests. Primjer u JavaScriptu radi na Node.js 18 ili novijem.

Streamovi ostalih formata

Endpointi Responses i Messages također streamaju. Njihovi okviri nose redak event: s imenom događaja i redak data: s njegovim JSON-om. Svaka stranica navodi svoje događaje redom.

U streamu Chat CompletionsResponsesMessages
Okviri Retci data:Retci event: i data:Retci event: i data:
Razmišljanje stiže u delta.reasoning_contentresponse.reasoning_summary_text.deltathinking_delta
Tekst odgovora stiže u delta.contentresponse.output_text.deltatext_delta
Usage stiže u Zadnji chunkresponse.completedmessage_delta
Stream završava s Zadnji chunk, zatim data: [DONE]response.completedmessage_stop