启动知识导入任务
POST /studio/rag/chat/v1/datasets/{dataset_id}/jobs/{job_id}:start
请求头(Request Header)
Authorization 可以使用如下两种Header
- 动态生成 Authorization Header, 参考认证(authentication)
-H "X-Date: $xdate" \
-H "Authorization: $auth"
- 直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'
请求参数(Request Parameters)
| 名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
| dataset_id | string | 是 | 知识库的ID. |
| job_id | string | 是 | 要启动的任务的ID. |
请求体(Request Body)
| 参数 | 类型 | 必须 | 描述 |
|---|---|---|---|
| documents | array[object] | 否 | 包含上传到AOSS临时路径的失败文件信息列表. |
| failed_file_size | int64 | 否 | 上传到AOSS临时路径的失败文件总大小. |
| failed_file_count | int64 | 否 | 上传到AOSS临时路径的失败文件总数量. |
其中,documents的参数如下
| 名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
| document_id | string | 否 | 文档ID. |
| display_name | string | 否 | 知识名称. |
| segment_count | int64 | 否 | 文档的段数量. |
| document_token | int64 | 否 | 标记数. |
| document_state | integer($enum) | 否 | 知识状态(例如:UNKNOWN). |
| document_error | integer($enum) | 否 | 失败原因(例如:UNKNOWN). |
| document_size | int64 | 否 | 文档大小. |
其中,document_state有如下情况
| 枚举值 | 数值 | 含义 |
|---|---|---|
| DOCUMENT_STAGE_UNSPECIFIED | 0 | 未指定 |
| DOCUMENT_PARSING | 1 | 正在解析 |
| DOCUMENT_PARSED_SUCCESSFULLY | 2 | 解析成功 |
| DOCUMENT_PARSING_FAILED | 3 | 解析失败 |
| DOCUMENT_PARSING_CANCELLED | 4 | 已取消 |
| DOCUMENT_QUEUED | 5 | 排队中 |
| DOCUMENT_CRAWLING | 6 | 抓取中 |
| DOCUMENT_CRAWLING_FAILED | 7 | 抓取失败 |
其中,document_error有如下情况
| 枚举值 | 数值 | 含义 |
|---|---|---|
| DOCUMENT_ERROR_UNSPECIFIED | 0 | 未知原因 |
| UNSUPPORTED_FORMAT | 1 | 不支持的格式 |
| UNSUPPORTED_WEBSITE_CRAWLING | 2 | 不支持的网站抓取 |
| OTHER_TECHNICAL_REASONS | 3 | 其他技术原因 |
| DOWNLOAD_FAILURE | 4 | 文档存储失败 |
| STORAGE_FAILURE | 5 | 文档存储失败 |
| STORAGE_TIMEOUT | 6 | 文档存储超时 |
| UPLOAD_FAILURE | 7 | 文档上传到AOSS失败 |
请求示例(Request Example)
curl 'https://rag.cn-sh-01.sensecoreapi.cn/studio/rag/chat/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,无特殊返回.