Real-time progress with SSE
Prijímajte priebežné informácie o stave úloh prekladu súborov (/jobs) v reálnom čase prostredníctvom SSE (Server-Sent Events). Ak SSE nie je k dispozícii, spojenie vráti 404; namiesto toho si získavajte stav úlohy opakovane.
Priebeh pripojenia
Section titled “Priebeh pripojenia”Prehliadač EventSource nemôže odosielať vlastné hlavičky, takže poverenia vyžadujú dva kroky:
- Váš server vymení API kľúč za tiket (platný 30 sekúnd, použiteľný jedenkrát)
- Pripojte sa k SSE pomocou tiketu (môže to nastať v prehliadači; tiket nie je dlhodobým poverením)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}GET /api/v1/sse/jobs/{job_id}?ticket=...JavaScript príklad
Section titled “JavaScript príklad”Uchovajte API kľúč na serveri: server získa tiket a odovzdá ho prehliadaču.
// Server (Node.js 18+): exchange the key for a ticketasync 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 serverconst 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();});Typy udalostí
Section titled “Typy udalostí”| Udialosť | Popis |
|---|---|
job_update | Zmenený stav alebo fáza (okamžite po pripojení sa odošle snímka aktuálneho stavu) |
job_done | Úloha skončila (completed alebo failed); môžete uzavrieť pripojenie |
timeout | Prenos dosiahol maximálnu dobu trvania; opätovné pripojenie |
error | Problém na strane servera; získajte nový lístok a pripojte sa neskôr. |
Údaje o udalosti
Section titled “Údaje o udalosti”stage_message servera je v čínštine:
event: job_updatedata: {"status":"processing","stage":"translating","stage_progress":45,"stage_message":"正在翻译..."}
event: job_donedata: {"status":"completed","stage":"completed","stage_progress":100,"stage_message":""}Po dokončení úlohy získajte zoznam výsledkov pomocou GET /api/v1/artifacts?job_id=....
Python príklad
Section titled “Python príklad”pip install requests sseclient-pyimport json
import requestsimport 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 connectedresponse = 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 insteadPoznámky
Section titled “Poznámky”- Lístok funguje iba raz; pred opätovným pripojením si vyžiadajte nový.
- Každý účet môže mať naraz otvorených najviac 6 SSE pripojení a vymeniť najviac 30 lístkov za minútu; ak to prekročíte, odpoveď je
429, takže buď počkajte naRetry-After, alebo namiesto toho vykonajte poll - Keď po dlhú dobu nie sú žiadne udalosti práce, server odosiela udalosť
timeout; získajte nový lístok a opätovne sa pripojte. - Počas nečinnosti pripojenia server odosiela komentáre srdcových tepov; klientské programy by mali riadky s komentármi ignorovať.
- Ak sa spojenie preruší, ako záloha funguje opakovanie dotazov
GET /jobs/{id}.