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}ಪೋಲಿಂಗ್ ಬ್ಯಾಕ್ಅಪ್ ಆಗಿ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ