REST Resource: documents

संसाधन: दस्तावेज़

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

JSON काेड में दिखाना 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView),
  "contentLengthBytes": integer
}
फ़ील्ड
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

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

string

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

string

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

string

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

string (Timestamp format)

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

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

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

integer

सिर्फ़ आउटपुट के लिए. यह content फ़ील्ड की लंबाई को बाइट में दिखाता है.

DocumentView

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

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

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

  • name
  • uri
  • dataSource
  • title
  • description
  • updateTime
  • view
  • contentLengthBytes

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

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

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

तरीके

batchGet

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

get

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

searchDocumentChunks

 इससे Google के डेवलपर दस्तावेज़ों में, डेवलपर से जुड़ी जानकारी खोजी जा सकती है.