Chunks

तरीका: corpora.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 का उदाहरण है.

फ़ील्ड
name string

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

data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

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

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

तरीका: corpora.documents.chunks.list

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

एंडपॉइंट

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

तरीका: corpora.documents.chunks.get

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

एंडपॉइंट

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

तरीका: corpora.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 रिसॉर्स का नाम. आईडी में ज़्यादा से ज़्यादा 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 का उदाहरण है.

फ़ील्ड
data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

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

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

तरीका: corpora.documents.chunks.delete

Chunk मिटाता है.

एंडपॉइंट

delete 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} के तौर पर दिखता है.

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

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

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

अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.

तरीका: corpora.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 बनाने का अनुरोध करें.

फ़ील्ड
parent string

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

chunk object (Chunk)

ज़रूरी है. Chunk बनाना है.

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

तरीका: corpora.documents.chunks.batchUpdate

Chunk को एक साथ अपडेट करें.

एंडपॉइंट

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

पाथ पैरामीटर

parent string

ज़रूरी नहीं. अपडेट किए जाने वाले Chunk वाले Document का नाम. हर 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 को अपडेट करने का अनुरोध.

फ़ील्ड
chunk object (Chunk)

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

updateMask string (FieldMask format)

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

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

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

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

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

एंडपॉइंट

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

पाथ पैरामीटर

parent string

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

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

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

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

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

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

अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.

DeleteChunkRequest

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

फ़ील्ड
name string

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

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

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

संसाधन: चंक

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

फ़ील्ड
name string

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

data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

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

आरएफ़सी 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)

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

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

ChunkData

Chunk कॉन्टेंट को दिखाने वाला निकाला गया डेटा.

फ़ील्ड
data Union type
data इनमें से कोई एक हो सकता है:
stringValue string

Chunk कॉन्टेंट को स्ट्रिंग के तौर पर. हर चंक में ज़्यादा से ज़्यादा 2,043 टोकन हो सकते हैं.

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

  // data
  "stringValue": string
  // Union type
}

स्थिति

Chunk की लाइफ़साइकल के स्टेटस.

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