REST Resource: corpora.documents

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

Document, Chunk का संग्रह होता है. Corpus में ज़्यादा से ज़्यादा 10,000 Document हो सकते हैं.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
फ़ील्ड
name

string

इम्यूटेबल. आइडेंटिफ़ायर. Document संसाधन का नाम. आईडी ("corpora/*/documents/" प्रीफ़िक्स को छोड़कर) में 40 वर्ण तक हो सकते हैं, जो अंग्रेज़ी के छोटे अक्षर और डैश (-) होते हैं. आईडी के शुरू या आखिर में डैश नहीं हो सकता. अगर नाम बनाने पर कोई नाम नहीं दिया जाता है, तो displayName से एक यूनीक नाम लिया जाएगा. साथ ही, 12 वर्णों का रैंडम सफ़िक्स भी शामिल किया जाएगा. उदाहरण: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName

string

ज़रूरी नहीं. Document का डिसप्ले नेम, जिसे कोई भी व्यक्ति आसानी से पढ़ सके. डिसप्ले नेम में, 512 से ज़्यादा वर्ण नहीं होने चाहिए. इनमें स्पेस भी शामिल हैं. उदाहरण: "Semantic Retriever डॉक्यूमेंटेशन"
customMetadata[]

object (CustomMetadata)

ज़रूरी नहीं. उपयोगकर्ता से मिला कस्टम मेटाडेटा, क्वेरी के लिए इस्तेमाल किए जाने वाले की-वैल्यू पेयर के तौर पर स्टोर किया जाता है. किसी Document में ज़्यादा से ज़्यादा 20 CustomMetadata हो सकते हैं.
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. Document को आखिरी बार अपडेट करने का टाइमस्टैंप.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक तक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब Document को बनाया गया था.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक तक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

तरीके

create

 खाली Document बनाता है.

delete

 Document को मिटाता है.

get

 किसी खास Document के बारे में जानकारी मिलती है.

list

 Corpus में मौजूद सभी Document की सूची बनाता है.

patch

 Document से अपडेट होता है.

query

 Document पर सिमैंटिक खोज करता है.