本文介绍Paraformer实时语音识别Java API的使用。
前提条件
已开通服务并获取API Key。请配置API Key到环境变量,而非硬编码在代码中,防范因代码泄露导致的安全风险。
模型列表
模型名 | 模型简介 |
模型名 | 模型简介 |
paraformer-realtime-v2 | 推荐使用。Paraformer最新多语种实时语音识别模型。
|
paraformer-realtime-8k-v2 | 推荐使用。Paraformer最新8k中文实时语音识别模型,模型结构升级,具有更快的推理速度和更好的识别效果。
|
paraformer-realtime-v1 | Paraformer中文实时语音识别模型。
|
paraformer-realtime-8k-v1 | Paraformer中文实时语音识别模型。
|
快速开始
Recognition类提供了同步调用和流式调用等接口。请根据实际需求选择合适的调用方式:
同步调用:针对本地文件进行识别,并一次性返回完整的处理结果。适合处理录制好的音频。
流式调用:可直接对音频流进行识别,并实时输出结果。音频流可以来自外部设备(如麦克风)或从本地文件读取。适合需要即时反馈的场景。
同步调用
提交单个语音实时转写任务,通过传入本地文件的方式同步阻塞地拿到转写结果。
实例化Recognition类,调用call
方法绑定请求参数和待识别文件,进行识别并最终获取识别结果。
流式调用:基于回调
提交单个语音实时转写任务,通过实现回调接口的方式流式输出实时识别结果。
启动流式语音识别
实例化Recognition类,调用
call
方法绑定请求参数和回调接口(ResultCallback)并启动流式语音识别。流式传输
循环调用Recognition类的
sendAudioFrame
方法,将从本地文件或设备(如麦克风)读取的二进制音频流分段发送至服务端。在发送音频数据的过程中,服务端会通过回调接口(ResultCallback)的
onEvent
方法,将识别结果实时返回给客户端。建议每次发送的音频时长约为100毫秒,数据大小保持在1KB至16KB之间。
结束处理
调用Recognition类的
stop
方法结束语音识别。该方法会阻塞当前线程,直到回调接口(ResultCallback)的
onComplete
或者onError
回调触发后才会释放线程阻塞。
流式调用:基于Flowable
提交单个语音实时转写任务,通过实现工作流(Flowable)的方式流式输出实时识别结果。
Flowable 是一个用于工作流和业务流程管理的开源框架,它基于 Apache 2.0 许可证发布。关于Flowable的使用,请参见Flowable API详情。
高并发调用
在DashScope Java SDK中,采用了OkHttp3的连接池技术,以减少重复建立连接的开销。详情请参见实时语音识别高并发场景。
请求参数
通过RecognitionParam
的链式方法配置模型、采样率、音频格式等参数。配置完成的参数对象传入Recognition类的call
/streamCall
方法中使用。
参数 | 类型 | 默认值 | 是否必须 | 说明 |
参数 | 类型 | 默认值 | 是否必须 | 说明 |
model | String | - | 是 | 用于实时语音识别的模型。详情请参见模型列表。 |
sampleRate | Integer | - | 是 | 设置待识别音频采样率(单位Hz)。 因模型而异:
|
format | String | - | 是 | 设置待识别音频格式。 支持的音频格式:pcm、wav、mp3、opus、speex、aac、amr。 |
vocabularyId | String | - | 否 | 设置热词ID,若未设置则不生效。v2及更高版本模型设置热词ID时使用该字段。 在本次语音识别中,将应用与该热词ID对应的热词信息。具体使用方法请参见定制热词。 |
phraseId | String | - | 否 | 设置热词ID,若未设置则不生效。v1系列模型设置热词ID时使用该字段。 在本次语音识别中,将应用与该热词ID对应的热词信息。具体使用方法请参见Paraformer语音识别热词定制与管理。 |
disfluencyRemovalEnabled | boolean | false | 否 | 设置是否过滤语气词:
|
language_hints | String[] | ["zh", "en"] | 否 | 设置待识别语言代码。如果无法提前确定语种,可不设置,模型会自动识别语种。 目前支持的语言代码:
该参数仅对支持多语言的模型生效(参见模型列表)。
通过parameter设置 通过parameters设置
|
semantic_punctuation_enabled | boolean | false | 否 | 设置是否开启语义断句,默认关闭。
语义断句准确性更高,适合会议转写场景;VAD(Voice Activity Detection,语音活动检测)断句延迟较低,适合交互场景。 通过调整 该参数仅在模型为v2及更高版本时生效。
通过parameter设置 通过parameters设置
|
max_sentence_silence | Integer | 800 | 否 | 设置VAD(Voice Activity Detection,语音活动检测)断句的静音时长阈值(单位为ms)。 当一段语音后的静音时长超过该阈值时,系统会判定该句子已结束。 参数范围为200ms至6000ms,默认值为800ms。 该参数仅在
通过parameter设置 通过parameters设置
|
punctuation_prediction_enabled | boolean | true | 否 | 设置是否在识别结果中自动添加标点:
该参数仅在模型为v2及更高版本时生效。
通过parameter设置 通过parameters设置
|
heartbeat | boolean | false | 否 | 当需要与服务端保持长连接时,可通过该开关进行控制:
该参数仅在模型为v2及更高版本时生效。 使用该字段时,SDK版本不能低于2.19.1。
通过parameter设置 通过parameters设置
|
inverse_text_normalization_enabled | boolean | true | 否 | 设置是否开启ITN(Inverse Text Normalization,逆文本正则化)。 默认开启(true)。开启后,中文数字将转换为阿拉伯数字。 该参数仅在模型为v2及更高版本时生效。
通过parameter设置 通过parameters设置
|
apiKey | String | - | 否 | 用户API Key。 |
关键接口
Recognition
类
Recognition
通过“import com.alibaba.dashscope.audio.asr.recognition.Recognition;
”方式引入。它的关键接口如下:
接口/方法 | 参数 | 返回值 | 描述 |
接口/方法 | 参数 | 返回值 | 描述 |
|
| 无 | 基于回调形式的流式实时识别,该方法不会阻塞当前线程。 |
|
| 识别结果 | 基于本地文件的同步调用,该方法会阻塞当前线程直到全部音频读完,该方法要求所识别文件具有可读权限。 |
|
|
| 基于Flowable的流式实时识别。 |
|
| 无 | 推送音频,每次推送的音频流不宜过大或过小,建议每包音频时长为100ms左右,大小在1KB~16KB之间。 识别结果通过回调接口(ResultCallback)的onEvent方法获取。 |
| 无 | 无 | 停止实时识别。 该方法会阻塞当前线程,直到回调实例 |
| 无 | requestId | 获取当前任务的requestId,在调用 该方法自2.18.0版本及以后的SDK中才开始提供。 |
| 无 | 首包延迟 | 获取首包延迟,从发送第一包音频到收到首包识别结果延迟,在任务完成后使用。 该方法自2.18.0版本及以后的SDK中才开始提供。 |
| 无 | 尾包延迟 | 获得尾包延迟,发送 该方法自2.18.0版本及以后的SDK中才开始提供。 |
回调接口(ResultCallback
)
流式调用时,服务端会通过回调的方式,将关键流程信息和数据返回给客户端。您需要实现回调方法,处理服务端返回的信息或者数据。
回调方法的实现,通过继承抽象类ResultCallback
完成,继承该抽象类时,您可以指定泛型为RecognitionResult
。RecognitionResult
封装了服务器返回的数据结构。
由于Java支持连接复用,因此没有onClose
和onOpen
。
接口/方法 | 参数 | 返回值 | 描述 |
接口/方法 | 参数 | 返回值 | 描述 |
|
| 无 | 当服务有回复时会被回调。 |
| 无 | 无 | 任务完成后该接口被回调。 |
|
| 无 | 发生异常时该接口被回调。 |
响应结果
实时识别结果(RecognitionResult
)
RecognitionResult
代表一次实时识别的结果。
接口/方法 | 参数 | 返回值 | 描述 |
接口/方法 | 参数 | 返回值 | 描述 |
| 无 | requestId | 获取requestId。 |
| 无 | 是否是完整句子,即产生断句 | 判断给定句子是否已经结束。 |
| 无 | 获取单句信息,包括时间戳和文本信息等。 |
单句信息(Sentence
)
接口/方法 | 参数 | 返回值 | 描述 |
接口/方法 | 参数 | 返回值 | 描述 |
| 无 | 句子开始时间,单位为ms | 返回句子开始时间。 |
| 无 | 句子结束时间,单位为ms | 返回句子结束时间。 |
| 无 | 识别文本 | 返回识别文本。 |
| 无 | 字时间戳信息(Word)的List集合 | 返回字时间戳信息。 |
| 无 | 当前句子的情感 | 返回当前句子的情感:
仅在关闭语义断句( 仅paraformer-realtime-8k-v2模型支持情感识别。 |
| 无 | 当前句子识别情感的置信度 | 返回当前句子识别情感的置信度,取值范围:[0.0,1.0]。值越大表示置信度越高。 仅paraformer-realtime-8k-v2模型支持情感识别。 |
字时间戳信息(Word
)
接口/方法 | 参数 | 返回值 | 描述 |
接口/方法 | 参数 | 返回值 | 描述 |
| 无 | 字开始时间,单位为ms | 返回字开始时间。 |
| 无 | 字结束时间,单位为ms | 返回字结束时间。 |
| 无 | 字 | 返回识别的字。 |
| 无 | 标点 | 返回标点。 |
错误码
在使用API过程中,如果调用失败并返回错误信息,请参见错误信息进行解决。
更多示例
更多示例,请参见GitHub。
常见问题
在长时间静默的情况下,如何保持与服务端长连接?
将请求参数heartbeat
设置为true,并持续向服务端发送静音音频。
更多常见问题,请参见GitHub QA。
- 本页导读 (1)
- 前提条件
- 模型列表
- 快速开始
- 同步调用
- 流式调用:基于回调
- 流式调用:基于Flowable
- 高并发调用
- 请求参数
- 关键接口
- Recognition类
- 回调接口(ResultCallback)
- 响应结果
- 实时识别结果(RecognitionResult)
- 单句信息(Sentence)
- 字时间戳信息(Word)
- 错误码
- 更多示例
- 常见问题
- 在长时间静默的情况下,如何保持与服务端长连接?