Postęp w czasie rzeczywistym z SSE
Otrzymuj postęp zadań tłumaczenia plików (/jobs) w czasie rzeczywistym za pośrednictwem SSE (Server-Sent Events). Gdy SSE nie jest dostępne, połączenie zwraca 404; zamiast tego sprawdzaj status zadania.
Przepływ połączenia
Dział zatytułowany „Przepływ połączenia”Przeglądarka EventSource nie może wysyłać niestandardowych nagłówków, więc uwierzytelnianie odbywa się w dwóch krokach:
- Twój serwer wymienia klucz API na bilet (ważny przez 30 sekund, do jednorazowego użycia)
- Połącz się z SSE za pomocą biletu (może to nastąpić w przeglądarce; bilet nie jest długotrwałym poświadczeniem)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}GET /api/v1/sse/jobs/{job_id}?ticket=...JavaScript example
Dział zatytułowany „JavaScript example”Zachowaj klucz API na serwerze: serwer pobiera token i przekazuje go do przeglądarki.
// 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 zdarzeń
Dział zatytułowany „Typy zdarzeń”| Zdarzenie | Opis |
|---|---|
job_update | Status lub etap został zmieniony (natychmiast po nawiązaniu połączenia wysyłany jest zrzut ekranu aktualnego stanu) |
job_done | Zadanie zakończone (completed lub failed); możesz zamknąć połączenie |
timeout | Prąd osiągnął maksymalną długość; połącz ponownie |
error | Problem po stronie serwera; uzyskaj nowy token i spróbuj ponownie połączyć się później |
Dane zdarzenia
Dział zatytułowany „Dane zdarzenia”Serwer stage_message jest w języku chińskim:
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 zakończeniu zadania uzyskaj listę wyników za pomocą GET /api/v1/artifacts?job_id=....
Python example
Dział zatytułowany „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 instead- Bilet działa tylko raz; przed ponownym połączeniem uzyskaj nowy.
- Każde konto może jednocześnie utrzymać maksymalnie 6 połączeń SSE i wymieniać co najwyżej 30 biletów na minutę; po przekroczeniu tego limitu odpowiedź brzmi
429, więc należy poczekać naRetry-Afterlub zamiast tego wykonać zapytanie cykliczne. - Gdy przez długi czas nie występują żadne zdarzenia związane z zadaniem, serwer wysyła zdarzenie
timeout; uzyskaj nowy bilet i ponownie nawiąż połączenie. - Podczas gdy połączenie jest nieaktywne, serwer wysyła komentarze sygnalizujące aktywność; klienty powinny ignorować te linie komentarzy.
- Jeśli połączenie zostanie przerwane, pobieranie danych za pomocą polingu
GET /jobs/{id}służy jako rozwiązanie awaryjne.