编辑: 捷安特680 | 2019-12-28 |
1 目次 技能插件接入文档
1 技能插件接入文档(2016-12-02) 接口说明 请求方法 GET 请求地址 http://api.ruyi.ai/v1/message 请求参数说明 参数名 参数 类型 是否必须参数说明 q String 是 自然语言表达,例如 我要听周杰伦的歌 , 我要听段 子来了 , 今天上海的天气 等app_key String 是 应用开发者秘钥,注册开发者后台账号,建立虚拟 助理后获得 user_id String 是 用户唯一标识,便于支持个性化语义解析.建议开 发者使用UUID字符,且不同用户必须用不同的 user_id,防止意图串. context String 否 用户当前上下文信息.context的一个实例,JSON字 符串格式 返回结果说明 名称 类型 说明 parameters Object 解析到的实体以及服务说明 outputs Array 服务输出结果,微信端只会收到type字段以wechat开 头的内容,硬件端收到所有内容,依据需求解析使用 技能插件接入文档
2 技能插件请求示例 音乐 请求示例(成功,返回20首歌的播放列表) http://api.ruyi.ai/ruyi-api/v1/message? app_key=APP_KEY&
user_id=user0&
q=我要听周杰伦的歌 返回结果 { code : 0, msg : ok , result : { text : 我要听周杰伦的歌 , msg_id : e7ed40d0-5dca-424d-9cba-8b5d3a853189 , intents : [{ parameters : { artist1 : 周杰伦 , service : music action : sys.action.music/artist , name : 0-按歌手名点歌 , result : { music_list : [{ id :
1792609941 , pic : http://img.xiami.net/images/album/im g42/218842/2188421475218842_1.jpg , name : 七里香 , artist : 周杰伦 id :
1792609927 , pic : http://img.xiami.net/images/album/im g40/217940/2179401475217940_1.jpg , name : 稻香 , artist : 周杰伦 id :
1776214561 , 技能插件接入文档
3 pic : http://img.xiami.net/images/album/im g26/16/58106c29e904a_809326_1477471273_1.jpg , name : 稻香 , artist : 周杰伦 id :
1776367151 , pic : http://img.xiami.net/images/album/im g94/214391894/21003528081465637172_1.jpg , name : 前世情人 , artist : 周杰伦;
Kyle Xian id :
1792609929 , pic : http://img.xiami.net/images/album/im g42/218842/2188421475218842_1.jpg , name : 发如雪 , artist : 周杰伦 id :
1770879442 , pic : http://img.xiami.net/images/album/im g69/7169/5012291332307701_1.jpg , name : 好久不见 , artist : 周杰伦 id :
1773859337 , pic : http://img.xiami.net/images/album/im g69/7169/10205528291420552829_1.jpg , name : 淘汰 , artist : 陈奕迅;
周杰伦 id :
2081428 , pic : http://img.xiami.net/images/album/im g69/7169/1686091472615063_1.jpg , name : 简单爱 , artist : 周杰伦 id :
1775919020 , pic : http://img.xiami.net/images/album/im g26/16/58106c29e904a_809326_1477471273_1.jpg , name : 说好的幸福呢 , artist : 周杰伦 技能插件接入文档
4 id :
1769918293 , pic : http://img.xiami.net/images/album/im g69/7169/4157521472622080_1.jpg , name : 听妈妈的话 , artist : 周杰伦 id :
1776265946 , pic : http://img.xiami.net/images/album/im g71/7/581070fd53d58_370971_1477472509_1.jpg , name : 双截棍 , artist : 周杰伦 id :
1792609923 , pic : http://img.xiami.net/images/album/im g40/217940/2179401475217940_1.jpg , name : 爱情废柴 , artist : 周杰伦 id :
1769164023 , pic : http://img.xiami.net/images/album/im g69/7169/3508241474974383_1.jpg , name : 星晴 , artist : 周杰伦 id :
1792609940 , pic : http://img.xiami.net/images/album/im g42/218842/2188421475218842_1.jpg , name : 蒲公英的约定 , artist : 周杰伦 id :
1773859338 , pic : http://img.xiami.net/images/album/im g69/7169/10205528291420552829_1.jpg , name : 简单爱 , artist : 陈奕迅;
周杰伦 id :
1776230341 , pic : http://img.xiami.net/images/album/im g26/16/58106c29e904a_809326_1477471273_1.jpg , 技能插件接入文档
5 name : 晴天 , artist : 周杰伦 id :
2081179 , pic : http://img.xiami.net/images/album/im g69/7169/1685921475912891_1.jpg , name : 安静 , artist : 周杰伦 id :
1776211878 , pic : http://img.xiami.net/images/album/im g26/16/58106c29e904a_809326_1477471273_1.jpg , name : 烟花易冷 , artist : 周杰伦 id :
2307728 , pic : http://img.xiami.net/images/album/im g69/7169/1899151472366346_1.jpg , name : 霍元甲 , artist : 周杰伦 id :
3464843 , pic : http://img.xiami.net/images/album/im g69/7169/312608_1.jpg , name : 手牵手 , artist : 王力宏;
陶;
蔡琴;
张惠妹;
周华健;
伍思凯;
孙燕姿;
周杰伦;
F4;
庾澄庆;
徐若u;
吴宗宪;
S.H.E;
张清芳;
张宇;
动力火车;
信乐团;
蔡依林;
萧亚轩;
江蕙 msg : ok , text : 正在为您播放【周杰伦】的【七里香】,资源来自虾 米.\n 如果说「下一个」「换一个」,硬件端即将播放【周杰伦】的【稻香】 , type : dialog outputs : [{ type : wechat.text , property : { text : 正在为您播放【周杰伦】的【七里香】,资源来 自虾米.\n 如果说「下一个」「换一个」,硬件端即将播放【周杰伦】的【稻香】 技能插件接入文档
6 score : 1.0 , scoreColor : c4 , is_match : 1, id : 4ec56fbf-542a-45cd-8ab4-6445d6838028 meta_process_milliseconds :
150 } } 请求示例(失败,无版权或无符合搜索条件的歌曲,返回20首推荐 歌曲,result中加入字段code:404) http://api.ruyi.ai/ruyi-api/v1/message? app_key=APP_KEY&
user_id=user0&
q=我要听周杰伦的粤语歌 返回结果 { code : 0, msg : ok , result : { text : 我要听周杰伦的粤语歌 , msg_id : b5854c38-e647-484d-ba94-0756c0c60665 , intents : [{ parameters : { tag1 : 粤语 , artist1 : 周杰伦 , service : music action : sys.action.music/artists_tags , name : 0-单个歌手+单个标签 , result : { music_list : [{ id :
1776365722 , pic : http://img.xiami.net/images/album/im g71/7/581070fd53d58_370971_1477472509_1.jpg , name : 迷迭香 , artist : 周杰伦 技能插件接入文档
7 id :
1792695965 , pic : http://img.xiami.net/images/album/im g84/397584/3975841477397584_1.png , name : 说好的幸福呢 , artist : 周杰伦 id :
1776213361 , pic : http://img.xiami.net/images/album/im g26/16/58106c29e904a_........