Method: corpora.documents.chunks.list

רשימה של כל הפריטים מסוג Chunk בDocument.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. השם של Document שמכיל Chunk. דוגמה: corpora/my-corpus-123/documents/the-doc-abc

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אפשרות. המספר המרבי של Chunk שניות להחזרה (לכל דף). השירות עשוי להחזיר פחות Chunk שניות.

אם לא צוין, יוחזרו עד 10 ערכי Chunk. הגודל המקסימלי הוא 100 Chunks לדף.
pageToken

string

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

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

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

גוף הבקשה

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

גוף התשובה

תשובה מאת chunks.list שמכילה רשימה מעומדת של Chunk. הערכים מסוג Chunk ממוינים לפי chunk.create_time בסדר עולה.

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

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

object (Chunk)

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

string

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

היקפי הרשאות

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

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

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