Developer Knowledge API

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

खास जानकारी देने वाला बटन

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

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

तुरंत शुरू करने के लिए, क्विकस्टार्ट गाइड देखें.

खोजे जा सकने वाले कॉन्टेंट का कॉर्पस, कॉर्पस रेफ़रंस में दिया गया है.

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

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

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 अनुरोधों की पुष्टि करें. उदाहरण के लिए, REST API के लिए क्विकस्टार्ट गाइड देखें.
• ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी), OAuth 2.0 या सेवा खाते: आधिकारिक क्लाइंट लाइब्रेरी या प्रोडक्शन वर्कफ़्लो का इस्तेमाल करते समय, अनुरोधों की पुष्टि करें. क्रेडेंशियल सेट अप करने के बारे में ज़्यादा जानने के लिए, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल का दस्तावेज़ पढ़ें.

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

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

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

सीमाएं

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