### 3.1.6 Smart Reply #### (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=走路](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": "2abe03ff-10e8-4eaf-a069-831ba1639b51", "intents": [ { "parameters": { "reply": "走自己的路、让猫和狗说去吧", "service": "smart_reply" }, "action": "dialog", "name": "smart_reply", "result": { "text": "走自己的路、让猫和狗说去吧", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": "走自己的路、让猫和狗说去吧" } }, { "type": "dialog", "property": { "text": "走自己的路、让猫和狗说去吧", "emotion": "calm" } } ], "score": "1.0", "scoreColor": "c4", "is_match": 1, "id": "4634e213-e5e5-4a9a-8e6e-40189e0f448e" } ], "meta_process_milliseconds": 342 } } ``` **详细参数说明** | 名称 | 类型 | 说明 | | :--- | :--- | :--- | | service | String | 服务名称 | | text | String | 返回文本内容 |