AddFile - 添加文档_大模型服务平台百炼(Model Studio)-阿里云帮助中心

将存储于阿里云百炼临时存储空间内的非结构化文档导入至阿里云百炼应用数据。不支持通过API导入结构化文档，请通过控制台导入。

接口说明

RAM 用户（子账号）需先获取阿里云百炼的数据权限（需要AliyunBailianDataFullAccess，已包括 sfm:AddFile 权限点），并加入一个业务空间后，方可调用本接口。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。
调用本接口前，请先通过 ApplyFileUploadLease 接口获取上传租约，并使用upload_file方法（从本地上传）或upload_file_link方法（从对象存储 OSS 上传）将文档上传至阿里云百炼的临时存储空间。代码示例请参见通过 API 上传文档。
本接口调用成功后，系统将开始解析并导入文档至应用数据。在请求高峰时段，该过程可能需要数小时，请耐心等待。您可以调用 DescribeFile 接口查询文档的解析状态。
每个业务空间最多支持 10 万个文档。
本接口不具备幂等性。

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
sfm:AddFile	create	全部资源 ``	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
LeaseId	string	是	文档上传租约 ID，对应 ApplyFileUploadLease 接口返回的 `FileUploadLeaseId`。	68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx
Parser	string	是	解析器类型枚举值。取值范围： DASHSCOPE_DOCMIND：阿里云文档智能解析（暂不支持更改）。	DASHSCOPE_DOCMIND
CategoryId	string	是	上传文档所属类目 ID，即 AddCategory 接口返回的`CategoryId`。您也可以在应用数据-非结构化数据页签，单击类目名称旁的 ID 图标获取。此处允许传入 default，即使用系统创建的“默认类目”。当 CategoryType 为 SESSION_FILE，此值传“default”即可，系统会自动创建或者匹配默认类目，后续会开放动态文件类目接口及控制台管理页面。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
WorkspaceId	string	是	业务空间 ID，即文档将上传至该业务空间中。获取方式请参见如何使用业务空间。	llm-3shx2gu255oqxxxx
Tags	array	否	文档关联的标签列表。默认值为空，即文档不关联任何标签。最多传入 10 个标签。
	string	否	文档的标签。每个标签最多 12 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等），下划线_，中划线-。	产品介绍
CategoryType	string	否	类目类型，可选，默认值为 UNSTRUCTURED，取值范围： UNSTRUCTURED：非结构化数据，用于构建知识库场景。 SESSION_FILE：用于智能体应用会话交互的文件。说明在使用 SESSION_FILE 的情况下，调用 ApplyFileUploadLease 接口时，CategoryType 参数也应传入 SESSION_FILE。说明仅用户当前会话有效，用户关闭会话后文件过期（最长有效期为 7 天），不支持长期保存。	UNSTRUCTURED
OriginalFileUrl	string	否	说明该参数暂不开放，请勿传入。

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	string	错误状态码。	DataCenter.FileTooLarge
Data	object	接口业务数据字段。
FileId	string	文档 ID，请妥善保管该值，它将用于后续与此文档相关的所有 API 操作。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
Parser	string	解析该文档使用的解析器类型。可能值为： DASHSCOPE_DOCMIND：阿里云文档智能解析。	DASHSCOPE_DOCMIND
Message	string	错误信息。	User not authorized to operate on the specified resource.
RequestId	string	请求 ID。	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Status	string	接口返回的状态码。	200
Success	string	接口调用是否成功，可能值为： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "Code": "DataCenter.FileTooLarge",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "Parser": "DASHSCOPE_DOCMIND"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": 200,
  "Success": true
}

错误码

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