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

ex

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

dumi_doc-master/doc/api/response.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 # 响应字段解释
TMBOY 44:c1d8923072ba 2
TMBOY 44:c1d8923072ba 3 ## Table of Contents
TMBOY 44:c1d8923072ba 4
TMBOY 44:c1d8923072ba 5
TMBOY 44:c1d8923072ba 6 * [响应字段解释](#响应字段解释)
TMBOY 44:c1d8923072ba 7 * [Table of Contents](#table-of-contents)
TMBOY 44:c1d8923072ba 8 * [正常返回的结果](#正常返回的结果)
TMBOY 44:c1d8923072ba 9 * [常见的错误返回](#常见的错误返回)
TMBOY 44:c1d8923072ba 10 * [返回值（response）中数据格式分块详细说明](#返回值response中数据格式分块详细说明)
TMBOY 44:c1d8923072ba 11 * [bot_id、bot_meta](#bot_idbot_meta)
TMBOY 44:c1d8923072ba 12 * [views](#views)
TMBOY 44:c1d8923072ba 13 * [文本卡片](#文本卡片)
TMBOY 44:c1d8923072ba 14 * [图文卡片](#图文卡片)
TMBOY 44:c1d8923072ba 15 * [图片卡片](#图片卡片)
TMBOY 44:c1d8923072ba 16 * [resource](#resource)
TMBOY 44:c1d8923072ba 17 * [天气](#天气)
TMBOY 44:c1d8923072ba 18 * [新闻](#新闻)
TMBOY 44:c1d8923072ba 19 * [音乐](#音乐)
TMBOY 44:c1d8923072ba 20 * [speech](#speech)
TMBOY 44:c1d8923072ba 21 * [directives](#directives)
TMBOY 44:c1d8923072ba 22 * [AudioPlayer](#audioplayer)
TMBOY 44:c1d8923072ba 23 * [Speaker](#speaker)
TMBOY 44:c1d8923072ba 24 * [SpeechSynthesizer](#speechsynthesizer)
TMBOY 44:c1d8923072ba 25 * [SpeechRecognizer](#speechrecognizer)
TMBOY 44:c1d8923072ba 26 * [Extension](#extension)
TMBOY 44:c1d8923072ba 27 * [hint](#hint)
TMBOY 44:c1d8923072ba 28 * [nlu](#nlu)
TMBOY 44:c1d8923072ba 29 * [格式说明](#格式说明)
TMBOY 44:c1d8923072ba 30 * [包含query解析结果的结构化数据](#包含query解析结果的结构化数据)
TMBOY 44:c1d8923072ba 31 * [以下是跑出来的一批nlu数据的例子](#以下是跑出来的一批nlu数据的例子)
TMBOY 44:c1d8923072ba 32
TMBOY 44:c1d8923072ba 33
TMBOY 44:c1d8923072ba 34 ### 正常返回的结果
TMBOY 44:c1d8923072ba 35
TMBOY 44:c1d8923072ba 36 以下是一次典型请求中，sdk（客户端）收到的完整json数据
TMBOY 44:c1d8923072ba 37
TMBOY 44:c1d8923072ba 38 ```javascript
TMBOY 44:c1d8923072ba 39 {
TMBOY 44:c1d8923072ba 40 "status":0, //0 表示成功，其他值表示失败
TMBOY 44:c1d8923072ba 41 "msg":"ok", //错误状态文本
TMBOY 44:c1d8923072ba 42 "se_query":"我要听周杰伦的歌", //用户请求的query
TMBOY 44:c1d8923072ba 43 "logid":"xxxx1234354", //日志查询用的logid
TMBOY 44:c1d8923072ba 44 "id":"id12334235", //消息id
TMBOY 44:c1d8923072ba 45 "user_id":"", //请求的用户id
TMBOY 44:c1d8923072ba 46 "cuid":"", //请求的设备id
TMBOY 44:c1d8923072ba 47 "time":1482226019, //当前的服务端时间戳
TMBOY 44:c1d8923072ba 48 "client_msg_id": "string", //客户端上报的请求msg id，如果是回复用户的某个请求的消息，可以用这个字段串起来
TMBOY 44:c1d8923072ba 49 "speech_id": "string", //如果是个语音请求，这是语音的id（请求中的speech_id字段，2合一的get参数sn）
TMBOY 44:c1d8923072ba 50 "need_passport_login": false, //如果为true，客户端应该调用百度passport登录接口
TMBOY 44:c1d8923072ba 51 "result":{
TMBOY 44:c1d8923072ba 52 "bot_id":"duer_music", //返回结果的bot的id，如果没有任何垂类服务返回，bot_id== NO_RESULT
TMBOY 44:c1d8923072ba 53 "bot_meta":{ //下游bot元数据
TMBOY 44:c1d8923072ba 54 "description":"返回音乐类结果", // 文字描述
TMBOY 44:c1d8923072ba 55 "version":"1.0.0", //版本
TMBOY 44:c1d8923072ba 56 "type":"音乐" //TODO，bot类型见pm给的分类
TMBOY 44:c1d8923072ba 57 },
TMBOY 44:c1d8923072ba 58 "views":[ //显示用的数据，一个结果里可包含多个卡片
TMBOY 44:c1d8923072ba 59 {
TMBOY 44:c1d8923072ba 60 "type":"list", //卡片类型，只有txt,list,image三种类型
TMBOY 44:c1d8923072ba 61 "list":[
TMBOY 44:c1d8923072ba 62 {
TMBOY 44:c1d8923072ba 63 "title": "东方破",
TMBOY 44:c1d8923072ba 64 "image": "http://nodeapi.cloudfoundry.com/qrcode.jpg",
TMBOY 44:c1d8923072ba 65 "url": "http://nodeapi.cloudfoundry.com/"
TMBOY 44:c1d8923072ba 66 },
TMBOY 44:c1d8923072ba 67 {
TMBOY 44:c1d8923072ba 68 "title": "双截棍",
TMBOY 44:c1d8923072ba 69 "image": "http://nodeapi.cloudfoundry.com/qrcode.jpg",
TMBOY 44:c1d8923072ba 70 "url": "http://nodeapi.cloudfoundry.com/"
TMBOY 44:c1d8923072ba 71 }
TMBOY 44:c1d8923072ba 72 ]
TMBOY 44:c1d8923072ba 73 }
TMBOY 44:c1d8923072ba 74 ],
TMBOY 44:c1d8923072ba 75 "directives":[ //指令，用于控制给客户端、目标硬件下达命令，可选字段，一个结果可包含多条啊指令
TMBOY 44:c1d8923072ba 76 {
TMBOY 44:c1d8923072ba 77 "header": { //指令的名字
TMBOY 44:c1d8923072ba 78 "namespace": "AudioPlayer",
TMBOY 44:c1d8923072ba 79 "name": "Play"
TMBOY 44:c1d8923072ba 80 },
TMBOY 44:c1d8923072ba 81 "payload": { //指令的参数
TMBOY 44:c1d8923072ba 82 "play_behavior": "REPLACE_ALL",
TMBOY 44:c1d8923072ba 83 "audio_item": {
TMBOY 44:c1d8923072ba 84 "audio_item_id": "156",
TMBOY 44:c1d8923072ba 85 "stream": {
TMBOY 44:c1d8923072ba 86 "url": "http://yinyueshiting.baidu.com/data2/music/124088643/124088643.mp3?xcode=57462f29cfc176f86a37d80a2c02fc5b",
TMBOY 44:c1d8923072ba 87 "stream_format": "AUDIO_MP3",
TMBOY 44:c1d8923072ba 88 "offset_ms": 0,
TMBOY 44:c1d8923072ba 89 "token": "156",
TMBOY 44:c1d8923072ba 90 "progress_report_interval_ms": 10000
TMBOY 44:c1d8923072ba 91 }
TMBOY 44:c1d8923072ba 92 }
TMBOY 44:c1d8923072ba 93 }
TMBOY 44:c1d8923072ba 94 }
TMBOY 44:c1d8923072ba 95 ],
TMBOY 44:c1d8923072ba 96
TMBOY 44:c1d8923072ba 97 "nlu": { //query解析的结果
TMBOY 44:c1d8923072ba 98 "domain": "music",
TMBOY 44:c1d8923072ba 99 "intent": "music", //domain + intent确定一种解析结果的类型
TMBOY 44:c1d8923072ba 100 "slots": { //从query中提取出来的槽位信息
TMBOY 44:c1d8923072ba 101 "action_type":"1",
TMBOY 44:c1d8923072ba 102 "singer": "周杰伦"
TMBOY 44:c1d8923072ba 103 }
TMBOY 44:c1d8923072ba 104 },
TMBOY 44:c1d8923072ba 105 "resource":{ //数据资源，可选字段
TMBOY 44:c1d8923072ba 106 "type":"music_ref",//资源类型，目前已经有music/news/weather等资源类型
TMBOY 44:c1d8923072ba 107 "data":{
TMBOY 44:c1d8923072ba 108 "api": {
TMBOY 44:c1d8923072ba 109 "method": "GET",
TMBOY 44:c1d8923072ba 110 "url": "http: //s.xiaodu.baidu.com/v20161223/resource/music?user_id=888"
TMBOY 44:c1d8923072ba 111 }
TMBOY 44:c1d8923072ba 112 //以上地址，可以增加page参数来翻页，如 http://s.xiaodu.baidu.com/v20161223/resource/music?user_id=888&page=2
TMBOY 44:c1d8923072ba 113 //抓取以上api地址后会返回如下格式
TMBOY 44:c1d8923072ba 114 /*
TMBOY 44:c1d8923072ba 115 {
TMBOY 44:c1d8923072ba 116 "status": 0,
TMBOY 44:c1d8923072ba 117 "code": null,
TMBOY 44:c1d8923072ba 118 "data": {
TMBOY 44:c1d8923072ba 119 "page": 1,
TMBOY 44:c1d8923072ba 120 "total_page": 5,
TMBOY 44:c1d8923072ba 121 "list": [
TMBOY 44:c1d8923072ba 122 {
TMBOY 44:c1d8923072ba 123 "duration": "238",
TMBOY 44:c1d8923072ba 124 "name": "恋红尘",
TMBOY 44:c1d8923072ba 125 "alias": "",
TMBOY 44:c1d8923072ba 126 "singer_name": "祁隆,彭丽嘉",
TMBOY 44:c1d8923072ba 127 "all_singer_name": "",
TMBOY 44:c1d8923072ba 128 "genre": "流行",
TMBOY 44:c1d8923072ba 129 "tag": "好听,新歌,网络歌曲",
TMBOY 44:c1d8923072ba 130 "language": "",
TMBOY 44:c1d8923072ba 131 "original_singer": "",
TMBOY 44:c1d8923072ba 132 "composer": "",
TMBOY 44:c1d8923072ba 133 "lyricist": "",
TMBOY 44:c1d8923072ba 134 "url": "http://music.baidu.com/song/271665582?fm=altg_new3",
TMBOY 44:c1d8923072ba 135 "same_name_url": "http://music.baidu.com/search?fm=altg_new3&key=%E6%81%8B%E7%BA%A2%E5%B0%98",
TMBOY 44:c1d8923072ba 136 "streaming_vedio_url": "http://zhangmenshiting.baidu.com/data2/music/a1d4eca5675d21e6e0b3dad002de5c1d/271665733/271665733.mp3?x
TMBOY 44:c1d8923072ba 137 code=2e387ebc099d9e5aa0d51cfc739c1004",
TMBOY 44:c1d8923072ba 138 "head_image_url": "http://qukufile2.qianqian.com/data2/pic/25b1faff5bf89f84b6491593e31381ed/271665166/271665166.jpg",
TMBOY 44:c1d8923072ba 139 "album_name": "恋红尘",
TMBOY 44:c1d8923072ba 140 "album_url": "",
TMBOY 44:c1d8923072ba 141 "score": "0",
TMBOY 44:c1d8923072ba 142 "publish_time": "2016-09-20",
TMBOY 44:c1d8923072ba 143 "publish_company": "华宇世博",
TMBOY 44:c1d8923072ba 144 "is_need_pay_listen": "0",
TMBOY 44:c1d8923072ba 145 "from_site": "1",
TMBOY 44:c1d8923072ba 146 "hot": "237391"
TMBOY 44:c1d8923072ba 147 }...
TMBOY 44:c1d8923072ba 148 ]
TMBOY 44:c1d8923072ba 149 }
TMBOY 44:c1d8923072ba 150 }
TMBOY 44:c1d8923072ba 151 */
TMBOY 44:c1d8923072ba 152 }
TMBOY 44:c1d8923072ba 153 },
TMBOY 44:c1d8923072ba 154 'should_end_session':false, //默认为true，如果为false，客户端应该立即进入收听用户query的状态，不用重新唤醒
TMBOY 44:c1d8923072ba 155 "speech": { //TTS播报用的数据
TMBOY 44:c1d8923072ba 156 "type": "Text", //有SSML和Text两种类型
TMBOY 44:c1d8923072ba 157 "content": "为您播放周杰伦的歌曲",
TMBOY 44:c1d8923072ba 158 "reprompt": "" //可选，should_end_session==false的时候，会自动进入语音识别状态，8s后如果用户都不说话，客户端会用tts播放一个短提示，reprompt就是短提示的内容
TMBOY 44:c1d8923072ba 159 }
TMBOY 44:c1d8923072ba 160 }
TMBOY 44:c1d8923072ba 161 }
TMBOY 44:c1d8923072ba 162
TMBOY 44:c1d8923072ba 163 ```
TMBOY 44:c1d8923072ba 164
TMBOY 44:c1d8923072ba 165 ### 常见的错误返回
TMBOY 44:c1d8923072ba 166
TMBOY 44:c1d8923072ba 167 返回值 | 含义
TMBOY 44:c1d8923072ba 168 ---------- | -------------
TMBOY 44:c1d8923072ba 169 status:1,msg: appid unvalid | appid无效
TMBOY 44:c1d8923072ba 170 status:2,msg: appkey unvalid | appkey无效
TMBOY 44:c1d8923072ba 171 status:3,msg: appqps warning | appqps前一天峰值警告
TMBOY 44:c1d8923072ba 172 status:4,msg: appqps refuse | appqps拒绝
TMBOY 44:c1d8923072ba 173 status:5,msg: appqpd warning | appqpd前一天峰值警告
TMBOY 44:c1d8923072ba 174 status:6,msg: appqpd refuse | appqpd拒绝
TMBOY 44:c1d8923072ba 175 status:7,msg: sericelist empty | 请求的服务列表未配置
TMBOY 44:c1d8923072ba 176
TMBOY 44:c1d8923072ba 177 ### 返回值（response）中数据格式分块详细说明
TMBOY 44:c1d8923072ba 178
TMBOY 44:c1d8923072ba 179 #### bot_id、bot_meta
TMBOY 44:c1d8923072ba 180
TMBOY 44:c1d8923072ba 181 bot 是真正负责返回结果的度秘平台子服务，每条结果中会带有真正服务的bot的id和meta信息
TMBOY 44:c1d8923072ba 182 下面的表格是现有的bot及其说明
TMBOY 44:c1d8923072ba 183
TMBOY 44:c1d8923072ba 184 bot_id | 说明
TMBOY 44:c1d8923072ba 185 ------ | -------
TMBOY 44:c1d8923072ba 186 phone | 电话服务
TMBOY 44:c1d8923072ba 187 remind | 提醒服务
TMBOY 44:c1d8923072ba 188 recommend_service_wireless source_sub_type: joke | 笑话
TMBOY 44:c1d8923072ba 189 duer_weather | 天气服务
TMBOY 44:c1d8923072ba 190 music | 音乐服务
TMBOY 44:c1d8923072ba 191 restaurant_bot | 美食服务
TMBOY 44:c1d8923072ba 192 life_common | 生活服务（地图导航）
TMBOY 44:c1d8923072ba 193 sac | 火车航班,查限行
TMBOY 44:c1d8923072ba 194 aries_general aries_guide aries_dqa kg_service | 通用信息(翻译)
TMBOY 44:c1d8923072ba 195 sysprofile_service | 系统画像
TMBOY 44:c1d8923072ba 196 image_satisfy | 图搜服务
TMBOY 44:c1d8923072ba 197
TMBOY 44:c1d8923072ba 198
TMBOY 44:c1d8923072ba 199 #### views
TMBOY 44:c1d8923072ba 200 返回展示卡片数据，必选字段。一次可返回一个或多个卡片。
TMBOY 44:c1d8923072ba 201 一共有三种类型：
TMBOY 44:c1d8923072ba 202
TMBOY 44:c1d8923072ba 203 ##### 文本卡片
TMBOY 44:c1d8923072ba 204 只能返回一段文本
TMBOY 44:c1d8923072ba 205 ```javascript
TMBOY 44:c1d8923072ba 206 {
TMBOY 44:c1d8923072ba 207 "type":"txt",
TMBOY 44:c1d8923072ba 208 "content":"为你推荐如下热门资讯",
TMBOY 44:c1d8923072ba 209 "url":"http://www.baidu.com" //可选字段
TMBOY 44:c1d8923072ba 210 }
TMBOY 44:c1d8923072ba 211 ```
TMBOY 44:c1d8923072ba 212
TMBOY 44:c1d8923072ba 213 ##### 图文卡片
TMBOY 44:c1d8923072ba 214 ```javascript
TMBOY 44:c1d8923072ba 215 {
TMBOY 44:c1d8923072ba 216 "type":"list",
TMBOY 44:c1d8923072ba 217 "list":[
TMBOY 44:c1d8923072ba 218 {
TMBOY 44:c1d8923072ba 219 "title": "你来我家接我吧",
TMBOY 44:c1d8923072ba 220 "summary": "这是女神与高富帅之间的对话", ///可选字段
TMBOY 44:c1d8923072ba 221 "image": "http://nodeapi.cloudfoundry.com/qrcode.jpg",//可选字段
TMBOY 44:c1d8923072ba 222 "url": "http://nodeapi.cloudfoundry.com/"
TMBOY 44:c1d8923072ba 223 },
TMBOY 44:c1d8923072ba 224 {
TMBOY 44:c1d8923072ba 225 "title": "你来我家接我吧",
TMBOY 44:c1d8923072ba 226 "summary": "这是女神与高富帅之间的对话", //可选字段
TMBOY 44:c1d8923072ba 227 "image": "http://nodeapi.cloudfoundry.com/qrcode.jpg",//可选字段
TMBOY 44:c1d8923072ba 228 "url": "http://nodeapi.cloudfoundry.com/"
TMBOY 44:c1d8923072ba 229 }
TMBOY 44:c1d8923072ba 230 ]
TMBOY 44:c1d8923072ba 231 }
TMBOY 44:c1d8923072ba 232 ```
TMBOY 44:c1d8923072ba 233
TMBOY 44:c1d8923072ba 234 ##### 图片卡片
TMBOY 44:c1d8923072ba 235 可一次返回多张图片，可选缩略图
TMBOY 44:c1d8923072ba 236 ```javascript
TMBOY 44:c1d8923072ba 237 {
TMBOY 44:c1d8923072ba 238 "type": "image",
TMBOY 44:c1d8923072ba 239 "list": [
TMBOY 44:c1d8923072ba 240 {
TMBOY 44:c1d8923072ba 241 "src":"http://c.hiphotos.baidu.com/image/pic/item/7af40ad162d9f2d38d7056c8acec8a136327ccb0.jpg",
TMBOY 44:c1d8923072ba 242 "thumb":"http://c.hiphotos.baidu.com/image/pic/item/7af40ad162d9f2d38d7056c8acec8a136327ccb0.jpg" //可选字段 缩略图
TMBOY 44:c1d8923072ba 243 },
TMBOY 44:c1d8923072ba 244 {
TMBOY 44:c1d8923072ba 245 "src":"http://b.hiphotos.baidu.com/image/pic/item/b21bb051f8198618df86c5424eed2e738ad4e637.jpg",
TMBOY 44:c1d8923072ba 246 "thumb":"http://c.hiphotos.baidu.com/image/pic/item/7af40ad162d9f2d38d7056c8acec8a136327ccb0.jpg" //可选字段 缩略图
TMBOY 44:c1d8923072ba 247 },
TMBOY 44:c1d8923072ba 248 {
TMBOY 44:c1d8923072ba 249 "src":"http://c.hiphotos.baidu.com/image/pic/item/83025aafa40f4bfbc9c817b9074f78f0f63618c6.jpg",
TMBOY 44:c1d8923072ba 250 "thumb":"http://c.hiphotos.baidu.com/image/pic/item/7af40ad162d9f2d38d7056c8acec8a136327ccb0.jpg" //可选字段 缩略图
TMBOY 44:c1d8923072ba 251 }
TMBOY 44:c1d8923072ba 252 ]
TMBOY 44:c1d8923072ba 253 }
TMBOY 44:c1d8923072ba 254
TMBOY 44:c1d8923072ba 255 ```
TMBOY 44:c1d8923072ba 256
TMBOY 44:c1d8923072ba 257 #### resource
TMBOY 44:c1d8923072ba 258 根据用户的意图和度秘服务的能力，在一些请求里会返回复杂的结构化数据，用于客户端的特殊逻辑和展示，现有的resource类型有以下几类，还在不断增加中
TMBOY 44:c1d8923072ba 259
TMBOY 44:c1d8923072ba 260 ##### 天气
TMBOY 44:c1d8923072ba 261 ```javascript
TMBOY 44:c1d8923072ba 262 "resource":{
TMBOY 44:c1d8923072ba 263 "type":"weather",
TMBOY 44:c1d8923072ba 264 "data":{
TMBOY 44:c1d8923072ba 265 "city": "北京",
TMBOY 44:c1d8923072ba 266 "current_temp": "-1℃", //实时温度，只有query查询今天的天气的时候才会有值，如“今天天气怎么样”
TMBOY 44:c1d8923072ba 267 "pm25": "426", //实时pm2.5，只有query查询今天的天气的时候才会有值，如“今天天气怎么样”
TMBOY 44:c1d8923072ba 268 "temp": "-3℃~5℃", //当天的温度
TMBOY 44:c1d8923072ba 269 "time": "周二 12月20日", //查询目标时间的文字描述
TMBOY 44:c1d8923072ba 270 "weather": "雾",//天气的文字描述
TMBOY 44:c1d8923072ba 271 "weather_all": "雾，-3℃~5℃，微风", //完整的天气描述
TMBOY 44:c1d8923072ba 272 "wind": "微风",
TMBOY 44:c1d8923072ba 273 "weather_info": [//未来5天的天气数据
TMBOY 44:c1d8923072ba 274 {
TMBOY 44:c1d8923072ba 275 "current_temp": "-1℃",
TMBOY 44:c1d8923072ba 276 "icon": "http://s1.bdstatic.com/r/www/aladdin/img/new_weath/bigicon/4.png",
TMBOY 44:c1d8923072ba 277 "pm25": "426",
TMBOY 44:c1d8923072ba 278 "pm_level": "严重污染",
TMBOY 44:c1d8923072ba 279 "temp": "-3℃~5℃",
TMBOY 44:c1d8923072ba 280 "time": "周二 12月20日",
TMBOY 44:c1d8923072ba 281 "weather": "雾",
TMBOY 44:c1d8923072ba 282 "wind": "微风"
TMBOY 44:c1d8923072ba 283 },
TMBOY 44:c1d8923072ba 284 {
TMBOY 44:c1d8923072ba 285 "icon": "http://s1.bdstatic.com/r/www/aladdin/img/new_weath/icon/7.png",
TMBOY 44:c1d8923072ba 286 "temp": "-3℃~3℃",
TMBOY 44:c1d8923072ba 287 "time": "周三 12月21日",
TMBOY 44:c1d8923072ba 288 "weather": "霾",
TMBOY 44:c1d8923072ba 289 "wind": "微风"
TMBOY 44:c1d8923072ba 290 },
TMBOY 44:c1d8923072ba 291 {
TMBOY 44:c1d8923072ba 292 "icon": "http://s1.bdstatic.com/r/www/aladdin/img/new_weath/icon/1.png",
TMBOY 44:c1d8923072ba 293 "temp": "-5℃~6℃",
TMBOY 44:c1d8923072ba 294 "time": "周四 12月22日",
TMBOY 44:c1d8923072ba 295 "weather": "晴",
TMBOY 44:c1d8923072ba 296 "wind": "北风3-4级"
TMBOY 44:c1d8923072ba 297 },
TMBOY 44:c1d8923072ba 298 {
TMBOY 44:c1d8923072ba 299 "icon": "http://s1.bdstatic.com/r/www/aladdin/img/new_weath/icon/1.png",
TMBOY 44:c1d8923072ba 300 "temp": "-6℃~3℃",
TMBOY 44:c1d8923072ba 301 "time": "周五 12月23日",
TMBOY 44:c1d8923072ba 302 "weather": "晴转多云",
TMBOY 44:c1d8923072ba 303 "wind": "北风微风"
TMBOY 44:c1d8923072ba 304 },
TMBOY 44:c1d8923072ba 305 {
TMBOY 44:c1d8923072ba 306 "icon": "http://s1.bdstatic.com/r/www/aladdin/img/new_weath/icon/5.png",
TMBOY 44:c1d8923072ba 307 "temp": "-5℃~3℃",
TMBOY 44:c1d8923072ba 308 "time": "周六 12月24日",
TMBOY 44:c1d8923072ba 309 "weather": "多云转霾",
TMBOY 44:c1d8923072ba 310 "wind": "北风微风"
TMBOY 44:c1d8923072ba 311 }
TMBOY 44:c1d8923072ba 312 ]
TMBOY 44:c1d8923072ba 313 }
TMBOY 44:c1d8923072ba 314 },
TMBOY 44:c1d8923072ba 315 ```
TMBOY 44:c1d8923072ba 316
TMBOY 44:c1d8923072ba 317 ##### 新闻
TMBOY 44:c1d8923072ba 318
TMBOY 44:c1d8923072ba 319 一次查询会返回多条新闻，现在是10条，新闻内容（content字段）如果太长会被截断
TMBOY 44:c1d8923072ba 320 ```javascript
TMBOY 44:c1d8923072ba 321 "resource":{
TMBOY 44:c1d8923072ba 322 "type":"news",
TMBOY 44:c1d8923072ba 323 "data":{
TMBOY 44:c1d8923072ba 324 "list":[
TMBOY 44:c1d8923072ba 325 {
TMBOY 44:c1d8923072ba 326 "id":"xxx1234bbb",
TMBOY 44:c1d8923072ba 327 "title":"河北首次启动区域红色应急响应 雾霾笼罩",
TMBOY 44:c1d8923072ba 328 "summary":"河北首次启动区域红色应急响应 雾霾笼罩",
TMBOY 44:c1d8923072ba 329 "content":"霾是什么？雾是什么？都是怎么形成的？它们的关系是什么？气温丶湿度丶风力丶风向丶地形丶地表丶温湿度丶灰尘丶烟尘丶粉尘丶扬尘那个危害更大，这些都应当弄清了，再谈霾和雾，不要把霾字前加雾字。这本来就是两种截然不同的两种物质。只是它们互相影响而已。把它们混为一谈。就是错的引导。霾在四五年前就已经开始了。只是越来越严重而已。它是随着汽车进入家庭而伴生的。", //新闻内容
TMBOY 44:c1d8923072ba 330 "url":"http://headline.baidu.com/doc/detail?app_from=dumi_news&url_key=http%3A//news.163.com/photoview/00AP0001/2216510.html",
TMBOY 44:c1d8923072ba 331 "image" : "http://ztd00.photos.bdimg.com/ztd/whfpf%3D160%2C120%2C50%3Bq%3D70/sign=1a96a9f0f41f4134e062563e4322a4fc/d000baa1cd11728bfb98b831c1fcc3cec3fd2c6f.jpg",
TMBOY 44:c1d8923072ba 332 "thumb":"http://ztd00.photos.bdimg.com/ztd/whfpf%3D160%2C120%2C50%3Bq%3D70/sign=1a96a9f0f41f4134e062563e4322a4fc/d000baa1cd11728bfb98b831c1fcc3cec3fd2c6f.jpg",
TMBOY 44:c1d8923072ba 333 "pubtime":"2016-12-20 20:01:01"
TMBOY 44:c1d8923072ba 334 },
TMBOY 44:c1d8923072ba 335 {
TMBOY 44:c1d8923072ba 336 "id":"xxx1234bbb",
TMBOY 44:c1d8923072ba 337 "title":"河北首次启动区域红色应急响应 雾霾笼罩",
TMBOY 44:c1d8923072ba 338 "summary":"河北首次启动区域红色应急响应 雾霾笼罩",
TMBOY 44:c1d8923072ba 339 "content":"霾是什么？雾是什么？都是怎么形成的？它们的关系是什么？气温丶湿度丶风力丶风向丶地形丶地表丶温湿度丶灰尘丶烟尘丶粉尘丶扬尘那个危害更大，这些都应当弄清了，再谈霾和雾，不要把霾字前加雾字。这本来就是两种截然不同的两种物质。只是它们互相影响而已。把它们混为一谈。就是错的引导。霾在四五年前就已经开始了。只是越来越严重而已。它是随着汽车进入家庭而伴生的。",
TMBOY 44:c1d8923072ba 340 "url":"http://headline.baidu.com/doc/detail?app_from=dumi_news&url_key=http%3A//news.163.com/photoview/00AP0001/2216510.html",
TMBOY 44:c1d8923072ba 341 "image":"http://ztd00.photos.bdimg.com/ztd/whfpf%3D160%2C120%2C50%3Bq%3D70/sign=1a96a9f0f41f4134e062563e4322a4fc/d000baa1cd11728bfb98b831c1fcc3cec3fd2c6f.jpg",
TMBOY 44:c1d8923072ba 342 "thumb":"http://ztd00.photos.bdimg.com/ztd/whfpf%3D160%2C120%2C50%3Bq%3D70/sign=1a96a9f0f41f4134e062563e4322a4fc/d000baa1cd11728bfb98b831c1fcc3cec3fd2c6f.jpg",
TMBOY 44:c1d8923072ba 343 "pubtime":"2016-12-20 20:01:01"
TMBOY 44:c1d8923072ba 344 }
TMBOY 44:c1d8923072ba 345 ]
TMBOY 44:c1d8923072ba 346 }
TMBOY 44:c1d8923072ba 347 },
TMBOY 44:c1d8923072ba 348 ```
TMBOY 44:c1d8923072ba 349
TMBOY 44:c1d8923072ba 350 ##### 音乐
TMBOY 44:c1d8923072ba 351 [音乐垂类的resource说明](../bot/audio_music.md#resource-部分的解释说明)
TMBOY 44:c1d8923072ba 352
TMBOY 44:c1d8923072ba 353 #### speech
TMBOY 44:c1d8923072ba 354 目前仅返回Text类型，SSML类型在开发中，[SSML的说明](https://www.w3.org/TR/speech-synthesis/)
TMBOY 44:c1d8923072ba 355 ```javascript
TMBOY 44:c1d8923072ba 356 "speech": {
TMBOY 44:c1d8923072ba 357 "type": "Text",
TMBOY 44:c1d8923072ba 358 "content": "为您播放周杰伦的歌曲"
TMBOY 44:c1d8923072ba 359 }
TMBOY 44:c1d8923072ba 360 ```
TMBOY 44:c1d8923072ba 361
TMBOY 44:c1d8923072ba 362 #### directives
TMBOY 44:c1d8923072ba 363 基础结构：
TMBOY 44:c1d8923072ba 364 ```javascript
TMBOY 44:c1d8923072ba 365 "directives":[ //指令，用于控制给客户端、目标硬件下达命令，可选字段，一个结果可包含多条啊指令
TMBOY 44:c1d8923072ba 366 {
TMBOY 44:c1d8923072ba 367 "header": {
TMBOY 44:c1d8923072ba 368 "namespace": "",//指令的分类
TMBOY 44:c1d8923072ba 369 "name": "" //指令的名字
TMBOY 44:c1d8923072ba 370 },
TMBOY 44:c1d8923072ba 371 "payload":{ //指令的参数
TMBOY 44:c1d8923072ba 372 }
TMBOY 44:c1d8923072ba 373 }
TMBOY 44:c1d8923072ba 374 ]
TMBOY 44:c1d8923072ba 375 ```
TMBOY 44:c1d8923072ba 376 现在有以下namespace指令可能返回
TMBOY 44:c1d8923072ba 377
TMBOY 44:c1d8923072ba 378 ##### AudioPlayer
TMBOY 44:c1d8923072ba 379 * [AudioPlayer](../directives/AudioPlayer.md) 音乐播放相关指令
TMBOY 44:c1d8923072ba 380
TMBOY 44:c1d8923072ba 381 ##### Speaker
TMBOY 44:c1d8923072ba 382 * [Speaker](../directives/Speaker.md) 扬声器控制、设置相关指令
TMBOY 44:c1d8923072ba 383
TMBOY 44:c1d8923072ba 384 ##### SpeechSynthesizer
TMBOY 44:c1d8923072ba 385 * [SpeechSynthesizer](../directives/SpeechSynthesizer.md) 语音播报（TTS）相关指令
TMBOY 44:c1d8923072ba 386
TMBOY 44:c1d8923072ba 387 ##### SpeechRecognizer
TMBOY 44:c1d8923072ba 388 * 只有部分客户端支持的指令
TMBOY 44:c1d8923072ba 389 * [SpeechRecognizer](../directives/SpeechRecognizer.md) 语音识别相关指令
TMBOY 44:c1d8923072ba 390
TMBOY 44:c1d8923072ba 391 ##### Extension
TMBOY 44:c1d8923072ba 392 * 只有部分客户端支持的指令
TMBOY 44:c1d8923072ba 393 * [Extension](../directives/Extension.md) 部分客户端会收到的扩展指令
TMBOY 44:c1d8923072ba 394
TMBOY 44:c1d8923072ba 395
TMBOY 44:c1d8923072ba 396 #### hint
TMBOY 44:c1d8923072ba 397 用户接下去可能会输入的query，可以用来给用户提示，辅助用户输入
TMBOY 44:c1d8923072ba 398 比如下面的例子是“讲个笑话”这个query返回的hint
TMBOY 44:c1d8923072ba 399 ```javascript
TMBOY 44:c1d8923072ba 400 "hint":["再来一个", "文字笑话", "图片笑话"],
TMBOY 44:c1d8923072ba 401 ```
TMBOY 44:c1d8923072ba 402
TMBOY 44:c1d8923072ba 403
TMBOY 44:c1d8923072ba 404 #### nlu
TMBOY 44:c1d8923072ba 405
TMBOY 44:c1d8923072ba 406 ##### 格式说明
TMBOY 44:c1d8923072ba 407
TMBOY 44:c1d8923072ba 408 ```javascript
TMBOY 44:c1d8923072ba 409 "nlu": { //query解析的结果
TMBOY 44:c1d8923072ba 410 "domain": "music",
TMBOY 44:c1d8923072ba 411 "intent": "music", //domain + intent确定一种解析结果的类型
TMBOY 44:c1d8923072ba 412 "slots": { //从query中提取出来的槽位信息
TMBOY 44:c1d8923072ba 413 "action_type":"1",
TMBOY 44:c1d8923072ba 414 "singer": "周杰伦"
TMBOY 44:c1d8923072ba 415 }
TMBOY 44:c1d8923072ba 416 }
TMBOY 44:c1d8923072ba 417 ```
TMBOY 44:c1d8923072ba 418
TMBOY 44:c1d8923072ba 419 ##### 包含query解析结果的结构化数据
TMBOY 44:c1d8923072ba 420
TMBOY 44:c1d8923072ba 421 描述|domain|intent|slots(可用的槽位)|example
TMBOY 44:c1d8923072ba 422 ----|------|------|-----------------|-------
TMBOY 44:c1d8923072ba 423 火车票|22|22|end_point(终点站), start_point(起点站), search_type(如：高铁), start_time(时间)|给我买张到武汉的高铁票
TMBOY 44:c1d8923072ba 424 天气|duer_weather|sys_weather|loc_city(城市), loc_county(国家), loc_province(省), time(时间)|北京明天天气如何
TMBOY 44:c1d8923072ba 425 地址查询类需求|lbs|poi|poi(地址字符串)|射阳在哪儿
TMBOY 44:c1d8923072ba 426 周边查询类需求|lbs|nearby|start_point(出发地),start_point_bd_la(出发地纬度),start_point_bd_lo(出发地经度),user_location_city(用户当前所在城市),end_point(目的地),travel_type(出行方式),坐标类型为bd09ll(百度经纬度坐标)|附近的飞机场
TMBOY 44:c1d8923072ba 427 导航查询类需求|lbs|navigation/route/traffic_condition|start_point(出发地),start_point_bd_la(出发地纬度),start_point_bd_lo(出发地经度),user_location_city(用户当前所在城市),end_point(目的地),travel_type(出行方式),坐标类型为bd09ll(百度经纬度坐标)|导航从北京到上海
TMBOY 44:c1d8923072ba 428 音乐类需求|music|music|action_type(0. 关闭 1. 打开 2. 播放 3. 暂停 4. 下一首 5. 上一首 6. 换一首 7. 重播), song(歌名), singer(歌手), music_language(语言), music_emotion(情感，如悲伤、欢快等), music_tag, music_type(嘻哈、摇滚、儿歌等)|
TMBOY 44:c1d8923072ba 429 让度秘唱歌，类似调戏|music|music_sing|CommandAccepter, action_type(0. 关闭 1. 打开 2. 播放 3. 暂停 4. 下一首 5. 上一首 6. 换一首 7. 重播), song(歌名), singer(歌手)|
TMBOY 44:c1d8923072ba 430 联系人查询需求|phone|contact|action_type(1：查看 0：新建 2：发送), pinyin_for_view(要查看的联系人的拼音), name_for_view(要查看的联系人的名字), pinyin_to_send(要发送的联系人的拼音), name_to_send(要发送的联系人的名字)|告诉我张凤仪的电话号码, 庞翔宇的电话号码发给张凤仪
TMBOY 44:c1d8923072ba 431 打开网址|phone|open_website|action_type, name, website_url|携程火车票
TMBOY 44:c1d8923072ba 432 发短信|phone|sms|content(短信内容), number(目标号码), name(目标姓名), pinyin(目标姓名拼音)|短信发给15140559455
TMBOY 44:c1d8923072ba 433 提醒、闹钟|remind|remind|action, event_title, intent, remind_time, remind_type_message, remind_type_phone, remind_type_dumi, remind_type_clock, remind_time_type, remind_time_value, remind_time_data, status|设置提醒每天晚上9点半洗衣服。
TMBOY 44:c1d8923072ba 434 美食、团购|restaurant_bot|find|catetag, fragment, location, sortby, cuisine, crowd, groupon|附近有什么好吃的饭馆
TMBOY 44:c1d8923072ba 435
TMBOY 44:c1d8923072ba 436 ##### 以下是跑出来的一批nlu数据的例子
TMBOY 44:c1d8923072ba 437
TMBOY 44:c1d8923072ba 438 [Examples](../nlu/example.md)