查询任务接口
功能介绍
查询当前知识库的任务详情。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
repo_id |
是 |
String |
参数解释: 知识库ID。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_size |
否 |
Integer |
参数解释: 每页显示的记录数,表示一次请求返回的数据条数。默认值为10,表示一页展示10条数据。 约束限制: 不涉及 取值范围: 1-65535 默认取值: 10 |
page_num |
否 |
Integer |
参数解释: 当前请求的页码,表示从第几页开始获取数据。默认值为1,表示第一页。 约束限制: 不涉及 取值范围: 1~65535 默认取值: 1 |
task_type |
否 |
String |
参数解释: 任务类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
task_status |
否 |
String |
参数解释: 任务状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
file_name |
否 |
String |
参数解释: 文档名。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释: 任务总数。 取值范围: 不涉及 |
page_size |
Integer |
参数解释: 页码。 取值范围: 不涉及 |
page_num |
Integer |
参数解释: 每页数量。 取值范围: 不涉及 |
fail_count |
Integer |
参数解释: 失败任务数量。 取值范围: 不涉及 |
success_count |
Integer |
参数解释: 成功任务数量。 取值范围: 不涉及 |
running_count |
Integer |
参数解释: 正在运行任务数量。 取值范围: 不涉及 |
pending_count |
Integer |
参数解释: 正在排队任务数量。 取值范围: 不涉及 |
tasks |
Array of TaskInfo objects |
参数解释: 任务列表。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 任务ID。 取值范围: 不涉及 |
name |
String |
参数解释: 文档名。 取值范围: 不涉及 |
type |
String |
参数解释: 任务类型。 取值范围: 不涉及 |
status |
String |
参数解释: 任务状态。 取值范围: 不涉及 |
process |
Float |
参数解释: 任务进度。 取值范围: 不涉及 |
create_time |
String |
参数解释: 任务创建时间。 取值范围: 不涉及 |
task_desc |
String |
参数解释: 任务描述。 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
查询当前知识库的任务详情。
/v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks?task_type=QA&task_status=SUCCESS&page_size=2
响应示例
状态码:200
任务列表响应体。
{ "fail_count" : 0, "success_count" : 3, "running_count" : 0, "pending_count" : 0, "total" : 3, "page_num" : 1, "page_size" : 2, "tasks" : [ { "id" : "30fafbb1-a118-4859-ba0e-45b3bf3fdbb1", "name" : "电商建站SaaS接口文档v1.0.0.docx", "type" : "QA", "status" : "SUCCESS", "process" : 1, "create_time" : "1713183918628" }, { "id" : "03b1677d-19dd-4883-8598-ad3c18769d60", "name" : "创新营NUWA MiniDemo开发指南 2021-10-12-v07.docx", "type" : "QA", "status" : "SUCCESS", "process" : 1, "create_time" : "1713183918592", "task_desc" : "阿萨德" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
任务列表响应体。 |
400 |
请求体参数错误。 |
500 |
内部异常。 |
错误码
请参见错误码。