इस गाइड में, Developer Knowledge API का इस्तेमाल शुरू करने का तरीका बताया गया है. आपको डेवलपर नॉलेज एपीआई चालू करने, एपीआई पासकोड पाने, और डेवलपर दस्तावेज़ खोजने और उसे वापस पाने के लिए, एपीआई कॉल करने का तरीका बताया जाएगा.
शुरू करने से पहले
एपीआई चालू करना
- Google APIs लाइब्रेरी में, Developer Knowledge API पेज खोलें.
- देख लें कि आपने वह सही प्रोजेक्ट चुना हो जिसमें आपको एपीआई का इस्तेमाल करना है.
- चालू करें पर क्लिक करें. एपीआई को चालू करने या इस्तेमाल करने के लिए, IAM की किसी खास भूमिका की ज़रूरत नहीं होती.
एपीआई पासकोड बनाना और उसे सुरक्षित करना
- जिस प्रोजेक्ट के लिए आपने एपीआई चालू किया है उसके Google Cloud Console में, क्रेडेंशियल पेज पर जाएं.
- क्रेडेंशियल बनाएं पर क्लिक करें. इसके बाद, मेन्यू से एपीआई पासकोड चुनें.
- नाम फ़ील्ड में, कुंजी का नाम डालें.
-
एपीआई के इस्तेमाल से जुड़ी पाबंदियां चुनें ड्रॉप-डाउन पर क्लिक करें. इसके बाद, Developer Knowledge API टाइप करें. नतीजे पर क्लिक करें. इसके बाद, ठीक है पर क्लिक करें.
- ध्यान दें: अगर आपने अभी-अभी Developer Knowledge API चालू किया है, तो हो सकता है कि यह सूची में दिखने में कुछ समय ले. कुछ मिनट बाद फिर से कोशिश करें.
- बनाएं पर क्लिक करें.
दस्तावेज़ के हिस्सों को खोजना
Developer Knowledge API की कुंजी मिलने के बाद, एपीआई का इस्तेमाल शुरू किया जा सकता है. यहां दिए गए उदाहरण में, "BigQuery" से जुड़े दस्तावेज़ के हिस्सों को खोजने का तरीका बताया गया है:
अपने Developer Knowledge API पासकोड को एनवायरमेंट वैरिएबल में सेव करें:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"YOUR_API_KEYको जनरेट की गई एपीआई कुंजी से बदलें.searchDocumentChunksएंडपॉइंट को कॉल करने के लिए,curlका इस्तेमाल करें:curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
इस कमांड से, क्वेरी से मेल खाने वाले दस्तावेज़ों के हिस्सों की सूची मिलती है. इसमें कॉन्टेंट के स्निपेट और हर दस्तावेज़ के लिए parent शामिल होता है.
दस्तावेज़ वापस पाना
searchDocumentChunks से मिले जवाब में, दस्तावेज़ के हिस्सों की सूची होती है.
हर दस्तावेज़ के हिस्से में एक parent फ़ील्ड होता है. इसका इस्तेमाल करके, GetDocument की मदद से दस्तावेज़ का पूरा कॉन्टेंट वापस पाया जा सकता है.
searchDocumentChunks कॉल से मिले दस्तावेज़ के किसी एक हिस्से का parent कॉपी करें. उदाहरण के लिए, documents/developers.google.com/.... इसे एनवायरमेंट वैरिएबल में सेव करें. इसके बाद, GetDocument एंडपॉइंट को कॉल करने के लिए curl का इस्तेमाल करें:
export DOC_NAME="DOCUMENT_NAME"
curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"
यह फ़ंक्शन, चुने गए दस्तावेज़ का पूरा मार्कडाउन कॉन्टेंट दिखाता है.
आगे क्या करना है
- शामिल किए गए दस्तावेज़ों की पूरी सूची देखने के लिए, कॉर्पस रेफ़रंस देखें.
- एपीआई के तरीकों और पैरामीटर के बारे में ज़्यादा जानकारी के लिए, एपीआई के रेफ़रंस के लिए दस्तावेज़ देखें.