Pular para o conteúdo

Progresso em tempo real com SSE

Receba o andamento dos trabalhos de tradução de arquivos (/jobs) em tempo real por meio de SSE (Server-Sent Events). Quando SSE não estiver disponível, a conexão retorna 404; consulte o status do trabalho em vez disso.

O EventSource do navegador não pode enviar cabeçalhos personalizados, portanto as credenciais exigem duas etapas:

  1. Seu servidor troca a chave da API por um ticket (válido por 30 segundos, utilizável uma única vez)
  2. Conecte-se ao SSE com o ticket (isso pode ocorrer no navegador; o ticket não é uma credencial de longa duração)
POST /api/v1/sse/ticket/{job_id} → {"ticket": "..."}
GET /api/v1/sse/jobs/{job_id}?ticket=...

Mantenha a chave API no servidor: o servidor obtém o ticket e o entrega ao navegador.

// 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();
});
EventoDescrição
job_updateStatus ou etapa alterado (uma captura do estado atual é enviada logo após a conexão)
job_doneA tarefa terminou (completed ou failed); você pode fechar a conexão
timeoutO fluxo atingiu sua duração máxima; reconectar
errorProblema no servidor; obtenha um novo ticket e reconecte-se mais tarde

O stage_message do servidor está em chinês:

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

Quando o trabalho for concluído, obtenha a lista de resultados com 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
  • Um ticket funciona uma única vez; obtenha um novo antes de reconectar
  • Cada conta pode manter no máximo 6 conexões SSE abertas por vez e trocar no máximo 30 tickets por minuto; além disso, a resposta é 429, portanto aguarde Retry-After ou faça uma consulta em seu lugar.
  • Quando não há eventos de trabalho por um longo período, o servidor envia um evento timeout; obtenha um novo ticket e reconecte-se.
  • Enquanto a conexão estiver ociosa, o servidor envia comentários de heartbeat; os clientes devem ignorar as linhas de comentário.
  • Se a conexão for interrompida, o polling GET /jobs/{id} funciona como alternativa.