Method: corpora.documents.list

Перечисляет все Document в Corpus .

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Название Corpus , содержащего Document s. Пример: corpora/my-corpus-123

Параметры запроса

Параметры
pageSize

integer

Необязательный. Максимальное количество возвращаемых Document (на страницу). Служба может возвращать меньше Document s.

Если не указано, будет возвращено не более 10 Document s. Максимальный размер документа составляет 20 Document на страницу.

pageToken

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова documents.list .

Предоставьте nextPageToken , возвращенный в ответе, в качестве аргумента для следующего запроса на получение следующей страницы.

При разбиении на страницы все остальные параметры, предоставленные в documents.list должны соответствовать вызову, который предоставил токен страницы.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ от documents.list , содержащий постраничный список Document s. Document s сортируются по возрастанию document.create_time .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Поля
documents[]

object ( Document )

Возвращенный Document s.

nextPageToken

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено, страниц больше нет.

Области авторизации

Требуется одна из следующих областей OAuth:

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

Для получения дополнительной информации см. Обзор аутентификации .