Lewati ke konten

Progres waktu nyata dengan SSE

Terima progres pekerjaan terjemahan file (/jobs) secara real time melalui SSE (Server-Sent Events). Ketika SSE tidak tersedia, koneksi mengembalikan 404; sebaiknya lakukan polling status pekerjaan.

EventSource pada browser tidak dapat mengirim header khusus, sehingga kredensial memerlukan dua langkah:

  1. Server Anda menukar kunci API dengan tiket (berlaku selama 30 detik, dapat digunakan satu kali)
  2. Hubungkan ke SSE dengan tiket (ini dapat terjadi di peramban; tiket bukan kredensial yang bertahan lama)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}
GET /api/v1/sse/jobs/{job_id}?ticket=...

Simpan kunci API di server: server memperoleh tiket dan menyerahkannya ke 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();
});
PeristiwaDeskripsi
job_updateStatus atau tahap berubah (snapshot dari keadaan saat ini dikirim segera setelah koneksi terhubung)
job_donePekerjaan telah berakhir (completed atau failed); Anda dapat menutup koneksi
timeoutAliran telah mencapai durasi maksimum; sambungkan kembali
errorMasalah sisi server; dapatkan tiket baru dan hubungkan kembali nanti

stage_message server dalam bahasa Tionghoa:

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

Saat pekerjaan selesai, dapatkan daftar hasil dengan 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
  • Sebuah tiket hanya berlaku sekali; dapatkan tiket baru sebelum menyambung kembali
  • Setiap akun dapat mempertahankan hingga 6 koneksi SSE terbuka secara bersamaan dan menukar maksimal 30 tiket per menit; jika melebihi batas tersebut, respons yang diterima adalah 429, jadi tunggu Retry-After atau lakukan polling sebagai gantinya.
  • Ketika tidak ada peristiwa pekerjaan untuk waktu yang lama, server mengirimkan peristiwa timeout; dapatkan tiket baru dan sambungkan kembali
  • Selama koneksi dalam keadaan idle, server mengirimkan komentar heartbeat; klien harus mengabaikan baris komentar tersebut.
  • Jika koneksi terputus, polling GET /jobs/{id} berfungsi sebagai cadangan.