### 3.3.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": "b814e7b9-73ed-4b5a-bdb4-bcb2d2b782b6",
"intents": [{
"parameters": {
"type": "ruyi-customized-agent-info",
"upsert": "true",
"alias": "小蘋果",
"service": "2cattribute"
},
"action": "sys.action.item/update",
"name": "終端助理_設置姓名",
"result": {
"updated_item": {
"_id": "3571127f-976d-4368-991e-868b9e59fab4",
"type": "ruyi-customized-agent-info",
"alias": "小蘋果",
"service": "2cattribute",
"appId": "6e3a8217-d07d-4cb8-803c-75e952bb521b",
"userId": "user0",
"updated_time": 1487240842616,
"created_time": 1487240842616,
"item_status": "VALID"
},
"msg": "ok",
"text": "我的名字叫&name",
"type": "dialog"
},
"outputs": [{
"type": "wechat.text",
"property": {
"text": "好呀,那以后主人就叫我\"小蘋果\",是嗎"
}
}, {
"type": "dialog",
"property": {
"text": "好呀,那以后主人就叫我\"小蘋果\",是嗎",
"emotion": "suspect"
}
}],
"score": "1.0",
"scoreColor": "c4",
"is_match": 1,
"id": "444bdafd-e21f-4dcd-8ad7-3c83cc667996"
}],
"meta_process_milliseconds": 81
}
}
```
**請求示例**
還原姓名
* 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": "cd5cfea9-1454-4366-acc5-299703b1a076",
"intents": [{
"parameters": {
"type": "ruyi-customized-agent-info",
"unset": "alias",
"service": "2cattribute"
},
"action": "sys.action.item/update",
"name": "終端助理_忘記姓名",
"result": {
"updated_item": {
"_id": "3571127f-976d-4368-991e-868b9e59fab4",
"type": "ruyi-customized-agent-info",
"service": "2cattribute",
"appId": "6e3a8217-d07d-4cb8-803c-75e952bb521b",
"userId": "user0",
"updated_time": 1487241093479,
"created_time": 1487240842616,
"item_status": "VALID"
},
"msg": "ok",
"text": "我是&name",
"type": "dialog"
},
"outputs": [{
"type": "wechat.text",
"property": {
"text": "唔,好的!"
}
}, {
"type": "dialog",
"property": {
"text": "遵命",
"emotion": "calm"
}
}],
"score": "1.0",
"scoreColor": "c4",
"is_match": 1,
"id": "d8c14220-1881-45bc-b1b9-21651c882699"
}],
"meta_process_milliseconds": 371
}
}
```
**詳細參數說明**
| 名稱 | 類型 | 說明 |
| :--- | :--- | :--- |
| service | String | 服務名稱 |
| type | String | 類型|
| upsert | String | 判斷助理名是否存在 |
| alias | String | 機器人名字 |
|updated_time|String|更新時間
|created_time|String|創建時間
| yes | String | 確認 |
| no | String | 否定 |
- 1. 海知智能第三方技能插件開放平臺概述
- 2. 快速接入API
- 2.1 硬件接口調用
- 2.2 快速接入微信
- 2.3 API接入常見問題
- 3. 技能插件
- 3.1 基礎能力類
- 頂級過濾器
- 用戶知識圖譜
- 機器人檔案
- 通用閑聊
- 兒童閑聊
- Smart Reply
- 輕量閑聊
- 3.2 語音游戲類
- 成語接龍
- 詞匯樂園
- 詞語接龍
- 鸚鵡學舌
- 動腦猜猜
- 挑戰單詞
- 冒險世界
- 猜猜我是誰
- 阿拉丁學詩詞
- 貓貓托管所
- 漂流瓶
- 詩詞大會
- 國學大會
- 我愛猜歌名
- 我在看著你
- 燈謎猜猜
- 3.3 休閑娛樂類
- 星座運勢
- 悅耳聲音
- 幸運簽
- 調教機器人
- 娛樂推送
- 3.4 生活服務類
- 黃歷
- 計算器
- 古詩詞
- 時間詢問
- 翻譯類技能
- 天氣資訊
- 日程創建
- 日程創建指令
- 鬧鐘
- 食材知識
- 冥想音樂
- 格言
- 每日英語
- 漢語詞典
- 豆果菜譜
- 古文翻譯
- 3.5 音頻點播類
- 喜馬拉雅FM
- 新聞廣播
- 音樂點播
- Smart Music
- 兒童聽聽
- Smart Audio
- 兒童笑話
- 點播控制指令
- 3.6 視頻點播類
- 影視點播
- 3.7 百科知識類
- 人物百科
- 百科問答
- 實時百科
- 3.8 體育健康類
- 五分鐘健身
- 4. 開發者初級教程
- 4.1 開通服務
- 4.2 創建機器人
- 4.3 設置機器人
- 4.4 獲取技能插件
- 4.5 讓機器人學會聊天
- 4.6 導入知識庫
- 4.7 多種問答形式
- 4.8 數據統計
- 4.9 粉絲管理
- 5. 開發者中級教程
- 5.1 詞典運用
- 5.2 意圖處理
- 5.3 暗號使用
- 5.4 事件觸發
- 5.5 優先級
- 5.6 觸發器
- 5.7 快捷鍵
- 5.8 意圖報錯
- 6. 開發者高級教程
- 6.1 handlebars模版語言
- 6.2 JavaScript簡單介紹
- 6.3 JavaScript使用說明
- 6.4 JavaScript使用案例
- 6.5 JavaScript常見問題
- 7. 快速發布技能
- 8. 幫助中心
- 8.1 常見概念
- 8.2 幫助視頻
- 8.3 聯系我們