Skip to main content
同步任务

提交导入任务

向已创建的知识库追加导入文档,返回导入任务 ID(ingestionId),可通过查询任务状态接口跟踪执行进度。

前提

已获取 API Key 和业务空间 ID,并完成鉴权配置,详见API 总览与鉴权说明。

接口

POST /api/v1/indices/rag/index/job/create 向已创建的知识库追加导入文档。

请求体

字段必填类型说明
indexId是string知识库 ID
sourceType否string数据来源类型。DATA_CENTER_CATEGORY 表示按类目导入(需指定 categoryIds),DATA_CENTER_FILE 表示按文件导入(需指定 docIds)。不传此参数时,默认导入整个数据中心的全部文件,请谨慎使用
categoryIds否array<string>类目 ID 列表。当 sourceType 为 DATA_CENTER_CATEGORY 时必填
docIds否array<string>文件 ID 列表。当 sourceType 为 DATA_CENTER_FILE 时必填。注意参数名为 docIds,不是 documentIds 或 fileIds;传错名称时服务端会忽略该参数并返回 Index.InvalidParameter(Required parameter(dataSource.fileIds) missing)
chunkMode否string切片模式,用于对本次导入的文件单独设定分段策略(与知识库创建时的全局配置独立)。h1~h5 按对应层级的标题切分(h1 为一级标题,依此类推,最深支持到 h5 五级标题),length 按固定长度切分,page 按页切分,regex 按自定义正则切分
chunkSize否integer切片大小(字符数),取值范围 16000。chunkMode 为 length 时必填;chunkMode 为 h1h5 时若指定则一并考虑(未传入时使用默认值 500)
overlapSize否integer切片重叠大小(字符数),取值范围 01024。仅 chunkMode 为 length 时生效,按标题切分(h1h5)时不生效
separator否string切片分隔符,仅 chunkMode 为 regex 时生效;当 chunkMode 为 regex 时必填,否则返回 Index.InvalidParameter(Separator can't be null)
enableHeaders否boolean是否启用标题提取,默认 false

请求示例

curl -X POST "$BASE_URL/api/v1/indices/rag/index/job/create" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "indexId": "your-kb-id",
    "categoryIds": ["your-category-id"]
  }'
其中 BASE_URL 为 https://{workspace_id}.cn-beijing.maas.aliyuncs.com({workspace_id} 为业务空间 ID),BAILIAN_API_KEY 为阿里云百炼 API Key。

响应示例

提交成功返回 200。
{
  "code": "Success",
  "status_code": 200,
  "data": {
    "updated_at": 1782191904527,
    "created_at": 1782191904527,
    "ingestionId": "your-ingestion-id",
    "pipelineId": "your-kb-id",
    "status": "PENDING"
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

响应字段

字段类型说明
codestring响应码,成功时为 Success
status_codeintegerHTTP 状态码
request_idstring请求唯一标识,排查问题时请提供此 ID
successboolean请求是否成功
messagestring提示信息,成功时为 success
statusstring请求状态:SUCCESS 或 FAILED
dataobject响应数据。子字段 pipelineId(string,知识库 ID)、ingestionId(string,导入任务 ID)、status(string,任务状态,提交后为 PENDING)

错误码

HTTP 状态码错误码(code)说明
400Index.InvalidParameter请求参数无效:Required parameter missing or invalid.
401InvalidApiKeyAPI Key 无效或缺失:Invalid API-key provided.
Managed Agents
Sandbox
Security
RAG
应用调用
长期记忆
ParseX
框架