AIUI文档中心
AIUI平台说明
什么是AIUI
AIUI平台能力介绍
AIUI交互流程说明
AIUI快速入门
AIUI应用管理说明
应用接入和配置
应用后处理
敏感词
AIUI开发接入
AIUI接入概述
声学接入
交互接入
SDK接入
SDK介绍
参数配置
消息事件
交互状态
结果解析
WebSocketAPI接入
精简协议接入
常用功能
交互控制
语音唤醒
语音合成
用户个性化
自定义参数
离线命令词
翻译模式
流式识别
语义VAD
发音人列表
关键词过滤
情景模式
错误码
星火交互认知大模型说明
大模型概述
开发接入
SDK接入
API接入
大模型API服务鉴权
特色能力
超拟人合成
声音复刻
大模型功能
大模型错误码
软硬件产品接入
RK3328 降噪板
RK3328降噪板白皮书
RK3328降噪板使用手册
RK3328降噪板规格书
RK3328降噪板协议手册
RK3328 AIUI评估板开发套件
RK3328评估板白皮书
RK3328评估板使用手册
RK3328评估板规格书
RK3328评估板开发手册
RK3588 AIUI多模态开发套件
RK3588一体机多模态产品规格书
RK3588多模态套件使用手册
视频传输协议
串口通信协议
音频传输协议
ZG803 离线语音识别套件
ZG803 产品白皮书
USB声卡套件
USB声卡产品白皮书
USB声卡使用指南
AC7911 AIUI语音开发套件
AC7911-产品白皮书
AC7911-快速体验指南
AC7911-开发指南
AC7911-协议手册
AC7911-硬件参数
AIUI评估板接入
集成方式
软件包说明
AIUIServiceKitSDK
串口SDK
评估板参数配置
调试升级
技能工作室
技能概述
名词解析
技能
意图和语料
实体
动态实体
模糊匹配
填槽对话
技能设计规范
语音技能设计规范
开放技能接入审核规范
开放技能图标图片规范
技能开发
创建技能和意图
意图配置
技能测试
技能发布
技能后处理
技能导入导出
云函数APIv2.1
云函数APIv2.0
问答库开发
语句问答
关键词问答
文档问答
设备人设开发
技能协议
语义协议:重要字段和通用字段
技能后处理协议:标准请求
技能后处理协议:请求校验
技能后处理协议:Request_v2.1协议
技能后处理协议:Response_v2.1协议
技能资源限制
硬件设计参考
常见问题
AIUI常见问题
评估板常见问题
动态实体常见问题
联系方式
服务条款
AIUI开放平台服务协议
AIUI开放平台隐私政策
小飞在家用户协议
小飞在家隐私政策
小飞在家开源软件使用许可
讯飞账号隐私政策
讯飞账号用户协议
讯飞带屏音箱用户协议
讯飞带屏音箱隐私政策
AIUI SDK隐私政策
AIUI SDK合规使用说明
本文档使用 MrDoc 发布
-
+
首页
应用接入和配置
**目 录** 1. AIUI接入流程 2. 应用创建 3. 接入配置 4. 应用配置 4.1. 应用信息说明 4.2. 情景模式 4.3. 语音识别 4.4. 结构化语义 4.5. 星火大模型 4.6. 后处理 4.7. 语音合成 5. 模拟测试 6. 应用数据统计 6.1 服务统计 6.2. 设备统计 6.3. 激活设备明细 6.4. 信源授权管理 # 1. AIUI接入流程 下面是AIUI应用接入和配置使用简单示意图,主要包含: 应用创建、开发资料获取(SDK下载、API文档等)、能力信息配置(识别、语义、合成、后处理等)、技能开发、应用调试(端侧集成测试、页面模拟测试)、应用审核与发布 ![](/media/202305/2023-05-03_145149_2589560.3787195276097729.png) ## 2. 应用创建 AIUI应用创建有两种方式: - 一是直接通过AIUI平台创建新应用,具体方式为: 在AIUI平台首页,点击“我的应用”,或在“产品接入”下拉菜单中点击“我的应用”,进入应用管理页面,点击“创建应用”,然后填写相关信息确定即可。 ![](/media/202409/1_1725351782.jpg) ![](/media/202409/2024-09-06_105022_6546610.8489885428371512.png) - 一种是在[讯飞开放平台](http://www.xfyun.cn "讯飞开放平台")创建新应用后相同账号登陆[AIUI开放平台](http://aiui.xfyun.cn "AIUI开放平台"),创建的新应用会同步到AIUI平台应用列表下。 这是由于AIUI开放平台与讯飞开放平台共用一套账号体系。 **需要注意:<span style="color:red">虽然两个平台的应用信息是相互打通的,但两个平台授权信息和能力输出是相互独立的。</span>** ## 3. 接入配置 - SDK下载:应用创建后,在**接入配置**页面可下载对应平台SDK 如需Linux arm或其他架构SDK,可以按照[AIUI常见问题](https://aiui-doc.xf-yun.com/project-1/doc-80/ "AIUI常见问题")中详细描述说明到AIUI提交申请。 ![](/media/202409/2024-09-06_103057_9179790.8888390363733599.png) - API接入:可在开发工具页面进行WebSocket API接口调试以及白名单设置。 注意:当前页面提供的API文档和接口调试工具,是适用与传统语义链路。如果应用配置开启了大模型语义,那么需要对接[大模型API文档](https://aiui-doc.xf-yun.com/project-1/doc-181/ "大模型API文档"),且当前接口调试工具不可用。 ![](/media/202409/2024-09-06_103617_3284200.9390227089420179.png) ## 4. 应用配置 ### 4.1. 应用信息说明 AIUI应用交互授权和服务配置都绑定在应用信息中,应用信息在创建AIUI应用时由平台自动生成,不可更改。目前AIUI应用信息展示主要有两种类型: - 一种是新AIUI应用:包含 appid、appkey、apisecret。该应用可以同时支持识别翻译链路、传统语义链路、交互大模型链路 服务使用。关于AIUI服务链路可见[文档说明](https://aiui-doc.xf-yun.com/project-1/doc-403/)。图示如下: ![](/media/202409/3_1725351815.jpg) - 一种是老AIUI应用:仅包含 appid、appkey。该类应用仅支持 识别翻译链路、传统语义链路 服务使用。不支持接入交互大模型语义链路,图示如下: ![](/media/202409/4_1725351826.jpg) ### 4.2. 情景模式 AIUI应用创建的每个情景模式的配置都是相互独立互不干扰的。一个产品可创建多个情景适配不同的用户。例如配置粤语识别情景和普通话识别情景,通过代码动态切换。 **创建情景模式:**点击“+”号新增。情景模式分为语义情景和翻译情景。每个语义情景可配置不同的识别、语义、后处理、合成。 ![](/media/202409/2024-09-06_104824_4575340.10324687747016803.png) **保存、发布:**配置修改后点击“保存修改”,配置信息将在测试环境生效(情景模式后加`_box`)立即生效。更新发布成功后正式环境才生效。 注意: 1. 默认main情景。 2. 一个应用最多10个情景。 3. 可按需发布对应情景模式的更新,如不需要更新技能和配置到某个情景模式的生产环境,可不做勾选 4. 应用发布前需要先提交“审核上线”,等通过后即可进行“发布” ![](/media/202409/2024-09-06_105519_2102560.23276588659587483.png) ![](/media/202409/2024-09-06_105603_9404630.6159809841310302.png) ### 4.3. 语音识别 引擎配置切换主要分三类: 1、声学模型:中文近场、中文远场 2、语言类型:中文、英文 3、方言领域:中文普通话、四川话、粤语等方言 其次也包含其他定制领域的识别引擎,如餐饮、家具、车载、医疗等,这些引擎是在指定领域定制优化了相关专有名词,使的对应业务场景下的交互识别率更高。 ![](/media/202409/2024-09-06_110357_5740560.40095414360984927.png) - **识别添加标点** 识别结果最后添加标点 - **识别结果优先阿拉伯数字** 示例:识别为“1岁”,而不是“一岁” - **progressive 流式识别** 简称 pgs。说话过程中返回多次中间结果,并不断修正。 - **所见即可说** 一次性热词,提高识别率。 - **上传识别热词** 永久热词,提高识别率。 - **识别敏感词过滤** 把敏感词过滤成`*`,不展示给用户,默认关闭。开启后需要解析 ![](/media/202409/2024-09-06_110938_9112530.9588720443368072.png) ### 4.4. 结构化语义 - **技能配置** 在开启结构化语义后,可以通过“管理技能配置”进行技能管理,包含技能增删配置、信源配置、自定义技能或问答库阈值配置。 **技能优先级**:自定义技能 > 自定义问答 > 设备人设 > 官方技能 > 关键词问答。 ![](/media/202409/2024-09-06_111325_5508620.8307174826233175.png) ![](/media/202409/2024-09-06_111614_7120280.9021010197782339.png) - **关键词过滤** 过滤识别结果中的关键词,不进行语义理解。常用于过滤唤醒词 比如:唤醒词是“小飞小飞” **过滤前**:“小飞小飞,你好“ **过滤后**:“你好“ - **语义敏感词过滤** 给用户回复的信息中包含敏感信息,可以通过设置过滤掉。支持自定义增加。 注意: 到触发语义敏感词过滤时,固定响应: ```json { answer: { text: "文明社会,请文明用语。", topic: "", type: "T" }, operation: "ANSWER", rc: 0, service: "forbidden", sid: "xxxxxxxxx", state: null, text: "xxx", uuid: "xxxxxxxxx" } ``` - **精简协议** 简化结构化语义,将技能结果分为:媒资类和播报类。默认关闭。 将多个技能精简成一种输出协议,大大降低技能适配工作。适用于无屏设备。 - **兜底设置** 用户说法未命中技能和问答,就进入兜底。兜底包括讯飞闲聊、讯飞视频搜索、无回复兜底。 如下图,左侧侧图标可对兜底回复的优先级顺序。技能开启后,可以点击设置图标,设置兜底技能的回复范围。 **需要注意:<span style="color:red">在开启交互大模型时,语义理解下的兜底设置将不可配置,默认隐藏掉。</span>** ![](/media/202409/2024-09-06_113908_1039740.4449501032902161.png) - - **讯飞闲聊** 讯飞闲聊风格有通用版和儿童版,内容包含「讯飞知识图谱」、「精选问答」和「闲聊」。 - - **讯飞视频搜索** 影视类交互,增加模糊搜索匹配度。 - - **无回复兜底** 技能和兜底均无法响应用户时进入无回复兜底,可在平台配置兜底回复,例如:“听不懂你在说什么”。 ### 4.5. 星火大模型 开启星火大模型,代表交互服务切换到交互大模型语义链路,需要按照[文档说明](https://aiui-doc.xf-yun.com/project-1/doc-406/ "文档说明")对接新版本SDK或API。 - **知识溯源** 该配置是控制交互时,是否下发大模型做知识问答时所查询到的知识片段。 ![](/media/202409/2024-09-06_114610_5507770.062473454381694826.png) ### 4.6. 后处理 文档参考[后处理](https://aiui-doc.xf-yun.com/project-1/doc-5/)。 ### 4.7. 语音合成 多种发音人都支持在线试听,调节语速、音量、语调。 **需要注意:<span style="color:red">新增的超拟人合成发音人配置,目前不支持云端托管合成</span>**,使用时需要按照[文档说明](https://aiui-doc.xf-yun.com/project-1/doc-407/ "文档说明")使用端侧合成。 ## 5. 模拟测试 应用配置完成,保存后可以在平台上模拟测试。你可以看到AIUI应用的回复,查看JSON信息。 ![](https://aiui-file.cn-bj.ufileos.com/aiui-doc/2_app_setting/11.png) ## 6. 应用数据统计 AIUI提供交互服务量、设备装机量、装机量明细和设备交互记录的在线查看功能。 ### 6.1 服务统计 服务统计是对交互量的统计,支持在线查询已使用交互次数及剩余交互次数。 基于服务类型查询,目前AIUI平台仅支持传统语义链路数据分析:最近一个月,SDK或者WebSocket API的不同的端的调用次数。 ![](/media/202409/2024-09-06_120235_1798720.260578511144116.png) ### 6.2. 设备统计 按照客户上传的SN统计激活台数,支持AIUI在线交互、离线唤醒降噪: - AIUI在线交互 1、日新增设备:每天新增加的设备数,按UID统计。默认显示前一天的数据。 2、日活跃设备:每天活跃的设备数,按UID统计,计算当日会话UID去重后的总和。默认显示前一天的数据。 3、累计设备:该应用下有过会话的UID去重后总和 4、剩余台数:已购买还未使用的授权装机量总和 ![](/media/202409/2024-09-06_115931_5926620.35726990807777004.png) - 离线唤醒降噪(VTN) 1、累计设备:已激活设备数 2、剩余台数:剩余可用唤醒装机量 ![](/media/202409/2024-09-06_120027_7697980.07721027967343974.png) ### 6.3. 激活设备明细 - 支持设置SN白名单能力:设置后仅支持SDK方式使用,API接入不可设置SN白名单。 - 支持开发者按照设备唯一标识(SN)、时间段、授权类型 查询设备是否注册及注册时间。包含AIUI激活信息、离线唤醒激活信息 ![](/media/202409/2024-09-06_115433_6642160.6728177844176918.png) ### 6.4. 信源授权管理 目前AIUI平台提供音乐技能付费信源开通能力,当服务有信源授权后,可以通过这里查看信源激活使用详情。 ![](/media/202409/2024-09-06_115343_2376870.8326129143177705.png)
admin
2024年9月6日 12:06
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码