Method: corpora.documents.list

تمام Document موجود در یک Corpus را فهرست می کند.

درخواست HTTP

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

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

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

مولفه های
parent

string

ضروری. نام Corpus حاوی Document s. مثال: corpora/my-corpus-123

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

مولفه های
pageSize

integer

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

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

pageToken

string

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

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

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

درخواست بدن

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

بدن پاسخگو

پاسخ از documents.list حاوی فهرست صفحه بندی شده از Document s. Document بر اساس صعودی document.create_time مرتب شده اند.

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

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

object ( Document )

Document برگشتی s.

nextPageToken

string

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

محدوده مجوز

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

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

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