Chunks

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

संसाधन: समूह

Chunk, Document का एक सब-पार्ट है, जिसे वेक्टर दिखाने और स्टोरेज के लिए इंडिपेंडेंट यूनिट माना जाता है. Corpus में ज़्यादा से ज़्यादा 10 लाख Chunk हो सकते हैं.

JSON के काेड में दिखाना 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
फ़ील्ड
name string

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

data object (ChunkData)

ज़रूरी है. Chunk के लिए कॉन्टेंट, जैसे कि टेक्स्ट स्ट्रिंग. हर डेटा ग्रुप में ज़्यादा से ज़्यादा 2043 में टोकन जोड़े जा सकते हैं.

customMetadata[] object (CustomMetadata)

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

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

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

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

state enum (State)

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

ChunkData

एक्सट्रैक्ट किया गया डेटा, जो Chunk के कॉन्टेंट के बारे में बताता है.

JSON के काेड में दिखाना 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
फ़ील्ड

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

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

stringValue string

स्ट्रिंग के तौर पर Chunk कॉन्टेंट. हर डेटा ग्रुप में ज़्यादा से ज़्यादा 2043 में टोकन जोड़े जा सकते हैं.

स्थिति

Chunk के लाइफ़साइकल की स्थितियां.

Enums
STATE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. अगर स्थिति को छोड़ दिया जाता है, तो इस मान का इस्तेमाल किया जाता है.
STATE_PENDING_PROCESSING Chunk संसाधित किया जा रहा है (एम्बेड करना और वेक्टर मेमोरी).
STATE_ACTIVE Chunk प्रोसेस हो गई है और क्वेरी करने के लिए उपलब्ध है.
STATE_FAILED Chunk के डेटा को प्रोसेस नहीं किया जा सका.

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

यह Chunk बनाता है.

एंडपॉइंट

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

पाथ पैरामीटर

parent string

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

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

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

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

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

तरीका: Corपर.documents.chunks.list

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

एंडपॉइंट

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

पाथ पैरामीटर

parent string

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

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

pageSize integer

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

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

pageToken string

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

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

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

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

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

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

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

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

फ़ील्ड
chunks[] object (Chunk)

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

nextPageToken string

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

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

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

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

एंडपॉइंट

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

पाथ पैरामीटर

name string

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

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

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

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

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

तरीका: Corपर.documents.chunks.patch

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

एंडपॉइंट

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

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

पाथ पैरामीटर

chunk.name string

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

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

updateMask string (FieldMask format)

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

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

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

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

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

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

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

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

एंडपॉइंट

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

पाथ पैरामीटर

name string

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

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

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

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

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

तरीका: Corpara.documents.chunks.batchCreate

बैच में Chunk बनाएं.

एंडपॉइंट

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

पाथ पैरामीटर

parent string

ज़रूरी नहीं. उस Document का नाम जहां Chunk का यह बैच बनाया जाएगा. हर CreateChunkRequest के पैरंट फ़ील्ड को इस वैल्यू से मैच करना चाहिए. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc यह corpora/{corpora}/documents/{document} का रूप लेता है.

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

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

फ़ील्ड
requests[] object (CreateChunkRequest)

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

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

chunks.batchCreate से मिले जवाब में, बनाए गए Chunk की सूची शामिल है.

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

फ़ील्ड
chunks[] object (Chunk)

Chunk बनाए गए.

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

CreateChunkRequest

Chunk बनाने का अनुरोध करें.

JSON के काेड में दिखाना 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
फ़ील्ड
parent string

ज़रूरी है. उस Document का नाम जहां यह Chunk बनाया जाएगा. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

ज़रूरी है. बनाया जाने वाला Chunk.

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

बैच अपडेट Chunk.

एंडपॉइंट

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

पाथ पैरामीटर

parent string

ज़रूरी नहीं. उस Document का नाम जिसमें अपडेट किए जाने वाले Chunk हैं. हर UpdateChunkRequest के पैरंट फ़ील्ड को इस वैल्यू से मैच करना चाहिए. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc यह corpora/{corpora}/documents/{document} का रूप लेता है.

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

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

फ़ील्ड
requests[] object (UpdateChunkRequest)

ज़रूरी है. अपडेट किए जाने वाले Chunk के बारे में बताने वाले अनुरोध मैसेज. एक बैच में, ज़्यादा से ज़्यादा 100 Chunk अपडेट किए जा सकते हैं.

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

chunks.batchUpdate से मिले जवाब में, अपडेट किए गए Chunk की सूची शामिल है.

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

फ़ील्ड
chunks[] object (Chunk)

Chunk अपडेट की गईं.

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

UpdateChunkRequest

Chunk को अपडेट करने का अनुरोध करें.

JSON के काेड में दिखाना 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
फ़ील्ड
chunk object (Chunk)

ज़रूरी है. अपडेट करने के लिए Chunk.

updateMask string (FieldMask format)

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

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

तरीका: Corpara.documents.chunks.batchDelete

एक साथ Chunk मिटाएं.

एंडपॉइंट

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

पाथ पैरामीटर

parent string

ज़रूरी नहीं. उस Document का नाम जिसमें मिटाने के लिए Chunk हैं. हर DeleteChunkRequest के पैरंट फ़ील्ड को इस वैल्यू से मैच करना चाहिए. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc यह corpora/{corpora}/documents/{document} का रूप लेता है.

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

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

फ़ील्ड
requests[] object (DeleteChunkRequest)

ज़रूरी है. मिटाने के लिए Chunk के बारे में बताने वाले अनुरोध मैसेज.

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

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

DeleteChunkRequest

Chunk को मिटाने का अनुरोध करें.

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

ज़रूरी है. मिटाने के लिए, Chunk संसाधन का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk