Documents

तरीका: corpora.documents.create

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

एंडपॉइंट

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

पाथ पैरामीटर

parent string

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

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

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

फ़ील्ड
name string

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

displayName string

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

customMetadata[] object (CustomMetadata)

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

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

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

मेथड: corpora.documents.query

यह Document पर सिमैंटिक सर्च करता है.

एंडपॉइंट

post 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 का नाम पहले ही बताया जा चुका है.

क्वेरी का उदाहरण: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter ऑब्जेक्ट की सूची: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

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

MetadataFilter ऑब्जेक्ट की सूची: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

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

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

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

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

Fields
relevantChunks[] object (RelevantChunk)

जवाब में मिले काम के चंक.

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

मेथड: corpora.documents.list

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

एंडपॉइंट

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

पाथ पैरामीटर

parent string

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

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

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
}

तरीका: 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 का एक इंस्टेंस शामिल किया जाता है.

मेथड: corpora.documents.patch

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

एंडपॉइंट

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

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

पाथ पैरामीटर

document.name string

इम्यूटेबल. आइडेंटिफ़ायर. Document संसाधन का नाम. आईडी में ज़्यादा से ज़्यादा 40 वर्ण हो सकते हैं. आईडी में "corpora/*/documents/" प्रीफ़िक्स शामिल नहीं होता. आईडी में लोअरकेस अल्फ़ान्यूमेरिक वर्ण या डैश (-) हो सकते हैं. आईडी की शुरुआत या आखिर में डैश नहीं हो सकता. अगर नाम नहीं दिया गया है, तो 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 और ऑब्जेक्ट भी मिट जाएंगे.

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

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

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

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

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

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

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

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

Fields
name string

इम्यूटेबल. आइडेंटिफ़ायर. Document संसाधन का नाम. आईडी में ज़्यादा से ज़्यादा 40 वर्ण हो सकते हैं. आईडी में "corpora/*/documents/" प्रीफ़िक्स शामिल नहीं होता. आईडी में लोअरकेस अल्फ़ान्यूमेरिक वर्ण या डैश (-) हो सकते हैं. आईडी की शुरुआत या आखिर में डैश नहीं हो सकता. अगर नाम नहीं दिया गया है, तो 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 को आखिरी बार अपडेट किए जाने का टाइमस्टैंप.

यह RFC 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 बनाए जाने का टाइमस्टैंप.

यह RFC 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".

JSON के काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": 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
  ]
}