全部产品
Search

搜索本产品

    大模型服务平台百炼：AddFile - 添加文档

    文档中心

    大模型服务平台百炼：AddFile - 添加文档

    更新时间：Dec 05, 2024

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

    接口说明

    说明 该接口调用成功后，租约 ID 即刻失效，请勿使用相同的租约 ID 重复提交。

    • 请务必在成功调用 ApplyFileUploadLease 接口后的 12 小时内调用本接口，否则会因租约过期导致调用失败。

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

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

    • 导入至数据管理的原始文档仅用于导入知识库前的临时存储，不支持长期保存，请自行妥善保存原文档。

    • 本接口不具备幂等性。

    调试

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

    授权信息

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

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

    请求语法

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

    请求参数

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

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

    		68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx
    Parserstring是

    解析器类型枚举值。取值范围：

    • DASHSCOPE_DOCMIND：阿里云文档智能解析（暂不支持更改）。
    		DASHSCOPE_DOCMIND
    CategoryIdstring是

    类目 ID，即文档将上传至该类目中。AddCategory 接口返回的CategoryId。您也可以在数据管理-非结构化数据页面，单击类目名称旁的 ID 图标获取。允许传入“default”，即使用系统创建的“默认类目”。

    		cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
    WorkspaceIdstring是

    业务空间 ID，即文档将上传至该业务空间中。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。

    		llm-3shx2gu255oqxxxx
    Tagsarray否

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

    string否

    文档的标签。每个标签最多 12 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等），下划线_，中划线-。

    		产品介绍

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    Codestring

    错误状态码。

    		DataCenter.FileTooLarge
    Dataobject

    接口业务数据字段。

    FileIdstring

    文档 ID，请妥善保管该值，它将用于后续与此文档相关的所有 API 操作。

    		file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
    Parserstring

    解析该文档使用的解析器类型。可能值为：

    • DASHSCOPE_DOCMIND：阿里云文档智能解析。
    		DASHSCOPE_DOCMIND
    Messagestring

    错误信息。

    		User not authorized to operate on the specified resource.
    RequestIdstring

    请求 ID。

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

    接口返回的状态码。

    		200
    Successstring

    接口调用是否成功，可能值为：

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

    错误码

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