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

ex

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

dumi_doc-master/doc/nlu-resource-collaboration-notes.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 # nlu+resource合作方式资源播放状态上报接口
TMBOY 44:c1d8923072ba 2
TMBOY 44:c1d8923072ba 3 ## 背景
TMBOY 44:c1d8923072ba 4
TMBOY 44:c1d8923072ba 5 资源方对回传他们资源的播放状态要求很强硬，（包括用户ID（加密后）、声音音频ID、声音播放时长等等）——若违反则资源方将停止与百度的合作协议。
TMBOY 44:c1d8923072ba 6
TMBOY 44:c1d8923072ba 7 所以：`基于nlu+resource的合作方式，合作方也需要上报资源播放状态。`
TMBOY 44:c1d8923072ba 8
TMBOY 44:c1d8923072ba 9 ps:上报的端上的播放状态也为多轮解析提供了支撑。
TMBOY 44:c1d8923072ba 10
TMBOY 44:c1d8923072ba 11 声明：`合作方若没有按照规范上报客户端的播放状态，则需要自行承担相关资源方停止合作的风险`
TMBOY 44:c1d8923072ba 12
TMBOY 44:c1d8923072ba 13 ## 上报接口
TMBOY 44:c1d8923072ba 14
TMBOY 44:c1d8923072ba 15 <table>
TMBOY 44:c1d8923072ba 16 <tr>
TMBOY 44:c1d8923072ba 17 <td>URL</td>
TMBOY 44:c1d8923072ba 18 <td>https://xiaodu.baidu.com/saiya/mediastat</td>
TMBOY 44:c1d8923072ba 19
TMBOY 44:c1d8923072ba 20 </tr>
TMBOY 44:c1d8923072ba 21 <tr>
TMBOY 44:c1d8923072ba 22 <td>Method</td>
TMBOY 44:c1d8923072ba 23 <td>POST</td>
TMBOY 44:c1d8923072ba 24
TMBOY 44:c1d8923072ba 25 </tr>
TMBOY 44:c1d8923072ba 26 </table>
TMBOY 44:c1d8923072ba 27
TMBOY 44:c1d8923072ba 28 ## 接口参数
TMBOY 44:c1d8923072ba 29
TMBOY 44:c1d8923072ba 30 ### 参数说明
TMBOY 44:c1d8923072ba 31 <table>
TMBOY 44:c1d8923072ba 32 <tr>
TMBOY 44:c1d8923072ba 33 <td>key</td>
TMBOY 44:c1d8923072ba 34 <td>内容</td>
TMBOY 44:c1d8923072ba 35 <td>类型</td>
TMBOY 44:c1d8923072ba 36 <td>是否可能为空</td>
TMBOY 44:c1d8923072ba 37 <td>示例</td>
TMBOY 44:c1d8923072ba 38 <td>备注</td>
TMBOY 44:c1d8923072ba 39 </tr>
TMBOY 44:c1d8923072ba 40 <tr>
TMBOY 44:c1d8923072ba 41 <td>bot_id</td>
TMBOY 44:c1d8923072ba 42 <td>垂类bot标识</td>
TMBOY 44:c1d8923072ba 43 <td>string</td>
TMBOY 44:c1d8923072ba 44 <td>否</td>
TMBOY 44:c1d8923072ba 45 <td>audio_news</td>
TMBOY 44:c1d8923072ba 46 <td></td>
TMBOY 44:c1d8923072ba 47 </tr>
TMBOY 44:c1d8923072ba 48 <tr>
TMBOY 44:c1d8923072ba 49 <td>url</td>
TMBOY 44:c1d8923072ba 50 <td>播放的资源地址</td>
TMBOY 44:c1d8923072ba 51 <td>string</td>
TMBOY 44:c1d8923072ba 52 <td>否</td>
TMBOY 44:c1d8923072ba 53 <td style="word-break:break-all">http://fdfs.***.com/group3/M01/77/42/wKgDsVKMdDLCVKUUAIMXy99Q7Vo340.mp3</td>
TMBOY 44:c1d8923072ba 54 <td>播放资源地址</td>
TMBOY 44:c1d8923072ba 55 </tr>
TMBOY 44:c1d8923072ba 56 <tr>
TMBOY 44:c1d8923072ba 57 <td>appid</td>
TMBOY 44:c1d8923072ba 58 <td>合作方标识</td>
TMBOY 44:c1d8923072ba 59 <td>string</td>
TMBOY 44:c1d8923072ba 60 <td>否</td>
TMBOY 44:c1d8923072ba 61 <td>dm4B485F6F3BE40F**</td>
TMBOY 44:c1d8923072ba 62 <td></td>
TMBOY 44:c1d8923072ba 63 </tr>
TMBOY 44:c1d8923072ba 64 <tr>
TMBOY 44:c1d8923072ba 65 <td>appkey</td>
TMBOY 44:c1d8923072ba 66 <td>合作方标识</td>
TMBOY 44:c1d8923072ba 67 <td>string</td>
TMBOY 44:c1d8923072ba 68 <td>否</td>
TMBOY 44:c1d8923072ba 69 <td>92D6A5FD2E69A84847147E69FA70B1**</td>
TMBOY 44:c1d8923072ba 70 <td></td>
TMBOY 44:c1d8923072ba 71 </tr>
TMBOY 44:c1d8923072ba 72 <tr>
TMBOY 44:c1d8923072ba 73 <td>cuid</td>
TMBOY 44:c1d8923072ba 74 <td>用户标识</td>
TMBOY 44:c1d8923072ba 75 <td>string</td>
TMBOY 44:c1d8923072ba 76 <td>否</td>
TMBOY 44:c1d8923072ba 77 <td>2D6A5FD2E69A84847147E6</td>
TMBOY 44:c1d8923072ba 78 <td></td>
TMBOY 44:c1d8923072ba 79 </tr>
TMBOY 44:c1d8923072ba 80 <tr>
TMBOY 44:c1d8923072ba 81 <td>token</td>
TMBOY 44:c1d8923072ba 82 <td>资源id</td>
TMBOY 44:c1d8923072ba 83 <td>string</td>
TMBOY 44:c1d8923072ba 84 <td>否</td>
TMBOY 44:c1d8923072ba 85 <td>188376</td>
TMBOY 44:c1d8923072ba 86 <td></td>
TMBOY 44:c1d8923072ba 87 </tr>
TMBOY 44:c1d8923072ba 88 <tr>
TMBOY 44:c1d8923072ba 89 <td>offset_ms</td>
TMBOY 44:c1d8923072ba 90 <td>播放时长</td>
TMBOY 44:c1d8923072ba 91 <td>int</td>
TMBOY 44:c1d8923072ba 92 <td>是</td>
TMBOY 44:c1d8923072ba 93 <td>20000</td>
TMBOY 44:c1d8923072ba 94 <td>单位ms</td>
TMBOY 44:c1d8923072ba 95 <tr>
TMBOY 44:c1d8923072ba 96 <td>action</td>
TMBOY 44:c1d8923072ba 97 <td>用户动作</td>
TMBOY 44:c1d8923072ba 98 <td>enum</td>
TMBOY 44:c1d8923072ba 99 <td>是</td>
TMBOY 44:c1d8923072ba 100 <td>PLAYING</td>
TMBOY 44:c1d8923072ba 101 <td>PLAYING</td>
TMBOY 44:c1d8923072ba 102 </tr>
TMBOY 44:c1d8923072ba 103 <tr>
TMBOY 44:c1d8923072ba 104 <td></td>
TMBOY 44:c1d8923072ba 105 <td></td>
TMBOY 44:c1d8923072ba 106 <td></td>
TMBOY 44:c1d8923072ba 107 <td></td>
TMBOY 44:c1d8923072ba 108 <td></td>
TMBOY 44:c1d8923072ba 109 <td>STOPPED</td>
TMBOY 44:c1d8923072ba 110 </tr>
TMBOY 44:c1d8923072ba 111 <tr>
TMBOY 44:c1d8923072ba 112 <td></td>
TMBOY 44:c1d8923072ba 113 <td></td>
TMBOY 44:c1d8923072ba 114 <td></td>
TMBOY 44:c1d8923072ba 115 <td></td>
TMBOY 44:c1d8923072ba 116 <td></td>
TMBOY 44:c1d8923072ba 117 <td>PAUSED</td>
TMBOY 44:c1d8923072ba 118 </tr>
TMBOY 44:c1d8923072ba 119 <tr>
TMBOY 44:c1d8923072ba 120 <td></td>
TMBOY 44:c1d8923072ba 121 <td></td>
TMBOY 44:c1d8923072ba 122 <td></td>
TMBOY 44:c1d8923072ba 123 <td></td>
TMBOY 44:c1d8923072ba 124 <td></td>
TMBOY 44:c1d8923072ba 125 <td>FINISHED</td>
TMBOY 44:c1d8923072ba 126 </tr>
TMBOY 44:c1d8923072ba 127 </table>
TMBOY 44:c1d8923072ba 128
TMBOY 44:c1d8923072ba 129 ### post body 示例
TMBOY 44:c1d8923072ba 130 ```
TMBOY 44:c1d8923072ba 131 curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
TMBOY 44:c1d8923072ba 132 "bot_id": "audio_news",
TMBOY 44:c1d8923072ba 133 "url": "http://fdfs.***.com/group3/M01/77/42/wKgDsVKMdDLCVKUUAIMXy99Q7Vo340.mp3",
TMBOY 44:c1d8923072ba 134 "appid": "dm4B485F6F3BE40F",
TMBOY 44:c1d8923072ba 135 "appkey": "92D6A5FD2E69A84847147E69FA70B1",
TMBOY 44:c1d8923072ba 136 "cuid": "2D6A5FD2E69A84847147E6",
TMBOY 44:c1d8923072ba 137 "token": "188376",
TMBOY 44:c1d8923072ba 138 "offset_ms": 2000000000,
TMBOY 44:c1d8923072ba 139 "action": "PLAYING"
TMBOY 44:c1d8923072ba 140 }' "https://xiaodu.baidu.com/saiya/mediastat" `
TMBOY 44:c1d8923072ba 141
TMBOY 44:c1d8923072ba 142 ```