更新时间:2025-07-22 GMT+08:00
分享

批量删除文档接口

功能介绍

根据多个文档ID,进行文档批量删除。

URI

DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/batch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

application_id

String

参数解释:

应用ID,获取方法请参见获取应用ID

约束限制:

字符串

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

repo_id

String

参数解释:

知识库ID。

获取方式:

账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

file_ids

Array of strings

参数解释:

文件ID数组。

约束限制:

不涉及

取值范围:

文件ID只能包含1到64位数字、字母、中划线和下划线。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

预期删除文档总数。

取值范围:

不涉及

deleted_count

Integer

参数解释:

成功删除文档总数。

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

请求示例

批量删除文档接口。

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/0c3fae2d-428e-454c-ad80-2e5c5fa7b33a/files/batch

{
  "file_ids" : [ "520543f5c9eaa1e192963b2cb8fb0d0b", "48b60057c4d83a519745c30bda653022" ]
}

响应示例

状态码:200

删除成功。

{
  "total_count" : 1,
  "deleted_count" : 1
}

状态码

状态码

描述

200

删除成功。

400

参数错误。

500

内部异常。

错误码

请参见错误码

相关文档