批次刪除檔案
介面說明
- 不支援透過 API 刪除資料表。如需刪除資料表或表中特定的資料,請前往應用資料操作。
- 本介面用於刪除應用資料中的檔案,不會影響已建構好的知識庫。如需刪除知識庫中的檔案,請呼叫 DeleteIndexDocument 介面。
- RAM 使用者(子帳號)需要先取得阿里雲百鍊的 API 權限(需要
AliyunBailianDataFullAccess,已包括 sfm:DeleteFiles 權限點),並加入一個業務空間後,方可呼叫本介面。阿里雲帳號(主帳號)可直接呼叫無須授權。建議您透過最新版阿里雲百鍊 SDK來呼叫本介面。 - 本介面僅能刪除狀態為解析失敗(PARSE_FAILED)或解析完成(PARSE_SUCCESS)的檔案。
- 本介面具有冪等性。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
當前API暫無授權資訊透出。
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 類別所屬的業務空間 ID。取得方式請參見如何使用業務空間。 | llm-mbhn96xxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| FileIds | array | 是 | 需要刪除的檔案 id 清單,單次刪除最多支援 20 個檔案 | |
string | 否 | 需要刪除的檔案 id | file_xxxx |
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | 錯誤狀態碼。 | DataCenter.FileTooLarge |
| Data | object | 傳回內容 | |
| DeleteFileResultList | array<object> | 刪除結果 | |
object | 單個檔案刪除結果 | ||
| FileId | string | file_6b193b9b4b1546ef9eaa7340e69adfca_10052857 | |
| Status | string | DELETED | |
| Message | string | 錯誤資訊。 | Required parameter(%s) missing or invalid, please check the request parameters. |
| RequestId | string | Id of the request | 17204B98-7734-4F9A-8464-2446A84821CA |
| Status | string | 介面傳回的狀態碼。 | 200 |
| Success | boolean | 介面呼叫是否成功,可能值為:
| true |
樣本
正常返回樣本
JSON格式