全部产品
Search

搜索本产品

    大模型服务平台百炼：SubmitIndexAddDocumentsJob - 提交索引追加任务

    文档中心

    大模型服务平台百炼：SubmitIndexAddDocumentsJob - 提交索引追加任务

    更新时间：Dec 03, 2024

    向一个非结构化知识库追加导入已解析的文档。结构化知识库暂不支持通过API追加导入新知识，详情请参见下方接口说明。

    接口说明

    • 关于向结构化知识库追加导入新知识，详情请参见更新知识库。
    • 调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 IDIndexId有效）。
    • 调用该接口前，请先调用 AddFile 接口将您需要追加导入的文档上传至百炼。
    • 本接口调用成功后，如果需要查询任务的执行状态，接下来您可调用 GetIndexJobStatus 接口。注意 GetIndexJobStatus 接口频繁调用会被限流，频率请勿高于 20 次/分钟。
    • 本接口调用成功后，将执行一段时间，请求返回前请勿重复发起请求。本接口不具备幂等性。

    调试

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

    授权信息

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

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

    请求语法

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

    请求参数

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

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

    		llm-3shx2gu255oqxxxx
    IndexIdstring是

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

    		79c0alxxxx
    SourceTypestring是

    数据管理的数据类型。 更多信息，请参见知识库。取值范围：

    • DATA_CENTER_CATEGORY：类目类型，即导入数据中心指定类目下的所有文档，支持导入多个类目。
    • DATA_CENTER_FILE：文档类型，即导入数据中心下的指定文档，支持导入多个文档。
    说明 如果本参数传入 DATA_CENTER_CATEGORY，则必须指定CategoryIds参数；如果本参数传入 DATA_CENTER_FILE，则必须指定DocumentIds参数。
    		DATA_CENTER_FILE
    DocumentIdsarray否

    文档 ID 列表。

    string否

    文档 ID，即 AddFile 接口返回的FileId。您也可以在数据管理页面，单击文件名称旁的 ID 图标获取。

    		doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx
    CategoryIdsarray否

    类目 ID 列表。

    string否

    类目 ID，即 AddCategory 接口返回的CategoryId。您也可以在数据管理-非结构化数据页面，单击类目旁的 ID 图标获取。

    		cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    		778C0B3B-xxxx-5FC1-A947-36EDD13606AB
    Dataobject

    接口返回的业务字段。

    Idstring

    任务 ID，又称JobId。

    		42687eb254a34802bed398357f5498ae
    Statusstring

    接口返回的状态码。

    		200
    Successboolean

    接口调用是否成功，可能值为：

    • true：成功。
    • false：失败。
    		true
    Messagestring

    错误信息。

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

    错误状态码。

    		Index.InvalidParameter

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": "200",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter"
}

    错误码

    HTTP status code错误码错误信息
    400IdempotentParameterMismatchThe 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.

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

    变更历史

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