Method: corpora.documents.delete

刪除 Document

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

必要欄位。要刪除的 Document 資源名稱。範例:corpora/my-corpus-123/documents/the-doc-abc

查詢參數

參數
force

boolean

選用設定。如果設為 True,與這個 Document 相關的所有 Chunk 和物件都會一併刪除。

如果為 false (預設值),如果 Document 包含任何 Chunk,系統會傳回 FAILED_PRECONDITION 錯誤。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會是空白的。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱驗證總覽