系統為開發者提供了一套Java SDK服務API。本手冊將簡單地介紹API列表,及API對應的功能概覽。
請注意:
開發者通過API接口傳輸的數據,請務必進行必要脫敏處理,并確保傳輸的數據中不包含任何個人信息。
機器人管理
API | 描述 |
用于創建一個Robot實例。每新增1個客戶,都須調用本接口創建一個Robot、獲取RobotCode。 | |
用于更新機器人配置信息 | |
用于刪除指定機器人。刪除后該機器人相關的所有數據(包括機器人配置、知識等)也都將被刪除,且刪除后不可再恢復。 | |
Robot核心問答接口,用于輸入用戶問題、調用指定機器人獲取機器人應答結果。 | |
Robot問答測試接口,用于模擬用戶問題,進行應答測試。 |
行業包管理
API | 描述 |
用于查詢系統為開發者提供的全部知識包,包括retailbot提供的通用包、行業包、ISV自定義的行業包 | |
用于查詢單個指定的行業包有效版本列表 | |
用于批量查詢多個行業包的有效版本列表 | |
用于查詢指定包的指定版本下,所包含的知識列表 | |
根據指定的行業包查詢訂閱了指定行業包、指定版本的機器人訂閱關系列表 | |
根據機器人Code查詢指定機器人與行業包訂閱關系列表 | |
為指定機器人訂閱指定行業包 | |
為指定機器人取消訂閱指定行業包,取消訂閱后,該Robot下將無法再查詢到該行業包相關的知識(含答案),且重新訂閱該行業包后原有答案不會再恢復。 | |
用于將指定Robot的指定行業包,從a版本升級到b版本。版本升級后,相同場景的答案會自動保留,新版本不再包含的場景的答案會自動刪除。 |
知識管理
API | 描述 |
查詢商家已訂閱知識包知識列表 | |
用于查詢指定知識的詳細信息 | |
將指定Robot的指定場景的啟用狀態設置為“開啟”。場景開啟后,在實時問答服務中可被定位到。 | |
將指定Robot的指定場景的啟用狀態設置為“關閉”。場景關閉后,在實時問答服務中不可被定位到。 |
答案管理
API | 描述 |
用于在指定知識下新建一個答案 | |
用于更新一個已有的答案內容 | |
用于查詢一個指定答案的詳情 | |
用于刪除一個指定的答案。刪除后不可再恢復,且無法再查詢到已被刪除的答案的信息。 |
知識類目樹管理
API | 描述 |
獲取完整的知識類目樹,用于知識庫場景展示等功能 |
對話數據管理
API | 描述 |
用于向retailbot回流完整的人機對話日志 | |
用于向retailbot回流完整的人人對話日志 | |
訓練師上傳語料打標數據訓練AI問答模型 |