Ga naar inhoud

Realtime voortgang met SSE

Ontvang de voortgang van bestandstranslatietaken (/jobs) in realtime via SSE (Server-Sent Events). Wanneer SSE niet beschikbaar is, retourneert de verbinding 404; query in plaats daarvan de taakstatus.

De EventSource van de browser kan geen aangepaste headers verzenden, dus inloggegevens vereisen twee stappen:

  1. Uw server ruilt de API-sleutel in voor een ticket (geldig voor 30 seconden, éénmalig te gebruiken)
  2. Maak verbinding met SSE met het ticket (dit kan in de browser gebeuren; het ticket is geen langdurig inloggegevens)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}
GET /api/v1/sse/jobs/{job_id}?ticket=...

Houd de API-sleutel op de server: de server verkrijgt het ticket en geeft dit door aan de browser.

// 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();
});
EvenementBeschrijving
job_updateStatus of fase gewijzigd (een momentopname van de huidige status wordt direct na het verbinden verzonden)
job_doneDe taak is beëindigd (completed of failed); u kunt de verbinding sluiten
timeoutDe stream heeft de maximale duur bereikt; maak opnieuw verbinding
errorServerprobleem; verkrijg een nieuw ticket en maak later opnieuw verbinding

De stage_message van de server is in het Chinees:

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

Wanneer de taak is voltooid, haal dan de resultatenlijst op met 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
  • Een ticket werkt één keer; verkrijg een nieuw ticket voordat u opnieuw verbinding maakt.
  • Elk account kan tegelijkertijd maximaal 6 SSE-verbindingen openhouden en maximaal 30 tickets per minuut uitwisselen; daarna is de reactie 429, dus wacht op Retry-After of voer in plaats daarvan een polling uit.
  • Wanneer er gedurende lange tijd geen taakgebeurtenissen zijn, verzendt de server een timeout-gebeurtenis; verkrijg een nieuw ticket en maak opnieuw verbinding.
  • Terwijl de verbinding inactief is, verzendt de server heartbeat-opmerkingen; clients dienen opmerkingregels te negeren.
  • Als de verbinding wegvalt, fungeert polling GET /jobs/{id} als fallback.