汉语词典 · ruyi.ai开发者文档

### 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 | 识别关键词 |