Skip to main content
資料連線（原應用程式資料）

AddFile

將儲存於阿里雲百煉臨時儲存空間內的檔案匯入至阿里雲百煉資料連接（原應用資料）。

介面說明

  • RAM 使用者（子帳號）需要首先取得阿里雲百煉的 API 權限（需要 AliyunBailianDataFullAccess，已包括 sfm:AddFile 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。
  • 本介面不具備冪等性。
限流說明： 本介面頻繁呼叫會被限流，頻率請勿超過 10 次/秒。如遇限流，請稍後重試。

調試

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

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：
  • 操作：是指具體的許可權點。
  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：
    • 對於必選的資源類型，用前面加 * 表示。
    • 對於不支援資源級授權的操作，用全部資源表示。
  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。
  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:AddFile

create

*All Resource

*

無無

請求文法 

PUT /{WorkspaceId}/datacenter/file HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

WorkspaceId

string

是

業務空間 ID，即檔案將上傳至該業務空間中。取得方式請參見如何使用業務空間。

llm-3shx2gu255oqxxxx

請求參數

名稱

類型

必填

描述

樣本值

LeaseId

string

是

上傳租約 ID，對應 ApplyFileUploadLease 介面返回的 FileUploadLeaseId。

68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx

Parser

string

是

解析器類型。可能取值範圍包括：

  • DOCMIND（智慧文件解析）

  • DOCMIND_DIGITAL（電子文件解析）

  • DOCMIND_LLM_VERSION（大模型文件解析）

  • DASH_QWEN_VL_PARSER（Qwen VL 解析）

  • DOCMIND_LLM_VERSION_MEDIA（影音解析）

  • AUTO_SELECT（自動選擇解析器）

會以目前設定的解析器對您上傳的檔案進行解析，若輸入 AUTO_SELECT 則會使用所屬類目設定的解析器。

AUTO_SELECT

CategoryId

string

是

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

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

Tags

array

否

  • 檔案關聯的標籤清單。最多傳入 100 個標籤，所有標籤字元長度總和不能超過 700。

  • 預設值為空，即不設定標籤。

string

否

檔案的標籤。每個標籤最多 32 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等），底線 _，連字號 -。

产品介绍

CategoryType

string

否

類目類型，可選，預設值為 UNSTRUCTURED，取值範圍：

  • UNSTRUCTURED：類目，用於建構知識庫場景。

UNSTRUCTURED

OriginalFileUrl

string

否

透過此參數為檔案新增一個 URL，系統將在建構文件搜尋類知識庫時記錄該連結。在使用阿里雲百煉主控台與智能體應用對話時，隨該檔案召回結果返回（透過 docUrl 欄位）。

智能體應用必須開啟知識庫，並啟用展示回答來源功能，否則此參數不生效。

www.test.com/111.docx

ParserConfig

object

否

解析器設定，僅當類型被設定為 Qwen VL 解析時才需要傳入。

ModelName

string

否

模型名稱。

qwen-vl-max

ModelPrompt

string

否

呼叫 Qwen VL 解析時的 Prompt。

#角色 你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片，详细描述图片中的内容。

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

Code

string

錯誤狀態碼。

DataCenter.FileTooLarge

Data

object

介面業務資料欄位。

FileId

string

檔案 ID，請妥善保管該值，它將用於後續與此檔案相關的所有 API 操作。

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

Parser

string

解析該檔案使用的解析器類型。可能值為：

  • DASHSCOPE_DOCMIND：阿里雲文件智慧解析

DASHSCOPE_DOCMIND

Message

string

錯誤訊息。

User not authorized to operate on the specified resource.

RequestId

string

請求 ID。

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

Status

string

介面返回的狀態碼。

200

Success

string

介面呼叫是否成功，可能值為：

  • true：成功

  • false：失敗

true

樣本

正常返回樣本 JSON格式 
{
  "Code": "DataCenter.FileTooLarge",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "Parser": "DASHSCOPE_DOCMIND"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": "true"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。
應用調用
應用組件
Assistant API（下線中）
更多