Method: corpora.documents.list

Liệt kê tất cả Document trong một Corpus.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
parent

string

Bắt buộc. Tên của Corpus chứa Document. Ví dụ: corpora/my-corpus-123

Tham số truy vấn

Các tham số
pageSize

integer

Không bắt buộc. Số lượng Document tối đa cần trả về (mỗi trang). Dịch vụ có thể trả về ít Document hơn.

Nếu không chỉ định, hệ thống sẽ trả về tối đa 10 Document. Giới hạn kích thước tối đa là 20 Document giây trên mỗi trang.
pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi documents.list trước đó.

Cung cấp nextPageToken được trả về trong phản hồi làm đối số cho yêu cầu tiếp theo để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác được cung cấp cho documents.list phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi từ documents.list chứa một danh sách các Document được phân trang. Document được sắp xếp theo document.create_time tăng dần.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Các trường
documents[]

object (Document)

Các Document được trả về.
nextPageToken

string

Mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua thì không có trang nào khác.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về xác thực.