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

取得 Chunk 清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標,父項文件資源名稱,例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}

如果呼叫者沒有列出這份文件下 Chunk 的權限,無論這份文件是否存在,系統都會傳回 PERMISSION_DENIED 錯誤。

查詢參數

參數
pageSize

integer

要傳回的 Chunk 數量上限。如未指定,則預設為 100。允許的最大值為 1000。超出的數值將一律指定為 1000。

如果這個欄位為負數,系統會傳回 INVALID_ARGUMENT 錯誤。

pageToken

string

屬於接收自前一個 ChunkService.ListChunks 呼叫的網頁權杖 ListChunksResponse.next_page_token。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ChunkService.ListChunks 的所有其他參數須與提供網頁權杖的呼叫相符。否則,系統會傳回 INVALID_ARGUMENT 錯誤。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會包含 ListChunksResponse 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱Authentication Overview