請求一個上傳租約用於上傳知識庫檔案,或智慧體應用會話交互的檔案。
介面說明
- RAM 使用者(子帳號)需要首先取得阿里雲百煉的 API 權限(需要
AliyunBailianDataFullAccess,已包括 sfm:ApplyFileUploadLease 權限點),並加入一個業務空間後,方可呼叫本介面。阿里雲帳號(主帳號)可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。 - 本介面不具備冪等性。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:
- 操作:是指具體的許可權點。
- 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。
-
資源類型:是指操作中支援授權的資源類型。具體說明如下:
- 對於必選的資源類型,用前面加 * 表示。
- 對於不支援資源級授權的操作,用
全部資源表示。
- 條件關鍵字:是指雲產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
sfm:ApplyFileUploadLease | none | *全部資源
| 無 | 無 |
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| CategoryId | string | 是 | cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx | |
| WorkspaceId | string | 是 | 上傳檔案所屬的業務空間 ID。取得方式請參見如何使用業務空間。 | llm-3z7uw7fwz0vexxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| FileName | string | 是 | 上傳用於建構知識庫的檔案:
如需新增資料表並上傳資料,請使用阿里雲百煉控制台,API 不支援。 | XXXX產品清單.pdf |
| Md5 | string | 是 | 上傳檔案的 MD5 值,伺服器端會驗證該欄位(當前暫未開啟),請正確填寫。 | 19657c391f6c70bcea63c154d8606bb3 |
| SizeInBytes | string | 是 | 上傳檔案的大小,單位位元組,伺服器端會驗證該欄位(當前暫未開啟),請正確填寫。取值範圍:1B-100M。 | 1000 |
| CategoryType | string | 否 | 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 方式上傳,需使用二進位方式上傳。 | |
| 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格式