查询指定的知识库创建任务或知识库追加任务的当前状态。
接口说明
- 您需要有一个正在执行中的知识库作业任务（创建知识库任务可以调用 SubmitIndexJob 接口，创建知识库追加任务可以调用 SubmitIndexAddDocumentsJob 接口），并且获得相应的
JobId。 - 本接口调用间隔建议在 5 秒以上。
- 本接口具有幂等性。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| sfm:GetIndexJobStatus | get |
|
| 无 |
请求语法
GET /{WorkspaceId}/index/job/status HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 知识库所属的业务空间 ID。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。 | llm-3z7uw7fwz0vexxxx |
| JobId | string | 是 | 知识库作业任务 ID，即 SubmitIndexJob 接口或 SubmitIndexAddDocumentsJob 接口返回的 | 20230718xxxx-146c93bf |
| IndexId | string | 是 | 知识库 ID，即 CreateIndex 接口返回的 | 79c0alxxxx |
| PageNumber | integer | 否 | SubmitIndexJob 接口和 SubmitIndexAddDocumentsJob 接口均支持批量导入文档。本接口返回的字段包括知识库作业任务的总状态 | 1 |
| pageSize | integer | 否 | 指定分页查询时每页展示的文档导入任务数量。最大值不限。默认值为 10。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "Index.Forbidden",
"Data": {
"Documents": [
{
"Code": "Index.Document.ChunkError",
"DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
"DocName": "XXX产品介绍",
"Message": "document parse error",
"Status": "RUNNING"
}
],
"JobId": "66122af12a4e45ddae6bd6c84555xxxx",
"Status": "PENDING"
},
"Message": "User not authorized to operate on the specified resource.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史