Method: documents.searchDocumentChunks

यह Google के डेवलपर दस्तावेज़ में, डेवलपर से जुड़ी जानकारी खोजता है. यह उपयोगकर्ता की क्वेरी के आधार पर, DocumentChunk दिखाता है. एक ही Document से कई chunk हो सकते हैं. पूरे दस्तावेज़ पाने के लिए, 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 फ़ील्ड, पूरी स्ट्रिंग के ठीक-ठीक मैच के लिए, = (बराबर) और != (बराबर नहीं) ऑपरेटर के साथ काम करते हैं. इनके साथ, कुछ हद तक मैच, प्रीफ़िक्स मैच, और रेगुलर एक्सप्रेशन मैच की सुविधा काम नहीं करती.

TIMESTAMP फ़ील्ड, =, <, <=, >, और >= ऑपरेटर के साथ काम करते हैं. टाइमस्टैंप, आरएफ़सी-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 में, खोज क्वेरी से जुड़ा कॉन्टेंट का स्निपेट शामिल होता है. पूरे दस्तावेज़ का कॉन्टेंट पाने के लिए, DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments के साथ, हर नतीजे के DocumentChunk.parent फ़ील्ड का इस्तेमाल करें.
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.