SubmitIndexJob

介面說明

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

限流說明： 本介面頻繁呼叫會被限流，頻率請勿超過 10 次/秒。如遇限流，請稍後重試。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:SubmitIndexJob

create

*All Resource

*

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
WorkspaceId	string	是	知識庫所屬的業務空間 ID。取得方式請參見如何使用業務空間。	llm-3shx2gu255oqxxxx

請求參數

名稱	類型	必填	描述	樣本值
IndexId	string	是	知識庫 ID，即 CreateIndex 介面回傳的`Data.Id`。	79c0alxxxx

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Code	string	錯誤狀態碼。	Index.InvalidParameter
Data	object	介面回傳的業務欄位。
Id	string	任務 ID，即呼叫 GetIndexJobStatus 介面時需要用到的任務`JobId`。	eFDr2fGRzP9gdDZWAdo3xxxx
IndexId	string	知識庫 ID。	79c0alxxxx
Message	string	錯誤訊息。	Required parameter(%s) missing or invalid, please check the request parameters.
RequestId	string	請求 ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	介面回傳的狀態碼。	200
Success	boolean	介面呼叫是否成功，可能值： true：成功。 false：失敗。	true

樣本

正常返回樣本

JSON格式

{
  "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
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	RagIndex.IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

變更歷史

更多資訊，參考變更詳情。