Průběh v reálném čase s SSE
Přijímejte průběh práce na překladu souborů (/jobs) v reálném čase prostřednictvím SSE (Server-Sent Events). Pokud není SSE k dispozici, spojení vrátí 404; místo toho zkontrolujte stav úlohy.
Průběh připojení
Section titled “Průběh připojení”Prohlížeč EventSource nemůže odesílat vlastní záhlaví, takže přihlašovací údaje vyžadují dva kroky:
- Váš server vymění API klíč za lístek (platný po dobu 30 sekund, použitelný jednou)
- Připojte se k SSE pomocí tiketu (může to proběhnout v prohlížeči; tiket není dlouhodobé přihlašovací údaje)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}GET /api/v1/sse/jobs/{job_id}?ticket=...JavaScript příklad
Section titled “JavaScript příklad”Uchovávejte API klíč na serveru: server získá ticket a předá ho prohlížeči.
// 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 událostí
Section titled “Typy událostí”| Událost | Popis |
|---|---|
job_update | Status nebo fáze se změnila (snímek aktuálního stavu je odeslán ihned po připojení) |
job_done | Úloha skončila (completed nebo failed); můžete uzavřít spojení |
timeout | Proud dosáhl maximální délky; připojit znovu |
error | Problém na serveru; získejte nový token a připojte se později |
Data události
Section titled “Data události”stage_message serveru je v čínštině:
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ískáte seznam výsledků pomocí GET /api/v1/artifacts?job_id=....
Python example
Section titled “Python example”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”- Jedno tiket funguje pouze jednou; před opětovným připojením si vyžádejte nový.
- Každý účet může mít současně otevřeno nejvýše 6 SSE spojení a směnit nejvýše 30 tiketů za minutu; v opačném případě je odpověď
429, takže buď počkejte naRetry-After, nebo místo toho provádějte polling. - Pokud po dlouhou dobu nejsou žádné události práce, server odešle událost
timeout; získejte nový lístek a připojte se znovu. - Během nečinnosti spojení server odesílá srdcové zprávy; klienti by měli řádky komentářů ignorovat.
- Pokud se připojení přeruší, jako záloha funguje opakované dotazování
GET /jobs/{id}.