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

批量创建任务接口

功能介绍

批量创建任务。

URI

POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks

表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参数

参数

是否必选

参数类型

描述

task_type

String

参数解释:

任务类型

约束限制:

不涉及

取值范围:

  • QA: QA生成任务,

  • DELETE_TABLES: 表格删除,

  • TABLE_EXTRACTION:表格生成任务,

  • RETRY_FILES: 批量文件重试。

默认取值:

不涉及

file_ids

Array of strings

参数解释:

文件ID列表。

约束限制:

不涉及

取值范围:

文件ID,长度在1到64之间,只能包含字母、数字、下划线和短横线。

默认取值:

不涉及

task_context

TaskContext object

参数解释:

任务上下文。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 TaskContext

参数

是否必选

参数类型

描述

is_inherit_parser

Boolean

参数解释:

是否继承解析器的标志位。

取值范围:

不涉及

file_ids

Array of strings

参数解释:

文件ID列表。

取值范围:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

需要创建任务数量。

取值范围:

不涉及

created_count

Integer

参数解释:

成功创建任务数量。

取值范围:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

请求示例

  • 批量QA生成

    /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks
    
    {
      "file_ids" : [ "313dc4fa-da64-4d97-b31c-2d557985ca14", "89f52509-e5c6-4a1a-8891-cb333b74f81a" ],
      "task_type" : "QA"
    }
  • 批量文件重试

    /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks
    
    {
      "task_type" : "RETRY_FILES",
      "file_ids" : [ "1fee542f05221fec339810e38e6e3718", "2f6053aa43ecbc36e87494c05f32019d", "61e5504a20be43e1b1c7379702e95087" ]
    }

响应示例

状态码:200

批量创建任务返回体。

{
  "total_count" : 1,
  "created_count" : 1
}

状态码

状态码

描述

200

批量创建任务返回体。

400

请求体参数错误。

500

内部异常。

错误码

请参见错误码

相关文档