### 3.4.14 漢語詞典 #### （1）功能說明 通過打開漢語詞典來查詢詞語（含成語）的解釋。 #### （2） 接口說明 **請求方法** * POST **請求地址** * [http://api.ruyi.ai/v1/message](http://api.ruyi.ai/v1/message) **請求參數說明** | 參數名 | 參數類型 | 是否必須 | 參數說明 | | :--- | :--- | :---: | :--- | | q | String | 是 | 自然語言表達，例如“成語一馬當先是什么意思" | | app\_key | String | 是 | 應用開發者秘鑰，注冊開發者后臺賬號，建立虛擬助理后獲得 | | user\_id | String | 是 | 用戶唯一標識，便于支持個性化語義解析。建議開發者使用 UUID 字符，且不同用戶必須用不同的 user\_id，防止意圖串。 | #### （3） 返回說明 **返回參數說明** | 名稱 | 類型 | 說明 | | :--- | :--- | :--- | | code | Integer | 返回代碼 | | msg | String | 返回代碼描述 | | parameters | JSON Object | 解析到的實體以及服務說明 | | action | String | 服務的接口名稱 | | name | String | 匹配的意圖名稱 | | result | JSON Object | 接口返回內容 | | outputs | Array | 服務輸出結果，微信端使用 type 類型為 wechat 開頭的內容；硬件端收到所有內容，依據需求解析使用 | **返回代碼說明** | 返回代碼 | 錯誤類型 | 說明 | | :--- | :--- | :--- | | 0／200 | 成功 | 請求成功 | | 400 | 無效請求 | 某些必需參數缺失或參數值錯誤，詳見msg字段 | | 401 | 未授權 | 授權失敗，app\_key缺失或錯誤 | | 403 | 請求被禁止 | 有效請求，但服務拒絕響應，請聯系contact@ruyi.ai | | 408 | 請求超時 | 請求響應超時，一般響應時間設置為2000ms以內 | | 429 | 短時間內大量訪問 | 短時間內請求數過多 | | 500 | 內部錯誤 | 服務處理異常 | | 503 | 服務不可用 | 服務異常或正在維護 | #### （4）請求示例 **請求范例** _打開漢語詞典_ _遺憾這個詞語是什么意思_ _成語一馬當先是什么意思_ _退出_ **請求示例** （打開詞典） * http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=打開漢語詞典 返回結果 ```json { "code": 0, "msg": "ok", "result": { "_text": "打開漢語詞典", "msg_id": "059146f8-3f18-4df6-8fc4-6a6898a79f78", "intents": [ { "parameters": { "service": "dictionary" }, "name": "喚醒辭海（小米）", "result": { "text": "歡迎來到如意漢語詞典。你可以問我“一馬當先這個詞語的意思”", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": "歡迎來到如意漢語詞典。你可以問我“一馬當先這個詞語的意思”" } }, { "type": "dialog", "property": { "text": "歡迎來到如意漢語詞典。你可以問我“一馬當先這個詞語的意思”", "emotion": "positive" } } ], "score": "1.0", "scoreColor": "c4", "is_match": 1, "skill_id": "cc192a1c-a61c-4ddb-8e7c-0cfab5de3e80", "id": "1e68ab60-d400-415c-888a-07228e80e7ca", "action": "dialog" } ], "meta_process_milliseconds": 118 } } ``` **請求示例** （打開詞典） * http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=遺憾這個詞語什么意思 返回結果 ```json { "code": 0, "msg": "ok", "result": { "_text": "遺憾這個詞語什么意思", "msg_id": "da38844a-9281-4bd1-856f-b13f899d14e3", "intents": [ { "parameters": { "key": "4d5e1f85cde9491bab023dd98a98d95f", "keyword": "遺憾", "意思": "什么意思", "這個詞語": "這個詞", "service": "dictionary" }, "action": "詞語解釋", "name": "詞語查詢（無暗號版）", "result": { "code": 200, "response": { "result": { "words": "遺憾", "content": "yí/wèi hàn<br>因未能稱心如愿而惋惜：全集已刊行，先生無遺憾矣｜遺憾終生。外交上常用來表示不滿：貴方所提條件太高，我們不能接受，深表遺憾。" }, "error_code": 0, "reason": "Succes" }, "text": "遺憾是指因未能稱心如愿而惋惜：全集已刊行，先生無遺憾矣｜遺憾終生。外交上常用來表示不滿：貴方所提條件太高，我們不能接受，深表遺憾。", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": "遺憾是指因未能稱心如愿而惋惜：全集已刊行，先生無遺憾矣｜遺憾終生。外交上常用來表示不滿：貴方所提條件太高，我們不能接受，深表遺憾。" } }, { "type": "dialog", "property": { "text": "遺憾是指因未能稱心如愿而惋惜：全集已刊行，先生無遺憾矣｜遺憾終生。外交上常用來表示不滿：貴方所提條件太高，我們不能接受，深表遺憾。", "emotion": "positive" } } ], "score": "0.999835612918792", "scoreColor": "c4", "is_match": 1, "skill_id": "cc192a1c-a61c-4ddb-8e7c-0cfab5de3e80", "id": "0492ceb1-5062-4f37-ac58-ca06143ddd42" } ], "meta_process_milliseconds": 543 } } ``` **請求示例** （退出詞典） * http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=退出 返回結果 ```json { "code": 0, "msg": "ok", "result": { "_text": "退出", "msg_id": "84a06501-05e6-43b7-a1d1-f494b5462661", "intents": [ { "parameters": { "service": "dictionary" }, "name": "退出如意技能", "result": { "text": "已退出漢語詞典，下次使用記得跟我說“打開漢語詞典”", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": "已退出漢語詞典，下次使用記得跟我說“打開漢語詞典”" } }, { "type": "dialog", "property": { "text": "已退出漢語詞典，下次使用記得跟我說“打開漢語詞典”", "emotion": "calm" } } ], "score": "1.0", "scoreColor": "c4", "is_match": 1, "skill_id": "cc192a1c-a61c-4ddb-8e7c-0cfab5de3e80", "id": "a856b7a7-bac1-4781-ae38-8b77dca3fd2d", "action": "dialog" } ], "meta_process_milliseconds": 48 } } ``` **詳細參數說明** | 名稱 | 類型 | 說明 | | :--- | :--- | :--- | | service | String | 服務名稱 | | keyword | String | 識別關鍵詞 |