跳转到内容

Tijek u stvarnom vremenu s SSE

Primajte napredak zadataka prevoda datoteka (/jobs) u stvarnom vremenu putem SSE (Server-Sent Events). Kada SSE nije dostupan, veza vraća 404; umjesto toga provjeravajte status zadatka.

Preglednik EventSource ne može slati prilagođene zaglavlja, pa zato vjerodajnice zahtijevaju dva koraka:

  1. Vaš poslužitelj zamjenjuje API ključ za karticu (važeću 30 sekundi, koristivu jednom)
  2. Povežite se s SSE pomoću ulaznice (ovo se može dogoditi u pregledniku; ulaznica nije vjerodajnica dugog trajanja)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}
GET /api/v1/sse/jobs/{job_id}?ticket=...

Zadržite API ključ na poslužitelju: poslužitelj dobiva karticu i predaje je pregledniku.

// Server (Node.js 18+): exchange the key for a ticket
async function createSseTicket(jobId) {
const response = await fetch(
`https://omnidoc.top/api/v1/sse/ticket/${jobId}`,
{ method: 'POST', headers: { 'X-API-Key': process.env.OMNIDOC_API_KEY } }
);
if (!response.ok) throw new Error(`ticket failed: ${response.status}`);
return (await response.json()).ticket;
}
// Browser: connect to SSE with the ticket from your server
const source = new EventSource(
`https://omnidoc.top/api/v1/sse/jobs/${jobId}?ticket=${encodeURIComponent(ticket)}`
);
// The events are named, so use addEventListener (onmessage does not receive them)
source.addEventListener('job_update', (event) => {
const data = JSON.parse(event.data);
console.log(`status: ${data.status}, stage: ${data.stage}, progress: ${data.stage_progress}%`);
});
source.addEventListener('job_done', (event) => {
const data = JSON.parse(event.data);
console.log(`finished: ${data.status}`);
source.close();
});
DogađajOpis
job_updateStatus ili faza su promijenjeni (snimka trenutnog stanja šalje se odmah nakon spajanja)
job_doneZadatak je završen (completed ili failed); možete zatvoriti vezu
timeoutTok je dostigao maksimalnu duljinu; ponovno povežite
errorProblem na strani servera; zatražite novu karticu i ponovno se povežite kasnije

Serverova stage_message je na kineskom jeziku:

event: job_update
data: {"status":"processing","stage":"translating","stage_progress":45,"stage_message":"正在翻译..."}
event: job_done
data: {"status":"completed","stage":"completed","stage_progress":100,"stage_message":""}

Kada se zadatak završi, dobit ćete popis rezultata s GET /api/v1/artifacts?job_id=....

Terminal window
pip install requests sseclient-py
import json
import requests
import sseclient # sseclient-py
BASE = "https://omnidoc.top/api/v1"
HEADERS = {"X-API-Key": "sk_your_key"}
job_id = "q3f8s6c2a9m1k4tx"
ticket_response = requests.post(
f"{BASE}/sse/ticket/{job_id}", headers=HEADERS, timeout=20
)
ticket_response.raise_for_status()
ticket = ticket_response.json()["ticket"]
# Read timeout longer than the 15-second heartbeat; no API key while connected
response = requests.get(
f"{BASE}/sse/jobs/{job_id}",
params={"ticket": ticket},
stream=True,
timeout=(10, 60),
)
response.raise_for_status()
client = sseclient.SSEClient(response)
for event in client.events():
data = json.loads(event.data)
print(f"[{event.event}] {data.get('stage')} {data.get('stage_progress', 0)}%")
if event.event in {"job_done", "timeout", "error"}:
break # timeout / error: get a new ticket and reconnect, or poll instead
  • Karta vrijedi samo jednom; prije ponovnog povezivanja nabavite novu.
  • Svaki račun može istovremeno održavati najviše 6 SSE veza i razmjenjivati najviše 30 tiketa u minuti; izvan tog ograničenja odgovor je 429, stoga pričekajte Retry-After ili umjesto toga koristite polling.
  • Kada dugo nema događaja za rad, poslužitelj šalje događaj timeout; zatražite novu karticu i ponovno se povežite
  • Dok je veza neaktivna, poslužitelj šalje oznake otkucaja; klijenti trebaju ignorirati redove s komentarima.
  • Ako se veza prekine, polling GET /jobs/{id} služi kao rezerva.