### 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 | 識別的過濾詞 |