SubmitIndexJob - 提交索引创建任务

提交指定的 CreateIndex 任务以完成知识库创建。

接口说明

  1. 调用本接口前,您必须预先调用 CreateIndex 接口,并且获取到对应的IndexId
  2. 本接口调用成功后,将执行一段时间,请求返回前请勿重复发起请求。
  3. 本接口调用成功后,如果需要查询任务的执行状态,接下来可调用 GetIndexJobStatus 接口。
  4. 本接口不具备幂等性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:SubmitIndexJobcreate
*全部资源
*

请求语法

POST /{WorkspaceId}/index/submit_index_job HTTP/1.1

请求参数

名称类型必填描述示例值
WorkspaceIdstring

知识库所属的业务空间 ID。在百炼的控制台首页,单击页面左上角业务空间详情图标获取。

llm-3shx2gu255oqxxxx
IndexIdstring

知识库 ID,即 CreateIndex 接口返回的Data.Id

79c0alxxxx

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

错误状态码。

Index.InvalidParameter
Dataobject

接口返回的业务字段。

Idstring

任务 ID,即调用 GetIndexJobStatus 接口时需要用到的任务JobId

eFDr2fGRzP9gdDZWAdo3xxxx
IndexIdstring

知识库 ID。

79c0alxxxx
Messagestring

错误信息。

Required parameter(%s) missing or invalid, please check the request parameters.
RequestIdstring

请求 ID。

17204B98-xxxx-4F9A-8464-2446A84821CA
Statusstring

接口返回的状态码。

200
Successboolean

接口调用是否成功,可能值:

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "Index.InvalidParameter",
  "Data": {
    "Id": "eFDr2fGRzP9gdDZWAdo3xxxx",
    "IndexId": "79c0alxxxx"
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400RagIndex.IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.该请求使用与先前但不相同的请求相同的客户端令牌。不要重复使用具有不同请求的客户端令牌,除非请求相同。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史