Method: projects.locations.dataStores.branches.documents.chunks.list

מקבל רשימה של Chunk.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*/documents/*}/chunks

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

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

פרמטרים
parent

string

חובה. שם המשאב של מסמך ההורה, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

אם למבצע הקריאה אין הרשאה להציג את Chunks במסמך הזה, בין אם המסמך קיים ובין אם לא, מוחזרת שגיאת PERMISSION_DENIED.

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

פרמטרים
pageSize

integer

מספר המקסימלי של Chunks שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 100. הערך המקסימלי המותר הוא 1,000. ערכים גבוהים מ-1,000 יומרו ל-1,000.

אם הערך בשדה הזה שלילי, תוחזר שגיאת INVALID_ARGUMENT.
pageToken

string

טוקן של דף ListChunksResponse.next_page_token שהתקבל מקריאה קודמת של ChunkService.ListChunks. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-ChunkService.ListChunks חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.