ApplyFileUploadLease

更新時間:
Copy as MD

請求一個上傳租約用於上傳知識庫檔案,或智慧體應用會話交互的檔案。

介面說明

  • RAM 使用者(子帳號)需要首先取得阿里雲百煉的 API 權限(需要AliyunBailianDataFullAccess,已包括 sfm:ApplyFileUploadLease 權限點),並加入一個業務空間後,方可呼叫本介面。阿里雲帳號(主帳號)可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。

  • 本介面不具備冪等性。

限流說明: 本介面頻繁呼叫會被限流,頻率請勿超過 10 次/秒。如遇限流,請稍後重試。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:ApplyFileUploadLease

none

*全部資源

*

請求文法

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

路徑參數

名稱

類型

必填

描述

樣本值

CategoryId

string

上傳用於建構知識庫的檔案時:

  • 該欄位代表上傳檔案所屬類目 ID,即 AddCategory 介面返回的CategoryId。您也可以在應用資料-檔案頁籤,按一下類目名稱旁的 ID 圖示取得。此處允許傳入 default,即使用系統建立的「預設類目」。

說明

如需新增資料表並上傳資料,請使用阿里雲百煉控制台,API 不支援。

  • 此處傳入 default 即可,系統會自動建立或者匹配預設類目,後續會開放動態檔案類目介面及控制台管理頁面。。

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

WorkspaceId

string

上傳檔案所屬的業務空間 ID。取得方式請參見如何使用業務空間

llm-3z7uw7fwz0vexxxx

請求參數

名稱

類型

必填

描述

樣本值

FileName

string

上傳用於建構知識庫的檔案:

  • 該欄位代表上傳檔案的名稱,注意後綴需要帶上檔案格式類型,支援格式:
    • 文件(小於 150MB):doc、docx、wps、ppt、pptx、xls、xlsx、md、txt、pdf、epub、mobi。

    • 表格(建議 10MB 以內,10 萬行以內):xls、xlsx。

    • 純文字(建議不要超過 10MB):md、txt。

    • 圖片(小於 20MB,最短邊 > 15px, 長邊 < 8192px,長寬比 < 50):png、jpg、jpeg、bmp、gif。

    • 音訊:aac、amr、flac、flv、m4a、mp3、mpeg、ogg、opus、wav、webm、wma。

    • 影片:mp4、mkv、avi、mov、wmv。

  • 檔案名稱長度限制 4-128 個字元。其它限制請參考知識庫配額與限制

說明

如需新增資料表並上傳資料,請使用阿里雲百煉控制台,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

  • POST

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

檔案的上傳方式,可能值為:

  • OSS.PreSignedURL

  • HTTP。

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:成功。

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情