### 3.1.3 機器人檔案 #### （1） 功能說明 實現此功能請先登錄 [ruyi開發者后臺](http://ruyi.ai) 通過`機器人設置>屬性設置`頁面設置機器人的相關屬性后，即可通過問答`你叫什么名字`、`你是男生嗎`、`你爸媽是誰`等獲得機器人的檔案信息，增加了和用戶的互動與親和感。具體屬性包括姓名、性別、生日、愛好和父母信息等5類。同時滿足了客戶對機器人的定制化需求，創建屬于自己獨一無二的機器人。 #### （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": "661af2ee-fff7-4e95-9e88-3c3dbb87aa9f", "intents": [ { "parameters": { "alias": "寶寶", "aliasTails": "想給我改名咩，對我說"以后我就叫你XXX"認領我吧~", "aliasTailsFlag": "true", "service": "agentattribute" }, "action": "a", "name": "姓名", "result": { "text": "嗨！我是&name ！請多多指教！", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": " 我叫寶寶，想給我改名咩，對我說"以后我就叫你XXX"認領我吧~" } }, { "type": "dialog", "property": { "text": " 我叫寶寶，想給我改名咩，對我說"以后我就叫你XXX"認領我吧~", "emotion": "calm" } } ], "score": "1.0", "scoreColor": "c4", "is_match": 1, "id": "72f3155d-fa4c-44fd-8ba9-adf0731f8c15" } ], "meta_process_milliseconds": 37 } } ``` **詳細參數說明** |名稱 |類型| 說明 |:---|:---|:--- |service| String |服務名稱 |alias| String |機器人姓名 |aliasTails| String |機器人姓名小尾巴內容：對機器人姓名的補充描述 |aliasTailsFlag| bool |機器人姓名小尾巴：true 表示勾選小尾巴，false表示未勾選小尾巴 |ageyear| String |機器人設置生日年份 |agemonth| String |機器人設置生日月份 |ageday| String |機器人設置出生日期 |birthday| String |機器人設置生日 |zodiac| String |機器人屬相 |constellation| String |機器人星座 |sex| String |機器人性別 |sexTails| bool |機器人性別小尾巴內容：對機器人性別的補充描述 |sexTailsFlag| String |機器人性別小尾巴：true 表示勾選小尾巴，false 表示未勾選小尾巴 |hobby| String |機器人愛好 |hobbyTails| bool |機器人愛好小尾巴內容：對機器人愛好的補充描述 |hobbyTailsFlag| String |機器人愛好小尾巴：true 表示勾選小尾巴，false 表示未勾選小尾巴 |father| String |機器人父親姓名 |fatherTails| String |機器人父親姓名小尾巴內容：對機器人父親的補充描述 |fatherTailsFlag| bool|父親姓名小尾巴：true 表示勾選小尾巴，false 表示未勾選小尾巴 |mother| String |母親姓名 |motherTails| String |母親姓名小尾巴內容 |motherTailsFlag| bool |母親姓名小尾巴：true 表示勾選小尾巴，false 表示未勾選小尾巴