SubmitIndexAddDocumentsJob
向一个非结构化知识库追加导入已解析的文档。结构化知识库暂不支持通过API追加导入新知识,详情请参见下方接口说明
服务地址:
华东2 金融云
输入参数
只看必填
WorkspaceId知识库所属的业务空间 ID
IndexId知识库 ID
SourceType应用数据的数据类型
DocumentIds文档 ID 列表
0文档 ID
CategoryIds类目 ID 列表
0类目 ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 关于向结构化知识库追加导入新知识,详情请参见更新知识库
  • RAM 用户(子账号)需要首先获取百炼的数据权限(需要AliyunBailianDataFullAccess,已包括 sfm:SubmitIndexAddDocumentsJob 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 调用本接口前,请确保您的知识库已经创建完成且未被删除(即知识库 IDIndexId有效)。
  • 调用该接口前,请先调用 AddFile 接口将您需要追加导入的文档上传至百炼。
  • 本接口调用成功后,如果需要查询任务的执行状态,接下来您可调用 GetIndexJobStatus 接口。此接口返回的文档列表Documents包含了您此次追加全部文档,您可以查看每个文档是否导入(解析)成功。注意频繁调用 GetIndexJobStatus 接口会被限流,频率请勿高于 20 次/分钟。
  • 本接口调用成功后,将执行一段时间,请求返回前请勿重复发起请求。本接口不具备幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。

请求语法

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

路径参数

字段名称字段详情
WorkspaceIdstring

知识库所属的业务空间 ID。获取方式请参见如何使用业务空间

示例值:llm-3shx2gu255oqxxxx

请求参数

字段名称字段详情
IndexIdstring

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

示例值:79c0alxxxx参考取值来源:
    SubmitIndexJob
SourceTypestring

应用数据的数据类型。展开详情

示例值:DATA_CENTER_FILE枚举值:DATA_CENTER_CATEGORYDATA_CENTER_FILE
DocumentIdsarray<string>

文档 ID 列表。

CategoryIdsarray<string>

类目 ID 列表。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Dataobject

接口返回的业务字段。

Statusstring

接口返回的状态码。

示例值:200
Successboolean

接口调用是否成功,可能值为:展开详情

示例值:true
Messagestring

错误信息。

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

错误状态码。

示例值:Index.InvalidParameter
变更历史
暂无变更历史