Method: corpora.documents.list

Mencantumkan semua Document dalam Corpus.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama Corpus yang berisi Document. Contoh: corpora/my-corpus-123

Parameter kueri

Parameter
pageSize

integer

Opsional. Jumlah maksimum Document untuk ditampilkan (per halaman). Layanan mungkin menampilkan lebih sedikit Document.

Jika tidak ditentukan, maksimal 10 Document akan ditampilkan. Batas ukuran maksimum adalah 20 Document per halaman.
pageToken

string

Opsional. Token halaman, diterima dari panggilan documents.list sebelumnya.

Berikan nextPageToken yang ditampilkan dalam respons sebagai argumen ke permintaan berikutnya untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk documents.list harus cocok dengan panggilan yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari documents.list yang berisi daftar Document yang diberi nomor halaman. Document diurutkan dengan document.create_time menaik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Kolom
documents[]

object (Document)

Document yang ditampilkan.
nextPageToken

string

Token, yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, berarti tidak ada halaman lagi.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.