本產品（
智能對話機器人/2022-04-08）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
類目管理
| API | 標題 | API概述 |
|---|---|---|
| CreateCategory | 類目-新建 | 新建類目。 |
| DeleteCategory | 類目-刪除 | 刪除類目， 已發布的類目變成已刪除未發布狀態，未發布的類目則直接刪除。 |
| UpdateCategory | 類目-更新 | 編輯類目。 |
| DescribeCategory | 類目-詳情 | 查看單個類目信息。 |
| ListCategory | 獲取類目列表 | 獲取類目列表。 |
會話管理
| API | 標題 | API概述 |
|---|---|---|
| Feedback | 問答點贊、點踩 | 保存用戶對于問答結果的評價。 |
| Chat | 會話 | 根據機器人唯一標識（機器人ID）與其進行會話，僅適用于智能對話機器人（舊版）。 |
| Associate | 會話-聯想API | 根據用戶query聯想知識庫中的FAQ。 |
| BeginSession | 獲取歡迎語 | 獲取歡迎語接口。 |
| Nlu | 統一NLU接口 | 針對用戶query，返回機器人有關這個query的語言理解（nlu）結果。當前只支持對話工廠、中控的NLU信息透出，其他引擎后續按需支持。 |
全局服務
| API | 標題 | API概述 |
|---|---|---|
| GetAsyncResult | 獲取異步函數執行結果 | 獲取異步服務執行結果，配合Chat接口使用。 |
機器人管理
| API | 標題 | API概述 |
|---|---|---|
| 機器人管理 | 機器人管理 | |
| CreateInstance | 機器人-創建 | 創建沙箱環境機器人。 |
| DeleteInstance | 機器人-刪除 | 刪除沙箱和線上的機器人。 |
| UpdateInstance | 機器人-更新 | 更新機器人名稱，描述。 |
| LinkInstanceCategory | 機器人-綁定類目 | 機器人綁定知識類目。 |
| DescribeInstance | 獲取機器人詳情 | 查詢機器人詳情。 |
| ListInstance | 機器人-列表 | 查詢機器人列表。 |
| 機器人發布 | 機器人發布 | |
| CreateInstancePublishTask | 創建機器人發布任務 | 將沙箱機器人發布到線上。 |
| CancelInstancePublishTask | 取消機器人發布 | 在發布機器人的過程中，取消機器人發布任務。 |
| ContinueInstancePublishTask | 繼續機器人發布 | 機器人發布告警時，忽略告警并繼續發布。 |
| GetInstancePublishTaskState | 查詢機器人發布進度 | 查詢機器人發布進度。 |
FAQ管理
| API | 標題 | API概述 |
|---|---|---|
| FAQ答案 | FAQ答案 | |
| CreateSolution | 創建FAQ答案 | 創建知識答案。 |
| DeleteSolution | 刪除FAQ答案 | 刪除答案。 |
| UpdateSolution | 更新FAQ答案 | 更新答案。 |
| ListSolution | 獲取FAQ答案列表 | 查詢知識的答案列表。 |
| FAQ關聯問 | FAQ關聯問 | |
| CreateConnQuestion | 創建關聯問 | 為知識添加關聯知識。 |
| DeleteConnQuestion | 刪除FAQ關聯問 | 刪除知識的關聯知識。 |
| UpdateConnQuestion | 更新FAQ關聯問 | 更新關聯關系。 |
| ListConnQuestion | 獲取關聯問列表 | 查詢知識的關聯問題列表。 |
| FAQ相似問 | FAQ相似問 | |
| CreateSimQuestion | 創建相似問 | 創建相似問題。 |
| DeleteSimQuestion | 刪除FAQ相似問 | 刪除相似問題。 |
| UpdateSimQuestion | 更新FAQ相似問 | 更新相似問題。 |
| ListSimQuestion | 獲取FAQ相似問列表 | 查詢知識的相似問題列表。 |
| FAQ | FAQ | |
| CreateFaq | 創建FAQ | 創建一條知識。 |
| DeleteFaq | 刪除FAQ | 刪除一條知識。 |
| UpdateFaq | 修改FAQ | 編輯一條知識。 |
| DescribeFaq | 獲取FAQ詳情 | 查詢知識詳情。 |
| SearchFaq | FAQ搜索 | 搜索知識。 |
對話工廠
| API | 標題 | API概述 |
|---|---|---|
| 實體管理 | 實體管理 | |
| 實體 | 實體 | |
| CreateDSEntity | 實體-創建 | 創建實體，特指實體的Meta信息，如：實體名稱、實體類型。 |
| DeleteDSEntity | 實體-刪除 | 刪除一個實體，會級聯刪除該實體下所有的實體成員及同義詞、正則表達式。 |
| UpdateDSEntity | 實體-修改 | 實體meta信息修改，僅支持修改實體名稱；實體類型不支持修改。 |
| DescribeDSEntity | 實體-詳情 | 查詢指定機器人下指定實體的meta信息，如：實體類型、實體名稱、創建時間、修改時間等。 |
| ListDSEntity | 實體-列表 | 查詢指定機器人下的實體列表數據，僅返回每個實體的meta信息，如：實體類型、實體名稱、創建時間、修改時間等。 |
| 實體成員 | 實體成員 | |
| CreateDSEntityValue | 實體成員-創建 | 為指定的某個實體，添加實體成員信息，包含：實體值、對應的同義詞列表，同一實體內部的實體值、同義詞唯一。 |
| DeleteDSEntityValue | 實體-實體成員-刪除 | 刪除某個實體的某個成員；若為標準實體，會同步刪除其同義詞（若有）。 |
| UpdateDSEntityValue | 實體成員-修改 | 修改某個實體的某個實體成員，有實體值&同義詞、正則表達式兩類數據修改。注意：往一個標準實體中添加正則表達式是不被允許的，反之亦然。 |
| ListDSEntityValue | 實體成員-列表 | 查詢指定實體的實體成員列表及詳情數據，同時支持關鍵詞篩選（contains），篩選范圍：實體值、同義詞。 |
| 意圖管理 | 意圖管理 | |
| 意圖 | 意圖 | |
| CreateIntent | 意圖-創建 | 新建意圖，主要包含意圖的meta信息，如：意圖名稱、意圖別名、意圖關聯詞槽信息；不包含意圖話術、LGF。 |
| DeleteIntent | 意圖-刪除 | 刪除一個意圖，會級聯刪除該意圖下所有的意圖話術和高級語義配置（LGF）。 |
| UpdateIntent | 意圖-修改 | 修改意圖，主要包含意圖的meta信息，如：意圖名稱、意圖別名、意圖關聯詞槽信息；不包含意圖話術、LGF。 |
| DescribeIntent | 意圖-詳情 | 返回指定意圖的 meta 信息，如：意圖類型、意圖名稱、創建時間、修改時間等。 |
| ListIntent | 意圖-列表 | 查詢指定機器人下的意圖列表數據，僅返回每個意圖的 meta 信息，如：意圖類型、意圖名稱、創建時間、修改時間等。 |
| 意圖話術 | 意圖話術 | |
| CreateUserSay | 意圖-話術創建 | 為指定意圖添加話術的信息。 |
| DeleteUserSay | 意圖-話術-刪除 | 修改意圖話術信息。 |
| UpdateUserSay | 意圖-話術-修改 | 修改意圖話術信息。 |
| ListUserSay | 意圖-話術-列表 | 查詢指定意圖的話術內容及關聯槽位信息，支持關鍵話術篩選（contains）。 |
| 高級語義配置（LGF） | 高級語義配置（LGF） | |
| CreateLgf | 意圖-LGF-創建 | 為指定意圖創建高級語義配置（LGF）。 |
| DeleteLgf | 意圖-LGF-刪除 | 刪除指定高級語義配置。 |
| UpdateLgf | LGF-修改 | 為指定意圖創建高級語義配置（LGF）。 |
| ListLgf | 意圖-LGF-列表 | 查詢指定意圖的高級語義配置（LGF）。 |
視角管理
| API | 標題 | API概述 |
|---|---|---|
| CreatePerspective | 視角-創建 | 創建視角。 |
| DeletePerspective | 視角-刪除 | 刪除視角。 |
| UpdatePerspective | 視角-更新 | 更新視角名稱和描述。 |
| DescribePerspective | 視角-詳情 | 查詢視角詳情。 |
| QueryPerspectives | 視角-列表 | 查詢視角列表。 |
發布管理
| API | 標題 | API概述 |
|---|---|---|
| CreatePublishTask | 創建發布任務 | 創建發布中心的發布任務。 |
| CancelPublishTask | 取消發布任務 | 取消正在發布中的任務。 |
| GetPublishTaskState | 查詢發布進度 | 查詢發布進度。 |
業務空間
| API | 標題 | API概述 |
|---|---|---|
| GetAgentInfo | 根據實例ID獲取業務空間信息 | 獲取業務空間ID。 |
| ListAgent | 獲取業務空間列表 | 獲取當前阿里云賬號的業務空間列表。 |
渠道聊天窗
| API | 標題 | API概述 |
|---|---|---|
| GenerateUserAccessToken | 獲取用戶免登Token | 用于聊天窗用戶免登時，獲取Token，通過該Token可將用戶的企業身份帶入。 |
數據看板
| API | 標題 | API概述 |
|---|---|---|
| GetBotSessionData | 機器人接待概況 | 查詢機器?問答概覽指標。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| InitIMConnect | 初始化im連接 | 通過渠道后臺配置生成的from值，自定義初始化im連接信息，初始化時支持傳遞用戶鑒權token。 |
| ListSaasInfo | 獲取SaaS被集成信息列表 | 獲取SaaS被集成信息列表。 |
| ListSaasPermissionGroupInfos | 獲取權限被集成信息列表 | 獲取權限被集成信息列表，可通過該列表返回的權限組，給用戶授權。 |