Developer Knowledge API

झलक देखें

इस प्रॉडक्ट पर, "Pre-GA के तहत आने वाले प्रॉडक्ट और सुविधाओं से जुड़ी शर्तें" लागू होती हैं. ये शर्तें, सेवा की खास शर्तें पेज पर 'सेवा की सामान्य शर्तें' सेक्शन में दी गई हैं. Pre-GA के तहत आने वाले प्रॉडक्ट, "जैसी हैं वैसी" ही उपलब्ध कराए जाते हैं. ऐसा हो सकता है कि इनके लिए आपको सीमित सहायता ही मिले. ज़्यादा जानकारी के लिए, लॉन्च के चरणों की जानकारी देखें.

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

खास जानकारी

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

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

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

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

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

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

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

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

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

पुष्टि करना

Developer Knowledge API का इस्तेमाल करने के लिए, Developer Knowledge API पासकोड की ज़रूरत होती है. कोई नया खाता बनाने के लिए:

1. जिस प्रोजेक्ट के लिए आपने एपीआई चालू किया है उसके Google Cloud Console में, क्रेडेंशियल पेज पर जाएं.
2. क्रेडेंशियल बनाएं पर क्लिक करें. इसके बाद, मेन्यू से एपीआई पासकोड चुनें. एपीआई कुंजी बनाए गए डायलॉग में, नई कुंजी के लिए स्ट्रिंग दिखती है.
3. एपीआई पासकोड में बदलाव करें पर क्लिक करें.
4. नाम फ़ील्ड में, कुंजी का नाम डालें.
5. एपीआई से जुड़ी पाबंदियां में जाकर, कुंजी को सीमित करें को चुनें.
6. एपीआई चुनें सूची में जाकर, Developer Knowledge API को चालू करें. इसके बाद, ठीक है पर क्लिक करें.
   • ध्यान दें: अगर आपने अभी-अभी Developer Knowledge API चालू किया है, तो हो सकता है कि यह एपीआई चुनें सूची में दिखने में कुछ समय लगे.
7. सेव करें पर क्लिक करें.

अपने अनुरोधों में, इस Developer Knowledge API पासकोड को शामिल करें. उदाहरण के लिए, REST कॉल में key क्वेरी पैरामीटर का इस्तेमाल करके इसे शामिल किया जाना चाहिए. उदाहरण के लिए, क्विकस्टार्ट गाइड देखें.

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

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

सीमाएं

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