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- एकदा तिकीट कार्यरत होते; पुन्हा कनेक्ट करण्यापूर्वी नवीन तिकीट मिळवा
- प्रत्येक खाते एका वेळी जास्तीत जास्त 6 SSE कनेक्शन उघडे ठेवू शकते आणि प्रति मिनिट जास्तीत जास्त 30 तिकीटे देवू शकते; त्यापुढे प्रतिसाद
429असतो, त्यामुळेRetry-Afterसाठी प्रतीक्षा करा किंवा त्याऐवजी पोल करा - जेव्हा बराच काळ कोणतेही जॉब इव्हेंट नसते, तेव्हा सर्व्हर
timeoutइव्हेंट पाठवतो; नवीन तिकीट मिळवा आणि पुन्हा कनेक्ट करा - कनेक्शन निष्क्रिय असताना सर्व्हर हार्टबीट कॉमेंट पाठवतो; क्लायंट्सने कॉमेंट लाइन्स दुर्लक्षित कराव्यात.
- जर कनेक्शन तुटले, तर पोलिंग
GET /jobs/{id}फॉलबॅक म्हणून कार्य करते.