將儲存於阿里雲百鍊臨時儲存空間內的非結構化文檔匯入至阿里雲百鍊應用資料。不支援通過API匯入結構化文檔,請通過控制台匯入。
介面說明
-
RAM 使用者(子帳號)需先擷取阿里雲百鍊的資料許可權(需要
AliyunBailianDataFullAccess,已包括 sfm:AddFile 許可權點),並加入一個業務空間後,方可調用本介面。阿里雲帳號(主帳號)可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。 -
本介面不具備等冪性。
限流說明: 本介面頻繁調用會被限流,頻率請勿超過 10 次/秒。如遇限流,請稍後重試。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sfm:AddFile |
create |
*全部資源
|
無 | 無 |
請求文法
PUT /{WorkspaceId}/datacenter/file HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| LeaseId |
string |
是 |
上傳租約 ID,對應 ApplyFileUploadLease 介面返回的 |
68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx |
| Parser |
string |
是 |
解析器類型。取值範圍:
說明 解析器會根據當前類目的資料解析設定,對您上傳的文檔進行解析。 |
DASHSCOPE_DOCMIND |
| CategoryId |
string |
是 |
需傳入上傳文檔所屬類目 ID,即 AddCategory 介面返回的 |
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| WorkspaceId |
string |
是 |
業務空間 ID,即文檔將上傳至該業務空間中。擷取方式請參見如何使用業務空間。 |
llm-3shx2gu255oqxxxx |
| Tags |
array |
否 |
文檔關聯的標籤列表。預設值為空白,即文檔不關聯任何標籤。最多傳入 10 個標籤。 |
|
|
string |
否 |
文檔的標籤。每個標籤最多 32 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等),底線_,中劃線-。 |
產品介紹 |
|
| CategoryType |
string |
否 |
類目類型,可選,預設值為 UNSTRUCTURED,取值範圍:
|
UNSTRUCTURED |
| OriginalFileUrl |
string |
否 |
通過此參數為文檔添加一個 URL,系統將在構建非結構化知識庫時記錄該連結。在使用阿里雲百鍊控制台與智能體應用對話時,隨該文檔召回結果返回(通過 說明
智能體應用必須開啟知識庫,並啟用展示回答來源功能,否則此參數不生效。 |
www.test.com/111.docx |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| Code |
string |
錯誤狀態代碼。 |
DataCenter.FileTooLarge |
| Data |
object |
介面業務資料欄位。 |
|
| FileId |
string |
文檔 ID,請妥善保管該值,它將用於後續與此文檔相關的所有 API 操作。 |
file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
| Parser |
string |
解析該文檔使用的解析器類型。可能值為:
|
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 |
樣本
正常返回樣本
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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。