Package google.developers.knowledge.v1

इंडेक्स

DeveloperKnowledge

Developer Knowledge API, प्रोग्राम के हिसाब से डेवलपर को Google के सार्वजनिक डेवलपर दस्तावेज़ का ऐक्सेस अपने-आप देता रहता है. इससे आपको इस नॉलेज बेस को अपने ऐप्लिकेशन और वर्कफ़्लो में शामिल करने में मदद मिलती है.

इस एपीआई को, Google के डेवलपर के लिए दस्तावेज़ों को मशीन से पढ़े जा सकने वाले फ़ॉर्मैट में ऐक्सेस करने के लिए, कैननिकल सोर्स के तौर पर डिज़ाइन किया गया है.

आम तौर पर, इसका इस्तेमाल इस तरह किया जाता है: सबसे पहले, किसी क्वेरी के आधार पर काम के पेज के यूआरआई खोजने के लिए DeveloperKnowledge.SearchDocumentChunks का इस्तेमाल करें. इसके बाद, सबसे ऊपर दिखने वाले नतीजों का पूरा कॉन्टेंट फ़ेच करने के लिए DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments का इस्तेमाल करें.

दस्तावेज़ का पूरा कॉन्टेंट, मार्कडाउन फ़ॉर्मैट में दिया गया है.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

यह एक साथ कई दस्तावेज़ों को वापस लाता है. हर दस्तावेज़ में पूरा मार्कडाउन कॉन्टेंट होता है.

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

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

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

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

rpc GetDocument(GetDocumentRequest) returns (Document)

यह फ़ंक्शन, पूरे मार्कडाउन कॉन्टेंट के साथ एक दस्तावेज़ वापस लाता है.

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

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

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

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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

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

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

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

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

BatchGetDocumentsRequest

DeveloperKnowledge.BatchGetDocuments के लिए मैसेज का अनुरोध.

फ़ील्ड
names[]

string

ज़रूरी है. इससे उन दस्तावेज़ों के नाम तय किए जाते हैं जिन्हें वापस पाना है. एक बैच में ज़्यादा से ज़्यादा 20 दस्तावेज़ों को वापस लाया जा सकता है. दस्तावेज़, अनुरोध में मौजूद names के क्रम में ही दिखाए जाते हैं.

फ़ॉर्मैट: documents/{uri_without_scheme} उदाहरण: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

ज़रूरी नहीं. इससे दस्तावेज़ के DocumentView के बारे में पता चलता है. अगर कोई वैल्यू सेट नहीं की जाती है, तो DeveloperKnowledge.BatchGetDocuments की डिफ़ॉल्ट वैल्यू DOCUMENT_VIEW_CONTENT होती है.

BatchGetDocumentsResponse

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

फ़ील्ड
documents[]

Document

इसमें मांगे गए दस्तावेज़ शामिल हैं.

दस्तावेज़

दस्तावेज़, Developer Knowledge कॉर्पस से लिए गए कॉन्टेंट के एक हिस्से को दिखाता है.

फ़ील्ड
name

string

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

string

सिर्फ़ आउटपुट के लिए. कॉन्टेंट का यूआरआई दिखाता है, जैसे कि docs.cloud.google.com/storage/docs/creating-buckets.
content

string

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

string

सिर्फ़ आउटपुट के लिए. दस्तावेज़ के बारे में जानकारी देता है.
data_source

string

सिर्फ़ आउटपुट के लिए. इससे दस्तावेज़ के डेटा सोर्स के बारे में पता चलता है. डेटा सोर्स का उदाहरण: firebase.google.com
title

string

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

Timestamp

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि दस्तावेज़ के कॉन्टेंट या मेटाडेटा को पिछली बार कब अपडेट किया गया था.
view

DocumentView

सिर्फ़ आउटपुट के लिए. इससे दस्तावेज़ के DocumentView के बारे में पता चलता है.

DocumentChunk

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

फ़ील्ड
parent

string

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

string

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

string

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

Document

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

DocumentView

इससे यह तय होता है कि Document के किन फ़ील्ड को शामिल किया गया है.

Enums
DOCUMENT_VIEW_UNSPECIFIED डिफ़ॉल्ट / सेट नहीं की गई वैल्यू. अगर DocumentView की वैल्यू नहीं दी गई है, तो हर एपीआई तरीके की डिफ़ॉल्ट वैल्यू देखें.
DOCUMENT_VIEW_BASIC

इसमें सिर्फ़ बुनियादी मेटाडेटा फ़ील्ड शामिल होते हैं: - name - uri - data_source - title - description - update_time - view

यह DeveloperKnowledge.SearchDocumentChunks के लिए डिफ़ॉल्ट व्यू है.
DOCUMENT_VIEW_FULL इसमें सभी Document फ़ील्ड शामिल होते हैं.
DOCUMENT_VIEW_CONTENT

इसमें DOCUMENT_VIEW_BASIC फ़ील्ड और content फ़ील्ड शामिल हैं.

यह DeveloperKnowledge.GetDocument और DeveloperKnowledge.BatchGetDocuments के लिए डिफ़ॉल्ट व्यू है.

GetDocumentRequest

DeveloperKnowledge.GetDocument के लिए मैसेज का अनुरोध.

फ़ील्ड
name

string

ज़रूरी है. इससे उस दस्तावेज़ का नाम पता चलता है जिसे वापस पाना है. फ़ॉर्मैट: documents/{uri_without_scheme} उदाहरण: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

ज़रूरी नहीं. इससे दस्तावेज़ के DocumentView के बारे में पता चलता है. अगर कोई वैल्यू सेट नहीं की जाती है, तो DeveloperKnowledge.GetDocument की डिफ़ॉल्ट वैल्यू DOCUMENT_VIEW_CONTENT होती है.

SearchDocumentChunksRequest

DeveloperKnowledge.SearchDocumentChunks के लिए मैसेज का अनुरोध.

फ़ील्ड
query

string

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

int32

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

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

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

string

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

string

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

SearchDocumentChunks, DocumentChunk दिखाता है, जबकि फ़िल्टर DocumentChunk.document फ़ील्ड पर लागू होता है.

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

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

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

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

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

उदाहरण:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

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

SearchDocumentChunksResponse

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

फ़ील्ड
results[]

DocumentChunk

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

string

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