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 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

documents.list 的回應，內含 Document 的分頁清單。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

詳情請參閱驗證總覽。