Прогресс в реальном времени с SSE
Получайте информацию о ходе выполнения заданий по переводу файлов (/jobs) в реальном времени через SSE (Server-Sent Events). Если SSE недоступен, соединение возвращает 404; вместо этого проверяйте статус задания опросом.
Поток подключения
Заголовок раздела «Поток подключения»Браузер EventSource не может отправлять пользовательские заголовки, поэтому для передачи учётных данных требуется два этапа:
- Ваш сервер обменивает API‑ключ на тикет (действителен 30 секунд, используется один раз)
- Подключитесь к SSE с помощью билета (это может происходить в браузере; билет не является долговечным удостоверением).
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}GET /api/v1/sse/jobs/{job_id}?ticket=...JavaScript пример
Заголовок раздела «JavaScript пример»Храните API‑ключ на сервере: сервер получает билет и передаёт его браузеру.
// 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();});Типы событий
Заголовок раздела «Типы событий»| Событие | Описание |
|---|---|
job_update | Изменён статус или этап (снимок текущего состояния отправляется сразу после подключения) |
job_done | Задача завершена (completed или failed); можно закрыть соединение |
timeout | Достигнута максимальная продолжительность потока; повторное подключение |
error | Проблема на стороне сервера; получите новый тикет и повторите подключение позже |
Данные о событии
Заголовок раздела «Данные о событии»Язык сервера stage_message — китайский:
event: job_updatedata: {"status":"processing","stage":"translating","stage_progress":45,"stage_message":"正在翻译..."}
event: job_donedata: {"status":"completed","stage":"completed","stage_progress":100,"stage_message":""}По завершении задачи получите список результатов с помощью GET /api/v1/artifacts?job_id=....
Python пример
Заголовок раздела «Python пример»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Примечания
Заголовок раздела «Примечания»- Билет действителен один раз; получите новый перед повторным подключением.
- Каждая учётная запись может одновременно поддерживать не более 6 соединений SSE и обменивать не более 30 тикетов в минуту; при превышении этого лимита ответ будет
429, поэтому либо дождитесьRetry-After, либо используйте опрос. - Если в течение длительного времени не поступает никаких событий задач, сервер отправляет событие
timeout; получите новый тикет и повторите подключение. - Пока соединение находится в состоянии простоя, сервер отправляет комментарии heartbeat; клиенты должны игнорировать строки с комментариями.
- Если соединение прерывается, в качестве резервного варианта используется опрос
GET /jobs/{id}.