Method: corpora.documents.chunks.list

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

مولفه های
parent

string

ضروری. نام Document حاوی Chunk s. مثال: corpora/my-corpus-123/documents/the-doc-abc

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

مولفه های
pageSize

integer

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

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

pageToken

string

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

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

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

درخواست بدن

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

بدن پاسخگو

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

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

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

object ( Chunk )

Chunk برگشتی.

nextPageToken

string

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

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.