开发文档

我们以一个小A机器人的应用为例,来给大家简单介绍下平台的使用方法。

背景:小A机器人是一款陪伴类机器人,主要功能有音乐、故事,天气、家居、儿童教育,闲聊对话等等。

1、创建&配置应用

整个平台流程分为五步,即注册、创建应用、创建技能、应用配置、集成开发。

1.1 注册&创建应用

进入AIUI开放平台http://aiui.xfyun.cn/,点击右上角登录或者注册按钮,完成登录操作。登录后,点击【我的应用】,进入应用管理页面。

在我的应用 > 创建应用中创建新应用,并填写应用相关信息。

注意:成功创建应用后,应用会获得一个appid,作为您所创建的应用的唯一标识。在后面请求服务的时候,appid是非常重要的信息。

1.2 应用配置

进入【我的应用】,以小A机器人为例,为该应用配置语义服务。

一个应用下支持多个情景模式,平台默认生成main情景模式。以main情景模式为例,在语义配置项下,点击【添加技能】,在弹出的技能选择页面进行勾选,包括自定义技能、问答库以及开放平台提供的开放技能。

说明:

(1)所有自定义的技能都会显示在这里供您添加,如果没有自定义技能,可以点击【创建自定义技能】进行DIY。

(2)如果您的应用需要使用开放平台提供的开放问答库,在开放问答处添加各种库即可。

1.3 效果体验

各项技能配置好之后,可以在右侧的快速体验窗口进行体验并查看语义结果(JSON格式)。

1.4 集成开发(此版本暂不提供)

给应用的语义服务配置好后,即可集成开发。下载应用下的sdk,根据开发文档进行集成开发。

注意:(1)sdk带着应用平台和应用appid信息,必须下载相应应用的sdk。(2)开发完成后,请及时提交应用审核,以免影响服务的使用。

2、自定义技能

如果平台开放的技能不能满足需求,可以进入【我的技能】> 我的技能DIY自己的技能。

首先介绍一些关键词:

意图

将某个技能的交互需求进行分类,并根据该意图确定所需的参数。比如音乐技能下,可以将需求分类以下几类意图:

1、 随机播放音乐(下图search_music),该意图不涉及具体语义槽。

2、 按照歌手(下图search_music_by_artist)来播放音乐,该意图涉及歌手artist这个语义槽。

3、 按照歌手和歌名(下图search_music_by_artist2song)来播放音乐等,该意图涉及歌手artist和歌名song语义槽。

说明:意图和语义槽的名称开发者可以根据自己的习惯进行定义。

语义槽

语义槽相当于意图中所涉及的关键信息,包含语义槽名称和语义槽值。语义槽名称如上述的artist,语义槽值为对应的具体实体内容,如歌手实体。语义解析后,返回语义槽名称和语义槽值。

接下来一张图告诉你如何开始你的语义DIY之旅。

说明:如果你想实现强大好用的自定义技能,一定要做好准备工作哦。准备工作:

1、有明确的目标,并且一定要确定好技能解决问题的范围。

2、目标进行拆解,也就是这个技能包括哪些细的功能点,确定关键信息,也就是语义槽值,语义槽值将是你后续做数据搜索和应用对接的关键。

3、针对拆解后的目标,尽可能多的编写说法句式,越多理解的能力越强。

3、自定义问答库

如前文所述,问答是用于解决闲聊、话题等类对话需求,是一种简单快速的实现语义理解的方式之一,AIUI开放平台提供了强大的匹配算法,您只要设计并添加想要实现的问答对即可。

目前AIUI开放平台支持两种自定义问答库的方法,您可以使用页面添加,也可以选择批量导入。页面添加和批量导入均支持多种问答模式。即一问一答,一问多答,多问一答,多问多答等。

3.1 自定义问答库的方法

首先进入我的技能->我的问答库

点击创建新的问答库,编辑新问答库的名称。

创建新的问答库后,进行问答对的添加。目前支持两种问答对的添加方式:

1、页面直接编辑问答对;

2、下载问答库模板,根据模板编辑好问答对之后,批量追加或覆盖。

编辑好问答对之后,无需发布,即可生效。

3.2 在应用中配置问答库

方法一、在【我的问答库】页面,给你的应用配置问答库

方法二、在【我的应用】页面,给你的应用配置问答库

说明:配置的方式有多种,总有一款适合你。

4、自定义实体

如果平台开放的开放实体不能满足需求,可以进入 我的技能 > 我的实体 开发自己的实体资源。点击“创建新实体”,对于新建的实体,编辑名称和词条即可。

自定义实体支持两种编辑方式:页面编辑和文件导入。开发者可以根据自己的喜好选择不同的自定义方式。

说明:如果是通过模版上传,请注意实体的格式。如果上传失败,则该文档存在格式问题,请根据提示进行修改。

5、资源限制说明

在【我的技能】中,针对用户下每种资源的创建,存在数量上的限制,具体如下表所示:

技能 技能个数 10个
一个技能下的意图数 20个
一个意图下的提问语料数 100个
一个技能下的槽位数 30个
一个意图下的槽位数 20个
问答库 问答库个数 10个
一个问答对问题数 20个,每个问题120个字符
一个问答对答案数 10个,每个答案500个字符
问答库导入的文件大小/问答对数 文件大小:<5M
问答对数:10000个
问答库导入 导入:10次/天
实体 实体个数 20个
一个词条类实体下的词条数 10000个
实体导入的文件大小 <5M
实体导入/导出次数 导入:10次/天
导出:10次/天