本產品（
智能對話機器人/2022-04-08）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
文檔管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDoc | 文檔新建 | 文檔新建。 |
| DeleteDoc | 刪除文檔 | 刪除文檔。 |
| UpdateDoc | 更新文檔 | 更新文檔。 |
| RetryDoc | 文檔重試 | 文檔重試。 |
| SearchDoc | 搜索文檔 | 搜索文檔。 |
| DescribeDoc | 文檔詳情 | 文檔詳情。 |
類目管理
| API | 標題 | API概述 |
|---|---|---|
| CreateCategory | 類目-新建 | 新建類目。 |
| DeleteCategory | 類目-刪除 | 刪除類目， 已發布的類目變成已刪除未發布狀態，未發布的類目則直接刪除。 |
| UpdateCategory | 類目-更新 | 編輯類目。 |
| DescribeCategory | 類目-詳情 | 查看單個類目信息。 |
| ListCategory | 獲取類目列表 | 獲取類目列表。 |
會話管理
| API | 標題 | API概述 |
|---|---|---|
| ApplyForStreamAccessToken | 獲取流式調用的連接信息 | 獲取流式調用的連接信息。 |
| Feedback | 問答點贊、點踩 | 保存用戶對于問答結果的評價。 |
| Associate | 會話-聯想API | 根據用戶query聯想知識庫中的FAQ。 |
| BeginSession | 獲取歡迎語 | 獲取歡迎語接口。 |
全局服務
| API | 標題 | API概述 |
|---|---|---|
| GetAsyncResult | 獲取異步函數執行結果 | 獲取異步服務執行結果，配合Chat接口使用。 |
機器人管理
| API | 標題 | API概述 |
|---|---|---|
| 機器人管理 | 機器人管理 | |
| CreateInstance | 機器人-創建 | 創建沙箱環境機器人。 |
| DeleteInstance | 機器人-刪除 | 刪除沙箱和線上的機器人。 |
| UpdateInstance | 機器人-更新 | 更新機器人名稱，描述。 |
| ListInstance | 機器人-列表 | 查詢機器人列表。 |
FAQ管理
| API | 標題 | API概述 |
|---|---|---|
| FAQ相似問 | FAQ相似問 | |
| CreateSimQuestion | 創建相似問 | 創建相似問題。 |
| DeleteSimQuestion | 刪除FAQ相似問 | 刪除相似問題。 |
| UpdateSimQuestion | 更新FAQ相似問 | 更新相似問題。 |
| ListSimQuestion | 獲取FAQ相似問列表 | 查詢知識的相似問題列表。 |
| FAQ | FAQ | |
| CreateFaq | 創建FAQ | 創建一條知識。 |
| DeleteFaq | 刪除FAQ | 刪除一條知識。 |
| UpdateFaq | 修改FAQ | 編輯一條知識。 |
| DescribeFaq | 獲取FAQ詳情 | 查詢知識詳情。 |
| SearchFaq | FAQ搜索 | 搜索知識。 |
發布管理
| API | 標題 | API概述 |
|---|---|---|
| CreatePublishTask | 創建發布任務 | 創建發布中心的發布任務。 |
| CancelPublishTask | 取消發布任務 | 取消正在發布中的任務。 |
| GetPublishTaskState | 查詢發布進度 | 查詢發布進度。 |
業務空間
| API | 標題 | API概述 |
|---|---|---|
| GetAgentInfo | 根據實例ID獲取業務空間信息 | 獲取業務空間ID。 |
| ListAgent | 獲取業務空間列表 | 獲取當前阿里云賬號的業務空間列表。 |
渠道聊天窗
| API | 標題 | API概述 |
|---|---|---|
| GenerateUserAccessToken | 獲取用戶免登Token | 用于聊天窗用戶免登時，獲取Token，通過該Token可將用戶的企業身份帶入。 |
數據看板
| API | 標題 | API概述 |
|---|---|---|
| ListTongyiConversationLogs | 查詢單個會話的對話記錄 | 查詢對話機器人通義版的單個會話對話記錄 |
| ListTongyiChatHistorys | 會話歷史明細 | 調用ListTongyiChatHistorys接口獲取會話歷史明細。 |
| GetBotSessionData | 機器人接待概況 | 查詢機器?問答概覽指標。 |