Docuents

REST रिसॉर्स: Corपर.documents

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

Document, Chunk का एक कलेक्शन होता है. Corpus में ज़्यादा से ज़्यादा 10,000 Document हो सकते हैं.

JSON के काेड में दिखाना 
{
  "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 से ज़्यादा वर्ण नहीं होने चाहिए. उदाहरण: "सिमैंटिक रिट्रीवर दस्तावेज़"

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

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

createTime string (Timestamp format)

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

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

तरीका: Corपर.documents.create

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

एंडपॉइंट

पोस्ट https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

पाथ पैरामीटर

parent string

ज़रूरी है. उस Corpus का नाम जहां यह Document बनाया जाएगा. उदाहरण: corpora/my-corpus-123 यह corpora/{corpora} का रूप लेता है.

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

अनुरोध के मुख्य भाग में Document का उदाहरण है.

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

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

तरीका: कॉर्पोरा.documents.list

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

एंडपॉइंट

पाएं https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

पाथ पैरामीटर

parent string

ज़रूरी है. Document वाले Corpus का नाम. उदाहरण: corpora/my-corpus-123 यह corpora/{corpora} का रूप लेता है.

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

pageSize integer

ज़रूरी नहीं. दिए जाने वाले Document सेकंड की ज़्यादा से ज़्यादा संख्या (हर पेज के हिसाब से). सेवा से कम Document मिल सकते हैं.

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

pageToken string

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

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

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

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

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

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

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

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

फ़ील्ड
documents[] object (Document)

जवाब के तौर पर मिले Document.

nextPageToken string

एक टोकन, जिसे अगला पेज फिर से पाने के लिए pageToken के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को छोड़ दिया जाता है, तो और पेज नहीं होते हैं.

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

तरीका: कॉर्पोरा.documents.query

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

एंडपॉइंट

पोस्ट https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

पाथ पैरामीटर

name string

ज़रूरी है. क्वेरी करने के लिए Document का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc यह corpora/{corpora}/documents/{document} का रूप लेता है.

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

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

फ़ील्ड
query string

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

resultsCount integer

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

अगर जानकारी नहीं दी गई है, तो ज़्यादा से ज़्यादा 10 Chunk दिखाए जाएंगे. अधिकतम 100 परिणाम चुने जा सकते हैं.

metadataFilters[] object (MetadataFilter)

ज़रूरी नहीं. Chunk मेटाडेटा के लिए फ़िल्टर. हर MetadataFilter ऑब्जेक्ट एक खास कुंजी से मेल खाना चाहिए. कई MetadataFilter ऑब्जेक्ट, लॉजिकल "AND" से जोड़े जाते हैं.

ध्यान दें: Document-लेवल के हिसाब से फ़िल्टर करने की सुविधा, इस अनुरोध के लिए काम नहीं करती, क्योंकि Document नाम पहले से मौजूद है.

क्वेरी का उदाहरण: (साल >= 2020 OR साल < 2010) AND (शैली = ड्रामा या शैली = ऐक्शन)

MetadataFilter ऑब्जेक्ट की सूची: मेटाडेटा फ़िल्टर = [ {key = "chunk.custom_metadata.year" स्थितियां = [{int_value = 2020,, ऑपरेशन = GREATER_EQUAL}, {int_value = 2010, ऑपरेशन = LESS}}, {key = "chunk.custom_metadata.genre" शर्तें = [{stringValue = "ड्रामा", ऑपरेशन = EQUAL}, {stringValue = "action", action = EQUAL}}]

वैल्यू की अंकों वाली रेंज के लिए क्वेरी का उदाहरण: (साल > 2015 AND साल <= 2020)

MetadataFilter ऑब्जेक्ट की सूची: मेटाडेटा फ़िल्टर = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; शर्तें = [{int_value = 2020, ऑपरेशन = LESS_EQUAL}]}]

ध्यान दें: एक जैसी कुंजी के लिए, "AND" का इस्तेमाल सिर्फ़ अंकों वाली वैल्यू के लिए किया जा सकता है. स्ट्रिंग वैल्यू सिर्फ़ एक कुंजी के लिए "OR" के साथ काम करती हैं.

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

documents.query से मिले जवाब में, काम के हिस्सों की सूची शामिल है.

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

फ़ील्ड
relevantChunks[] object (RelevantChunk)

काम के हिस्से दिखाए गए.

JSON के काेड में दिखाना 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

तरीका: कॉर्पोरा.documents.get

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

एंडपॉइंट

पाएं https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

पाथ पैरामीटर

name string

ज़रूरी है. वापस पाने के लिए Document का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc यह corpora/{corpora}/documents/{document} का रूप लेता है.

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

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

जवाब का मुख्य हिस्सा

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

तरीका: कॉर्पोरा.documents.patch

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

एंडपॉइंट

पैच https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

पाथ पैरामीटर

document.name string

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

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

updateMask string (FieldMask format)

ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड की सूची. फ़िलहाल, इससे सिर्फ़ displayName और customMetadata को अपडेट किया जा सकता है.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नाम की सूची है, जिसे कॉमा लगाकर अलग किया गया है. उदाहरण: "user.displayName,photo".

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

अनुरोध के मुख्य भाग में Document का उदाहरण है.

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

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

तरीका: कॉर्पोरा.documents.delete

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

एंडपॉइंट

मिटाएं https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

पाथ पैरामीटर

name string

ज़रूरी है. मिटाने के लिए, Document संसाधन का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc यह corpora/{corpora}/documents/{document} का रूप लेता है.

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

force boolean

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

गलत होने पर (डिफ़ॉल्ट तौर पर), अगर Document में कोई Chunk मौजूद होता है, तो FAILED_PRECONDITION गड़बड़ी मिलेगी.

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

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

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

जवाब सही होने पर, जवाब का मुख्य हिस्सा खाली होता है.

CustomMetadata

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

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
फ़ील्ड
key string

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

यूनियन फ़ील्ड value.

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

stringValue string

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

stringListValue object (StringList)

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

numericValue number

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

StringList

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

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}
फ़ील्ड
values[] string

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