在 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文件進行開發調試。