Прогрес у реальному часі за допомогою SSE
Отримуйте інформацію про хід завдань перекладу файлів (/jobs) в режимі реального часу через SSE (Server-Sent Events). Якщо SSE недоступний, з’єднання повертає 404; замість цього перевіряйте статус завдання.
Потік з’єднання
Section titled “Потік з’єднання”Браузер EventSource не може надсилати спеціальні заголовки, тому облікові дані передаються у два етапи:
- Ваш сервер обмінює API-ключ на квиток (дійсний 30 секунд, використовується один раз)
- Підключіться до SSE за допомогою квитка (це може статися в браузері; квиток не є довготривалим обліковим даним)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}GET /api/v1/sse/jobs/{job_id}?ticket=...JavaScript приклад
Section titled “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();});Типи подій
Section titled “Типи подій”| Подія | Опис |
|---|---|
job_update | Статус або етап змінився (снапшот поточного стану надсилається одразу після підключення) |
job_done | Завдання завершено (completed або failed); можна закрити з’єднання |
timeout | Потік досяг максимальної тривалості; переподключитися |
error | Проблема на сервері; отримайте новий токен і підключіться знову пізніше |
Дані події
Section titled “Дані події”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 приклад
Section titled “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Примітки
Section titled “Примітки”- Квиток діє один раз; отримайте новий перед повторним підключенням
- Кожен обліковий запис може одночасно підтримувати не більше 6 з’єднань SSE і обмінювати не більше 30 квитків на хвилину; у протилежному випадку отримується помилка
429, тому зачекайте наRetry-Afterабо використайте опитування. - Коли протягом тривалого часу відсутні події завдань, сервер надсилає подію
timeout; отримайте новий токен і переподключіться. - Поки з’єднання знаходиться в режимі очікування, сервер надсилає коментарі пульсації; клієнти мають ігнорувати рядки коментарів.
- Якщо з’єднання втрачається, опитування
GET /jobs/{id}виконується як резервний механізм.