私有語料庫接口V2.0 · 幫助中心

## **接口說明** 為滿足用戶對自有私有語料庫數據的管理與操作，圖靈機器人再次開放語料庫API接口，接入成功后無需登錄圖靈機器人官網后臺進行數據的相關操作，直接通過該接口就能完成對私有語料庫一系列的操作，并能實現與官網私有語料庫數據同步更新。私有語料庫接口暫時對標準版及專業版用戶開放，提供了私有語料庫相關的6個接口（匹配度設置、加密模式設置、私有語料新增、刪除、修改、查詢）。 ## **使用說明** ### ****接口約定**** ### JSON格式數據格式統一使用JSON方式，則統一為如下方式： JSON方式(指定header ：Content-Type為application/json): ### 統一加密模式 md5(secret+timestamp) >注： >1.timestamp在三分鐘內有效 >2.secret為密鑰 ### 統一返回錯誤碼 |code| 說明| |-|-| |3**| 操作錯誤| |301| 缺少必要參數、參數格式錯誤| |4**| 權限錯誤| |401| APIkey不存在或者不具有權限| |405| token校驗失敗| |5**| 接口專屬錯誤| * * * * * ### ****匹配度修改**** #### 請求接口 http://www.tuling123.com/v1/kb/match #### 請求方式 HTTP GET/POST #### 請求數據 ~~~ { "apikey":" apikey ", "data":{ "match":60 }, "timestamp": timestamp, "token":" token " } ~~~ #### 參數說明 |參數名稱| 參數內容| |-|-| |apikey| 機器人apikey（必填）| |data| 要修改的數據| |match| 匹配度| |timestamp| timestamp（加密必填）| |token| md5加密計算結果（加密必填）| #### 返回數據說明成功返回： `{code: 0, data:{"match":degree}}` #### 特殊返回錯誤碼 |code| 說明| |-|-| |501| 匹配度不正確| * * * * * ### ****語料庫加密模式**** #### 請求接口 http://www.tuling123.com/v1/kb/secret #### 請求方式 HTTP GET/POST #### 請求數據 ~~~ { "apikey":" apikey ", "data":{ "mod":false, "secret":" secret " }, "timestamp": timestamp , "token":" token " } ~~~ #### 參數說明 |參數名稱| 參數內容| |-|-| |apikey| 機器人apikey（必填）| |data| 要修改的數據| |mod| 加密狀態| |secret|secret| |timestamp| timestamp（加密必填）| |token| md5加密計算結果（加密必填）| #### 返回數據說明成功返回： `{code: 0, data:{"mod":true}}` #### 特殊返回錯誤碼 |code| 說明| |-|-| |501| mod傳參不正確應為布爾值或匹配度不正確| * * * * * ### ****語料庫新增**** #### 請求接口 http://www.tuling123.com/v1/kb/import #### 請求方式 HTTP GET/POST #### 請求數據 ~~~ { "apikey":" apikey ", "data":{ "list":[ {"question":"question", "answer":"answer"} ]}, "timestamp": timestamp , "token":" token " } ~~~ #### 參數說明 |參數名稱| 參數內容| |-|-| |apikey| 機器人apikey（必填）| |data| 要修改的數據| |list| 數據列表| |question|新增問題| |answer|新增答案| |timestamp| timestamp（加密必填）| |token| md5加密計算結果（加密必填）| #### 返回數據說明成功返回： ~~~ { "data": { "successNum": 1, "knowledgeList": [{ "id": "2146008", "time": "2016-10-17 11:14:38", "answer": "answer", "label_id": 0, "question": "question" }] }, "code": 0 } ~~~ #### 特殊返回錯誤碼 |code| 說明| |-|-| |401| 權限錯誤| |501| 網絡錯誤 | * * * * * ### ****語料庫查詢**** #### 請求接口 http://www.tuling123.com/v1/kb/select #### 請求方式 HTTP GET/POST #### 請求數據 ~~~ { "apikey":" apikey ", "data": { "pages":{ "pageNumber":1, "pageSize":10, "searchBy": "question" } }, "timestamp": timestamp , "token":" token " } ~~~ #### 參數說明 |參數名稱| 參數內容| |-|-| |apikey| 機器人apikey（必填）| |data| 要修改的數據| |pages| 查詢返回頁面格式| |pageNumber| 頁數| |pageSize| 每頁顯示行數| |searchBy| 查詢的關鍵詞| |timestamp| timestamp（加密必填）| |token| md5加密計算結果（加密必填）| #### 返回數據說明成功返回： ~~~ { "code": 0, "data": { "totalCount": 2, "knowledgeCount": 2, "knowledgeList": [ { "id": "2", "question": "question2", "answer": "您設定的question2的答案", "time": "2015-12-03 14:34:36" }, { "id": "1", "question": "question1", "answer": "您設定的question1的答案", "time": "2015-12-03 14:34:35" } ] } } ~~~ #### 特殊返回錯誤碼 |code| 說明| |-|-| |501| 網絡錯誤 | * * * * * ### ****語料庫修改**** #### 請求接口 http://www.tuling123.com/v1/kb/update #### 請求方式 HTTP GET/POST #### 請求數據 ~~~ { "apikey":" apikey ", "data":{ list:[ {"id":"1","question":"新的問題”,"answer":"新的答案"}, {"id":"2","question":"新的問題”,"answer":"新的答案"} ]}, "timestamp": timestamp , "token":" token " } ~~~ #### 參數說明 |參數名稱| 參數內容| |-|-| |apikey| 機器人apikey（必填）| |data| 要修改的數據| |id| 需要更改的數據id| |question| 新的問題| |answer| 新的答案| |timestamp| timestamp（加密必填）| |token| md5加密計算結果（加密必填）| #### 返回數據說明成功返回： ~~~ {"code":0,"data":"2"} ~~~ * * * * * ### ****語料庫刪除**** #### 請求接口 http://www.tuling123.com/v1/kb/delete #### 請求方式 HTTP GET/POST #### 請求數據 ~~~ { "apikey": "apikey", "data": { "clear": false, "ids": [1,2,3] } "timestamp": timestamp , "token":" token " } ~~~ #### 參數說明 |參數名稱| 參數內容| |-|-| |apikey| 機器人apikey（必填）| |data| 要修改的數據| |clear| 是否清空數據庫| |isclear| 清空數據庫標志位| |ids| 待刪除的數據id編號| |timestamp| timestamp（加密必填）| |token| md5加密計算結果（加密必填）| #### 返回數據說明成功返回： ~~~ {"code":0,"data":"3"} ~~~ #### 特殊返回錯誤碼 |code| 說明| |-|-| |501| 無權刪除該條數據 | ## **注意事項** （1）使用者須為圖靈機器人標準版或專業版用戶；（2）用戶使用私有語料庫新增接口批量導入數據時，享有與官網Excel上傳導入相同的權限設置（10000條/5次/天）。官網導入數據與接口導入數據都以累計的方式進行，每天數據導入量上限為10000條，次數上限為5次；（3）用戶使用私有語料新增接口逐條添加數據時，每日導入量上限為10000條；（4）圖靈機器人對私有語料庫接口提供了加密模式設置，目前分為加密和不加密兩種形式，用戶可按需自行設定。（5）用戶如想修改私有語料庫中的數據時，推薦將該條數據刪除后再重新添加。