### 3.1.1 顶级过滤器 #### (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 { "_text": "苍井空是谁", "msg_id": "98df932d-2e76-4196-9663-a7571c7dff28", "intents": [{ "parameters": { "blacklist": "苍井空", "any1": "", "any2": "是谁", "service": "blacklist" }, "action": "dialog", "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, "id": "c7375e39-4326-42c4-b96c-5c307baacf67" }], "meta_process_milliseconds": 70 } ``` **详细参数说明** | 名称 | 类型 | 说明 | | :--- | :--- | :--- | | service | String | 服务名称 | | blacklist | String | 识别的过滤词 |