REST Resource: documents

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

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

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

सिर्फ़ आउटपुट के लिए. दस्तावेज़ के बारे में जानकारी देता है.
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 के बारे में पता चलता है.

DocumentView

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

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

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

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

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

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

तरीके

batchGet

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

get

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

searchDocumentChunks

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