在 DSH 环境中为智能体添加语音识别功能,通常需要处理音频输入的格式差异(链接、Base64、文件路径)并管理外部 API 密钥。xby-asr-zh 插件解决了这些具体需求,提供了中文语音识别能力。
插件定位¶
这是一个中文语音识别插件,归属于「模型推理」类别,由 xby-skill 维护。它允许 DSH 进程直接调用语音识别服务,无需开发者自行搭建识别后端。
核心功能¶
插件提供以下核心能力:
- set_xby_apikey:在聊天中设置 API 密钥。该操作会自动持久化,重启 DSH 进程后依然有效。
- asr_paraformer_int8:中文语音识别。调用时需要输入音频文件的链接(URL)。
- asr_paraformer_int8_for_data_base64:中文语音识别。调用时需要输入音频文件的 BASE64 编码。
- asr_paraformer_int8_for_data_file:中文语音识别。调用时需要输入音频文件的文件路径。
安装¶
推荐通过 GitHub 直接安装,也支持本地目录或 Patch 文件安装。
方式一:从 GitHub 直接安装(推荐)¶
使用以下命令将插件添加到指定的 profile 中:
dsh plugin --profile web add github:xby_skill/xby-asr-zh
方式二:从本地目录安装(开发模式)¶
仅用于本地开发调试,需要提供本地目录的绝对路径:
dsh plugin --profile web add /absolute/path/to/xby-asr-zh
方式三:通过 cordis.patch.yml 开发调试¶
利用 Patch 文件进行调试:
dsh web --profile web --patch /absolute/path/to/dsh-ocr-plugin/cordis.patch.yml
前置条件¶
使用该插件前,需要前往 小笨羊官网 注册并获取 API 密钥。在调用语音识别功能前,必须先通过 set_xby_apikey 命令设置该密钥。
使用示例¶
安装完成后,在 DSH 的对话或脚本中使用相应的命令。
设置密钥¶
在聊天中输入:
set_xby_apikey <你的API密钥>
调用识别服务¶
根据音频源的不同,选择对应的命令格式:
- 音频文件链接:
asr_paraformer_int8 https://example.com/audio.mp3
- Base64 编码:
asr_paraformer_int8_for_data_base64 <音频数据的Base64字符串>
- 文件路径:
asr_paraformer_int8_for_data_file /path/to/local/audio.wav
注意事项¶
- 插件以当前 DSH 进程的权限运行,安装前建议检查源码与许可证。
- 插件支持从 GitHub 直接安装或本地目录安装。
- 开发者可以通过
cordis.patch.yml文件进行开发调试。