Method: corpora.documents.delete

Xoá Document.

Yêu cầu HTTP

DELETE https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

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

Tham số đường dẫn

Các tham số
name

string

Bắt buộc. Tên tài nguyên của Document cần xoá. Ví dụ: corpora/my-corpus-123/documents/the-doc-abc

Tham số truy vấn

Các tham số
force

boolean

Không bắt buộc. Nếu bạn đặt chính sách này thành true, thì mọi Chunk và đối tượng liên quan đến Document này cũng sẽ bị xoá.

Nếu giá trị là false (mặc định), thì hệ thống sẽ trả về lỗi FAILED_PRECONDITION nếu Document chứa Chunk bất kỳ.

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

Nếu thành công, nội dung phản hồi sẽ trống.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

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