दस्तावेज़ अनुवाद एपीआई एक्सेस गाइड: वर्ड और पीडीएफ का बैच अनुवाद करने के लिए पायथन का उपयोग करें, और परिणाम प्राप्त करने के लिए वेबहुक का उपयोग करें
वर्ड, पीडीएफ, एक्सेल और अन्य फ़ाइलों का बैच अनुवाद करने के लिए ओमनीडॉक दस्तावेज़ अनुवाद एपीआई का उपयोग करें: अपलोड करने, कार्य बनाने, वेबहुक कॉलबैक और डाउनलोड की पूरी प्रक्रिया, पायथन उदाहरण, पैरामीटर विवरण, इडेम्पोटेंट रिट्री और बिलिंग नियमों के साथ।
दस्तावेज़ अनुवाद एपीआई एक स्वचालित प्रक्रिया में स्ट्रिंग अपलोडिंग, कार्य बनाना, कॉलबैक प्राप्त करना और अनुवाद डाउनलोड करना कर सकता है। आप संपूर्ण अनुवाद केवल चार चरणों में पूरा कर सकते हैं।
यदि आपका सिस्टम हर दिन अनुबंध, निर्देश, कागजात या रिपोर्ट संसाधित करता है, तो मैन्युअल अपलोडिंग, प्रतीक्षा और डाउनलोडिंग जल्दी ही एक बाधा बन जाएगी। केवल इन चरणों को प्रोग्राम को सौंपने से ही बैच प्रोसेसिंग स्थिर हो सकती है।
ओमनीडॉक (झियी) का दस्तावेज़ अनुवाद एपीआई पूरी प्रक्रिया को एक साथ जोड़ता है: फ़ाइलें अपलोड करें, कार्य बनाएं, पूर्णता सूचनाएं प्राप्त करें, और अनुवाद डाउनलोड करें। अनुवाद मूल दस्तावेज़ के लेआउट, तालिकाओं, चित्रों और सूत्रों को बरकरार रखता है, और द्विभाषी तुलना या केवल अनुवाद को आउटपुट कर सकता है।
यह आलेख उन डेवलपर्स के लिए उपयुक्त है जिन्हें दस्तावेज़ अनुवाद को अपने सिस्टम में एकीकृत करने की आवश्यकता है। पढ़ने के बाद, आप पूरी कॉलिंग प्रक्रिया, सामान्य पैरामीटर, इडेम्पोटेंट रिट्री मेथड्स, वेबहुक कॉलबैक और बिलिंग नियमों में महारत हासिल कर पाएंगे और पायथन का उपयोग करके एक पूरा कार्य चलाने में सक्षम होंगे।
दस्तावेज़ अनुवाद एपीआई तक कैसे पहुंचें? एक वाक्य का निष्कर्ष
आप स्वचालित रूप से अपलोड करने, कार्य बनाने, कॉलबैक प्राप्त करने और चार-चरणीय प्रक्रिया में अनुवाद डाउनलोड करने के लिए एपीआई का उपयोग करके दस्तावेज़ अनुवाद को अपने सिस्टम में एकीकृत कर सकते हैं।
तालिका 0 परिदृश्यों और अनुशंसित प्रथाओं तक पहुंच
| आपकी स्थिति | अनुशंसित प्रथाएँ | कारण |
|---|---|---|
| अनुबंधों, विशिष्टताओं, कागजातों या रिपोर्टों को बैच प्रक्रिया करने की आवश्यकता है | चार-चरणीय प्रक्रिया के अनुसार स्वचालित रूप से अपलोड करने, कार्य बनाने और अनुवाद डाउनलोड करने के लिए एपीआई का उपयोग करें | मैन्युअल अपलोडिंग, प्रतीक्षा और डाउनलोडिंग को हटा दें |
| द्विभाषी तुलना की आवश्यकता है | आउटपुट_मोड द्विभाषी (डिफ़ॉल्ट) पर सेट है | पीपीटीएक्स को छोड़कर, अन्य सभी प्रारूप द्विभाषी आउटपुट का समर्थन करते हैं |
| आशा है कि कार्य पूर्ण होते ही त्वरित कार्यवाही की जायेगी | वेबहुक कॉन्फ़िगर करें और गुप्त हस्ताक्षर सत्यापन भरें | कार्य समाप्त होने पर सिस्टम सक्रिय रूप से आपके सर्वर को सूचित करेगा। |
| नेटवर्क अस्थिर है और मैं बार-बार सबमिशन से चिंतित हूं। | कार्य बनाते समय Idempotency-कुंजी लाएँ, और समय समाप्त होने पर पहले स्थिति की जाँच करें। | यदि आपके पास एक ही कुंजी और एक ही अनुरोध है, तो मूल कार्य वापस कर दिया जाएगा और कोई बार-बार कटौती नहीं की जाएगी। |
पहुंचने से पहले बुनियादी जानकारी पढ़ें
एपीआई की बुनियादी परंपराएँ इस प्रकार हैं। कोड लिखना शुरू करने से पहले इन सामग्रियों की पुष्टि करें।
तालिका 1 एपीआई बुनियादी परंपराएँ
| परियोजना | उदाहरण देकर स्पष्ट करना |
|---|---|
| आधार यूआरएल | https://omnidoc.top/api/v1 |
| प्रमाणन | एपीआई कुंजी को एक्स-एपीआई-कुंजी अनुरोध हेडर में रखा गया है और इसे बियरर क्रेडेंशियल के रूप में भी भेजा जा सकता है; एपीआई कंसोल में बनाया गया |
| अनुरोध प्रारूप | JSON, सामग्री-प्रकार: एप्लिकेशन/json |
| ट्रैकिंग का अनुरोध करें | प्रत्येक प्रतिक्रिया की एक्स-अनुरोध-आईडी सहेजें और समर्थन से संपर्क करते समय इसे प्रदान करें |
| वर्तमान सीमित | 429 वापस आने पर पुनः प्रयास करने के लिए पुनः प्रयास करें-आफ्टर दबाएँ |
कौन सी फ़ाइलें समर्थित हैं?
Word (.docx), Excel (.xlsx), PowerPoint (.pptx), PDF, HTML, EPUB, टेक्स्ट के साथ मार्कडाउन, SRT/ASS उपशीर्षक, CSV, PNG/JPG छवियाँ और UniDoc दस्तावेज़ (.udoc) का समर्थन करता है।
पीपीटीएक्स को छोड़कर, अन्य सभी प्रारूप द्विभाषी आउटपुट का समर्थन करते हैं। जब पीपीटीएक्स द्विभाषावाद का अनुरोध करता है, तो केवल अनुवाद लौटाया जाता है। विशिष्ट तुलना विधियों के लिए, नीचे मुख्य तुलना देखें।
चार चरणों में अनुवाद पूरा करें
- अपलोड के लिए आवेदन करें: POST /upload/presign पर कॉल करें, फ़ाइल का नाम और आकार सबमिट करें, और प्रत्यक्ष स्थानांतरण पता प्राप्त करें, हेडर अपलोड करें और अंतिम_टोकन करें।
- अपलोड करें और पुष्टि करें: फ़ाइल डालने के लिए लौटाए गए अपलोड हेडर का उपयोग करें, और अपलोड करते समय एपीआई कुंजी न लाएं। फिर document.id के बदले में POST /upload/finalize पर कॉल करें।
- कार्य बनाएं: POST /jobs पर कॉल करें, document_id और target_lang सबमिट करें, और उसी समय Idempotency-Key लाने की अनुशंसा की जाती है।
- परिणाम प्राप्त करें: पोल प्राप्त करें /जॉब्स/{आईडी}, या एसएसई प्रगति की सदस्यता लें या वेबहुक कॉन्फ़िगर करें। कार्य पूरा होने के बाद, उत्पाद प्राप्त करने और उसे डाउनलोड करने के लिए GET /artifacts?job_id=... का उपयोग करें।
कार्य बनाने के लिए सामान्य पैरामीटर
कोई कार्य बनाते समय, दो सबसे अधिक उपयोग किए जाने वाले फ़ील्ड document_id और target_lang हैं। अन्य फ़ील्ड आवश्यकतानुसार सेट किए गए हैं।
तालिका 2 पोस्ट/नौकरी अनुरोध फ़ील्ड
| मैदान | गलती करना | उदाहरण देकर स्पष्ट करना |
|---|---|---|
| document_id | — | पुष्टिकृत दस्तावेज़ आईडी (आवश्यक) |
| target_lang | — | लक्ष्य भाषा कोड (आवश्यक) |
| source_lang | स्वचालित पहचान | स्रोत भाषा कोड |
| engine | xr-397b | अनुवाद विन्यास: xr-397b, डीपसीक, क्वेन, चैटजीपीटी, जेमिनी, क्लाउड |
| output_mode | bilingual | द्विभाषी द्विभाषी तुलना, केवल एकल अनुवाद |
| glossary_id | — | शब्दावली आईडी, एकीकृत ब्रांड नाम और पेशेवर शब्द |
| include_images | false | दस्तावेज़ में छवि पाठ को संसाधित करना है या नहीं |
| context_translation | false | उन्नत संदर्भ, अधिक सुसंगत शब्दावली |
| style_preset | — | शैली डिफ़ॉल्ट |
पायथन उदाहरण: एक कार्य बनाएं और पूरा होने की प्रतीक्षा करें
नीचे दिया गया स्निपेट केवल अनुरोधों पर निर्भर करता है। संपूर्ण अपलोड और डाउनलोड प्रक्रिया के लिए, कृपया डेवलपर दस्तावेज़ के पायथन पृष्ठ को देखें।
import time, uuid, requests
BASE = "https://omnidoc.top/api/v1"
HEADERS = {"X-API-Key": "sk_your_key"}
def create_job(document_id, target_lang="en", engine="xr-397b"):
r = requests.post(f"{BASE}/jobs",
headers={**HEADERS, "Idempotency-Key": str(uuid.uuid4())},
json={"document_id": document_id, "target_lang": target_lang, "engine": engine},
timeout=30)
r.raise_for_status()
return r.json()
def wait_for_job(job_id):
while True:
job = requests.get(f"{BASE}/jobs/{job_id}", headers=HEADERS, timeout=20).json()
if job["status"] in ("completed", "failed"):
return job
time.sleep(5)
बैचिंग और पुनः प्रयास: समवर्तीता, कतारबद्धता और निष्क्रियता
स्वचालित कतार
प्रत्येक खाता एक साथ 5 फ़ाइलों को संसाधित कर सकता है। ऊपरी सीमा से अधिक कार्य सामान्य रूप से बनाए और कतारबद्ध किए जाते हैं, और स्टेज_मैसेज इंगित करेगा कि आगे कितने कार्य हैं।
निष्क्रिय कुंजियाँ
यदि इडेम्पोटेंसी-कुंजी समान है और अनुरोध निकाय समान है, तो मूल कार्य वापस कर दिया जाएगा और बार-बार बनाया या चार्ज नहीं किया जाएगा। नेटवर्क टाइमआउट का सामना करते समय, पहले कार्य की स्थिति जांचें और नई कुंजी के साथ दोबारा सबमिट न करें।
त्रुटि कोड
- 403: कुंजी के लिए चयनित कॉन्फ़िगरेशन की अनुमति नहीं है।
- 404: दस्तावेज़ीकरण या शब्दावली मौजूद नहीं है।
- 415: प्रारूप समर्थित नहीं है।
- 422: फ़ाइल खाली है या पैरामीटर अमान्य हैं।
वेबहुक: कार्य समाप्त होने पर अपने सर्वर को सूचित करें
प्रत्येक उपयोगकर्ता 3 वेबहुक कॉन्फ़िगर कर सकता है. POST/webhooks के साथ बनाएं, PATCH के साथ अपडेट करें या निष्क्रिय करें।
जब फ़ाइल अनुवाद कार्य समाप्त हो जाता है (सफलता या विफलता की परवाह किए बिना), सिस्टम job.completed ईवेंट भेजता है:
- डेटा.स्टेटस पूर्ण या विफल हो गया है।
- data.char_count अनुवाद वर्णों की संख्या है।
वेबहुक बनाते समय रहस्य भरें, और प्रत्येक आगामी कॉलबैक एक्स-वेबहुक-सिग्नेचर लाएगा। कॉलबैक स्रोत की पुष्टि के लिए मूल अनुरोध पर हस्ताक्षर करने के लिए HMAC-SHA256 का उपयोग करें।
कॉलबैक यूआरएल सार्वजनिक नेटवर्क से पहुंच योग्य होना चाहिए, और HTTPS की अनुशंसा की जाती है।
शुल्क की गणना कैसे करें?
शुरू करने से पहले बैलेंस जांचें
- पीडीएफ: शेष राशि "पृष्ठों की संख्या × 2 अंक" से अधिक होनी चाहिए।
- अन्य प्रारूप: मूल शब्दों की संख्या के आधार पर शुल्क लिया जाता है, कम से कम 2 अंक।
- जब शेष राशि अपर्याप्त होगी, तो कोटा_अधिक हो जाने पर कार्य समाप्त हो जाएगा और कोई शुल्क नहीं काटा जाएगा।
वास्तविक उपयोग के आधार पर कटौती
कार्य पूरा होने के बाद वास्तविक उपयोग के आधार पर शुल्क काटा जाएगा। यदि कार्य विफल हो जाता है या रद्द कर दिया जाता है, तो कोई शुल्क नहीं काटा जाएगा।
निःशुल्क क्वेरी
शेष राशि, कार्य स्थिति, उपयोग, वाउचर और डाउनलोड पते की जांच के लिए अंक नहीं काटे जाएंगे।
पॉइंट पैकेज
पॉइंट पैकेज 3,000 पॉइंट के लिए 9.9 येन से शुरू होते हैं, और खरीदे गए पॉइंट लंबे समय के लिए वैध होते हैं। बिक्री पर पैकेजों के बारे में GET/बिलिंग/क्रेडिट/प्लान के माध्यम से पूछताछ की जा सकती है।
अगला कदम
पूर्ण कर्ल, पायथन, नोड.जेएस उदाहरण डेवलपर दस्तावेज़ में देखे जा सकते हैं: https://docs.omnidoc.top/guide/quickstart/।
यदि आप फिलहाल कोड नहीं लिखना चाहते हैं, तो आप मूल फ़ाइलों का सीधे अनुवाद करने के लिए ओमनीडॉक के एआई सहायक से भी जुड़ सकते हैं। विवरण के लिए, "एआई को सीधे वर्ड, एक्सेल और पीपीटी संचालित करने दें" देखें: https://omnidoc.top/blog/ai-word-excel-ppt-omnidoc/।
📊 कोर तुलना
विभिन्न फ़ाइल स्वरूपों में अलग-अलग द्विभाषी आउटपुट विधियाँ होती हैं। आप अपने फ़ाइल प्रकार के अनुसार पहले से योजना बना सकते हैं.
| फ़ाइल प्रकार | द्विभाषी तुलना विधि | क्या द्विभाषी का समर्थन करना है |
|---|---|---|
| Word | अनुच्छेद द्वारा तुलना करें | हाँ |
| Excel | कॉलम द्वारा तुलना करें | हाँ |
| पृष्ठ के अनुसार तुलना करें | हाँ | |
| उपशीर्षक (एसआरटी/एएसएस) | पंक्ति से तुलना करें | हाँ |
| PPTX | केवल अनुवाद पर लौटें | नहीं |
🎯कौन सा तरीका आपके लिए उपयुक्त है?
यदि आपको अनुबंधों, विशिष्टताओं या कागजातों को बैचने की आवश्यकता है
सिस्टम से कनेक्ट करने और स्वचालित रूप से अपलोड करने, कार्य बनाने और चार-चरणीय प्रक्रिया के अनुसार अनुवाद डाउनलोड करने के लिए एपीआई का उपयोग करें, मैन्युअल संचालन को समाप्त करें।
यदि आपका नेटवर्क अक्सर अस्थिर रहता है
कार्य बनाते समय Idempotency-कुंजी लाएँ। बार-बार निर्माण या बार-बार कटौती से बचने के लिए टाइमआउट के बाद सबसे पहले स्थिति के बारे में पूछें।
यदि आप कार्य समाप्त होने के तुरंत बाद उसे प्रोसेस करना चाहते हैं
वेबहुक कॉन्फ़िगर करें और हस्ताक्षर सत्यापन के लिए रहस्य भरें। कार्य पूरा होने पर सिस्टम सक्रिय रूप से आपके सर्वर को सूचित करेगा।
यदि आपके पास पेशेवर शब्दावली के लिए एकीकृत आवश्यकताएं हैं
पहले एक शब्दावली बनाएं, और फिर ब्रांड नामों और पेशेवर शब्दों के अनुवाद को एकीकृत करने के लिए कार्य बनाते समय शब्दावली_आईडी दर्ज करें।
❓ अक्सर पूछे जाने वाले प्रश्न (FAQ)
1. क्या एक ही कार्य को बार-बार सबमिट करने पर बार-बार कटौती होगी?
यदि इडेम्पोटेंसी-कुंजी समान है और अनुरोध निकाय समान है, तो मूल कार्य बार-बार निर्माण या कटौती के बिना वापस कर दिया जाएगा।
2. यदि कार्य विफल हो जाता है या रद्द कर दिया जाता है, तो क्या अंक काटे जाएंगे?
कोई शुल्क नहीं लिया जाएगा. जब कोई कार्य विफल हो जाता है या रद्द कर दिया जाता है, तो कोई कटौती नहीं की जाएगी।
3. अपर्याप्त अंक होने पर क्या होता है?
कोटा_अधिक हो जाने पर कार्य समाप्त हो जाएगा और कोई शुल्क नहीं काटा जाएगा। शुरू करने से पहले शेष राशि सीमा है: पीडीएफ को "पृष्ठों की संख्या × 2 अंक" से अधिक संतुलन की आवश्यकता होती है, और अन्य प्रारूपों को शब्द गणना के आधार पर कम से कम 2 अंक के संतुलन की आवश्यकता होती है।
4. क्या फ़ाइलें अपलोड करते समय मुझे एपीआई कुंजी लानी होगी?
अनावश्यक. अपलोड हेडर PUT फ़ाइल का उपयोग करते समय, API कुंजी न लाएँ।
5. यदि मुझे 429 ट्रैफ़िक सीमा का सामना करना पड़े तो मुझे क्या करना चाहिए?
प्रतिक्रिया में पुनः प्रयास-आफ्टर समय के अनुसार पुनः प्रयास करें।
📝सारांश
अपलोड, कार्य निर्माण, कॉलबैक और डाउनलोड को एक स्वचालित प्रक्रिया में जोड़कर, दस्तावेज़ अनुवाद को दैनिक व्यवसाय में एकीकृत किया जा सकता है। पायथन उदाहरण के साथ किसी कार्य को पूरा करके प्रारंभ करें, फिर आवश्यकतानुसार शब्दावली, द्विभाषी आउटपुट और वेबहुक जोड़ें।
इसे अभी आज़माएं: मूल लेआउट को बरकरार रखते हुए अनुवाद शुरू करने के लिए दस्तावेज़ अपलोड करें


