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

批量修改文档目录

功能介绍

批量移动知识库文档到指定目录。

URI

PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/files

表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列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

directory_id

String

参数解释:

移动到的目录id,可传入null,代表文档不设置目录。 长度不能超过64个字符。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

directory_id

String

参数解释:

目录id。

取值范围:

不涉及

success_file_ids

Array of strings

参数解释:

成功修改的文档数量。

取值范围:

不涉及

filter_same_category_file_ids

Array of strings

参数解释:

过滤掉的目录没变化文档。

取值范围:

不涉及

filter_exist_file_ids

Array of strings

参数解释:

过滤掉的目标目录已存在的文档。

取值范围:

不涉及

filter_not_in_status_file_ids

Array of strings

参数解释:

过滤掉的非SUCCESS、ERROR状态的文档,非SUCCESS、ERROR状态的文档不可移动。

取值范围:

不涉及

请求示例

批量移动知识库文档到指定目录。

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

{
  "file_ids" : [ "622f8e93ec50f5ce415afdd670a00527", "61170c6fc8cc84a0f546556ce1956c1a" ],
  "directory_id" : "0b6a2f30-3f66-4e8b-bbeb-5dd8cb56b38ea"
}

响应示例

状态码:200

更新文档目录响应。

{
  "directory_id" : "c327c4d7-6f4c-4b9a-8116-c1222b65d02b",
  "success_file_ids" : [ "8036fcab50cf21f9a1b9a3f80f2f320c", "9a3f96119a766d0087e2d99560d26d80", "3a4bc212ce2761e9a7f71b22507ab68b" ],
  "filter_same_category_file_ids" : [ ],
  "filter_exist_file_ids" : [ ],
  "filter_not_in_status_file_ids" : [ ]
}

状态码

状态码

描述

200

更新文档目录响应。

错误码

请参见错误码

相关文档