使用此 API 可為文件搜尋類(document)、資料查詢類(table)、圖片問答類(image)知識庫新增切片。
介面說明
- 對於文件搜尋類(document)、資料查詢類(table)、圖片問答類(image)知識庫,本介面可向指定知識庫中新增切片內容;目前尚不支援對影音搜尋類(multimedia)知識庫進行相關操作。僅當資料來源為表格連接器 (excel) 時,對資料查詢與圖片問答類型知識庫的操作方可生效。
- RAM 使用者(子帳號)需要首先取得阿里雲百煉的 API 權限(需要
AliyunBailianDataFullAccess,已包括 sfm:ChunkList 權限點),並加入一個業務空間後,方可呼叫本介面。阿里雲帳號(主帳號)可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK阿里雲百煉 SDK來呼叫本介面。 - 呼叫本介面前,請確保您的知識庫已經建立完成且未被刪除(即知識庫 ID
IndexId有效)。 - 本介面具有冪等性。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
當前API暫無授權資訊透出。
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 工作區識別碼。 | llm-19hxxxxx7htdf9lh |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| PipelineId | string | 是 | 知識庫 ID。 | 79c0alxxxx |
| dataId | string | 否 | 檔案 ID。 | doc_xxx |
| field | object | 否 | 插入的切片內容資訊,以鍵值對形式傳入。文件搜尋類知識庫使用固定 key 清單:
資料查詢類、圖片問答類知識庫 key 不固定,由該知識庫的資料來源表格決定:key 為 Excel 欄標題,value 為對應欄的值。 | { "content": "The Bailian platform supports parsing multiple document formats including PDF, Word, and PPT.", "title": "Document Parsing and Chunking", "image_urls": [ "https://example.com/images/chunk-flow.png", "https://example.com/images/parsing-result.png" ] } |
any | 否 | 插入切片的表頭欄位資訊,僅資料查詢類與圖片問答類知識庫支援。需要參與檢索或參與回覆的表頭為必填。各類型取值要求:
| {"Product Name": "Wireless Bluetooth Headphones", "Publish Time": 1752624000000, "Stock Quantity": 1580, "Unit Price": 299.99, "image_url":"https://example.com/images/headphones-front.jpg,https://example.com/images/headphones-side.jpg,https://example.com/images/headphones-package.jpg" } |
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | 請求 ID。 | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | 錯誤狀態碼。 | Index.InvalidParameter |
| Message | string | 錯誤訊息。 | Required parameter(%s) missing or invalid, please check the request parameters. |
| Success | boolean | 介面呼叫是否成功。 枚舉值:
| true |
| Data | boolean | 請求成功返回的業務資料。 枚舉值:
| true |
| Status | string | 介面返回的狀態碼。 | 200 |
樣本
正常返回樣本
JSON格式