bowen liu / Mbed OS mbed-os-example-blinky

ex

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

dumi_doc-master/doc/bot/remind.md@44:c1d8923072ba, 2017-07-18 (annotated)

Committer:
TMBOY
Date:
Tue Jul 18 16:27:22 2017 +0800
Revision:
44:c1d8923072ba
?

Who changed what in which revision?

UserRevisionLine numberNew contents of line
TMBOY 44:c1d8923072ba 1 # remind bot输出schema
TMBOY 44:c1d8923072ba 2
TMBOY 44:c1d8923072ba 3 ## 创建提醒(intent：remind)
TMBOY 44:c1d8923072ba 4 打电话返回的完整例子:
TMBOY 44:c1d8923072ba 5 ```javascript
TMBOY 44:c1d8923072ba 6 //query=明天上午8点提醒我起床
TMBOY 44:c1d8923072ba 7 {
TMBOY 44:c1d8923072ba 8 "result": {
TMBOY 44:c1d8923072ba 9 "bot_id": "remind",
TMBOY 44:c1d8923072ba 10 "bot_meta": {
TMBOY 44:c1d8923072ba 11 "version": "1.0.0",
TMBOY 44:c1d8923072ba 12 "type": "其他",
TMBOY 44:c1d8923072ba 13 "description": "desc"
TMBOY 44:c1d8923072ba 14 },
TMBOY 44:c1d8923072ba 15 "views": [
TMBOY 44:c1d8923072ba 16 {
TMBOY 44:c1d8923072ba 17 "type": "list",
TMBOY 44:c1d8923072ba 18 "list": [
TMBOY 44:c1d8923072ba 19 {
TMBOY 44:c1d8923072ba 20 "title": "起床",
TMBOY 44:c1d8923072ba 21 "summary": "为你设置了【起床】提醒。\n语音助手将于明天上午8点通知你",
TMBOY 44:c1d8923072ba 22 "url": "http://xiaodu.baidu.com/saiya/events",
TMBOY 44:c1d8923072ba 23 "image": "http://xiaodu.baidu.com/saiya/img/remind.png"
TMBOY 44:c1d8923072ba 24 }
TMBOY 44:c1d8923072ba 25 ]
TMBOY 44:c1d8923072ba 26 }
TMBOY 44:c1d8923072ba 27 ],
TMBOY 44:c1d8923072ba 28 "nlu": {
TMBOY 44:c1d8923072ba 29 "domain": "remind",
TMBOY 44:c1d8923072ba 30 "intent": "remind",
TMBOY 44:c1d8923072ba 31 "slots": {
TMBOY 44:c1d8923072ba 32 "event_title": "起床",
TMBOY 44:c1d8923072ba 33 "event_type": "wakeup",
TMBOY 44:c1d8923072ba 34 "remind_time": "{\"day\":\"next\",\"hour\":\"8\",\"apm\":\"am\"}",
TMBOY 44:c1d8923072ba 35 "remind_type_message": "否",
TMBOY 44:c1d8923072ba 36 "remind_type_phone": "否",
TMBOY 44:c1d8923072ba 37 "remind_type_dumi": "否",
TMBOY 44:c1d8923072ba 38 "remind_type_clock": "是",
TMBOY 44:c1d8923072ba 39 "remind_time_type": "abstime",
TMBOY 44:c1d8923072ba 40 "remind_time_data": "1486598400",
TMBOY 44:c1d8923072ba 41 "status": "create"
TMBOY 44:c1d8923072ba 42 }
TMBOY 44:c1d8923072ba 43 },
TMBOY 44:c1d8923072ba 44 "speech": {
TMBOY 44:c1d8923072ba 45 "type": "Text",
TMBOY 44:c1d8923072ba 46 "content": "为你设置了【起床】提醒。\n语音助手将于明天上午8点通知你"
TMBOY 44:c1d8923072ba 47 }
TMBOY 44:c1d8923072ba 48 },
TMBOY 44:c1d8923072ba 49 "id": "1486548437_49427afb0",
TMBOY 44:c1d8923072ba 50 "logid": "14865484374487",
TMBOY 44:c1d8923072ba 51 "user_id": "test",
TMBOY 44:c1d8923072ba 52 "time": 1486548437,
TMBOY 44:c1d8923072ba 53 "cuid": null,
TMBOY 44:c1d8923072ba 54 "se_query": "明天上午8点提醒我起床",
TMBOY 44:c1d8923072ba 55 "msg": "ok",
TMBOY 44:c1d8923072ba 56 "status": 0
TMBOY 44:c1d8923072ba 57 }
TMBOY 44:c1d8923072ba 58 ```
TMBOY 44:c1d8923072ba 59 ![remind_create](http://f.hiphotos.baidu.com/xiaodu/pic/item/574e9258d109b3ded96189eac5bf6c81810a4c51.jpg)
TMBOY 44:c1d8923072ba 60
TMBOY 44:c1d8923072ba 61 ### nlu部分的说明
TMBOY 44:c1d8923072ba 62
TMBOY 44:c1d8923072ba 63 |slot |desc | value |
TMBOY 44:c1d8923072ba 64 |---|---|---|
TMBOY 44:c1d8923072ba 65 |name | 名字 | 中文名 |
TMBOY 44:c1d8923072ba 66 |event_title | 提醒标题 | eg:起床|
TMBOY 44:c1d8923072ba 67 |event_type | 提醒事件类型 | eg:wakeup|
TMBOY 44:c1d8923072ba 68 |remind_time_data | 提醒设置的时间。只会在提醒创建前（即槽位完备）给出 | 1486598400|
TMBOY 44:c1d8923072ba 69 |remind_type_clock | 提醒触达方式闹钟 | 是|
TMBOY 44:c1d8923072ba 70 |status| create |创建|
TMBOY 44:c1d8923072ba 71
TMBOY 44:c1d8923072ba 72
TMBOY 44:c1d8923072ba 73 ## 查看提醒(intent：remind_manage)
TMBOY 44:c1d8923072ba 74 打电话返回的完整例子:
TMBOY 44:c1d8923072ba 75 ```javascript
TMBOY 44:c1d8923072ba 76 //query=查看我明天上午开会的提醒
TMBOY 44:c1d8923072ba 77 {
TMBOY 44:c1d8923072ba 78 "result": {
TMBOY 44:c1d8923072ba 79 "bot_id": "remind",
TMBOY 44:c1d8923072ba 80 "bot_meta": {
TMBOY 44:c1d8923072ba 81 "version": "1.0.0",
TMBOY 44:c1d8923072ba 82 "type": "其他",
TMBOY 44:c1d8923072ba 83 "description": "desc"
TMBOY 44:c1d8923072ba 84 },
TMBOY 44:c1d8923072ba 85 "views": [
TMBOY 44:c1d8923072ba 86 {
TMBOY 44:c1d8923072ba 87 "type": "txt",
TMBOY 44:c1d8923072ba 88 "content": "暂时没有提醒哦，有任何需求可以告诉我，语音助手帮你记下来。"
TMBOY 44:c1d8923072ba 89 }
TMBOY 44:c1d8923072ba 90 ],
TMBOY 44:c1d8923072ba 91 "nlu": {
TMBOY 44:c1d8923072ba 92 "domain": "remind",
TMBOY 44:c1d8923072ba 93 "intent": "remind_manage",
TMBOY 44:c1d8923072ba 94 "slots": {
TMBOY 44:c1d8923072ba 95 "action": "list",
TMBOY 44:c1d8923072ba 96 "event_title": "开会",
TMBOY 44:c1d8923072ba 97 "remind_time": "{\"day\":\"next\",\"apm\":\"am\"}",
TMBOY 44:c1d8923072ba 98 "remind_type_message": "否",
TMBOY 44:c1d8923072ba 99 "remind_type_phone": "否",
TMBOY 44:c1d8923072ba 100 "remind_type_dumi": "否",
TMBOY 44:c1d8923072ba 101 "remind_type_clock": "否"
TMBOY 44:c1d8923072ba 102 }
TMBOY 44:c1d8923072ba 103 },
TMBOY 44:c1d8923072ba 104 "speech": {
TMBOY 44:c1d8923072ba 105 "type": "Text",
TMBOY 44:c1d8923072ba 106 "content": "暂时没有提醒哦，有任何需求可以告诉我，语音助手帮你记下来。"
TMBOY 44:c1d8923072ba 107 }
TMBOY 44:c1d8923072ba 108 },
TMBOY 44:c1d8923072ba 109 "id": "1486549266_6504f3o6a",
TMBOY 44:c1d8923072ba 110 "logid": "14865492666785",
TMBOY 44:c1d8923072ba 111 "user_id": "test",
TMBOY 44:c1d8923072ba 112 "time": 1486549266,
TMBOY 44:c1d8923072ba 113 "cuid": null,
TMBOY 44:c1d8923072ba 114 "se_query": "查看我明天上午开会的提醒",
TMBOY 44:c1d8923072ba 115 "msg": "ok",
TMBOY 44:c1d8923072ba 116 "status": 0
TMBOY 44:c1d8923072ba 117 }
TMBOY 44:c1d8923072ba 118 ```
TMBOY 44:c1d8923072ba 119 ![remind_manage](http://c.hiphotos.baidu.com/xiaodu/pic/item/c9fcc3cec3fdfc03f85a8f3add3f8794a4c22615.jpg)
TMBOY 44:c1d8923072ba 120
TMBOY 44:c1d8923072ba 121 ### nlu部分的说明
TMBOY 44:c1d8923072ba 122
TMBOY 44:c1d8923072ba 123 |slot |desc | value |
TMBOY 44:c1d8923072ba 124 |---|---|---|
TMBOY 44:c1d8923072ba 125 |name | 名字 | 中文名 |
TMBOY 44:c1d8923072ba 126 |event_title | 提醒标题 | eg:起床|
TMBOY 44:c1d8923072ba 127 |remind_time | 提醒时间 | json |
TMBOY 44:c1d8923072ba 128 |action | 操作类型 | eg:list、update、delete，分别为查看、更新、删除|
TMBOY 44:c1d8923072ba 129
TMBOY 44:c1d8923072ba 130 ### 时间json内字段说明
TMBOY 44:c1d8923072ba 131
TMBOY 44:c1d8923072ba 132 remind_time如果不完备，会在多轮对话中不断的澄清，是一个中间结果
TMBOY 44:c1d8923072ba 133
TMBOY 44:c1d8923072ba 134 |Key |Value |说明|
TMBOY 44:c1d8923072ba 135 |---|---|---|
TMBOY 44:c1d8923072ba 136 |minute |3, +2, -1|string. 3分，2分钟后，1分钟前|
TMBOY 44:c1d8923072ba 137 |hour|2, +1, -3|string. 2点，1小时后，3小时前|
TMBOY 44:c1d8923072ba 138 |day|1, +2, -3, -1,next, +0|string. 1号，2天后，3天前，昨天，明天，今天|
TMBOY 44:c1d8923072ba 139 |month|1, +2, -3, +0|string. 1月，2个月后，3个月前，这个月|
TMBOY 44:c1d8923072ba 140 |year|1984, +1, -2, +0|string. 1984年，明年，2年前，今年|
TMBOY 44:c1d8923072ba 141 |week|+1, -1, 2, 3, 2+1|string. 下周，上一周，星期二，周三, 下周二|
TMBOY 44:c1d8923072ba 142 |apm|am, pm|string. 上午，下午|
TMBOY 44:c1d8923072ba 143 |const|recent, awhile|string. 刚刚，一会儿|
TMBOY 44:c1d8923072ba 144 |repeat|day, month, year|string. 每天，每月，每年|
TMBOY 44:c1d8923072ba 145 |special_day |weekend, weekday|string. 周末，工作日，节气，节日|
TMBOY 44:c1d8923072ba 146 |special_calendar|lunar|string. 农历|
TMBOY 44:c1d8923072ba 147
TMBOY 44:c1d8923072ba 148 ### 闹钟数据同步
TMBOY 44:c1d8923072ba 149 * 如果使用度秘的存储保存闹钟数据，通过请求度秘获取闹钟数据
TMBOY 44:c1d8923072ba 150 * URL: http://xiaodu.baidu.com/saiya/events/Index/clock
TMBOY 44:c1d8923072ba 151
TMBOY 44:c1d8923072ba 152 ```javascript
TMBOY 44:c1d8923072ba 153 {
TMBOY 44:c1d8923072ba 154 "status": 0,
TMBOY 44:c1d8923072ba 155 "msg": "",
TMBOY 44:c1d8923072ba 156 "data": [
TMBOY 44:c1d8923072ba 157 //一次性的提醒，type : abstime
TMBOY 44:c1d8923072ba 158 {
TMBOY 44:c1d8923072ba 159 "type": "abstime",
TMBOY 44:c1d8923072ba 160 "time": 1482019200, //闹钟响铃的时间 时间戳
TMBOY 44:c1d8923072ba 161 "id": "359482_1482019200",
TMBOY 44:c1d8923072ba 162 "title": "我的生日", // 闹钟的内容
TMBOY 44:c1d8923072ba 163 "clock_type": "normal" //闹钟的类型：普通normal，还有叫早wakeup; 计时器timer
TMBOY 44:c1d8923072ba 164 },
TMBOY 44:c1d8923072ba 165
TMBOY 44:c1d8923072ba 166 //or
TMBOY 44:c1d8923072ba 167 //周期重复type:repeat_mult, 周 工作日 月 年
TMBOY 44:c1d8923072ba 168 {
TMBOY 44:c1d8923072ba 169 "type": "repeat_mult",
TMBOY 44:c1d8923072ba 170 "repeat_mult": {
TMBOY 44:c1d8923072ba 171 "name": "每周",
TMBOY 44:c1d8923072ba 172 "type": "week", //week: 周， weekday:工作日，month：月， year：年
TMBOY 44:c1d8923072ba 173 "value": [
TMBOY 44:c1d8923072ba 174 1 //周级别 1~7， 月 1~31， 年 101 ~1231
TMBOY 44:c1d8923072ba 175 ]
TMBOY 44:c1d8923072ba 176 },
TMBOY 44:c1d8923072ba 177
TMBOY 44:c1d8923072ba 178 "time": 1479686400, //闹钟响铃的时间 时间戳
TMBOY 44:c1d8923072ba 179 "terminal": null,
TMBOY 44:c1d8923072ba 180 "id": 525568,
TMBOY 44:c1d8923072ba 181 "title": "吃饭",
TMBOY 44:c1d8923072ba 182 "clock_type": "normal"
TMBOY 44:c1d8923072ba 183 },
TMBOY 44:c1d8923072ba 184
TMBOY 44:c1d8923072ba 185 //or
TMBOY 44:c1d8923072ba 186 //每天重复type: absinterval
TMBOY 44:c1d8923072ba 187 //其实考虑有每几天的重复，目前只每天
TMBOY 44:c1d8923072ba 188 {
TMBOY 44:c1d8923072ba 189 "terminal": "na_ios",
TMBOY 44:c1d8923072ba 190 "type": "absinterval", //类型
TMBOY 44:c1d8923072ba 191 "repeat": {
TMBOY 44:c1d8923072ba 192 "type": "每天",
TMBOY 44:c1d8923072ba 193 "value": 86400 //每多久触发一次，时间戳 ，单位：秒
TMBOY 44:c1d8923072ba 194 },
TMBOY 44:c1d8923072ba 195 "time": 1481241600,
TMBOY 44:c1d8923072ba 196 "id": 604866,
TMBOY 44:c1d8923072ba 197 "title": "吃饭",
TMBOY 44:c1d8923072ba 198 "clock_type": "normal"
TMBOY 44:c1d8923072ba 199 }
TMBOY 44:c1d8923072ba 200 ]
TMBOY 44:c1d8923072ba 201 }
TMBOY 44:c1d8923072ba 202 ```
TMBOY 44:c1d8923072ba 203 ### 闹钟数据字段说明
TMBOY 44:c1d8923072ba 204
TMBOY 44:c1d8923072ba 205 |key |value|desc |
TMBOY 44:c1d8923072ba 206 |---|---|---|
TMBOY 44:c1d8923072ba 207 |title | 吃饭| 提醒的title |
TMBOY 44:c1d8923072ba 208 |type | 重复类型 | eg:abstime|
TMBOY 44:c1d8923072ba 209 |time | 提醒时间 | 时间戳 |
TMBOY 44:c1d8923072ba 210 |clock_type | 闹钟类型 | eg:timer、normal、wakeup，分别为计时器、普通闹钟、起床闹钟|
TMBOY 44:c1d8923072ba 211
TMBOY 44:c1d8923072ba 212
TMBOY 44:c1d8923072ba 213 ### 闹钟同步命令
TMBOY 44:c1d8923072ba 214 * 如果使用度秘的存储保存闹钟数据，收到同步命令，客户端需通过请求度秘获取闹钟数据
TMBOY 44:c1d8923072ba 215
TMBOY 44:c1d8923072ba 216 ```javascript
TMBOY 44:c1d8923072ba 217 {
TMBOY 44:c1d8923072ba 218 "header": {
TMBOY 44:c1d8923072ba 219 "namespace": "Remind",
TMBOY 44:c1d8923072ba 220 "name": "UpdateClock",
TMBOY 44:c1d8923072ba 221 "message_id": "message_id-1344"
TMBOY 44:c1d8923072ba 222 },
TMBOY 44:c1d8923072ba 223 "payload": {}
TMBOY 44:c1d8923072ba 224 }
TMBOY 44:c1d8923072ba 225 ```
TMBOY 44:c1d8923072ba 226 ### 闹钟停止命令
TMBOY 44:c1d8923072ba 227 * 停止闹钟响铃指令
TMBOY 44:c1d8923072ba 228
TMBOY 44:c1d8923072ba 229 ```javascript
TMBOY 44:c1d8923072ba 230 {
TMBOY 44:c1d8923072ba 231 "header": {
TMBOY 44:c1d8923072ba 232 "namespace": "Remind",
TMBOY 44:c1d8923072ba 233 "name": "StopClock",
TMBOY 44:c1d8923072ba 234 "message_id": "message_id-1344"
TMBOY 44:c1d8923072ba 235 },
TMBOY 44:c1d8923072ba 236 "payload": {}
TMBOY 44:c1d8923072ba 237 }
TMBOY 44:c1d8923072ba 238 ```