AddFile - 添加文件

更新时间:
复制为 MD 格式

将存储于阿里云百炼临时存储空间内的文件导入至阿里云百炼数据连接(原应用数据)。

接口说明

  • RAM 用户(子账号)需要首先获取阿里云百炼的 API 权限(需要AliyunBailianDataFullAccess,已包括 sfm:AddFile 权限点),并加入一个业务空间后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。

  • 本接口不具备幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 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

路径参数

名称

类型

必填

描述

示例值

WorkspaceId

string

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

llm-3shx2gu255oqxxxx

请求参数

名称

类型

必填

描述

示例值

LeaseId

string

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

68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx

Parser

string

解析器类型。可能取值范围包括:

  • DOCMIND(智能文档解析)

  • DOCMIND_DIGITAL(电子文档解析)

  • DOCMIND_LLM_VERSION(大模型文档解析)

  • DASH_QWEN_VL_PARSER(Qwen VL 解析)

  • DOCMIND_LLM_VERSION_MEDIA(音视频解析)

  • AUTO_SELECT(自动选择解析器)

说明 当 CategoryType 为 UNSTRUCTURED 时,解析器会根据当前类目的数据解析设置,对您上传的文件进行解析。
说明 当 CategoryType 为 SESSION_FILE 时,系统将使用默认方式(不支持更改)解析文件内容。

AUTO_SELECT

CategoryId

string

  • 当 CategoryType 为 UNSTRUCTURED 时,需传入上传文件所属类目 ID,即 AddCategory 接口返回的CategoryId。您也可以前往应用数据-文件页签,单击类目名称旁的 ID 图标获取类目 ID。此处允许传入 default,即使用系统创建的“默认类目”。

  • 当 CategoryType 为 SESSION_FILE 时,传入“default”即可。

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

Tags

array

  • 文件关联的标签列表。最多传入 100 个标签,所有标签字符长度总和不能超过 700。

  • 默认值为空,即不设置标签。

string

文件的标签。每个标签最多 32 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等),下划线_,中划线-。

产品介绍

CategoryType

string

类目类型,可选,默认值为 UNSTRUCTURED,取值范围:

  • UNSTRUCTURED:类目,用于构建知识库场景。

  • SESSION_FILE:用于智能体应用会话交互的文件。

    说明 在使用 SESSION_FILE 的情况下,调用 ApplyFileUploadLease 接口时,CategoryType 参数也应传入 SESSION_FILE
    说明 仅用户当前会话有效,用户关闭会话后文件过期(最长有效期为 7 天),不支持长期保存。

UNSTRUCTURED

OriginalFileUrl

string

通过此参数为文件添加一个 URL,系统将在构建文档搜索类知识库时记录该链接。在使用阿里云百炼控制台与智能体应用对话时,随该文件召回结果返回(通过docUrl字段)。

说明

智能体应用必须开启知识库,并启用展示回答来源功能,否则此参数不生效。

www.test.com/111.docx

ParserConfig

object

解析器配置,仅当类型被设置为 Qwen VL 解析时才需要传入。

ModelName

string

模型名称。

qwen-vl-max

ModelPrompt

string

调用 Qwen VL 解析时的 Prompt。

#角色 你是一个专业的图片内容标注人员,擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片,详细描述图片中的内容。

返回参数

名称

类型

描述

示例值

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"
}

错误码

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

变更历史

更多信息,参考变更详情