启动知识导入任务 | 大装置帮助中心
跳到主要内容

启动知识导入任务

POST /studio/rag/data/v1/datasets/{dataset_id}/jobs/{job_id}:start

请求头(Request Header)

Authorization 可以使用如下两种Header

-H "X-Date: $xdate" \
-H "Authorization: $auth"
  • 直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求参数(Request Parameters)

名称类型必须描述
dataset_idstring知识库的ID.
job_idstring要启动的任务的ID.

请求体(Request Body)

参数类型必须描述
documentsarray[object]包含上传到AOSS临时路径的失败文件信息列表.
failed_file_sizeint64上传到AOSS临时路径的失败文件总大小.
failed_file_countint64上传到AOSS临时路径的失败文件总数量.

其中,documents的参数如下

名称类型必须描述
document_idstring文档ID.
display_namestring知识名称.
segment_countint64文档的段数量.
document_tokenint64标记数.
document_stateinteger($enum)知识状态(例如:UNKNOWN).
document_errorinteger($enum)失败原因(例如:UNKNOWN).
document_sizeint64文档大小.

其中,document_state有如下情况

枚举值数值含义
DOCUMENT_STAGE_UNSPECIFIED0未指定
DOCUMENT_PARSING1正在解析
DOCUMENT_PARSED_SUCCESSFULLY2解析成功
DOCUMENT_PARSING_FAILED3解析失败
DOCUMENT_PARSING_CANCELLED4已取消
DOCUMENT_QUEUED5排队中
DOCUMENT_CRAWLING6抓取中
DOCUMENT_CRAWLING_FAILED7抓取失败

其中,document_error有如下情况

枚举值数值含义
DOCUMENT_ERROR_UNSPECIFIED0未知原因
UNSUPPORTED_FORMAT1不支持的格式
UNSUPPORTED_WEBSITE_CRAWLING2不支持的网站抓取
OTHER_TECHNICAL_REASONS3其他技术原因
DOWNLOAD_FAILURE4文档存储失败
STORAGE_FAILURE5文档存储失败
STORAGE_TIMEOUT6文档存储超时
UPLOAD_FAILURE7文档上传到AOSS失败

请求示例(Request Example)

curl 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/datasets/rag_feca3cbcc636484ca14195716d8aa588/jobs/3a53339f20964667b4c17949e8ddb20f:start' \
-H "X-Date: $xdate" \
-H "Authorization: $auth" \
-X POST \
--data-raw '{
"dataset_id":"rag_feca3cbcc636484ca14195716d8aa588",
"job_id":"3a53339f20964667b4c17949e8ddb20f",
"failed_file_count":0,
"failed_file_size":0,
"documents":[]
}'

响应示例(Response Example)

正常HTTP状态码为200,无特殊返回.