### 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 表示未勾选小尾巴