SubmitIndexJob

​

介面說明

• RAM 使用者（子帳號）需要先取得阿里雲百煉的API 權限（需要AliyunBailianDataFullAccess，已包括 sfm:SubmitIndexJob 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。
• 呼叫本介面前，您必須預先呼叫 CreateIndex 介面，並且取得對應的IndexId。
• 呼叫本介面後，任務需一定時間執行，高峰期可能耗時數小時。任務完成前請勿重複發起請求。如果需要查詢任務的執行狀態，可呼叫 GetIndexJobStatus 介面查詢。
• 知識庫建立完成後，接下來您便可以在應用管理中將建立好的知識庫與您位於相同業務空間裡的智能體應用 關聯（或者透過應用呼叫的rag_options傳入IndexID），以便為您的阿里雲百煉應用補充私有知識並提供最新資訊。當然，您也可以選擇不使用阿里雲百煉應用，直接透過呼叫 Retrieve 介面來查詢知識庫。
• 本介面不具備冪等性。

​

調試

​

授權資訊

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

​

請求文法

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

​

路徑參數

​

請求參數

​

返回參數

​

樣本

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

​

錯誤碼

​

變更歷史