获取文档目录
功能介绍
获取知识库下的文档目录信息。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
repo_id |
是 |
String |
参数解释: 知识库ID。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
directory_list |
Array of DirectoryInfo objects |
参数解释: 目录列表。 取值范围: 不涉及 |
total |
Integer |
参数解释: 返回的目录总数。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 目录名称。 取值范围: 不涉及 |
id |
String |
参数解释: 目录id。 取值范围: 不涉及 |
parent_id |
String |
参数解释: 父节点目录id,为null时,标识这个节点为父节点。 取值范围: 不涉及 |
level |
Integer |
参数解释: 目录层级,最高5层。 取值范围: 不涉及 |
create_time |
String |
参数解释: 创建时间。 取值范围: 不涉及 |
update_time |
String |
参数解释: 修改时间。 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
获取知识库下的文档目录信息响应成功。
{ "directory_list" : [ { "id" : "0b6a2f30-3f66-4e8b-bbeb-5dd8cb56b38ea", "name" : "new", "parent_id" : null, "level" : 1, "create_time" : "1733121281012", "update_time" : "1733121281012" }, { "id" : "2290f133-192b-404a-89bc-c31d3a4a2056", "name" : "一级目录1-二级目录2", "parent_id" : "c7bdbc50-8fba-4164-9b83-a0e19908cbef", "level" : 2, "create_time" : "1733132651531", "update_time" : "1733132651531" }, { "id" : "a63faf94-d9ae-4a46-a297-8d0518d2ffa9", "name" : "一级目录1-二级目录2-三级目录2", "parent_id" : "c7bdbc50-8fba-4164-9b83-a0e19908cbef", "level" : 2, "create_time" : "1733226105107", "update_time" : "1733226105107" }, { "id" : "c7bdbc50-8fba-4164-9b83-a0e19908cbef", "name" : "一级目录1", "parent_id" : null, "level" : 1, "create_time" : "1733132627960", "update_time" : "1733132627960" }, { "id" : "ca7dbbf5-0082-492c-8d3a-e28e9a456d89", "name" : "一级目录1-二级目录1", "parent_id" : "c7bdbc50-8fba-4164-9b83-a0e19908cbef", "level" : 2, "create_time" : "1733132648783", "update_time" : "1733132648783" } ], "total" : 5 }
状态码
状态码 |
描述 |
---|---|
200 |
获取知识库下的文档目录信息响应成功。 |
400 |
请求体参数错误。 |
500 |
内部异常。 |
错误码
请参见错误码。