API और एकीकरण
दस्तावेज़ित inference API या model-training API, सीमित दायरे वाले क्रेडेंशियल और मौजूदा उपयोग तथा API संदर्भ से एप्लिकेशन जोड़ें।
- API उत्पाद चुनेंInference अनुरोधों और मॉडल-ट्रेनिंग वर्कफ़्लो में अंतर समझें।
- उसका अनुबंध पढ़ेंसंबंधित API दस्तावेज़ और OpenAPI संदर्भ इस्तेमाल करें।
- सीमित दायरे की कुंजी बनाएँग्राहक API कुंजी बनाएँ और सुरक्षित रखें।
- एकीकरण करें और जाँचेंदस्तावेज़ित अनुरोध भेजें और उसका उत्तर देखें।
- निगरानी करें और कुंजी बदलेंउपयोग देखें और ज़रूरत पड़ने पर कुंजियाँ रद्द या बदलें।
सही API वर्कफ़्लो चुनें
Inference API मॉडल inference अनुरोधों के लिए है, जबकि model-training API कोटेशन, जॉब, सेशन और आर्टिफ़ैक्ट वाले अलग ट्रेनिंग वर्कफ़्लो का दस्तावेज़ीकरण करती है। यह न मानें कि inference एंडपॉइंट ट्रेनिंग शुरू करता है या ट्रेनिंग ऑपरेशन inference अनुबंध में उपलब्ध है। इच्छित उत्पाद के दस्तावेज़ पढ़ें और पुष्टि करें कि संबंधित मॉडल या ट्रेनिंग क्षमता सूचीबद्ध है। किसी परिचित तृतीय-पक्ष SDK के आधार पर method नाम निकालने के बजाय प्रकाशित अनुरोध और उत्तर स्वरूप अपनाएँ।
- पहचानें कि एप्लिकेशन को inference चाहिए या मॉडल ट्रेनिंग।
- संबंधित उत्पाद दस्तावेज़ और API संदर्भ खोलें।
- पुष्टि करें कि ज़रूरी क्षमता और मॉडल दस्तावेज़ित हैं।
API कुंजी बनाएँ और सुरक्षित रखें
प्रमाणित API-कुंजी पृष्ठ से ग्राहक API कुंजी बनाएँ और इंटरफ़ेस में scope चुनने का विकल्प हो तो केवल एकीकरण के लिए ज़रूरी scope चुनें। सीक्रेट केवल एक बार दिखता है, इसलिए उसे सीधे स्वीकृत secret manager में रखें। उसे source control में commit न करें, लॉग में न चिपकाएँ और ब्राउज़र कोड में उजागर न करें। जहाँ संभव हो, क्रेडेंशियल पर एप्लिकेशन और वातावरण का नाम लगाएँ। विकास और उत्पादन के लिए अलग क्रेडेंशियल रखें, ताकि एक कुंजी रद्द करने से असंबंधित एकीकरण बाधित न हों।
- प्रमाणित ग्राहक वर्कस्पेस में API keys खोलें।
- सबसे सीमित आवश्यक scope वाली कुंजी बनाएँ।
- सीक्रेट सुरक्षित रखें और source code तथा लॉग से बाहर रखें।
दस्तावेज़ित अनुबंध के अनुसार लागू करें
प्रमाणीकरण, एंडपॉइंट, अनुरोध फ़ील्ड, उत्तर सँभालने और त्रुटियों के लिए संबंधित API मार्गदर्शिका अपनाएँ। सेवा क्रेडेंशियल सार्वजनिक क्लाइंट कोड के बजाय भरोसेमंद सर्वर पर रखें। भेजने से पहले इनपुट सत्यापित करें, असफल उत्तरों को स्पष्ट रूप से सँभालें और Authorization header या संवेदनशील prompt डेटा लॉग न करें। प्रकाशित मशीन-पठनीय अनुबंध चाहिए तो OpenAPI संदर्भ इस्तेमाल करें। जब तक मौजूदा दस्तावेज़ साफ़ तौर पर न बताएँ, असमर्थित streaming, मीडिया या provider-native ऑपरेशन का अनुमान न लगाएँ।
- चुने गए API के लिए बताए गए ऑपरेशन और फ़ील्ड ही लागू करें।
- क्रेडेंशियल सर्वर पर रखें और डायग्नोस्टिक जानकारी से हटाएँ।
- दस्तावेज़ित त्रुटियाँ सँभालें और उपलब्ध होने पर अनुरोध पहचानकर्ता रखें।
उपयोग की निगरानी करें और क्रेडेंशियल प्रबंधित करें
एकीकरण के बाद उपयोग पृष्ठ पर अपने खाते की गतिविधि देखें और उसे एप्लिकेशन रिकॉर्ड से मिलाएँ। ट्रैफ़िक बढ़ाने या अतिरिक्त क्रेडेंशियल बनाने से पहले अप्रत्याशित बदलाव की जाँच करें। कुंजी उजागर हो सकती है तो उसे बदलें, एप्लिकेशन के secret store को अद्यतन करें और पुरानी कुंजी हटाने से पहले एकीकरण सत्यापित करें। जिन कुंजियों की अब ज़रूरत नहीं, उन्हें रद्द करें। उपयोग विवरण परिचालन समीक्षा में मदद करता है, लेकिन भविष्य के शुल्क या क्षमता की गारंटी नहीं है।
- प्लेटफ़ॉर्म उपयोग की तुलना एप्लिकेशन के अनुरोध रिकॉर्ड से करें।
- उजागर क्रेडेंशियल बदलें और नई कुंजी सत्यापित करें।
- अनुपयोगी कुंजियाँ रद्द करें और समय-समय पर पहुँच की समीक्षा करें।
अक्सर पूछे जाने वाले प्रश्न
क्या inference और model training एक ही API हैं?
नहीं। ये अलग उत्पाद हैं और इनके वर्कफ़्लो भी अलग हैं। अपनी ज़रूरत की क्षमता के लिए संबंधित संदर्भ अपनाएँ।
समर्थित API अनुबंध कहाँ मिलेगा?
इस मार्गदर्शिका से जुड़े उत्पाद दस्तावेज़ और OpenAPI संदर्भ देखें। उनमें मौजूदा प्रकाशित इंटरफ़ेस बताया गया है।
API सीक्रेट कहाँ रखना चाहिए?
सर्वर-साइड सुरक्षित secret manager का उपयोग करें। उसे repository में commit न करें, ब्राउज़र कोड में उजागर न करें और लॉग में शामिल न करें।
कुंजी उजागर हो जाए तो क्या करूँ?
API keys पृष्ठ से उसे बदलें या रद्द करें, एप्लिकेशन के secret store में नई कुंजी रखें और हाल के उपयोग में अप्रत्याशित गतिविधि जाँचें।