Qwen-Audio-3.x-ASR-Flash/Fun-ASR-Flash非实时语音识别HarmonyOS SDK可将语音转换为文本。
用户指南:非实时语音识别。关于支持的音频格式、文件大小限制、时长限制等输入要求,请参见音频规格。
快速开始
- 获取API Key:获取API Key,为安全起见,推荐将API Key配置到环境变量。
- 下载SDK并运行示例代码:
- 下载最新SDK整合包。
- 解压 TAR 包。在
neonui目录中获取 HAR 格式 SDK,并添加到项目依赖。需要 C++ 接入时,使用 TAR 包内的native/libs与native/include获取动态库和头文件。 - 用 DevEco Studio 打开工程。示例代码位于
DashFunAsrFlashFileTranscriberPage.ets,替换 API Key 后体验功能。
调用步骤
同步模式
-
初始化 SDK
-
按业务需求配置相关参数
-
调用
startFileTranscriber发送非实时语音识别请求,并等待结果返回。 -
在
onFileTransEventCallback接口中监听EVENT_FILE_TRANS_RESULT事件,获取最终识别结果。 -
调用
release释放 SDK 资源
请求参数
连接与控制参数
通过在initializeFileTrans接口的parameters参数中传入一个JSON字符串来配置。
参数示例:以下为 JSON 字符串示例,参数未完整列出。请按实际需求在编码时补充:
{
"url": "wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation",
"apikey": "st-****",
"device_id": "my_device_id",
"service_mode": "1"
}
参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
url | string | 是 | 服务地址,固定为 |
apikey | string | 是 | API Key。建议使用时效性短、安全性更高的临时API Key,以降低长期有效Key泄露的风险。 |
service_mode | string | 是 | 运行模式。非实时语音识别固定为 |
device_id | string | 是 | 用于标识终端用户的唯一字符串,可设为应用内用户ID或客户端生成的设备唯一标识符。此ID主要用于日志追踪和问题排查。 |
debug_path | string | 否 | 日志文件的存储路径。 此参数仅在调用initializeFileTrans接口时将 |
max_log_file_size | number | 否 | 设定日志文件的最大字节数。 此参数仅在调用initializeFileTrans接口时将 |
语音识别效果参数
通过setParams接口配置nls_config参数,或者通过startFileTranscriber接口配置所有语音识别效果参数。
参数示例:以下为 JSON 字符串示例,参数未完整列出。请按实际需求在编码时补充:
{
"apikey": "st-****",
"messages": [
{
"content": [
{
"input_audio": {
"data": "{YOUR_AUDIO_URL}"
},
"type": "input_audio"
}
],
"role": "user"
}
],
"nls_config": {
"format": "mp3",
"model": "qwen-audio-3.0-asr-flash"
}
}
参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
apikey | string | 否 | |
nls_config | object | 是 | 语音识别核心配置对象,包含模型选择、识别效果控制等关键参数。 |
nls_config.model | string | 是 | 指定示例调用的模型。模型信息请参见支持的模型与地域。 |
nls_config.format | string | 是 | 音频格式。根据实际音频格式填写,支持 |
nls_config.sample_rate | string | 否 | 音频采样率,单位Hz。例如 |
nls_config.vocabulary_id | string | 否 | 预编译热词列表 ID。 需预先调用创建热词列表接口生成,识别时传入该 ID 即可使用列表中的热词。 适用于词汇已知且相对稳定、需要跨请求复用同一词表的场景。 使用方法请参见预编译热词。 |
nls_config.instant_vocabulary | object | 否 | 即时热词。 重要即时热词的适用模型及限制请参见即时热词。 |
nls_config.language_hints | array[string] | 否 | 设置待识别语言代码。如果无法提前确定语种,可不设置,模型会自动识别语种。
|
messages | array[object] | 是 | 消息列表。包含当前待识别的音频,以及可选的对话上下文(用于提升识别效果)。 |
重要上下文功能用于提升专有词汇的识别准确率,使用方法详见上下文增强。
约束:上下文消息(input_text 和 text 类型)各最多 5 条,超出时保留最近的 5 条。每轮上下文文本总长度(user 和 assistant 的 text 字段长度之和)不超过 400 个字符(按字符数计算,每个字符计为 1),超出部分从末尾截断。
重要携带上下文时,messages 中的消息顺序有要求:上下文消息必须按对话轮次排列,每轮中 user(input_text 类型)必须在对应的 assistant(text 类型)之前;包含 input_audio 的 user 消息必须放在 messages 数组的最后。
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
role | string | 是 | 消息角色。取值范围:
|
content | array[object] | 是 | 消息内容列表。详细如下说明。 |
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
type | string | 是 | 内容类型。每个请求至少需要一条
|
input_audio | object | 否 | 当 |
input_audio.data | string | 是 | 待识别音频数据。关于支持的音频格式、文件大小限制、时长限制等输入要求,请参见音频规格。支持以下两种方式:
|
text | string | 否 | 当 |
关键接口
NativeNui
initializeFileTrans
初始化语音识别SDK实例。
说明与实时语音识别不同,非实时(录音文件)转录必须使用 initializeFileTrans 方法并传入 INativeFileTransCallback 回调,而不是 initialize。
此接口会引起阻塞,应在非UI线程调用。
方法签名public initializeFileTrans(callback: INativeFileTransCallback,
parameters: string,
level: number,
save_log: boolean = false): number
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
callback | INativeFileTransCallback | 文件转录事件和数据回调接口的实现。 |
parameters | string | JSON字符串,包含鉴权、连接和调试参数。参见连接与控制参数。 |
level | number | 控制SDK自身日志的打印级别,取值为枚举。 |
save_log | boolean | 是否保存本地日志。若为 |
返回错误码,参见错误码查询。
setParams
此接口用于独立设置或更新 nls_config 参数。如果所有参数都在startFileTranscriber中一次性提供,则无需调用此方法。
public setParams(params: string): number
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
params | string | 语音识别效果参数中的 |
返回错误码,参见错误码查询。
startFileTranscriber
开始识别。
方法签名public startFileTranscriber(params: string, task_id: ArrayBuffer): number
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
params | string | 语音识别效果参数。 |
task_id | ArrayBuffer | 任务ID缓冲区。SDK会将内部生成的随机任务ID字符串写入该缓冲区,要求缓冲区字节长度必须 >= 33字节(示例中使用 |
返回错误码,参见错误码查询。
queryFileTranscriber
此接口用于主动查询一个异步任务的当前状态和结果。调用成功后,结果将通过onFileTransEventCallback回调中的 EVENT_FILE_TRANS_QUERY_RESULT 事件返回。
public queryFileTranscriber(task_id: string): number
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
task_id | string | 待查询的任务ID(由 |
返回错误码,参见错误码查询。
cancelFileTranscriber
立即取消当前任务。
方法签名public cancelFileTranscriber(task_id: string): number
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
task_id | string | 待取消的任务ID。 |
返回错误码,参见错误码查询。
release
释放SDK所有内部资源。此方法调用后,SDK实例将变为不可用状态,如需再次使用,必须重新调用initializeFileTrans进行初始化。
方法签名public release(): number
返回值说明
返回错误码,参见错误码查询。
GetVersion
获得当前SDK版本信息。
方法签名public GetVersion(): string
返回值说明
当前SDK版本信息。
INativeFileTransCallback:监听回调
onFileTransEventCallback:监听事件和语音识别结果
方法签名onFileTransEventCallback: (event: Constants.NuiEvent, resultCode: number, finish: number,
asrResult: AsrResult, taskId: string) => void;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
event | Constants.NuiEvent | 回调事件。 |
resultCode | number | 错误码,在出现EVENT_ASR_ERROR事件时有效。 |
finish | number | 任务是否结束标记。 |
asrResult | AsrResult | 语音识别结果。 |
taskId | string | 任务ID。 |
onFileTransLogTrackCallback:监听追踪日志
此回调用于接收 SDK 内部的详细日志,方便进行问题定位和调试。
使用此回调需下载 20260908 或更新的 HarmonyOS SDK 包。
onFileTransLogTrackCallback?: (level: Constants.LogLevel, log: string) => void;
事件类型
HarmonyOS SDK 中事件类型通过 Constants.NuiEvent 枚举定义,以下列出录音文件转录相关的事件:
| 事件 | 说明 |
|---|---|
EVENT_FILE_TRANS_CONNECTED | 连接服务成功。 |
EVENT_FILE_TRANS_UPLOADED | 上传待识别音频文件成功。 |
EVENT_FILE_TRANS_QUERY_RESULT | 查询任务结果。 |
EVENT_FILE_TRANS_RESULT | 识别最终结果。 |
EVENT_ASR_ERROR | 语音识别过程中出现错误。 |