Documents

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

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

एंडपॉइंट

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

पाथ पैरामीटर

parent string

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

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

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

फ़ील्ड
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 हो सकते हैं.

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

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

तरीका: कॉर्पोरा.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 object list: metadataFilters = [ {key = &quot;chunk.custom_metadata.year&quot; स्थितियां = [{int_value = 2020,, ऑपरेशन = GREATER_EQUAL}, {int_value = 2010, ऑपरेशन = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}}]

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

MetadataFilter object list: metadataFilters = [ {key = &quot;chunk.custom_metadata.year&quot; स्थितियां = [{int_value = 2015, Operations = GREATER}]}, {key = "chunk.custom_metadata.year" शर्तें = [{int_value = 2020, Operations = LESS_EQUAL}]}]

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

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

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

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

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

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

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

तरीका: कॉर्पोरा.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
}

तरीका: corpora.documents.get

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

एंडपॉइंट

get 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 का उदाहरण है.

फ़ील्ड
displayName string

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

customMetadata[] object (CustomMetadata)

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

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

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

तरीका: corpora.documents.delete

Document मिटाता है.

एंडपॉइंट

delete 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 गड़बड़ी मिलेगी.

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

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

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

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

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

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

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

फ़ील्ड
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 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों के साथ. उदाहरण: "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".

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

CustomMetadata

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

फ़ील्ड
key string

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

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

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

stringValue string

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

stringListValue object (StringList)

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

numericValue number

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

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.
}

StringList

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

फ़ील्ड
values[] string

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

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