Developer Knowledge API

Developer Knowledge API, Google के सार्वजनिक डेवलपर दस्तावेज़ों को प्रोग्राम के हिसाब से ऐक्सेस करने की सुविधा देता है. इससे आपको इस नॉलेज बेस को अपने ऐप्लिकेशन और वर्कफ़्लो में इंटिग्रेट करने में मदद मिलती है.

खास जानकारी

Developer Knowledge API को, Google के डेवलपर दस्तावेज़ों को मशीन से पढ़े जा सकने वाले फ़ॉर्मैट में ऐक्सेस करने के लिए, कैननिकल सोर्स के तौर पर डिज़ाइन किया गया है. यह दस्तावेज़ों को खोजने और उन्हें वापस पाने के साथ-साथ, सवालों के जवाब देने के लिए फ़ंक्शन उपलब्ध कराता है:

• SearchDocumentChunks का इस्तेमाल करके, किसी क्वेरी के आधार पर काम के पेज यूआरआई और कॉन्टेंट स्निपेट ढूंढें.
• GetDocument या BatchGetDocuments पर क्लिक करके, खोज के नतीजों का पूरा कॉन्टेंट पाएं.
• AnswerQuery का इस्तेमाल, दस्तावेज़ों के कॉर्पस से ली गई क्वेरी के जवाब जनरेट करने के लिए किया जाता है.

Developer Knowledge API की मदद से, दस्तावेज़ के पेजों को खोजा और वापस पाया जा सकता है. ये पेज, बिना स्ट्रक्चर वाले मार्कडाउन कॉन्टेंट के तौर पर होते हैं. खोजे जा सकने वाले कॉन्टेंट का कॉर्पस, कॉर्पस रेफ़रंस में दिया गया है.

डेवलपर के ज्ञान का इस्तेमाल करने के तरीके

अपने वर्कफ़्लो के हिसाब से, इन प्लैटफ़ॉर्म पर जाकर डेवलपर नॉलेज को ऐक्सेस किया जा सकता है:

• REST API और RPC API: सीधे तौर पर एचटीटीपी या gRPC एंडपॉइंट को कॉल करें. तरीके की खास जानकारी के लिए, REST का रेफ़रंस और RPC का रेफ़रंस देखें.
• क्लाइंट लाइब्रेरी: Python, Node.js, TypeScript, Go, Java, PHP, और Ruby के लिए आधिकारिक क्लाइंट लाइब्रेरी का इस्तेमाल करके, Developer Knowledge API को अपने ऐप्लिकेशन में इंटिग्रेट करें.
• Google Cloud CLI (gcloud): दस्तावेज़ के चंक खोजने, Markdown कॉन्टेंट फ़ेच करने, और जवाब जनरेट करने के लिए, अपने टर्मिनल से gcloud developer-knowledge कमांड चलाएं.
• डेवलपर नॉलेज एमसीपी सर्वर: मॉडल कॉन्टेक्स्ट प्रोटोकॉल (एमसीपी) टूल (search_documents, get_documents, और answer_query) का इस्तेमाल करके, अपने एआई कोडिंग असिस्टेंट या एजेंट को Google के दस्तावेज़ से कनेक्ट करें. एमसीपी रेफ़रंस देखें.

अहम जानकारी: अगर एआई कोडिंग असिस्टेंट का इस्तेमाल किया जा रहा है, तो retrieving-developer-knowledge एजेंट स्किल इंस्टॉल करें. इसके लिए, npx skills add google/skills --skill retrieving-developer-knowledge चलाएं. इस स्किल की मदद से, आपके असिस्टेंट को पहले से मौजूद निर्देश मिलते हैं. इन निर्देशों में यह जानकारी शामिल होती है कि Developer Knowledge MCP सर्वर टूल को कैसे चुनना है, गड़बड़ियों को कैसे ठीक करना है, और अगर एमसीपी सर्वर उपलब्ध नहीं है, तो curl के साथ REST API को कैसे कॉल करना है. ज़्यादा जानने के लिए, डेवलपर नॉलेज एजेंट की स्किल का इस्तेमाल करना लेख पढ़ें.

एपीआई और एमसीपी सर्वर में से कोई एक चुनें

Developer Knowledge API और Developer Knowledge MCP सर्वर को इंटिग्रेशन की अलग-अलग ज़रूरतों के लिए डिज़ाइन किया गया है:

• इन स्थितियों में, Developer Knowledge API, क्लाइंट लाइब्रेरी या gcloud सीएलआई का इस्तेमाल करें:
  • आपके प्रोजेक्ट में एआई एजेंट का इस्तेमाल नहीं किया जाता.
  • आपको अपने एजेंट के लिए कस्टम टूल या टूल सेट तय करने हैं.
  • आपको नतीजों को प्रोसेस करना है या उन्हें किसी मॉडल में पास करने से पहले जोड़ना है. उदाहरण के लिए, पूरा कॉन्टेंट फ़ेच करने से पहले, दस्तावेज़ की बाइट लेंथ की जांच करना.
  • आपको खोज के नतीजों को फ़िल्टर करना होगा. जैसे, data_source या update_time के हिसाब से. इसके अलावा, फ़ील्ड मास्क लागू किए जा सकते हैं.
• डेवलपर नॉलेज एमसीपी सर्वर और एजेंट स्किल का इस्तेमाल तब करें, जब:
  • आपको कस्टम टूल की परिभाषाएं और ब्यौरे लिखे बिना, एआई कोडिंग असिस्टेंट या एजेंट को कनेक्ट करना हो.
  • आपको अपने-आप अपडेट होने की सुविधा चाहिए, क्योंकि Developer Knowledge MCP सर्वर नई सुविधाएं जोड़ता है.
  • आपको खोज के नतीजों पर कस्टम मेटाडेटा फ़िल्टर करने की ज़रूरत नहीं है.

एपीआई चालू करना

Developer Knowledge API का इस्तेमाल करने के लिए, आपको इसे सबसे पहले अपने Google Cloud प्रोजेक्ट के लिए चालू करना होगा.

अहम जानकारी: अगर आपके पास Google Cloud प्रोजेक्ट नहीं है, तो Google Cloud या Firebase के निर्देशों का इस्तेमाल करके एक प्रोजेक्ट बनाएं.

1. Google APIs लाइब्रेरी में, Developer Knowledge API पेज खोलें.
2. देख लें कि आपने वह सही प्रोजेक्ट चुना हो जिसमें आपको एपीआई का इस्तेमाल करना है.
3. चालू करें पर क्लिक करें. एपीआई को चालू करने या इस्तेमाल करने के लिए, IAM की किसी खास भूमिका की ज़रूरत नहीं होती.

पुष्टि करना

Developer Knowledge API से किए गए अनुरोधों की पुष्टि करने के लिए, इनमें से किसी एक तरीके का इस्तेमाल किया जा सकता है:

• एपीआई पासकोड: key क्वेरी पैरामीटर या X-Goog-Api-Key हेडर का इस्तेमाल करके, सीधे REST अनुरोधों या Developer Knowledge MCP सर्वर की पुष्टि करें.
• ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी), OAuth 2.0 या सेवा खाते: आधिकारिक क्लाइंट लाइब्रेरी या प्रोडक्शन वर्कफ़्लो का इस्तेमाल करते समय, अनुरोधों की पुष्टि करें. क्रेडेंशियल सेट अप करने के बारे में ज़्यादा जानने के लिए, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल का दस्तावेज़ पढ़ें.
• उपयोगकर्ता के क्रेडेंशियल (gcloud सीएलआई): gcloud auth login की मदद से, अपने Google Cloud खाते में साइन इन करके, सीएलआई के अनुरोधों की पुष्टि करें. सेटअप करने के निर्देशों के लिए, gcloud सीएलआई क्विकस्टार्ट देखें.

शामिल किए गए दस्तावेज़

एपीआई किन दस्तावेज़ों को खोजता है, इस बारे में जानने के लिए कॉर्पस रेफ़रंस देखें.

Developer Knowledge API का मकसद, Google डेवलपर के नए दस्तावेज़ों का ऐक्सेस देना है. हमारा मकसद, पब्लिश होने के 48 घंटों के अंदर कॉन्टेंट को फिर से इंडेक्स करना है. इससे नया या अपडेट किया गया दस्तावेज़ दो कामकाजी दिनों में उपलब्ध हो जाता है.

सीमाएं

• मार्कडाउन की क्वालिटी: मार्कडाउन, सोर्स एचटीएमएल से जनरेट होता है. ऐसा हो सकता है कि फ़ॉर्मैटिंग में कुछ गड़बड़ियां हों या फ़ॉर्मैटिंग से जुड़ी समस्याएं हों.
• कॉन्टेंट का दायरा: इसमें सिर्फ़ कॉर्पस के रेफ़रंस के सार्वजनिक पेज शामिल होते हैं. इसमें GitHub, ओएसएस साइटों, ब्लॉग या YouTube जैसे अन्य सोर्स का कॉन्टेंट शामिल नहीं है.