Method: documents.searchDocumentChunks

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

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

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

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

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

पैरामीटर
query

string

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

integer

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

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

ज़्यादा से ज़्यादा वैल्यू 100 हो सकती है. 100 से ज़्यादा वैल्यू को 100 पर सेट कर दिया जाएगा.
pageToken

string

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

string

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

documents.searchDocumentChunks, DocumentChunk दिखाता है. वहीं, फ़िल्टर को DocumentChunk.document फ़ील्ड पर लागू किया जाता है.

फ़िल्टर करने के लिए इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • 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 फ़ील्ड, पूरी स्ट्रिंग पर एग्ज़ैक्ट मैच के लिए = (बराबर है) और != (बराबर नहीं है) ऑपरेटर के साथ काम करते हैं. कुछ हद तक मैच करने, प्रीफ़िक्स से मैच करने, और रेगुलर एक्सप्रेशन से मैच करने की सुविधा काम नहीं करती.

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

ध्यान दें: फ़ील्ड के नाम snake_case में होने चाहिए. उदाहरण के लिए, dataSource. फ़िल्टर करने के एक्सप्रेशन के दाईं ओर मौजूद वैल्यू, डबल कोट में बंद स्ट्रिंग लिटरल होनी चाहिए. उदाहरण के लिए, "docs.cloud.google.com".

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

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