Method: corpora.documents.list

列出 Corpus 中的所有 Document。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。包含 Document 的 Corpus 的名称。示例：corpora/my-corpus-123

查询参数

参数
pageSize

integer

可选。要返回的 Document 数量上限（每页）。服务返回的 Document 可能会减少。

如果未指定，则最多返回 10 个 Document。大小上限为每页 20 个 Document。
pageToken

string

可选。从之前的 documents.list 调用收到的页面令牌。

将响应中返回的 nextPageToken 作为参数提供给下一个请求，以检索下一页。

进行分页时，提供给 documents.list 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

来自包含 Document 的分页列表的 documents.list 的响应。Document 按 document.create_time 升序排序。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
字段
documents[]

object (Document)

返回的 Document。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不会再显示页面。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅身份验证概览。