SSE உடன் நிகழ்நேர முன்னேற்றம்
SSE (Server-Sent Events) மூலம், /jobs கோப்பு மொழிபெயர்ப்புப் பணிகளின் நிலையை நிகழ்நேரத்தில் பெறுக. 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}சரிபார்ப்பு ஒரு மாற்று வழியாகச் செயல்படுகிறது.