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 Documents לדף.
pageToken

string

אפשרות. אסימון דף שהתקבל משיחה קודמת ב-documents.list.

יש לספק את ה-nextPageToken שהוחזר כארגומנט לבקשה הבאה לאחזור הדף הבא.

במהלך החלוקה לדפים, כל הפרמטרים האחרים שסיפקתם ל-documents.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תשובה מאת documents.list שמכילה רשימה מעומדת של Document. הערכים מסוג Document ממוינים לפי document.create_time בסדר עולה.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
שדות
documents[]

object (Document)

ה-Document שהוחזרו.
nextPageToken

string

אסימון שניתן לשלוח בתור pageToken לאחזור הדף הבא. אם שדה זה יושמט, לא יופיעו דפים נוספים.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

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

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