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

डेवलपर नॉलेज एपीआई की मदद से, Google Developers के डेवलपर प्रॉडक्ट के बारे में सवाल पूछे जा सकते हैं. साथ ही, सीधे तौर पर नैचुरल लैंग्वेज में जवाब पाए जा सकते हैं. हर क्वेरी के लिए, एपीआई, डेवलपर नॉलेज कॉर्पस से जवाब तैयार करता है. इसे एपीआई रेफ़रंस में ग्राउंडेड जनरेशन कहा जाता है. साथ ही, इसमें काम के दस्तावेज़ों के पेजों के साइटेशन शामिल होते हैं.

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

अपनी पसंद के टूल के लिए, अपना एनवायरमेंट सेट अप करें:

gcloud

gcloud सीएलआई इंस्टॉल और कॉन्फ़िगर करें. साथ ही, डेवलपर नॉलेज एपीआई को चालू करें.

REST

एपीआई को चालू करें और डेवलपर नॉलेज एपीआई पासकोड जनरेट करें. इसके बाद, अपने पासकोड को एनवायरमेंट वैरिएबल में सेव करें:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

YOUR_API_KEY को अपने डेवलपर नॉलेज एपीआई पासकोड से बदलें.

किसी क्वेरी का जवाब देना

कोई सवाल पूछने के लिए, gcloud developer-knowledge answer-query कमांड या answerQuery REST तरीके का इस्तेमाल करें.

यहां दिया गया उदाहरण, BigQuery डेटासेट बनाने के तरीके के बारे में क्वेरी भेजता है:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

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?"}'

जवाब में, answer.answerText फ़ील्ड में टेक्स्ट जवाब होता है, इसके साथ ही, citations और references भी answer ऑब्जेक्ट में शामिल होते हैं:

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

दस्तावेज़ के सोर्स फ़िल्टर करना

जवाब जनरेट करने के लिए इस्तेमाल किए जाने वाले दस्तावेज़ के सोर्स को सीमित करने के लिए, फ़िल्टर एक्सप्रेशन पास करें. gcloud सीएलआई में --query-filter फ़्लैग या अपने REST अनुरोध के मुख्य हिस्से में filter फ़ील्ड का इस्तेमाल करें. इस्तेमाल किए जा सकने वाले फ़िल्टर फ़ील्ड और ऑपरेटरों के बारे में जानने के लिए, देखें खोज के नतीजों को फ़िल्टर करना.

यहां दिया गया उदाहरण, दस्तावेज़ के सोर्स को docs.cloud.google.com तक सीमित करता है:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

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?",
    "filter": "data_source = \"docs.cloud.google.com\""
  }'

AnswerQuery और SearchDocumentChunks में से कोई एक चुनना

एपीआई या डेवलपर नॉलेज एमसीपी सर्वर का इस्तेमाल करते समय, वह तरीका चुनें जो आपकी ज़रूरत के हिसाब से सबसे सही हो:

  • AnswerQuery (या answer_query एमसीपी टूल): "कैसे करें" से जुड़े सामान्य सवालों, प्रॉडक्ट की तुलना करने, और सिलसिलेवार निर्देशों के लिए सबसे सही. इसमें आपको सोर्स दस्तावेज़ों के लिंक के साथ, पूरी जानकारी मिलती है.
  • SearchDocumentChunks (या search_documents एमसीपी टूल): सटीक सीएलआई फ़्लैग, कोड सिंटैक्स, पैरामीटर के नाम या IAM अनुमतियां (जैसे, service.resource.verb) ढूंढने के लिए सबसे सही. पूरा सवाल पूछने के बजाय, दो से पांच खास कीवर्ड इस्तेमाल करें.

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