Chunks

روش: corpora.documents.chunks.create

یک Chunk ایجاد می کند.

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

پارامترهای مسیر

string parent

مورد نیاز. نام Document که این Chunk در آن ایجاد می شود. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

درخواست بدن

بدنه درخواست شامل نمونه ای از Chunk است.

فیلدها
string name

تغییرناپذیر. شناسه. نام منبع Chunk . شناسه (نام بدون پیشوند "corpora/*/documents/*/chunks/") می‌تواند حداکثر دارای 40 کاراکتر باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در هنگام ایجاد خالی باشد، یک شناسه منحصربه‌فرد 12 نویسه‌ای تصادفی ایجاد می‌شود. مثال: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object ( ChunkData )

مورد نیاز. محتوای Chunk ، مانند رشته متن. حداکثر تعداد توکن در هر تکه 2043 است.

شی customMetadata[] object ( CustomMetadata )

اختیاری. کاربر فوق داده های سفارشی را که به صورت جفت کلید-مقدار ذخیره می شود، ارائه می کند. حداکثر تعداد CustomMetadata در هر تکه 20 عدد است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه جدیدی از Chunk است.

روش: corpora.documents.chunks.list

تمام Chunk یک Document را فهرست می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks را دریافت کنید

پارامترهای مسیر

string parent

مورد نیاز. نام Document حاوی Chunk s. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

پارامترهای پرس و جو

pageSize integer

اختیاری. حداکثر تعداد Chunk s برای بازگشت (در هر صفحه). ممکن است این سرویس تعداد کمتری Chunk را برگرداند.

اگر مشخص نشده باشد، حداکثر 10 Chunk برگردانده می شود. حداکثر اندازه مجاز 100 Chunk در هر صفحه است.

string pageToken

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی chunks.list .

nextPageToken بازگشتی در پاسخ را به عنوان آرگومان درخواست بعدی برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به chunks.list باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ از chunks.list حاوی لیست صفحه بندی شده از Chunk s. Chunk ها بر اساس chunk.create_time صعودی مرتب می شوند.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

فیلدها
chunks[] object ( Chunk )

Chunk برگشتی.

string nextPageToken

یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، صفحه دیگری وجود ندارد.

نمایندگی JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

روش: corpora.documents.chunks.get

اطلاعات مربوط به یک Chunk خاص را دریافت می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*} را دریافت کنید

پارامترهای مسیر

string name

مورد نیاز. نام 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/*}

پارامترهای مسیر

string chunk.name

تغییرناپذیر. شناسه. نام منبع 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 است.

فیلدها
data object ( ChunkData )

مورد نیاز. محتوای Chunk ، مانند رشته متن. حداکثر تعداد توکن در هر تکه 2043 است.

شی customMetadata[] object ( CustomMetadata )

اختیاری. کاربر فوق داده های سفارشی را که به صورت جفت کلید-مقدار ذخیره می شود، ارائه می کند. حداکثر تعداد CustomMetadata در هر تکه 20 عدد است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Chunk است.

روش: corpora.documents.chunks.delete

یک Chunk حذف می کند.

نقطه پایانی

حذف https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

پارامترهای مسیر

string name

مورد نیاز. نام منبع Chunk برای حذف. مثال: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk به شکل corpora/{corpora}/documents/{document}/chunks/{chunk} است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

روش: corpora.documents.chunks.batchCreate

دسته ای ایجاد Chunk s.

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

پارامترهای مسیر

string parent

اختیاری. نام Document که این دسته از Chunk s در آن ایجاد خواهد شد. فیلد والد در هر 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

فیلدها
string parent

مورد نیاز. نام 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 s.

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

پارامترهای مسیر

string parent

اختیاری. نام Document که حاوی Chunk است که باید به‌روزرسانی شود. فیلد والد در هر UpdateChunkRequest باید با این مقدار مطابقت داشته باشد. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

درخواست بدن

بدنه درخواست شامل داده هایی با ساختار زیر است:

فیلدها
شی requests[] object ( UpdateChunkRequest )

مورد نیاز. پیام های درخواستی که Chunk هایی را برای به روز رسانی مشخص می کند. حداکثر 100 Chunk را می توان در یک دسته به روز کرد.

بدن پاسخگو

پاسخ از chunks.batchUpdate حاوی لیستی از Chunk روز رسانی شده s.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

فیلدها
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 s.

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

پارامترهای مسیر

string parent

اختیاری. نام Document حاوی Chunk که باید حذف شوند. فیلد والد در هر DeleteChunkRequest باید با این مقدار مطابقت داشته باشد. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

درخواست بدن

بدنه درخواست شامل داده هایی با ساختار زیر است:

فیلدها
شی requests[] object ( DeleteChunkRequest )

مورد نیاز. پیام های درخواستی که Chunk های حذف را مشخص می کند.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

DeleteChunkRequest

درخواست حذف یک Chunk

فیلدها
string name

مورد نیاز. نام منبع Chunk برای حذف. مثال: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

نمایندگی JSON 
{
  "name": string
}

منبع REST: corpora.documents.chunks

منبع: تکه

یک Chunk بخشی فرعی از یک Document است که به عنوان یک واحد مستقل برای اهداف نمایش برداری و ذخیره سازی در نظر گرفته می شود. یک Corpus حداکثر می تواند 1 میلیون Chunk داشته باشد.

فیلدها
string name

تغییرناپذیر. شناسه. نام منبع Chunk . شناسه (نام بدون پیشوند "corpora/*/documents/*/chunks/") می‌تواند حداکثر دارای 40 کاراکتر باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در هنگام ایجاد خالی باشد، یک شناسه منحصربه‌فرد 12 نویسه‌ای تصادفی ایجاد می‌شود. مثال: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object ( ChunkData )

مورد نیاز. محتوای Chunk ، مانند رشته متن. حداکثر تعداد توکن در هر تکه 2043 است.

شی customMetadata[] object ( CustomMetadata )

اختیاری. کاربر فوق داده های سفارشی را که به صورت جفت کلید-مقدار ذخیره می شود، ارائه می کند. حداکثر تعداد CustomMetadata در هر تکه 20 عدد است.

رشته createTime string ( Timestamp format)

فقط خروجی مهر زمانی مربوط به زمان ایجاد Chunk .

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

رشته updateTime string ( Timestamp format)

فقط خروجی مُهر زمانی آخرین به‌روزرسانی Chunk .

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

state enum ( State )

فقط خروجی وضعیت فعلی Chunk

نمایندگی JSON 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}

ChunkData

داده های استخراج شده که نشان دهنده محتوای Chunk است.

فیلدها

data میدان اتحادیه

data فقط می توانند یکی از موارد زیر باشند:

stringValue string

محتوای Chunk به عنوان یک رشته. حداکثر تعداد توکن در هر تکه 2043 است.

نمایندگی JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}

ایالت

حالات برای چرخه حیات یک Chunk

Enums
STATE_UNSPECIFIED مقدار پیش فرض اگر حالت حذف شود از این مقدار استفاده می شود.
STATE_PENDING_PROCESSING Chunk در حال پردازش است (جاسازی و ذخیره سازی برداری).
STATE_ACTIVE Chunk پردازش شده و برای پرس و جو در دسترس است.
STATE_FAILED پردازش Chunk ناموفق بود.