請求一個上傳租約用於上傳非結構化文檔,或智能體應用會話互動的檔案。不支援通過API建立結構化資料表並上傳資料,請通過控制台操作。
介面說明
-
RAM 使用者(子帳號)需先擷取阿里雲百鍊的資料許可權(需要
AliyunBailianDataFullAccess,已包括 sfm:ApplyFileUploadLease 許可權點),並加入一個業務空間後,方可調用本介面。阿里雲帳號(主帳號)可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。 -
本介面不具備等冪性。
限流說明: 本介面頻繁調用會被限流,頻率請勿超過 10 次/秒。如遇限流,請稍後重試。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sfm:ApplyFileUploadLease |
none |
*全部資源
|
無 | 無 |
請求文法
POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| CategoryId |
string |
是 |
上傳用於構建知識庫的非結構化資料時:
說明
如需建立結構化資料表並上傳資料,請使用阿里雲百鍊控制台,API 不支援。
|
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| FileName |
string |
是 |
上傳用於構建知識庫的非結構化資料時:
說明
如需建立結構化資料表並上傳資料,請使用阿里雲百鍊控制台,API 不支援。 |
XXXX產品清單.pdf |
| Md5 |
string |
是 |
上傳文檔的 MD5 值,服務端會驗證該欄位(當前暫未開啟),請正確填寫。 |
19657c391f6c70bcea63c154d8606bb3 |
| SizeInBytes |
string |
是 |
上傳文檔的大小,單位位元組,服務端會驗證該欄位(當前暫未開啟),請正確填寫。取值範圍:1B-100M。 |
1000 |
| WorkspaceId |
string |
是 |
上傳文檔所屬的業務空間 ID。擷取方式請參見如何使用業務空間。 |
llm-3z7uw7fwz0vexxxx |
| 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 方式上傳,需使用二進位方式上傳。上傳程式碼範例請參見通過 API 上傳文檔。 |
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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。