Sari la conținut

Progres în timp real cu SSE

Recepeți progresul joburilor de traducere a fișierelor (/jobs) în timp real prin SSE (Server-Sent Events). Atunci când SSE nu este disponibil, conexiunea returnează 404; verificați în schimb starea jobului.

Navigatorul EventSource nu poate trimite capete personalizate, astfel că credențialele necesită două etape:

  1. Serverul dvs. înlocuiește cheia API cu un bilet (valabil 30 de secunde, utilizabil o dată)
  2. Conectați-vă la SSE folosind biletul (aceasta poate avea loc în browser; biletul nu este un credential cu durată lungă)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}
GET /api/v1/sse/jobs/{job_id}?ticket=...

Păstrați cheia API pe server: serverul obține ticket-ul și îl transmite browserului.

// 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();
});
EvenimentDescriere
job_updateStarea sau etapa s-a schimbat (o instantanee a stării curente este trimisă imediat după conectare)
job_doneTreaba s-a încheiat (completed sau failed); puteți închide conexiunea
timeoutStream-ul a atins durata maximă; reconectați-vă
errorProblema la server; obțineți un nou bilet și reconectați-vă mai târziu

Serverul stage_message este în limba chineză:

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":""}

Când sarcina se termină, obține lista de rezultate cu 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
  • Un bilet funcționează o singură dată; obțineți unul nou înainte de a vă reconecta.
  • Fiecare cont poate menține simultan deschise cel mult 6 conexiuni SSE și poate schimba cel mult 30 de bilete pe minut; în caz contrar, răspunsul este 429, deci așteptați Retry-After sau folosiți solicitarea cu sondaj.
  • Când nu există evenimente de job pentru o perioadă îndelungată, serverul trimite un eveniment timeout; obțineți un nou bilet și reconectați-vă.
  • În timp ce conexiunea este inactivă, serverul trimite comentarii de heartbeat; clienții ar trebui să ignore linii de comentarii.
  • Dacă conexiunea se întrerupe, polița GET /jobs/{id} funcționează ca o soluție de rezervă.