Documents

File Search API, आपकी सोर्स फ़ाइलों या दस्तावेज़ों को कुछ समय के लिए फ़ाइल ऑब्जेक्ट के तौर पर सेव करता है.

तरीका: fileSearchStores.documents.delete

यह कुकी, Document को मिटाती है.

एंडपॉइंट

delete https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

पाथ पैरामीटर

name string

ज़रूरी है. मिटाने के लिए Document का संसाधन नाम. उदाहरण: fileSearchStores/my-file-search-store-123/documents/the-doc-abc यह fileSearchStores/{filesearchstore}/documents/{document} के फ़ॉर्म में होता है.

क्वेरी पैरामीटर

force boolean

ज़रूरी नहीं. इसे सही पर सेट करने पर, इस Document से जुड़े सभी Chunk और ऑब्जेक्ट भी मिट जाएंगे.

अगर यह डिफ़ॉल्ट रूप से गलत है, तो FAILED_PRECONDITION में कोई भी Chunk होने पर, FAILED_PRECONDITION गड़बड़ी दिखेगी.Document

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर अनुरोध पूरा हो जाता है, तो जवाब के मुख्य हिस्से में एक खाली JSON ऑब्जेक्ट होता है.

मेथड: fileSearchStores.documents.get

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

एंडपॉइंट

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

पाथ पैरामीटर

name string

ज़रूरी है. उस Document का नाम जिसे वापस पाना है. उदाहरण: fileSearchStores/my-file-search-store-123/documents/the-doc-abc यह fileSearchStores/{filesearchstore}/documents/{document} के फ़ॉर्म में होता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में Document का एक इंस्टेंस शामिल किया जाता है.

मेथड: fileSearchStores.documents.list

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

एंडपॉइंट

get https://generativelanguage.googleapis.com/v1beta/{parent=fileSearchStores/*}/documents

पाथ पैरामीटर

parent string

ज़रूरी है. FileSearchStore का नाम, जिसमें Document शामिल हैं. उदाहरण: fileSearchStores/my-file-search-store-123 यह fileSearchStores/{filesearchstore} के फ़ॉर्म में होता है.

क्वेरी पैरामीटर

pageSize integer

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

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

pageToken string

ज़रूरी नहीं. यह पेज टोकन है, जो पिछले documents.list कॉल से मिला था.

अगले पेज को वापस पाने के लिए, अगले अनुरोध के तर्क के तौर पर, जवाब में मिले nextPageToken को शामिल करें.

पेज नंबर के हिसाब से डेटा दिखाने के दौरान, documents.list को दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मेल खाने चाहिए.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

documents.list से मिला जवाब, जिसमें पेज के हिसाब से Document की सूची होती है. Document को document.create_time के हिसाब से बढ़ते क्रम में लगाया गया है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

Fields
documents[] object (Document)

लौटाए गए Document.

nextPageToken string

यह एक टोकन है. इसका इस्तेमाल अगले पेज को वापस पाने के लिए, pageToken के तौर पर किया जा सकता है. अगर इस फ़ील्ड को शामिल नहीं किया जाता है, तो इसका मतलब है कि कोई और पेज उपलब्ध नहीं है.

JSON के काेड में दिखाना 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

REST रिसॉर्स: fileSearchStores.documents

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

Document, Chunk का एक कलेक्शन होता है.

Fields
name string

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

displayName string

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

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

यह आरएफ़सी 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".

createTime string (Timestamp format)

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

यह आरएफ़सी 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".

state enum (State)

सिर्फ़ आउटपुट के लिए. Document की मौजूदा स्थिति.

sizeBytes string (int64 format)

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

mimeType string

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

JSON के काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

CustomMetadata

उपयोगकर्ता से मिला मेटाडेटा, की-वैल्यू पेयर के तौर पर सेव किया जाता है.

Fields
key string

ज़रूरी है. स्टोर किए जाने वाले मेटाडेटा की कुंजी.

value Union type
value इनमें से सिर्फ़ एक हो सकता है:
stringValue string

स्टोर करने के लिए मेटाडेटा की स्ट्रिंग वैल्यू.

stringListValue object (StringList)

स्टोर करने के लिए मेटाडेटा की StringList वैल्यू.

numericValue number

स्टोर करने के लिए मेटाडेटा की संख्या वाली वैल्यू.

JSON के काेड में दिखाना 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

उपयोगकर्ता की ओर से दी गई स्ट्रिंग वैल्यू, जिन्हें किसी एक मेटाडेटा कुंजी को असाइन किया गया है.

Fields
values[] string

स्टोर करने के लिए मेटाडेटा की स्ट्रिंग वैल्यू.

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}

राज्य

Document के लाइफ़साइकल के स्टेटस.

Enums
STATE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. अगर राज्य की जानकारी नहीं दी जाती है, तो इस वैल्यू का इस्तेमाल किया जाता है.
STATE_PENDING Document में मौजूद कुछ Chunks को प्रोसेस किया जा रहा है. जैसे, एम्बेड करना और वेक्टर स्टोरेज.
STATE_ACTIVE Document का पूरा Chunks प्रोसेस किया जाता है और क्वेरी करने के लिए उपलब्ध होता है.
STATE_FAILED Document के कुछ Chunks प्रोसेस नहीं किए जा सके.