API標準及多語言預置SDK
本產品（bailian/2023-12-29）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
資料連線（原應用程式資料）
API | 標題 | API概述 |
|---|---|---|
| AddCategory | 新增類目 | 在指定的業務空間中建立一個類目，用於分類和管理檔案。每個業務空間最多建立500個類目。 |
| ListCategory | 類目列表 | 擷取指定業務空間下一個或多個類目的詳細資料。 |
| DeleteCategory | 刪除類目 | 永久性刪除指定的類目。 |
| ApplyFileUploadLease | 申請檔案上傳租約 | 請求一個上傳租約用於上傳知識庫檔案，或智慧體應用會話交互的檔案。 |
| AddFile | 新增檔案。 | 將儲存於阿里雲百煉臨時儲存空間內的檔案匯入至阿里雲百煉資料連接（原應用資料）。 |
| AddFilesFromAuthorizedOss | 從已授權 OSS Bucket 中匯入檔案。 | 將已授權 OSS Bucket 中的檔案匯入阿里雲百煉應用資料中。 |
| ListFile | 文件列表 | 取得指定類目下一個或多個文件的詳細資訊。 |
| DescribeFile | 查詢檔案狀態 | 查詢應用資料中檔案的基本資訊，包括檔案名稱、類型、狀態等。 |
| UpdateFileTag | 更新檔案標籤 | 更新指定檔案標籤。 |
| BatchUpdateFileTag | 批次更新文檔標籤 | 該介面用於批次更新資料連線中的文檔標籤。 |
| DeleteFile | 刪除檔案 | 永久刪除應用資料中的指定檔案。不支援通過API刪除資料表，詳見下方介面說明。 |
| DeleteFiles | 批次刪除檔案 | 批次刪除檔案 |
| GetParseSettings | 擷取類目解析設定 | 查詢指定類目的資料解析設定。 |
| GetAvailableParserTypes | 擷取檔案支援的解析器類型 | 根據輸入的檔案類型（副檔名），擷取所有支援的解析器類型列表。 |
| ChangeParseSetting | 修改類別解析設定。 | 設定特定檔案類型的解析方式。例如，為 .pdf 檔案指定使用大模型文件解析，為 .jpg 檔案指定使用 Qwen VL 解析。 |
| AddTable | 新增表格 | 為表格資料連接器新增表格。 |
| UpdateTableFromAuthorizedOss | 從已授權OSS Bucket中選擇檔案更新表格 | 使用已授權OSS Bucket中的檔案更新阿里雲百鍊資料連線中表格連接器中的表格。 |
| AddConnector | 新增連接器 | 建立連接器，當前介面僅支援建立檔案類型連接器。 |
| GetConnector | 擷取連接器資訊 | 擷取連接器資訊。當前介面僅支援擷取檔案連接器資訊。 |
| UpdateConnector | 編輯連接器 | 編輯連接器 |
知識庫
API | 標題 | API概述 |
|---|---|---|
| CreateIndex | 建立知識庫。 | 使用此 API 可建立兩類知識庫：基於文件或影音的非結構化知識庫，以及用於資料查詢或圖片問答的結構化知識庫。 |
| GetIndexJobStatus | 查詢知識庫建立任務狀態。 | 查詢指定的知識庫建立任務或知識庫追加任務的目前狀態。 |
| SubmitIndexJob | 提交知識庫建立任務 | 提交指定的 CreateIndex 任務以完成知識庫建立。 |
| SubmitIndexAddDocumentsJob | 提交知識庫追加任務 | 向指定知識庫中追加匯入已解析的檔案。 |
| Retrieve | 檢索知識庫 | 在指定的知識庫中檢索資訊。 |
| ListIndexDocuments | 查詢知識庫下的檔案列表。 | 取得指定知識庫中的檔案，以及它們的概要資訊。 |
| ListIndexFileDetails | 查詢知識庫下的檔案詳情。 | 取得指定知識庫中的檔案，以及它們的詳細資訊。 |
| DeleteIndexDocument | 刪除知識庫下的檔案 | 永久刪除指定知識庫中的檔案。 |
| ListIndices | 查詢知識庫列表 | 獲取指定業務空間下知識庫列表。 |
| DeleteIndex | 刪除知識庫 | 永久性刪除指定的知識庫。 |
| ListChunks | 查詢索引下的切片列表 | 查看文字切片列表及資訊。 |
| UpdateChunk | 修改切片 | 更新文本切片。 |
| DeleteChunk | 刪除切片 | 從指定的非結構化知識庫中永久刪除一個或多個文本切片。暫不支援通過API刪除結構化知識庫中的切片。 |
Prompt 工程
API | 標題 | API概述 |
|---|---|---|
| CreatePromptTemplate | 建立Prompt範本 | 建立Prompt範本。 |
| GetPromptTemplate | 擷取Prompt模板 | 基於模板Id擷取Prompt模板。 |
| UpdatePromptTemplate | 更新Prompt模板 | 基於模板Id累加式更新Prompt模板。 |
| DeletePromptTemplate | 刪除Prompt模板 | 基於模板Id刪除Prompt模板。 |
| ListPromptTemplates | 擷取Prompt模板列表 | 擷取Prompt模板列表。 |
其他
API | 標題 | API概述 |
|---|---|---|
| CreateMemory | 建立長期記憶體 | 建立一個長期記憶體。 |
| GetMemory | 取得長期記憶體 | 取得指定長期記憶體的描述資訊。 |
| UpdateMemory | 更新長期記憶體 | 更新指定長期記憶體的描述資訊。 |
| DeleteMemory | 刪除長期記憶體 | 永久性刪除指定的長期記憶體。 |
| ListMemories | 獲取長期記憶體列表 | 獲取指定業務空間下一個或多個長期記憶體的詳細資訊。 |
| CreateMemoryNode | 建立記憶片段 | 建立記憶片段。 |
| GetMemoryNode | 獲取記憶片段 | 獲取記憶片段。 |
| UpdateMemoryNode | 更新記憶片段 | 更新記憶片段。 |
| DeleteMemoryNode | 刪除記憶片段 | 刪除記憶片段。 |
| ListMemoryNodes | 獲取記憶片段列表 | 獲取記憶片段列表。 |
| ApplyTempStorageLease | 申請臨時檔案上傳許可 | 該介面用於高代碼部署，其他情境暫不支援。用於申請臨時檔案上傳許可，之後需要自己完成檔案上傳動作。 |
Others
API | 標題 | API概述 |
|---|---|---|
| AddChunk | 新增切片 | 使用此 API 可為文件搜尋類（document）、資料查詢類（table）、圖片問答類（image）知識庫新增切片。 |