Package google.developers.knowledge.v1alpha

इंडेक्स

DeveloperKnowledge

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

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

इसका इस्तेमाल आम तौर पर, पहले DeveloperKnowledge.SearchDocumentChunks का इस्तेमाल करके किसी क्वेरी के आधार पर काम के दस्तावेज़ के हिस्सों को ढूंढने के लिए किया जाता है. इसके बाद, सबसे काम के नतीजों का पूरा कॉन्टेंट फ़ेच करने के लिए, दस्तावेज़ के संसाधन के नामों (जैसे, DocumentChunk.parent या documents/{uri_without_scheme}) के साथ DeveloperKnowledge.GetDocument या DeveloperKnowledge.BatchGetDocuments का इस्तेमाल किया जाता है.

दस्तावेज़ का पूरा कॉन्टेंट, Markdown फ़ॉर्मैट में उपलब्ध कराया जाता है.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

यह ग्राउंडेड जनरेशन का इस्तेमाल करके, किसी क्वेरी का जवाब देता है.

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

इनमें से किसी एक 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 देखें.
BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

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

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

इनमें से किसी एक 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 देखें.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

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

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

इनमें से किसी एक 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 देखें.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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

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

इनमें से किसी एक 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 देखें.

जवाब दें

किसी क्वेरी का जवाब.

फ़ील्ड
answer_text

string

इसमें जवाब का टेक्स्ट शामिल होता है.
citations[]

AnswerCitation

सिर्फ़ आउटपुट के लिए. इसमें जवाब के लिए साइटेशन शामिल हैं.
references[]

AnswerReference

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

AnswerCitation

किसी सेगमेंट के लिए उद्धरण की जानकारी.

फ़ील्ड
start_index

int32

सिर्फ़ आउटपुट के लिए. इससे सेगमेंट की शुरुआत का पता चलता है. इसे बाइट (UTF-8 यूनिकोड) में मेज़र किया जाता है. इसमें सेगमेंट की शुरुआत का बाइट भी शामिल होता है. अगर मल्टी-बाइट वर्ण हैं, जैसे कि नॉन-ASCII वर्ण, तो इंडेक्स मेज़रमेंट, स्ट्रिंग की लंबाई से ज़्यादा होता है.
end_index

int32

सिर्फ़ आउटपुट के लिए. यह सेगमेंट के खत्म होने की जानकारी देता है. इसे बाइट (UTF-8 यूनिकोड) में मेज़र किया जाता है. इसमें सेगमेंट का आखिरी बाइट शामिल नहीं होता. अगर मल्टी-बाइट वर्ण हैं, जैसे कि नॉन-ASCII वर्ण, तो इंडेक्स मेज़रमेंट, स्ट्रिंग की लंबाई से ज़्यादा होता है.
sources[]

CitationSource

सिर्फ़ आउटपुट के लिए. इसमें एट्रिब्यूट किए गए सेगमेंट के लिए, उद्धरण के सोर्स शामिल होते हैं.

AnswerReference

यह किसी सोर्स के रेफ़रंस को दिखाता है.

फ़ील्ड
यूनियन फ़ील्ड content. इसमें रेफ़रंस का कॉन्टेंट शामिल होता है. content इनमें से सिर्फ़ एक हो सकता है:
document_reference

DocumentReference

सिर्फ़ आउटपुट के लिए. रेफ़रंस दस्तावेज़.

CitationSource

उद्धरण का सोर्स.

फ़ील्ड
reference_index

int32

सिर्फ़ आउटपुट के लिए. इसमें references के दोहराए गए फ़ील्ड में Answer.AnswerReference का इंडेक्स शामिल होता है.

DocumentReference

यह किसी दस्तावेज़ के रेफ़रंस को दिखाता है.

फ़ील्ड
document_chunk

DocumentChunk

सिर्फ़ आउटपुट के लिए. इसमें दस्तावेज़ का चंक शामिल होता है. document_chunk.id फ़ील्ड सेट नहीं किया गया है और यह खाली रहेगा.

AnswerQueryRequest

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

फ़ील्ड
query

string

ज़रूरी है. वह क्वेरी जिसका जवाब देना है.
filter

string

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

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

  • content_length_bytes (INTEGER): बाइट में Document.content फ़ील्ड की लंबाई.
  • 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.

INTEGER फ़ील्ड में =, <, <=, >, और >= ऑपरेटर इस्तेमाल किए जा सकते हैं.

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

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

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

उदाहरण:

  • Document.content_length_bytes: content_length_bytes < 50000 के हिसाब से फ़िल्टर करें
  • 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 गड़बड़ी का मैसेज दिखेगा.

AnswerQueryResponse

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

फ़ील्ड
answer

Answer

क्वेरी का जवाब.

BatchGetDocumentsRequest

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

फ़ील्ड
names[]

string

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

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

हर नाम में 500 से ज़्यादा वर्ण नहीं होने चाहिए. अगर किसी नाम में 500 से ज़्यादा वर्ण होंगे, तो INVALID_ARGUMENT गड़बड़ी का मैसेज दिखेगा.
view

DocumentView

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

BatchGetDocumentsResponse

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

फ़ील्ड
documents[]

Document

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

दस्तावेज़

दस्तावेज़, डेवलपर नॉलेज कॉर्पस में दस्तावेज़ के किसी पेज को दिखाता है. जैसे, https://docs.cloud.google.com/storage/docs/creating-buckets पर मौजूद पेज.

फ़ील्ड
name

string

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

string

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

string

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

string

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

string

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

string

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

Timestamp

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

DocumentView

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

int32

सिर्फ़ आउटपुट के लिए. content फ़ील्ड की लंबाई, बाइट में.

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 का इस्तेमाल करना चाहिए.
relevance_score

double

सिर्फ़ आउटपुट के लिए. यह चंक और सर्च क्वेरी के बीच के संबंध को दिखाता है. ज़्यादा स्कोर का मतलब है कि चंक ज़्यादा काम का है. स्कोर [0.0, 1.0] की रेंज में होता है.

DocumentView

इससे पता चलता है कि Document के कौनसे फ़ील्ड शामिल किए गए हैं.

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

इसमें सिर्फ़ बुनियादी मेटाडेटा फ़ील्ड शामिल होते हैं:

  • name
  • uri
  • data_source
  • title
  • description
  • update_time
  • view
  • content_length_bytes

यह 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

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

DocumentView

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

SearchDocumentChunksRequest

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

फ़ील्ड
query

string

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

int32

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

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

ज़्यादा से ज़्यादा वैल्यू 100 है. 100 से ज़्यादा की वैल्यू को 100 माना जाएगा.
page_token

string

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

string

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

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

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

  • content_length_bytes (INTEGER): बाइट में Document.content फ़ील्ड की लंबाई.
  • 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.

INTEGER फ़ील्ड में =, <, <=, >, और >= ऑपरेटर इस्तेमाल किए जा सकते हैं.

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

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

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

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

उदाहरण:

  • Document.content_length_bytes: content_length_bytes < 50000 के हिसाब से फ़िल्टर करें
  • 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 के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को शामिल नहीं किया जाता है, तो इसके बाद कोई पेज नहीं होगा.