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

获取 Chunk 的列表。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/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。允许的最大值为 1,000。大于 1,000 的值会强制转换为 1,000。

如果此字段为负数，则会返回 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
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

如需了解详情，请参阅 Authentication Overview。