全部产品
Search

搜索本产品

    大模型服务平台百炼：ApplyFileUploadLease - 申请文档上传租约

    文档中心

    大模型服务平台百炼：ApplyFileUploadLease - 申请文档上传租约

    更新时间：Dec 03, 2024

    请求文档上传租约，进行文档上传。暂不支持通过API上传结构化文档，请通过控制台上传。

    接口说明

    • 本接口返回的信息包括：一个用于上传非结构化文档的 HTTP URL 链接（租约），以及上传所需的相关参数。目前暂不支持结构化文档的上传。
    • 本接口返回的 HTTP URL 链接有效期为分钟级，请及时上传文档，以免链接过期导致无法上传。
    • 申请文档上传租约并上传文档后，文档将暂存于百炼的临时存储空间内 12 小时，请及时调用 AddFile 接口以完成最终导入（导入至百炼数据管理）。
    • 本接口不具备幂等性。

    调试

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

    授权信息

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

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

    请求语法

    POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1

    请求参数

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

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

    		cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
    FileNamestring是

    上传文档的名称，注意后缀需要带上文档格式类型。支持格式：pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、png、jpg、jpeg、bmp、gif。 文档名称长度限制 4-128 个字符。

    		XXXX产品清单.pdf
    Md5string是

    上传文档的 MD5 值，服务端会验证该字段（当前暂未开启），请正确填写。

    		19657c391f6c70bcea63c154d8606bb3
    SizeInBytesstring是

    上传文档的大小，单位字节，服务端会验证该字段（当前暂未开启），请正确填写。取值范围：1B-100M。

    		1000
    WorkspaceIdstring是

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

    		llm-3z7uw7fwz0vexxxx

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    Codestring

    错误状态码。

    		DataCenter.FileTooLarge
    Dataobject

    接口业务数据字段。

    FileUploadLeaseIdstring

    租约唯一 ID，后续调用 AddFile 接口时，需要使用该参数。

    		1e6a159107384782be5e45ac4759b247.1719325231035
    Paramobject

    用于上传文档的 HTTP 请求参数。

    Headersany

    需要放到 Header 中的 K-V 字段，K 和 V 均为字符串。

    		"X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf"
    Methodstring

    HTTP 调用方法，可能值为：

    • PUT
    • POST
    		PUT
    Urlstring

    文档的上传 URL 地址。

    		https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
    Typestring

    文档的上传方式，可能值为：

    • OSS.PreSignedURL
    • HTTP
    		HTTP
    Messagestring

    错误信息。

    		User not authorized to operate on the specified resource
    RequestIdstring

    请求 ID。

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

    接口返回的状态码。

    		200
    Successboolean

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

    • true：成功。
    • false：失败。
    		true

    示例

    正常返回示例

    JSON格式

    {
  "Code": "DataCenter.FileTooLarge",
  "Data": {
    "FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
    "Param": {
      "Headers": "\"X-bailian-extra\":\"MTAwNTQyNjQ5NTE2OTE3OA==\",\n\"Content-Type\":\"application/pdf\"",
      "Method": "PUT",
      "Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D"
    },
    "Type": "HTTP"
  },
  "Message": "User not authorized to operate on the specified resource",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": true
}

    错误码

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