Tok obrade u realnom vremenu sa SSE
Primajte informacije o toku obrade zadataka prevoda datoteka (/jobs) u realnom vremenu putem SSE (Server-Sent Events). Kada SSE nije dostupan, veza vraća 404; umesto toga proveravajte status zadatka.
Tok povezivanja
Section titled “Tok povezivanja”Pregledač EventSource ne može da šalje prilagođene zaglavlja, pa se akreditivi obrađuju u dva koraka:
- Vaš server zamenjuje API ključ za tiket (važi 30 sekundi, može se koristiti jednom)
- Povežite se na SSE pomoću tiketa (ovo se može desiti u pregledaču; tiket nije dugotrajna akreditacija)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}GET /api/v1/sse/jobs/{job_id}?ticket=...JavaScript primer
Section titled “JavaScript primer”Zadržite API ključ na serveru: server dobija tiket i prosleđuje ga pregledač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();});Vrste događaja
Section titled “Vrste događaja”| Događaj | Opis |
|---|---|
job_update | Status ili faza su promenjeni (snimak trenutnog stanja se šalje odmah nakon povezivanja) |
job_done | Posao je završen (completed ili failed); možete zatvoriti vezu |
timeout | Tok je dostigao svoje maksimalno trajanje; ponovnog povezivanja |
error | Problem na strani servera; dobijte novu kartu i ponovo se povežite kasnije |
Podaci o događaju
Section titled “Podaci o događaju”stage_message na serveru je na kineskom jeziku:
event: job_updatedata: {"status":"processing","stage":"translating","stage_progress":45,"stage_message":"正在翻译..."}
event: job_donedata: {"status":"completed","stage":"completed","stage_progress":100,"stage_message":""}Kada se zadatak završi, dobijte listu rezultata pomoću GET /api/v1/artifacts?job_id=....
Python primer
Section titled “Python primer”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 insteadBeleške
Section titled “Beleške”- Jedna karta važi samo jednom; pre ponovnog povezivanja, nabavite novu
- Svaki nalog može istovremeno da održava najviše 6 SSE veza i da razmeni najviše 30 tiketa u minuti; iznad toga odgovor je
429, pa sačekajteRetry-Afterili umesto toga obavite opitno pitanje. - Kada duže vreme nema događaja za zadatke, server šalje događaj
timeout; dobijte novu kartu i ponovo se povežite - Dok je veza neaktivna, server šalje komentare za puls; klijenti treba da ignorišu linije sa komentarima.
- Ako veza padne, opoziv
GET /jobs/{id}funkcioniše kao rezervna opcija.