क्विकस्टार्ट: Developer Knowledge API का इस्तेमाल शुरू करना

इस गाइड में, Developer Knowledge API का इस्तेमाल शुरू करने का तरीका बताया गया है. आपको डेवलपर नॉलेज एपीआई चालू करने, एपीआई पासकोड पाने, और डेवलपर दस्तावेज़ खोजने और उसे वापस पाने के लिए, एपीआई कॉल करने का तरीका बताया जाएगा.

शुरू करने से पहले

Developer Knowledge API का इस्तेमाल शुरू करने से पहले, पक्का करें कि आपने यहां दिए गए चरण पूरे कर लिए हों.

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

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

एपीआई पासकोड बनाना और उसे सुरक्षित करना

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

भरोसेमंद स्रोतों से मिली जानकारी के आधार पर जवाब जनरेट करके किसी क्वेरी का जवाब देना

Developer Knowledge API की कुंजी मिलने के बाद, एपीआई का इस्तेमाल शुरू किया जा सकता है. यहां दिए गए उदाहरण में, क्वेरी पूछने और दस्तावेज़ के आधार पर जवाब पाने का तरीका बताया गया है:

1. अपने Developer Knowledge API पासकोड को एनवायरमेंट वैरिएबल में सेव करें:

   export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
   

   YOUR_API_KEY को जनरेट की गई एपीआई कुंजी से बदलें.

2. AnswerQuery एंडपॉइंट को कॉल करने के लिए, curl का इस्तेमाल करें:

   curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"query": "How do I create a BigQuery dataset?"}'
   

यह कमांड, दस्तावेज़ के आधार पर आपकी क्वेरी का जवाब देती है.

दस्तावेज़ के हिस्सों को खोजना

अगर आपको जनरेट किए गए जवाब के बजाय, दस्तावेज़ के कुछ खास स्निपेट ढूंढने हैं, तो सीधे तौर पर दस्तावेज़ के चंक खोजे जा सकते हैं.

SearchDocumentChunks एंडपॉइंट को कॉल करने के लिए, curl का इस्तेमाल करें:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

जवाब में, दस्तावेज़ों से लिए गए कॉन्टेंट के मिलते-जुलते हिस्से और पैरंट दस्तावेज़ों के रेफ़रंस शामिल होते हैं.

दस्तावेज़ वापस पाना

searchDocumentChunks से मिले जवाब में, दस्तावेज़ के हिस्सों की सूची होती है. हर दस्तावेज़ के हिस्से में एक parent फ़ील्ड होता है. इसमें दस्तावेज़ का संसाधन नाम होता है. इसका इस्तेमाल GetDocument के साथ करके, दस्तावेज़ का पूरा कॉन्टेंट वापस पाया जा सकता है.

किसी दस्तावेज़ को वापस पाने के लिए, searchDocumentChunks से मिले किसी एक चंक से parent फ़ील्ड को कॉपी करें और उसे एनवायरमेंट वैरिएबल में सेव करें. इसके बाद, GetDocument एंडपॉइंट को कॉल करने के लिए curl का इस्तेमाल करें:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

यह फ़ंक्शन, चुने गए दस्तावेज़ का पूरा मार्कडाउन कॉन्टेंट दिखाता है.

आगे क्या करना है

• शामिल किए गए दस्तावेज़ों की पूरी सूची देखने के लिए, कॉर्पस रेफ़रंस देखें.
• एपीआई के तरीकों और पैरामीटर के बारे में ज़्यादा जानकारी के लिए, एपीआई के रेफ़रंस के लिए दस्तावेज़ देखें.