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}പോളിംഗ് ഒരു ഫാൾബാക്ക് ആയി പ്രവർത്തിക്കും