请求一个上传租约用于上传知识库文件,或智能体应用会话交互的文件。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sfm:ApplyFileUploadLease |
none |
*全部资源
|
无 | 无 |
请求语法
POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CategoryId |
string |
是 |
上传用于构建知识库的文件时:
说明
如需新增数据表并上传数据,请使用阿里云百炼控制台,API 不支持。
|
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| WorkspaceId |
string |
是 |
上传文件所属的业务空间 ID。获取方式请参见如何使用业务空间。 |
llm-3z7uw7fwz0vexxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| FileName |
string |
是 |
上传用于构建知识库的文件:
说明
如需新增数据表并上传数据,请使用阿里云百炼控制台,API 不支持。 |
XXXX产品清单.pdf |
| Md5 |
string |
是 |
上传文件的 MD5 值,服务端会验证该字段(当前暂未开启),请正确填写。 |
19657c391f6c70bcea63c154d8606bb3 |
| SizeInBytes |
string |
是 |
上传文件的大小,单位字节,服务端会验证该字段(当前暂未开启),请正确填写。取值范围:1B-100M。 |
1000 |
| CategoryType |
string |
否 |
类目类型,不传入该参数时,默认值为 UNSTRUCTURED。取值范围: UNSTRUCTURED:类目,用于构建知识库场景。 SESSION_FILE:上传用于智能体应用会话交互的文件。 说明
如需新增数据表并上传数据,请使用阿里云百炼控制台,API 不支持。 |
UNSTRUCTURED |
| UseInternalEndpoint |
boolean |
否 |
若您使用了阿里云百炼安全存储空间,需要生成仅阿里云同地域内网可访问的租约 URL 链接时,此处可传入 true,以提高安全性。不传入该参数时,默认值为 false,即生成公网可访问的租约 URL。 说明
若您未开通阿里云百炼安全存储空间,或不确定是否在使用,此处请勿传入 true(会上传失败)。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| Code |
string |
错误状态码。 |
DataCenter.FileTooLarge |
| Data |
object |
接口业务数据字段。 |
|
| FileUploadLeaseId |
string |
租约唯一 ID,后续调用 AddFile 接口时,需要使用该参数。 |
1e6a159107384782be5e45ac4759b247.1719325231035 |
| Param |
object |
用于上传文件的 HTTP 请求参数。 |
|
| Headers |
any |
需要放到 Header 中的 K-V 字段,K 和 V 均为字符串。 说明
返回的 Content-Type 可能为空值,后续按照空值上传即可。 |
"X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf" |
| Method |
string |
HTTP 调用方法,可能值为:
|
PUT |
| Url |
string |
文件的上传 URL 地址。 说明
该 URL 为预签名 URL,不支持 FormData 方式上传,需使用二进制方式上传。 |
https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D |
| Type |
string |
文件的上传方式,可能值为:
|
HTTP |
| Message |
string |
错误信息。 |
User not authorized to operate on the specified resource |
| RequestId |
string |
请求 ID。 |
778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status |
string |
接口返回的状态码。 |
200 |
| Success |
boolean |
接口调用是否成功,可能值为:
|
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
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。