### 3.2.4 鸚鵡學舌 #### （1） 功能說明 基于開發者后臺開發的定制化益智小游戲。像鸚鵡那樣學你說話！面向嬰幼兒的學舌游戲，用戶說"鸚鵡鸚鵡"開始游戲，用戶說一個詞語，機器人會像鸚鵡一樣重復一遍。只包括嚴格意義上的詞語，不包括"回家"這樣的動賓詞組。用戶可通過退出結束游戲。 #### （2）接口說明 **請求方法** * POST **請求地址** * 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": "b0618a1b-dd9a-413f-9108-86808bc4a128", "intents": [{ "parameters": { "kid_ciyu1": "什么", "service": "yingwu" }, "action": "0", "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": "031ffbe4-3580-4146-adef-8a6dc1c8734b" }], "meta_process_milliseconds": 27 } } ``` **請求示例失敗** (輸入錯誤的詞語) * 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": "2b259b43-38af-4d56-b554-94a387c94565", "intents": [{ "parameters": { "service": "yingwu" }, "action": "0", "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": "4e21dce1-99d9-4b8e-bf0e-a45b773913d2" }], "meta_process_milliseconds": 30 } } ``` **請求示例退出** （結束游戲，返回統計分數） * 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": "5f424322-17b0-44cd-92bb-644b77c24056", "intents": [{ "parameters": { "service": "yingwu" }, "action": "0", "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, "id": "fd653951-3aef-4503-9571-d9fd78af2bbc" }], "meta_process_milliseconds": 29 } } ``` **詳細參數說明** |名稱|類型|說明| |:---|:---|:--- |service | String |服務名稱 |kid_ciyu1|String |識別的正確詞語