Method: answerQuery

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

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

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

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

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

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

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

string

ज़रूरी है. जवाब देने के लिए क्वेरी.
filter

string

ज़रूरी नहीं. जवाब को ग्राउंड करने के लिए इस्तेमाल किए गए खोज के नतीजों पर, सख्त फ़िल्टर लागू करता है. एक्सप्रेशन, https://google.aip.dev/160 पर बताए गए सिंटैक्स के सबसेट के साथ काम करता है.

फ़िल्टर करने के लिए, ये फ़ील्ड इस्तेमाल किए जा सकते हैं:

  • contentLengthBytes (INTEGER): Document.content फ़ील्ड की लंबाई बाइट में.
  • dataSource (STRING): दस्तावेज़ का सोर्स. जैसे, docs.cloud.google.com. कॉर्पस में मौजूद डेटा सोर्स की पूरी सूची देखने के लिए, https://developers.google.com/knowledge/reference/corpus-reference पर जाएं.
  • updateTime (TIMESTAMP): वह टाइमस्टैंप जब दस्तावेज़ को आखिरी बार अपडेट किया गया था. किसी दस्तावेज़ को तब अपडेट माना जाता है, जब उसके मार्कडाउन कॉन्टेंट या मेटाडेटा में बदलाव किया जाता है.
  • uri (STRING): दस्तावेज़ का यूआरआई. जैसे, https://docs.cloud.google.com/bigquery/docs/tables.

INTEGER फ़ील्ड, =, <, <=, >, और >= ऑपरेटर के साथ काम करते हैं.

STRING फ़ील्ड, पूरी स्ट्रिंग पर पूरी तरह से मैच करने के लिए, = (बराबर) और != (बराबर नहीं) ऑपरेटर के साथ काम करते हैं. आंशिक मैच, प्रीफ़िक्स मैच, और रेगुलर एक्सप्रेशन मैच काम नहीं करते.

TIMESTAMP फ़ील्ड, =, <, <=, >, और >= ऑपरेटर के साथ काम करते हैं. टाइमस्टैंप, आरएफ़सी-3339 फ़ॉर्मैट में होने चाहिए. जैसे, "2025-01-01T00:00:00Z".

AND, OR, और NOT (या -) लॉजिकल ऑपरेटर का इस्तेमाल करके, एक्सप्रेशन को जोड़ा जा सकता है. OR की प्राथमिकता, AND से ज़्यादा होती है. प्राथमिकता के हिसाब से ग्रुप बनाने के लिए, कोष्ठकों का इस्तेमाल करें.

उदाहरण:

  • Document.content_length_bytes के हिसाब से फ़िल्टर करना: contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

filter स्ट्रिंग में 500 से ज़्यादा वर्ण नहीं होने चाहिए. 500 से ज़्यादा वर्ण होने पर, INVALID_ARGUMENT गड़बड़ी दिखेगी.

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

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

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

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

object (Answer)

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

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

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

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • 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

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

integer

सिर्फ़ आउटपुट के लिए. यह बाइट (यूटीएफ़-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 फ़ील्ड सेट नहीं है और यह खाली रहेगा.