跳转到内容

SSE арқылы нақты уақыттағы барыс-келіс

Файлдарды аудару жұмыстарының барысын (/jobs) SSE (Server-Sent Events) арқылы нақты уақыт режимінде алыңыз. Егер SSE қол жетімді болмаса, байланыс 404-ды қайтарады; оның орнына жұмыстың күйін сұраңыз.

Браузердің EventSource мүмкіндігі арнайы тақырыптарды жібере алмайды, сондықтан куәліктер екі қадамды қажет етеді:

  1. Серверіңіз API кілтін билетке ауыстырады (30 секундқа жарамды, бір рет қолданылады)
  2. Билетпен SSE жүйесіне қосылыңыз (бұл браузерде орын алуы мүмкін; билет ұзақ мерзімді сенімхат емес)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}
GET /api/v1/sse/jobs/{job_id}?ticket=...

API кілтін серверде сақтаңыз: сервер билетті алып, оны браузерге береді.

// 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();
});
ОқиғаСипаттама
job_updateМәртебе немесе кезең өзгерді (қосылғаннан кейін бірден ағымдағы жағдайдың скриншоты жіберіледі)
job_doneЖұмыс аяқталды (completed немесе failed); байланысты жабуға болады
timeoutАғын максималды ұзақтығына жетті; қайта қосыңыз
errorСервер жағындағы мәселе; жаңа билет алып, кейінірек қайта байланысыңыз

Сервердің stage_message нұсқасы қытай тілінде:

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

Жұмыс аяқталған кезде 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
  • Билет бір рет жарамды; қайта қосылғанға дейін жаңасын алыңыз
  • Әр аккаунт бір уақытта ең көбі 6 SSE байланысты ашып, минутына ең көбі 30 билет алмаса алады; одан асса жауап 429 болады, сондықтан Retry-After-ті күтіңіз немесе оның орнына сұрау жіберіңіз
  • Егер ұзақ уақыт бойы жұмыс оқиғалары болмаса, сервер timeout оқиғасын жібереді; жаңа билет алып, қайта қосылыңыз
  • Байланыс қалта режимінде болғанда сервер жүрек соғысы комментарийлерін жібереді; клиенттер комментарий жолдарын елемеуі керек.
  • Егер байланыс үзілсе, GET /jobs/{id} опросы қосалқы нұсқа ретінде жұмыс істейді.