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

获取 Document 的列表。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父分支资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}。使用 default_branch 作为分支 ID，以列出默认分支下的文档。

如果调用者无权列出相应分支下的 Document，无论该分支是否存在，系统都会返回 PERMISSION_DENIED 错误。

查询参数

参数
pageSize

integer

要返回的 Document 数量上限。如果未指定，则默认为 100。允许的最大值为 1000。大于 1000 的值会设置为 1000。

如果此字段为负数，则返回 INVALID_ARGUMENT 错误。
pageToken

string

从之前的 DocumentService.ListDocuments 调用接收的页面令牌 ListDocumentsResponse.next_page_token。利用其进行后续页面检索。

进行分页时，提供给 DocumentService.ListDocuments 的所有其他参数必须与提供页面令牌的调用匹配。 否则，系统将返回 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 ListDocumentsResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • discoveryengine.documents.list

如需了解详情，请参阅 IAM 文档。