文档

AddFile - 添加文档

更新时间:
一键部署

该接口用于将已经成功上传的文档添加到百炼系统中,添加成功之后,系统会自动启动文件的解析。文件解析有排队机制,如果队列较长,文件可能需要等待一段时间才能解析完成。

接口说明

  • 在调用此接口之前请确认已经调用 ApplyFileUploadLease 接口获取上传租约,并已经成功上传了文件。

  • 请务必在成功调用“申请上传文件”接口后,12 小时内调用此接口,否则会因为文件上传租约过期导致添加文件失败。

  • 该接口一旦调用成功后,租约即刻失效,请不要重复提交。

由于文件解析后续会启动商业化收费,正式启用付费之后,该接口的调用将产生费用,具体收费标准及收费方式将在正式启动商业化收费之后公布。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

PUT /{WorkspaceId}/datacenter/file

请求参数

名称类型必填描述示例值
LeaseIdstring

文件上传租约 Id,对应 ApplyFileUploadLease 接口返回的 FileUploadLeaseId。

68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847
Parserstring

解析器类型枚举值,目前已开放取值:DASHSCOPE_DOCMIND,即阿里云文档智能解析。

DASHSCOPE_DOCMIND
CategoryIdstring

类目 ID,取值请登录百炼(数据中心-数据管理)页面查看,允许传入“default”,即使用系统创建的"默认类目"。

cate_cdd11b1b79a74e8bbd675c356a91ee3510024405
WorkspaceIdstring

业务空间 id,请登录百炼后,在左上角业务空间详情中获取。

ws_3AXoiweeTyTd03IN

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

每次请求的唯一 ID

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

接口返回的业务字段

FileIdstring

文件唯一 ID 字段,后续查询等接口操作时使用

file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
Parserstring

解析该文档使用的解析器类型

DASHSCOPE_DOCMIND
Statusstring

接口返回的状态码

200
Successstring

调用是否成功

true
Messagestring

错误信息,有错误信息时返回该值

User not authorized to operate on the specified resource.
Codestring

错误状态码

DataCenter.FileTooLarge

示例

正常返回示例

JSON格式

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

错误码

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