从指定的非结构化知识库中永久删除一个或多个文档。暂不支持通过API删除结构化知识库中的知识，详情请参见下方接口说明。
接口说明
- 关于删除结构化知识库中的知识，详情请参见知识库。
- 调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 ID
IndexId有效）。 - 仅能删除知识库中状态为导入失败（INSERT_ERROR）或导入成功（FINISH）的文档。如需查询指定知识库下的文档状态，可调用 ListIndexDocuments 接口。
- 删除操作不可逆，被删的文档内容将无法恢复，且 Retrieve 接口将无法再获取其相关信息，请谨慎操作。
- 调用本接口不会删除数据管理中已导入的文档。
- 本接口具有幂等性。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| sfm:DeleteIndexDocument | delete | *全部资源 * |
| 无 |
请求语法
POST /{WorkspaceId}/index/delete_index_document HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 知识库所属的业务空间 ID。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。 | llm-3z7uw7fwz0vxxxx |
| IndexId | string | 是 | 知识库 ID，即 CreateIndex 接口返回的 | 79c0alxxxx |
| DocumentIds | array | 是 | 文档 ID 列表。 | |
| string | 是 | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "Index.InvalidParameter",
"Data": {
"DeletedDocument": [
"file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx"
]
},
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}错误码
访问错误中心查看更多错误码。