AddFile
将存储于百炼临时存储空间内的非结构化文档导入至百炼数据管理。不支持通过API导入结构化文档,请通过控制台导入
服务地址:
华东2 金融云
输入参数
只看必填
LeaseId文档上传租约 ID
Parser解析器类型枚举值
CategoryId- 上传文档所属类目 ID
WorkspaceId业务空间 ID
Tags文档关联的标签列表
0文档的标签
CategoryType类目类型
插件下载了解更多
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:AddFile 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 调用此接口前,请确保已通过 ApplyFileUploadLease 接口获取到上传租约并成功上传文档(支持本地或从对象存储 OSS 上传)至百炼的临时存储空间。示例代码请参考 通过 API 上传文档
说明 该接口调用成功后,租约 ID 即刻失效,请勿使用相同的租约 ID 重复提交。
  • 请务必在成功调用 ApplyFileUploadLease 接口后的 12 小时内调用本接口,否则会因租约过期导致调用失败。

  • 本接口调用成功后,系统将开始解析并导入文档。整个过程需一定时间,请耐心等待。

  • 每个业务空间最多导入 10 万个文档。

  • 调用本接口导入至数据管理的原始文档仅用于导入知识库前的临时存储,有效期为 90 天,不支持长期保存,请自行妥善保存原文档。

  • 本接口不具备幂等性。

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

请求语法

PUT /{WorkspaceId}/datacenter/file HTTP/1.1

路径参数

字段名称字段详情
WorkspaceIdstring

业务空间 ID,即文档将上传至该业务空间中。获取方式请参见如何使用业务空间

示例值:llm-3shx2gu255oqxxxx

请求参数

字段名称字段详情
LeaseIdstring

文档上传租约 ID,对应 ApplyFileUploadLease 接口返回的 FileUploadLeaseId

示例值:68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx参考取值来源:
    ApplyFileUploadLease
Parserstring

解析器类型枚举值。取值范围:展开详情

示例值:DASHSCOPE_DOCMIND
CategoryIdstring
  • 上传文档所属类目 ID,即 AddCategory 接口返回的CategoryId。您也可以在数据管理-非结构化数据页面,单击类目名称旁的 ID 图标获取。此处允许传入 default,即使用系统创建的“默认类目”。展开详情
示例值:cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
Tagsarray<string>

文档关联的标签列表。默认值为空,即文档不关联任何标签。最多传入 10 个标签。

CategoryTypestring

类目类型,可选,默认值为 UNSTRUCTURED,取值范围:展开详情

示例值:UNSTRUCTURED枚举值:UNSTRUCTUREDSESSION_FILE

返回参数

字段名称字段详情
Codestring

错误状态码。

示例值:DataCenter.FileTooLarge
Dataobject

接口业务数据字段。

Messagestring

错误信息。

示例值:User not authorized to operate on the specified resource.
RequestIdstring

请求 ID。

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

接口返回的状态码。

示例值:200
Successstring

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

示例值:true
变更历史
变更时间变更内容概要操作
2024-12-26
新增请求参数CategoryType
2024-09-18
新增请求参数Tags