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

अहम जानकारी: अगर कोडिंग में मदद करने वाले एआई असिस्टेंट का इस्तेमाल किया जा रहा है, तो npx skills add google/skills --skill retrieving-developer-knowledge को चलाकर, 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 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 अनुरोधों या डेवलपर नॉलेज एमसीपी सर्वर की पुष्टि करें.
• ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी), OAuth 2.0 या सेवा खाते: आधिकारिक क्लाइंट लाइब्रेरी या प्रोडक्शन वर्कफ़्लो का इस्तेमाल करते समय, अनुरोधों की पुष्टि करें. क्रेडेंशियल सेट अप करने के बारे में ज़्यादा जानने के लिए, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल से जुड़ा दस्तावेज़ देखें.
• उपयोगकर्ता के क्रेडेंशियल (gcloud सीएलआई): सीएलआई के अनुरोधों की पुष्टि करने के लिए, gcloud auth login का इस्तेमाल करके अपने Google Cloud खाते में साइन इन करें. सेटअप करने के निर्देशों के लिए, gcloud सीएलआई क्विकस्टार्ट देखें.

OAuth के दायरे

OAuth 2.0 या सेवा खातों से पुष्टि करते समय, Developer Knowledge API और Developer Knowledge MCP सर्वर, OAuth के इन स्कोप को स्वीकार करते हैं:

• https://www.googleapis.com/auth/cloud-platform: ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी), gcloud सीएलआई, और Google Cloud की आधिकारिक क्लाइंट लाइब्रेरी के लिए इस्तेमाल किया जाने वाला डिफ़ॉल्ट स्कोप.
• https://www.googleapis.com/auth/devprofiles.full_control: इस स्कोप का इस्तेमाल, उपयोगकर्ता की सहमति वाले OAuth 2.0 फ़्लो और एमसीपी सर्वर इंटिग्रेशन के लिए किया जाता है.
• https://www.googleapis.com/auth/developerprofiles.readonly: सेवा खातों और क्रेडेंशियल के लिए, सिर्फ़ पढ़ने के स्कोप का इस्तेमाल किया जा सकता है. इसके लिए, एंड-यूज़र को OAuth की सहमति वाली स्क्रीन पर सहमति देने की ज़रूरत नहीं होती.

धारक टोकन की अनुमति

किसी सेवा खाते या OAuth 2.0 ऐक्सेस टोकन की मदद से, सीधे तौर पर किए गए REST अनुरोधों की पुष्टि करने के लिए, टोकन को Authorization: Bearer हेडर में पास करें. साथ ही, X-Goog-User-Project में अपना बिलिंग प्रोजेक्ट तय करें:

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

PROJECT_ID को अपने Google Cloud प्रोजेक्ट आईडी से बदलें.

Python, Node.js, Go, और Java ऐप्लिकेशन के लिए, आधिकारिक क्लाइंट लाइब्रेरी, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी) और टोकन रीफ़्रेश को अपने-आप मैनेज करती हैं. उदाहरण के लिए, Developer Knowledge API के साथ क्लाइंट लाइब्रेरी का इस्तेमाल करना लेख पढ़ें.

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

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

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

सीमाएं

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