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}పోలింగ్ బ్యాకప్గా పనిచేస్తుంది.