Method: corpora.list

يسرد كل Corpora التي يملكها المستخدم.

طلب HTTP

GET https://generativelanguage.googleapis.com/v1beta/corpora

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

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

المَعلمات
pageSize

integer

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

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

string

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

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

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

نص الطلب

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

نص الاستجابة

رد من corpora.list يحتوي على قائمة مقسّمة على صفحات من Corpora. يتم ترتيب النتائج تصاعديًا باستخدام corpus.create_time.

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

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

object (Corpus)

الأجزاء التي تم إرجاعها.
nextPageToken

string

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

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

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

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

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