Skip to main content
知識庫

SubmitIndexAddDocumentsJob

向指定知識庫中追加匯入已解析的檔案。

介面說明

  • 本介面不支援資料查詢/圖片問答類知識庫。關於如何更新資料查詢/圖片問答類知識庫，請參見知識庫一文中關於更新知識庫的說明。
  • RAM 使用者（子帳號）需要首先獲取阿里雲百煉的 API 權限（需要 AliyunBailianDataFullAccess，已包括 sfm:SubmitIndexAddDocumentsJob 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。
  • 呼叫本介面前，請確保您的知識庫已經建立完成且未被刪除（即知識庫 ID IndexId 有效）。
  • 呼叫該介面前，請先呼叫 AddFile 介面將您需要追加匯入的檔案上傳至阿里雲百煉。
  • 呼叫本介面後，任務需一定時間執行，高峰期可能耗時數小時。任務完成前請勿重複發起請求。如果需要查詢任務的執行狀態，可呼叫 GetIndexJobStatus 介面查詢。此介面返回的檔案清單 Documents 為您本次追加（由您提供的 job_id 唯一確定）全部檔案，您可以檢視每個檔案是否匯入（解析）成功。注意頻繁呼叫 GetIndexJobStatus 介面會被限流，頻率請勿高於 20 次/分鐘。
  • 本介面呼叫成功後，將執行一段時間，請求返回前請勿重複發起請求。本介面不具備冪等性。
限流說明： 本介面頻繁呼叫會被限流，頻率請勿超過 10 次/秒。如遇限流，請稍後重試。

調試

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

授權資訊

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:SubmitIndexAddDocumentsJob

create

*全部資源。

*

無無

請求文法 

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

路徑參數

名稱

類型

必填

描述

樣本值

WorkspaceId

string

是

知識庫所屬的業務空間 ID。獲取方式請參見如何使用業務空間。

llm-3shx2gu255oqxxxx

請求參數

名稱

類型

必填

描述

樣本值

IndexId

string

是

知識庫 ID，即 CreateIndex 介面返回的 Data.Id。

79c0alxxxx

SourceType

string

是

資料來源類型。取值範圍：

  • DATA_CENTER_CATEGORY：類目類型，即匯入應用資料中指定類目下的所有檔案，支援匯入多個類目。

  • DATA_CENTER_FILE：檔案類型，即匯入應用資料下的指定檔案，支援匯入多個檔案。

如果本參數傳入 DATA_CENTER_CATEGORY，則必須指定 CategoryIds 參數；如果本參數傳入 DATA_CENTER_FILE，則必須指定 DocumentIds 參數。

枚舉值：

  • DATA_CENTER_CATEGORY :

    類目類型。

  • DATA_CENTER_FILE :

    檔案類型。

DATA_CENTER_FILE

DocumentIds

array

否

檔案 ID 清單。

string

否

檔案 ID，即 AddFile 介面返回的 FileId。您也可以在應用資料頁面，按一下檔案名稱旁的 ID 圖示獲取。

doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx

CategoryIds

array

否

類目 ID 清單。

string

否

類目 ID，即 AddCategory 介面返回的 CategoryId。您也可以在應用資料-檔案頁籤，按一下類目旁的 ID 圖示獲取。

cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

ChunkMode

string

否

該參數暫不開放，請勿傳入。

length

Separator

string

否

該參數暫不開放，請勿傳入。

(?<=。)

ChunkSize

integer

否

該參數暫不開放，請勿傳入。

128

OverlapSize

integer

否

該參數暫不開放，請勿傳入。

16

EnableHeaders

boolean

否

Excel 檔案表頭是否支援組裝。開啟後，知識庫會將所有 xlsx、xls 格式檔案的首行資料視為表頭，並自動拼接到每個文字切片中（資料列），避免大型語言模型誤將表頭視為普通資料列來處理。

建議僅在匯入檔案均為 xlsx、xls 格式且含表頭時開啟，否則無需開啟。

取值範圍：

  • true：開啟。

  • false：不開啟。

預設值為 false，即不開啟。

枚舉值：

  • true :

    開啟。

  • false :

    不開啟。

false

Extra

object

否

uniqueId

string

否

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

778C0B3B-xxxx-5FC1-A947-36EDD13606AB

Data

object

介面返回的業務欄位。

Id

string

任務 ID，又稱 JobId。

42687eb254a34802bed398357f5498ae

Status

string

介面返回的狀態碼。

200

Success

boolean

介面呼叫是否成功，可能值為：

  • true：成功。

  • false：失敗。

true

Message

string

錯誤訊息。

Required parameter(%s) missing or invalid, please check the request parameters.

Code

string

錯誤狀態碼。

Index.InvalidParameter

樣本

正常返回樣本 JSON格式 
{
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": "200",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400IdempotentParameterMismatchThe 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.
訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。
應用調用
應用組件
Assistant API（下線中）
更多
SubmitIndexAddDocumentsJob - Alibaba Cloud Model Studio