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

如需了解详情,请参阅身份验证概览