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初始化时会读取cfg配置,格式是json,参数如下: ~~~ json { "login":{ "appid": "", "key":"", "api_secret": "" }, "interact":{ "interact_timeout":"60000", "result_timeout":"5000" }, "global":{ "scene":"main_box", "clean_dialog_history":"auto", /* 1(sdk5.x版本语义) 2(sdk 6.x版本语义) */ "aiui_ver": "1" }, "vad":{ "vad_enable":"1", "engine_type":"evad", "res_type":"assets", "res_path":"vad/evad_16k.jet", "vad_bos":"5000", "vad_eos":"1000", "threshold":"0.7", "speech_timeout":"5000" }, // 识别(音频输入)参数 "iat":{ "sample_rate":"16000" }, "speech":{ "data_source":"sdk", "interact_mode": "oneshot" }, /* 用户参数,透传到后处理(非必须)*/ "userparams":{ "xxxx": "xxx" //自定义字段 }, "tts": { "play_mode": "sdk", "buffer_time": "0", "stream_type": "3", "audio_focus": "0" } /* 配置wss协议,避免路由器拦截数据*/ "aiui_ssb":{ "aiui_up_url": "wss://aiui-ipv6.openspeech.cn:443/aiui/v2.1/upload.do", "aiui_chid_url": "https://aiui-ipv6.openspeech.cn:443/v1.1/server/register", }, /* 日志设置 "log": { "debug_log": "0", "save_datalog": "0", "datalog_path": "", "datalog_size": 1024, "raw_audio_path": "" } } ~~~ ### 1.1. 配置字段说明 ## <table> <tr> <td colspan="2" align="center"><b>模块名称</b></td> <td colspan="3" align="center"><b>模块说明</b></td> </tr> <tr> <td><b>模块名称</b></td> <td><b>模块说明</b></td> <td><b>参数名称</b></td> <td><b>是否必传</b></td> <td><b>参数和取值说明</b></td> </tr> <tr> <td rowspan="3">login</td> <td rowspan="3">登录参数</td> <td>appid</td> <td>是</td> <td>AIUI应用信息appid</td> </tr> <tr> <td>key</td> <td>否</td> <td>AIUI应用信息appKey</td> </tr> <tr> <td>api_secret</td> <td>否</td> <td>AIUI应用信息apiSecret</td> </tr> <tr> <td rowspan="3">global</td> <td rowspan="3">全局参数</td> <td>scene</td> <td>是</td> <td>AIUI应用情景模式</td> </tr> <tr> <td>aiui_ver</td> <td>否</td> <td><b>AIUI交互链路指定</b><br>1:传统语义链路<br>2:大模型语义链路(6.6.xxx及以上版本默认取值)<br></td> </tr> <tr> <td>clean_dialog_history</td> <td>否</td> <td><b>清除交互历史设置</b><br>auto:自动清除历史(默认模式)<br>user:用户手动清除历史<br></td> </tr> <tr> <td rowspan="2">interact</td> <td rowspan="2">交互控制参数</td> <td>interact_timeout</td> <td>否</td> <td><b>交互超时(单位:ms)</b><br>即唤醒之后,如果在这段时间内无有效交互则重新进入待唤醒状态,<br>取值:[10000,180000)。<br>默认为1min。</td> </tr> <tr> <td>result_timeout</td> <td>否</td> <td><b>结果超时(单位:ms)</b><br>即检测到语音后端点后一段时间内无结果返回则抛出10120错误码。<br>默认值:5000。</td> </tr> <tr> <td rowspan="2">speech</td> <td rowspan="2">业务相关参数</td> <td>data_source</td> <td>是</td> <td><b>录音数据来源配置</b><br>sdk:sdk内部录音<br>user: 外部录音</td> </tr> <tr> <td>interact_mode</td> <td>是</td> <td><b>交互模式设置</b><br>continuous:持续交互,对于语音即“一次唤醒,多次交互”<br>oneshot:(默认模式)一次交互,对于语音即“一次唤醒,一次交互”</td> </tr> <tr> <td rowspan="10">vad</td> <td rowspan="10">音频端点检测参数</td> <td>vad_enable</td> <td>是</td> <td><b>VAD启用设置</b><br>1:(默认参数)开启vad<br>0:关闭vad</td> </tr> <tr> <td>engine_type</td> <td>是</td> <td><b>VAD引擎类型</b><br>取值有 meta、evad,注意该参数与实际加载的vad资源要对应</td> </tr> <tr> <td>res_type</td> <td>是</td> <td><b>VAD资源类型</b><br>使用模型vad时必须设置,取值说明如下<br>assets:assets资源(apk工程的assets文件)<br>res:res资源(apk工程的res文件)<br>path:path资源(sdcard文件)</td> </tr> <tr> <td>res_path</td> <td>是</td> <td><b>VAD资源文件路径</b><br>使用模型vad时必须设置。</td> </tr> <tr> <td>vad_bos</td> <td>否</td> <td><b>VAD前端超时时间</b><br>单位:毫秒 示例 "5000"</td> </tr> <tr> <td>vad_eos</td> <td>否</td> <td><b>VAD后端超时时间</b><br>单位:毫秒 示例 "1000"</td> </tr> <tr> <td>cloud_vad_eos</td> <td>否</td> <td><b>云端VAD后端超时时间</b><br>单位:毫秒 示例 "3000"</td> </tr> <tr> <td>cloud_vad_gap</td> <td>否</td> <td><b>云端VAD分句间隔</b><br>单位:毫秒 示例 "400"</td> </tr> <tr> <td>threshold</td> <td>否</td> <td><b>VAD检测阈值</b><br>控制VAD模块检测程度的,取值范围[0.1,0.9], 值越大越难触发vad</td> </tr> <tr> <td>speech_timeout</td> <td>否</td> <td><b>对话超时时间</b><br>vad_bos开始说话时计时,超过设置的时间自动结束对话并回调vad_eos,单位:毫秒,示例 "500"(默认值60000)</td> </tr> <tr> <td>userparams</td> <td>用户自定义参数</td> <td>用户自定义key</td> <td>否</td> <td><b>用户自定义value</b><br>无固定取值限制,开发者自定义健值对符合json格式即可</td> </tr> <tr> <td rowspan="2">audioparams</td> <td rowspan="2">音频透传参数</td> <td>msc.lng</td> <td>否</td> <td><b>经度</b><br>示例:117.16334474(不超过8位精度)</td> </tr> <tr> <td>msc.lat</td> <td>否</td> <td><b>纬度</b><br>示例:31.82102191(不超过8位精度)</td> </tr> <tr> <td>iat</td> <td>识别音频参数</td> <td>sample_rate</td> <td>否</td> <td><b>采样率</b><br>16000</td> </tr> <tr> <td rowspan="4">tts</td> <td rowspan="4">合成播放控制参数</td> <td>play_mode</td> <td>否</td> <td><b>播放控制</b><br>sdk:内部SDK托管播放(默认取值)<br>user:外部自行播放</td> </tr> <tr> <td>buffer_time</td> <td>否</td> <td><b>音频缓冲时长</b><br>当缓冲音频大于该值时才开始播放,默认值:0ms</td> <tr> <td>stream_type</td> <td>否</td> <td><b>播放音频流类型</b><br>取值参考AudioManager类,默认值:3</td> <tr> <td>audio_focus</td> <td>否</td> <td><b>播放音频时是否抢占焦点</b><br>1:抢占焦点<br>0:不抢占焦点(默认值)</td> </tr> <tr> <td rowspan="2">aiui_ssb</td> <td rowspan="2">交互协议透传参数<br>(使用加密协议,避免请求拦截)</td> <td>aiui_chid_url</td> <td>否</td> <td><b>登陆注册地址</b><br>https://aiui-ipv6.openspeech.cn:443/v1.1/server/register</td> </tr> <tr> <td>aiui_up_url</td> <td>否</td> <td><b>数据交互地址(传统语义链路)</b><br>wss://aiui-ipv6.openspeech.cn:443/aiui/v2.1/upload.do</td> </tr> <tr> <td rowspan="5">log</td> <td rowspan="5">日志设置</td> <td>debug_log</td> <td>否</td> <td><b>Debug日志开关</b><br>取值:1(打开),0(关闭),默认值:0。<br>日志打开时会向logcat打印调试日志。</td> </tr> <tr> <td>save_datalog</td> <td>否</td> <td><b>是否保存数据日志</b><br>取值:1(打开),0(关闭),默认值:0。<br>打开之后会将所有上传到云端的音频和云端返回的结果保存到本地,保存的路径位于/sdcard/AIUI/data/,每一次唤醒后的交互音频都保存在此目录下wakeXX开始的文件夹下。</td> <tr> <td>datalog_path</td> <td>否</td> <td><b>数据日志的保存路径</b><br>当不设置或者为空值时,使用默认值:“/sdcard/AIUI/data/”。</td> <tr> <td>datalog_size</td> <td>否</td> <td><b>数据日志的大小限制(单位:MB)</b><br>取值:[-1,+∞)<br>默认值:-1(表示无大小限制)。<br>注意:设置成-1可能会造成SD卡被日志写满,从而导致AIUI性能下降,影响体验效果。</td> </tr> <tr> <td>raw_audio_path</td> <td>否</td> <td><b>原始音频保存路径</b><br>当不设置或者为空值时,使用默认值:“/sdcard/AIUI/audio/”。</td> <tr> </table> ### 1.2. 动态参数配置 ## 动态设置scene可使用不同情景模式下对应的业务 **Android 示例代码** ~~~ java String setParams = "{\"global\":{\"scene\":\"main\"}}"; AIUIMessage setMsg = new AIUIMessage(CMD_SET_PARAMS, 0 , 0, setParams, null); mAIUIAgent.sendMessage(setMsg); ~~~ **iOS/Linux/Windows 示例代码** ~~~ c const char* setParams = "{\"global\":{\"scene\":\"main\"}}"; IAIUIMessage* writeMsg=IAIUIMessage::create(AIUIConstant::CMD_SET_PARAMS, 0, 0, setParams, NULL); m_angent->sendMessage(writeMsg); writeMsg->destroy(); ~~~ <IflyHeader />
admin
2024年11月19日 16:40
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码