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

למידע נוסף, קראו את הסקירה הכללית על אימות.