提交导入任务 - Knowledge Studio

POST

/api/v1/indices/rag/index/job/create

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/job/create" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "indexId": "your_kb_id",
    "categoryIds": ["cate_abc123"]
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "updated_at": 1782191904527,
    "created_at": 1782191904527,
    "ingestionId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "pipelineId": "your_kb_id",
    "status": "PENDING"
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Body

application/json

string

required

知识库 ID。

enum<string>

数据来源类型（可选）。DATA_CENTER_CATEGORY 表示按类目导入（需指定 categoryIds），DATA_CENTER_FILE 表示按文件导入（需指定 docIds）。不传此参数时，默认导入整个数据中心的全部文件，请谨慎使用。

Available options:DATA_CENTER_CATEGORY,DATA_CENTER_FILE

string[]

类目 ID 列表。当 sourceType 为 DATA_CENTER_CATEGORY 时必填。

string[]

文件 ID 列表。当 sourceType 为 DATA_CENTER_FILE 时必填。注意参数名为 docIds，不是 documentIds 或 fileIds；传错名称时服务端会忽略该参数并返回 Index.InvalidParameter（Required parameter(dataSource.fileIds) missing）。

enum<string>

切片模式，用于对本次导入的文件单独设定分段策略（与知识库创建时的全局配置独立）。h1~h5 按对应层级的标题切分（h1 为一级标题，依此类推，最深支持到 h5 五级标题），length 按固定长度切分，page 按页切分，regex 按自定义正则切分。

Available options:h1,h2,h3,h4,h5,length,page,regex

integer

切片大小（字符数），取值范围 1~6000。chunkMode 为 length 时必填；chunkMode 为 h1~h5 时若指定则一并考虑（未传入时使用默认值 500）。

Required range:1 <= x <= 6000

integer

切片重叠大小（字符数），取值范围 0~1024。仅 chunkMode 为 length 时生效，按标题切分（h1~h5）时不生效。

Required range:0 <= x <= 1024

string

切片分隔符，仅 chunkMode 为 regex 时生效；当 chunkMode 为 regex 时必填，否则返回 Index.InvalidParameter（Separator can't be null）。

boolean

defaultfalse

是否启用标题提取，默认 false。

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

请求唯一标识，排查问题时请提供此 ID。

object

Show child attributes

string

知识库 ID。

string

导入任务 ID。

string

任务状态，提交后为 PENDING。

boolean

请求是否成功。

string

提示信息，成功时为 success。

string

请求状态：SUCCESS 或 FAILED。