Method: documents.searchDocumentChunks

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

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

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

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

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

पैरामीटर
query

string

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

integer

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

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

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

string

ज़रूरी नहीं. इसमें, documents.searchDocumentChunks के पिछले कॉल से मिला पेज टोकन शामिल होता है. अगला पेज पाने के लिए, इसे उपलब्ध कराएं.
filter

string

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

documents.searchDocumentChunks से DocumentChunk मिलते हैं. हालांकि, फ़िल्टर, DocumentChunk.document फ़ील्ड पर लागू होता है.

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

  • 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.

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

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

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

उदाहरण:

  • 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 से ज़्यादा वर्ण नहीं होने चाहिए. इससे ज़्यादा वर्ण होने पर, 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/cloud-platform

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

DocumentChunk

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
फ़ील्ड
parent

string

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

string

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

string

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

object (Document)

सिर्फ़ आउटपुट के लिए. इससे, उस Document के बारे में मेटाडेटा दिखता है जिससे यह chunk लिया गया है. इस Document मैसेज का DocumentView, DOCUMENT_VIEW_BASIC पर सेट होगा. इसे यहां इसलिए शामिल किया गया है, ताकि क्लाइंट को सिर्फ़ मेटाडेटा फ़ील्ड की ज़रूरत होने पर, DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments को कॉल न करना पड़े. हालांकि, पूरे दस्तावेज़ का कॉन्टेंट पाने के लिए, क्लाइंट को DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments का इस्तेमाल करना चाहिए.