Method: corpora.documents.list

يسرد كل Document في Corpus.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
parent

string

مطلوبة. اسم Corpus الذي يتضمّن Document. مثال: corpora/my-corpus-123

معلمات طلب البحث

المَعلمات
pageSize

integer

اختياريّ. الحدّ الأقصى لعدد Document ثانية المطلوب عرضها (لكل صفحة). قد تعرِض الخدمة عدد أقل من Document ثوانٍ.

وفي حال عدم تحديد هذا الحقل، سيتم عرض 10 ثوانٍ على الأكثر من Document. الحدّ الأقصى للحجم هو 20 Document ثانية لكل صفحة.
pageToken

string

اختياريّ. رمز مميّز للصفحة تم تلقّيه من مكالمة سابقة لـ documents.list.

قدِّم nextPageToken المعروضة في الاستجابة كوسيطة للطلب التالي لاسترداد الصفحة التالية.

عند تقسيم النتائج على عدّة صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى documents.list مع الطلب الذي قدَّم الرمز المميّز للصفحة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

ردّ من documents.list يحتوي على قائمة مقسّمة على صفحات من Document. يتم ترتيب Document تصاعديًا حسب document.create_time.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
الحقول
documents[]

object (Document)

تم عرض Documents.
nextPageToken

string

رمز مميز يمكن إرساله كـ pageToken لاسترداد الصفحة التالية إذا تم حذف هذا الحقل، هذا يعني أنّ الصفحة لا تتضمّن المزيد من الصفحات.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، راجع نظرة عامة على المصادقة.