क्विकस्टार्ट: Developer Knowledge API के साथ gcloud सीएलआई का इस्तेमाल करना

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

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

gcloud CLI के साथ Developer Knowledge API का इस्तेमाल शुरू करने से पहले, यह तरीका अपनाएं.

gcloud सीएलआई को इंस्टॉल और कॉन्फ़िगर करना

gcloud सीएलआई को इंस्टॉल और कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं:

  1. अगर आपने gcloud सीएलआई इंस्टॉल नहीं किया है, तो gcloud सीएलआई इंस्टॉल करें.

  2. gcloud components update कमांड चलाकर पक्का करें कि आपके पास नया वर्शन है:

    gcloud components update

  3. gcloud auth login कमांड चलाकर, अपने Google Cloud खाते में साइन इन करें:

    gcloud auth login

  4. gcloud config set कमांड चलाकर, अपना ऐक्टिव Google Cloud प्रोजेक्ट सेट करें:

    gcloud config set project PROJECT_ID

    PROJECT_ID की जगह, अपने Google Cloud प्रोजेक्ट का आईडी डालें.

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

Developer Knowledge API चालू करने के लिए, यह तरीका अपनाएं:

  1. अपने Google Cloud प्रोजेक्ट में Developer Knowledge API चालू करने के लिए, gcloud services enable कमांड चलाएं:

    gcloud services enable developerknowledge.googleapis.com

    एपीआई को चालू करने या उसका इस्तेमाल करने के लिए, आपको पहचान और ऐक्सेस मैनेजमेंट (आईएएम) की खास भूमिकाओं की ज़रूरत नहीं होती.

  2. gcloud services list निर्देश चलाकर, पुष्टि करें कि आपके प्रोजेक्ट के लिए एपीआई चालू है:

    gcloud services list --enabled \
    --filter="name:developerknowledge.googleapis.com"

    आउटपुट में एपीआई का नाम और टाइटल दिखता है:

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

दस्तावेज़ से जवाब जनरेट करना

gcloud developer-knowledge answer-query कमांड की मदद से, Google के प्रॉडक्ट के बारे में सवाल पूछे जा सकते हैं. साथ ही, सीधे तौर पर और सामान्य भाषा में जवाब पाए जा सकते हैं. यह कमांड, आधिकारिक दस्तावेज़ के सोर्स से जानकारी इकट्ठा करती है. साथ ही, जिन पेजों का हवाला दिया गया है उनके उद्धरण देती है.

कोई सवाल पूछने और उसका जवाब पाने के लिए, यह तरीका अपनाएं:

  1. Cloud Storage बकेट बनाने का तरीका जानने के लिए, यह कमांड चलाएं:

    gcloud developer-knowledge answer-query \
    --query="How do I create a Cloud Storage bucket?"

  2. पुष्टि करें कि कमांड, जनरेट किया गया जवाब और सोर्स के रेफ़रंस, YAML फ़ॉर्मैट में दिखाती है:

    answer:
  answerText: |-
    To create a Cloud Storage bucket, you can use the Google Cloud console,
    the gcloud CLI (`gcloud storage buckets create`), client libraries, or
    the REST API...
  citations:
  - endIndex: 158
    sources:
    - referenceIndex: 0
    startIndex: 0
  references:
  - documentReference:
      documentChunk:
        content: |-
          This document shows you how to create a Cloud Storage
          [bucket](https://docs.cloud.google.com/storage/docs/buckets)...
        document:
          dataSource: docs.cloud.google.com
          name: documents/docs.cloud.google.com/storage/docs/creating-buckets
          title: Create a bucket
          uri: https://docs.cloud.google.com/storage/docs/creating-buckets
        parent: documents/docs.cloud.google.com/storage/docs/creating-buckets

    आउटपुट में मौजूद answer ऑब्जेक्ट में ये फ़ील्ड शामिल होते हैं:

    • answerText: आपकी क्वेरी का जवाब, सामान्य भाषा में जनरेट किया गया है.
    • citations: बाइट-ऑफ़सेट रेंज, startIndex और endIndex, answerText में मौजूद हैं. ये referenceIndex के हिसाब से, references में मौजूद काम की एंट्री से मैप होती हैं.
    • references: जवाब जनरेट करने के लिए इस्तेमाल किए गए सोर्स दस्तावेज़ के चंक और मेटाडेटा. इसमें document और parent शामिल हैं.

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

जनरेट किए गए जवाब के बजाय, Google के डेवलपर दस्तावेज़ में टेक्स्ट के कुछ खास हिस्से ढूंढने के लिए, gcloud developer-knowledge documents search-chunks कमांड का इस्तेमाल करें. यह कमांड, दस्तावेज़ों के कॉर्पस को स्कैन करती है. साथ ही, इससे मिलते-जुलते कॉन्टेंट के हिस्सों को उनके पैरंट दस्तावेज़ों के संसाधन नामों के साथ दिखाती है.

दस्तावेज़ के चंक खोजने के लिए, यह तरीका अपनाएं:

  1. Cloud Storage बकेट बनाने के बारे में दस्तावेज़ खोजने के लिए, यह कमांड चलाएं:

    gcloud developer-knowledge documents search-chunks \
    --query="How do I create a Cloud Storage bucket?"

  2. पुष्टि करें कि कमांड, YAML फ़ॉर्मैट में मिलते-जुलते दस्तावेज़ के हिस्सों की सूची दिखाती है:

    ---
content: |-
  This document shows you how to create a Cloud Storage
  [bucket](https://docs.cloud.google.com/storage/docs/buckets). If not otherwise
  specified in your request, buckets are created in the
  [US multi-region](https://docs.cloud.google.com/storage/docs/locations)...
document:
  contentLengthBytes: 31842
  dataSource: docs.cloud.google.com
  description: World-wide storage and retrieval of data in Google Cloud.
  name: documents/docs.cloud.google.com/storage/docs/creating-buckets
  title: Create a bucket
  updateTime: '2026-09-10T20:05:41Z'
  uri: https://docs.cloud.google.com/storage/docs/creating-buckets
  view: DOCUMENT_VIEW_BASIC
id: c1
parent: documents/docs.cloud.google.com/storage/docs/creating-buckets
relevanceScore: 0.856608

    जवाब के हर हिस्से में ये फ़ील्ड शामिल होते हैं:

    • content: दस्तावेज़ में मौजूद टेक्स्ट स्निपेट, जो क्वेरी से मेल खाता है.
    • document: सोर्स दस्तावेज़ का मेटाडेटा. इसमें title, description, uri, dataSource, और updateTime शामिल हैं.
    • id: दस्तावेज़ में मौजूद चंक का आइडेंटिफ़ायर.
    • parent: पैरंट दस्तावेज़ का संसाधन नाम. पूरा दस्तावेज़ वापस पाने के लिए, इस वैल्यू को describe कमांड को पास किया जा सकता है.
    • relevanceScore: खोज क्वेरी के हिसाब से, टेक्स्ट के उस हिस्से का काम का स्कोर.

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

काम का दस्तावेज़ मिलने के बाद, खोज के उन नतीजों में मौजूद parent फ़ील्ड का इस्तेमाल करके, दस्तावेज़ का पूरा मार्कडाउन कॉन्टेंट पाएं.

दस्तावेज़ के संसाधन के नाम के साथ gcloud developer-knowledge documents describe कमांड चलाएं. उदाहरण के लिए, Cloud Storage बकेट बनाने से जुड़ा दस्तावेज़ पाने के लिए, यह तरीका अपनाएं:

  1. यह कमांड चलाएं:

    gcloud developer-knowledge documents describe \
  documents/docs.cloud.google.com/storage/docs/creating-buckets

  2. पुष्टि करें कि कमांड, दस्तावेज़ का मेटाडेटा और पूरा मार्कडाउन कॉन्टेंट दिखाती है:

    content: |
  This document shows you how to create a Cloud Storage [bucket](https://docs.cloud.google.com/storage/docs/buckets). If not otherwise specified in your request, buckets are
  created in the [`US` multi-region](https://docs.cloud.google.com/storage/docs/locations)
  with a default storage class of [Standard storage](https://docs.cloud.google.com/storage/docs/storage-classes)
  and have a seven-day [soft delete](https://docs.cloud.google.com/storage/docs/soft-delete)
  retention duration...
contentLengthBytes: 31842
dataSource: docs.cloud.google.com
description: World-wide storage and retrieval of data in Google Cloud.
name: documents/docs.cloud.google.com/storage/docs/creating-buckets
title: Create a bucket
updateTime: '2026-09-10T20:05:41Z'
uri: https://docs.cloud.google.com/storage/docs/creating-buckets
view: DOCUMENT_VIEW_CONTENT

    आउटपुट में ये फ़ील्ड शामिल होते हैं:

    • content: दस्तावेज़ का पूरा मार्कडाउन टेक्स्ट.
    • contentLengthBytes: दस्तावेज़ के कॉन्टेंट का कुल साइज़ बाइट में.
    • dataSource: दस्तावेज़ को होस्ट करने वाला दस्तावेज़ डोमेन.
    • description: दस्तावेज़ का संक्षिप्त सारांश.
    • name: दस्तावेज़ का यूनीक रिसॉर्स नेम.
    • title: दस्तावेज़ का टाइटल.
    • updateTime: दस्तावेज़ को आखिरी बार अपडेट किए जाने का टाइमस्टैंप.
    • uri: यह दस्तावेज़ वाले पेज का सार्वजनिक यूआरएल होता है.
    • view: दस्तावेज़ का व्यू (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC या DOCUMENT_VIEW_FULL).

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