DeleteIndexDocument
从指定的非结构化知识库中永久删除一个或多个文档。暂不支持通过API删除结构化知识库中的知识,详情请参见下方接口说明
服务地址:
华东2 金融云
输入参数
只看必填
WorkspaceId知识库所属的业务空间 ID
IndexId知识库 ID
DocumentIds文档 ID 列表
0文档 ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • RAM 用户(子账号)需要首先获取百炼的数据权限(需要AliyunBailianDataFullAccess,已包括 sfm:DeleteIndexDocument 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 关于删除结构化知识库中的知识,详情请参见知识库
  • 调用本接口前,请确保您的知识库已经创建完成且未被删除(即知识库 IDIndexId有效)。
  • 仅能删除知识库中状态为导入失败(INSERT_ERROR)或导入成功(FINISH)的文档。如需查询指定知识库下的文档状态,可调用 ListIndexDocuments 接口。
  • 删除操作不可逆,被删的文档内容将无法恢复,且 Retrieve 接口将无法再获取其相关信息,请谨慎操作。
  • 调用本接口不会删除应用数据中已导入的文档。
  • 本接口具有幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。

请求语法

POST /{WorkspaceId}/index/delete_index_document HTTP/1.1

路径参数

字段名称字段详情
WorkspaceIdstring

知识库所属的业务空间 ID。获取方式请参见如何使用业务空间

示例值:llm-3z7uw7fwz0vxxxx

请求参数

字段名称字段详情
IndexIdstring

知识库 ID,即 CreateIndex 接口返回的Data.Id

示例值:79c0alxxxx参考取值来源:
    SubmitIndexJob
DocumentIdsarray<string>

文档 ID 列表。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:17204B98-xxxx-4F9A-8464-2446A84821CA
Codestring

错误状态码。

示例值:Index.InvalidParameter
Messagestring

错误信息。

示例值:Required parameter(%s) missing or invalid, please check the request parameters.
Successboolean

接口调用是否成功,可能值为:展开详情

示例值:true
Dataobject

接口业务数据字段。

Statusstring

接口返回的状态码。

示例值:200
变更历史
暂无变更历史