DeleteIndexDocument

​

介面說明

• 本介面不支援刪除資料查詢/圖片問答類知識庫中的資料。請透過阿里雲百鍊主控台操作。
• RAM 使用者（子帳號）需要先取得阿里雲百鍊的API 權限（需要AliyunBailianDataFullAccess，已包含 sfm:DeleteIndexDocument 權限點），然後才能呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百鍊 SDK來呼叫本介面。
• 呼叫本介面前，請確保您的知識庫已建立完成且未被刪除（即知識庫 IDIndexId有效）。
• 僅能刪除知識庫中狀態為匯入失敗（INSERT_ERROR）或匯入成功（FINISH）的檔案。如需查詢指定知識庫下的檔案狀態，可呼叫 ListIndexDocuments 介面。
• 刪除操作不可逆，被刪除的檔案內容將無法復原，且 Retrieve 介面將無法再取得其相關資訊，請謹慎操作。
• 呼叫本介面不會刪除應用資料中已匯入的文件。
• 本介面具有冪等性。

​

調試

​

授權資訊

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

​

請求文法

POST /{WorkspaceId}/index/delete_index_document HTTP/1.1

​

路徑參數

​

請求參數

​

返回參數

​

樣本

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "DeletedDocument": [
      "file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx"
    ]
  },
  "Status": "200"
}

​

錯誤碼

​

變更歷史