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

इस गाइड में, 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 चालू किया है, तो हो सकता है कि यह सूची में दिखने में थोड़ा समय ले कुछ मिनट बाद दोबारा कोशिश करें.
    • अगर आपको एआई क्लाइंट के सामान्य मॉडल कॉल के लिए, इसी पासकोड का इस्तेमाल करना है (उदाहरण के लिए, GEMINI_API_KEY), तो आपको Generative Language 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/v1: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"

इससे, तय किए गए दस्तावेज़ का पूरा Markdown कॉन्टेंट मिलता है.

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