Method: answerQuery

ग्राउंडेड जनरेशन का इस्तेमाल करके, क्वेरी का जवाब देता है.

एचटीटीपी अनुरोध

POST https://developerknowledge.googleapis.com/v1:answerQuery

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना
{
  "query": string
}
फ़ील्ड
query

string

ज़रूरी है. यह क्वेरी का जवाब है.

जवाब का मुख्य भाग

DeveloperKnowledge.AnswerQuery के लिए जवाब का मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है:

JSON फ़ॉर्मैट में दिखाया गया है
{
  "answer": {
    object (Answer)
  }
}
फ़ील्ड
answer

object (Answer)

यह क्वेरी का जवाब है.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.

जवाब

किसी क्वेरी का जवाब.

JSON फ़ॉर्मैट में दिखाया गया है
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
फ़ील्ड
answerText

string

इसमें जवाब का टेक्स्ट शामिल होता है.

citations[]

object (AnswerCitation)

सिर्फ़ आउटपुट के लिए. इसमें जवाब के लिए कोटेशन शामिल होते हैं.

references[]

object (AnswerReference)

सिर्फ़ आउटपुट के लिए. इसमें जवाब के लिए रेफ़रंस शामिल होते हैं.

AnswerCitation

किसी सेगमेंट के लिए कोटेशन की जानकारी.

JSON फ़ॉर्मैट में दिखाया गया है
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
फ़ील्ड
startIndex

integer

सिर्फ़ आउटपुट के लिए. बाइट (UTF-8 यूनिकोड) में मेज़र किए गए सेगमेंट की शुरुआत दिखाता है. इसमें, शुरुआती बाइट शामिल है. अगर मल्टी-बाइट वर्ण हैं, जैसे कि ASCII के अलावा दूसरे वर्ण, तो इंडेक्स मेज़रमेंट, स्ट्रिंग की लंबाई से ज़्यादा होता है.

endIndex

integer

सिर्फ़ आउटपुट के लिए. बाइट (UTF-8 यूनिकोड) में मेज़र किए गए सेगमेंट का आखिर दिखाता है. इसमें, आखिरी बाइट शामिल नहीं है. अगर मल्टी-बाइट वर्ण हैं, जैसे कि ASCII के अलावा दूसरे वर्ण, तो इंडेक्स मेज़रमेंट, स्ट्रिंग की लंबाई से ज़्यादा होता है.

sources[]

object (CitationSource)

सिर्फ़ आउटपुट के लिए. इसमें एट्रिब्यूट किए गए सेगमेंट के लिए कोटेशन सोर्स शामिल होते हैं.

CitationSource

कोटेशन सोर्स.

JSON फ़ॉर्मैट में दिखाया गया है
{
  "referenceIndex": integer
}
फ़ील्ड
referenceIndex

integer

सिर्फ़ आउटपुट के लिए. इसमें, दोहराए गए references फ़ील्ड में Answer.AnswerReference का इंडेक्स शामिल होता है.

AnswerReference

किसी सोर्स के रेफ़रंस को दिखाता है.

JSON फ़ॉर्मैट में दिखाया गया है
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
फ़ील्ड
यूनियन फ़ील्ड content. इसमें रेफ़रंस का कॉन्टेंट शामिल होता है. content इनमें से कोई एक हो सकता है:
documentReference

object (DocumentReference)

सिर्फ़ आउटपुट के लिए. रेफ़रंस वाला दस्तावेज़.

DocumentReference

किसी दस्तावेज़ के रेफ़रंस को दिखाता है.

JSON फ़ॉर्मैट में दिखाया गया है
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
फ़ील्ड
documentChunk

object (DocumentChunk)

सिर्फ़ आउटपुट के लिए. इसमें दस्तावेज़ का हिस्सा शामिल होता है. documentChunk.id फ़ील्ड सेट नहीं है और यह खाली रहेगा.