मुख्य सामग्री पर जाएं

अवलोकन

सभी जनरेशन अनुरोध एक ही मूलभूत लाइफ़साइकिल का पालन करते हैं: Job lifecycle diagram Job lifecycle diagram

जॉब स्टेट्स

queued जॉब प्रोसेस होने के लिए क्यू में प्रतीक्षा कर रहा है backlogged जॉब आपकी वर्तमान कॉन्करेंसी सीमा के पीछे प्रतीक्षा कर रहा है scheduled जॉब स्वीकार किया गया है और प्रोसेसिंग के लिए शेड्यूल किया गया है processing जॉब सक्रिय रूप से किसी वर्कर द्वारा प्रोसेस किया जा रहा है sampling जॉब आउटपुट सैंपल जनरेट कर रहा है intermediate-complete जॉब का एक मध्यवर्ती परिणाम है और यह प्रोसेसिंग जारी रख सकता है completed जॉब सफलतापूर्वक समाप्त हो गया, परिणाम result.urls में उपलब्ध है failed जॉब किसी त्रुटि के कारण विफल हो गया। विवरण शीर्ष-स्तरीय error ऑब्जेक्ट में होता है: code हमेशा मौजूद रहता है और message वैकल्पिक है। मॉडरेशन अस्वीकृति code: "content_policy" का उपयोग करती है। cancelled जॉब उपयोगकर्ता या सिस्टम द्वारा रद्द किया गया

विफलताएँ और रद्दीकरण

जॉब कई कारणों से विफल हो सकते हैं:
  • जनरेशन सर्विस से API त्रुटियाँ
  • अमान्य पैरामीटर या असमर्थित कॉन्फ़िगरेशन
  • कंटेंट मॉडरेशन (NSFW फ़िल्टरिंग)
  • स्वचालित टाइमआउट डिटेक्शन (होस्टेड टूल्स के लिए 3 मिनट, बाहरी प्रदाताओं के लिए 2 घंटे)
error.code, उसके साथ आने वाला संदेश, और आगे क्या करना है, यह सब त्रुटियाँ और डीबगिंग में दिया गया है। जॉब रद्द करने के लिए: /jobs/{id} पर एक DELETE अनुरोध भेजें। नोट: जॉब केवल तभी रद्द किए जा सकते हैं जब उनका स्टेटस queued या processing हो।
महत्वपूर्ण: विफल और रद्द किए गए जॉब्स के लिए शुल्क नहीं लिया जाता। आप केवल पूरे हुए जॉब्स के लिए भुगतान करते हैं।

जॉब स्टेटस की जाँच

/jobs/{id} पर एक GET अनुरोध का उपयोग करके जॉब स्टेटस के लिए पोल करें। अनुशंसित प्रथाएँ:
  • जब तक जॉब पेंडिंग हो (backlogged, queued, scheduled, processing, sampling, या intermediate-complete) हर 2-5 सेकंड में पोल करें
  • लंबे समय तक चलने वाले जॉब्स के लिए एक्सपोनेंशियल बैकऑफ़ का उपयोग करें
  • जब स्टेटस completed, failed, या cancelled हो जाए तो पोलिंग बंद करें
  • कुछ जॉब्स processing के दौरान प्रतिक्रियाओं में प्रीव्यू इमेज शामिल कर सकते हैं
उदाहरण पोलिंग कार्यान्वयन:

अगले चरण

वेबहुक

जॉब्स पूरे होने पर सूचनाएँ प्राप्त करें

रेट लिमिट्स

प्लान टियर के अनुसार API सीमाएँ समझें

त्रुटियाँ और डीबगिंग

HTTP त्रुटियाँ और विफल जॉब्स के त्रुटि कोड

Model APIs

सभी उपलब्ध एंडपॉइंट्स और पैरामीटर्स की खोज करें

API Keys & Billing

अपनी API कुंजियाँ बनाएँ और प्रबंधित करें