Method: documents.searchDocumentChunks

यह Google के डेवलपर दस्तावेज़ों में, डेवलपर से जुड़ी जानकारी खोजता है. यह कुकी, उपयोगकर्ता की क्वेरी के आधार पर DocumentChunk दिखाती है. एक ही Document के कई हिस्से हो सकते हैं. पूरे दस्तावेज़ वापस पाने के लिए, DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments का इस्तेमाल करें. इसके साथ ही, SearchDocumentChunksResponse.results में मिले DocumentChunk.parent का इस्तेमाल करें.

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

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

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

क्वेरी पैरामीटर

पैरामीटर
query

string

ज़रूरी है. इसमें उपयोगकर्ता की ओर से दी गई रॉ क्वेरी स्ट्रिंग शामिल होती है. जैसे, "Cloud Storage बकेट कैसे बनाएं?".
pageSize

integer

ज़रूरी नहीं. इससे यह तय किया जाता है कि ज़्यादा से ज़्यादा कितने नतीजे दिखाए जाएं. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए.

अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा पांच नतीजे दिखेंगे.

इसकी ज़्यादा से ज़्यादा वैल्यू 20 हो सकती है. इससे ज़्यादा वैल्यू डालने पर, INVALID_ARGUMENT गड़बड़ी होगी.
pageToken

string

ज़रूरी नहीं. इसमें पेज टोकन होता है, जो पिछले documents.searchDocumentChunks कॉल से मिला था. अगला पेज पाने के लिए, यह जानकारी दें.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

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

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

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

object (DocumentChunk)

इसमें दी गई क्वेरी के लिए खोज के नतीजे शामिल होते हैं. इस सूची में मौजूद हर DocumentChunk में, खोज क्वेरी से जुड़ा कॉन्टेंट का स्निपेट होता है. पूरे दस्तावेज़ का कॉन्टेंट वापस पाने के लिए, हर नतीजे के DocumentChunk.parent फ़ील्ड का इस्तेमाल DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments के साथ करें.
nextPageToken

string

ज़रूरी नहीं. यह कुकी ऐसा टोकन उपलब्ध कराती है जिसे pageToken के तौर पर भेजा जा सकता है, ताकि अगले पेज को वापस पाया जा सके. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होता.

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

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

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

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

DocumentChunk

DocumentChunk, DeveloperKnowledge कॉर्पस में मौजूद Document से कॉन्टेंट के किसी हिस्से को दिखाता है. पूरे दस्तावेज़ का कॉन्टेंट फ़ेच करने के लिए, parent को DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments पर पास करें.

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

string

सिर्फ़ आउटपुट के लिए. इसमें उस दस्तावेज़ का संसाधन नाम होता है जिससे यह हिस्सा लिया गया है. फ़ॉर्मैट: documents/{uri_without_scheme} उदाहरण: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

सिर्फ़ आउटपुट के लिए. इससे दस्तावेज़ में मौजूद इस चंक के आईडी के बारे में पता चलता है. किसी दस्तावेज़ में मौजूद हर चंक का आईडी यूनीक होता है. हालांकि, अलग-अलग दस्तावेज़ों में मौजूद चंक के आईडी एक जैसे हो सकते हैं. चंक आईडी स्थिर नहीं होता और समय के साथ बदल सकता है.
content

string

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