跳转到主要内容
Paraformer

Paraformer实时语音识别Java SDK

本文介绍Paraformer实时语音识别Java SDK的参数和接口细节。

**用户指南:**关于模型介绍和选型建议请参见实时语音识别-Fun-ASR/Paraformer。 在线体验:仅paraformer-realtime-v2、paraformer-realtime-8k-v2和paraformer-realtime-v1支持在线体验。

前提条件

  • 已开通服务并获取与配置 API Key。请配置API Key到环境变量,而非硬编码在代码中,防范因代码泄露导致的安全风险。
    当您需要为第三方应用或用户提供临时访问权限,或者希望严格控制敏感数据访问、删除等高风险操作时,建议使用临时鉴权Token。与长期有效的 API Key 相比,临时鉴权 Token 具备时效性短(60秒)、安全性高的特点,适用于临时调用场景,能有效降低API Key泄露的风险。使用方式:在代码中,将原本用于鉴权的 API Key 替换为获取到的临时鉴权 Token 即可。
  • 安装最新版DashScope SDK。

模型列表

paraformer-realtime-v2(推荐)paraformer-realtime-8k-v2(推荐)paraformer-realtime-v1paraformer-realtime-8k-v1
适用场景直播、会议等场景电话客服、语音信箱等 8kHz 音频的识别场景直播、会议等场景电话客服、语音信箱等 8kHz 音频的识别场景
采样率任意8kHz16kHz8kHz
语种中文(包含中文普通话和各种方言)、英文、日语、韩语、德语、法语、俄语 支持的中文方言:上海话、吴语、闽南语、东北话、甘肃话、贵州话、河南话、湖北话、湖南话、江西话、宁夏话、山西话、陕西话、山东话、四川话、天津话、云南话、粤语中文中文中文
标点符号预测支持 默认支持,无需配置支持 默认支持,无需配置支持 默认支持,无需配置支持 默认支持,无需配置
逆文本正则化(ITN)支持 默认支持,无需配置支持 默认支持,无需配置支持 默认支持,无需配置支持 默认支持,无需配置
定制热词支持 参见定制热词支持 参见定制热词支持 参见Paraformer语音识别热词定制与管理支持 参见Paraformer语音识别热词定制与管理
指定待识别语种支持 通过language_hints参数指定不支持不支持不支持
情感识别不支持情感识别遵循如下约束:
  • 仅限paraformer-realtime-8k-v2模型。
  • 必须关闭语义断句(可通过请求参数semantic_punctuation_enabled控制)。语义断句默认为关闭状态。
  • 只有在实时识别结果(RecognitionResult)的isSentenceEnd方法返回结果为true时才显示情感识别结果。
情感识别结果获取方式:调用单句信息(Sentence)的getEmoTag和getEmoConfidence方法分别获取当前句子的情感和情感置信度。
不支持不支持

快速开始

Recognition类提供了非流式调用和双向流式调用接口。请根据实际需求选择合适的调用方式:
  • 非流式调用:针对本地文件进行识别,并一次性返回完整的处理结果。适合处理录制好的音频。
  • 双向流式调用:可直接对音频流进行识别,并实时输出结果。音频流可以来自外部设备(如麦克风)或从本地文件读取。适合需要即时反馈的场景。

非流式调用

提交单个语音实时转写任务,通过传入本地文件的方式同步阻塞地拿到转写结果。
image
实例化Recognition类,调用call方法绑定请求参数和待识别文件,进行识别并最终获取识别结果。
import com.alibaba.dashscope.audio.asr.recognition.Recognition;
import com.alibaba.dashscope.audio.asr.recognition.RecognitionParam;
import com.alibaba.dashscope.utils.Constants;

import java.io.File;

public class Main {
    public static void main(String[] args) {
        Constants.baseWebsocketApiUrl = "wss://maas.qianwenaiapi.com/api-ws/v1/inference";
        // 创建Recognition实例
        Recognition recognizer = new Recognition();
        // 创建RecognitionParam
        RecognitionParam param =
                RecognitionParam.builder()
                        // 若没有将API Key配置到环境变量中,需将下面这行代码注释放开,并将apiKey替换为自己的API Key
                        // .apiKey("yourApikey")
                        .model("paraformer-realtime-v2")
                        .format("wav")
                        .sampleRate(16000)
                        // “language_hints”只支持paraformer-realtime-v2模型
                        .parameter("language_hints", new String[]{"zh", "en"})
                        .build();

        try {
            System.out.println("识别结果:" + recognizer.call(param, new File("{YOUR_AUDIO_FILE}")));
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 任务结束后关闭 WebSocket 连接
            recognizer.getDuplexApi().close(1000, "bye");
        }
        System.out.println(
                "[Metric] requestId: "
                        + recognizer.getLastRequestId()
                        + ", first package delay ms: "
                        + recognizer.getFirstPackageDelay()
                        + ", last package delay ms: "
                        + recognizer.getLastPackageDelay());
        System.exit(0);
    }
}

双向流式调用:基于回调

提交单个语音实时转写任务,通过实现回调接口的方式流式输出实时识别结果。
image
  1. 启动流式语音识别 实例化Recognition类,调用call方法绑定请求参数和回调接口(ResultCallback)并启动流式语音识别。
  2. 流式传输 循环调用Recognition类的sendAudioFrame方法,将从本地文件或设备(如麦克风)读取的二进制音频流分段发送至服务端。 在发送音频数据的过程中,服务端会通过回调接口(ResultCallback)的onEvent方法,将识别结果实时返回给客户端。 建议每次发送的音频时长约为100毫秒,数据大小保持在1KB至16KB之间。
  3. 结束处理 调用Recognition类的stop方法结束语音识别。 该方法会阻塞当前线程,直到回调接口(ResultCallback)的onComplete或者onError回调触发后才会释放线程阻塞。
import com.alibaba.dashscope.audio.asr.recognition.Recognition;
import com.alibaba.dashscope.audio.asr.recognition.RecognitionParam;
import com.alibaba.dashscope.audio.asr.recognition.RecognitionResult;
import com.alibaba.dashscope.common.ResultCallback;
import com.alibaba.dashscope.utils.Constants;

import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.TargetDataLine;

import java.nio.ByteBuffer;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

public class Main {
    public static void main(String[] args) throws InterruptedException {
        Constants.baseWebsocketApiUrl = "wss://maas.qianwenaiapi.com/api-ws/v1/inference";
        ExecutorService executorService = Executors.newSingleThreadExecutor();
        executorService.submit(new RealtimeRecognitionTask());
        executorService.shutdown();
        executorService.awaitTermination(1, TimeUnit.MINUTES);
        System.exit(0);
    }
}

class RealtimeRecognitionTask implements Runnable {
    @Override
    public void run() {
        RecognitionParam param = RecognitionParam.builder()
                // 若没有将API Key配置到环境变量中,需将apiKey替换为自己的API Key
                // .apiKey("yourApikey")
                .model("paraformer-realtime-v2")
                .format("wav")
                .sampleRate(16000)
                // “language_hints”只支持paraformer-realtime-v2模型
                .parameter("language_hints", new String[]{"zh", "en"})
                .build();
        Recognition recognizer = new Recognition();

        ResultCallback<RecognitionResult> callback = new ResultCallback<RecognitionResult>() {
            @Override
            public void onEvent(RecognitionResult result) {
                if (result.isSentenceEnd()) {
                    System.out.println("Final Result: " + result.getSentence().getText());
                } else {
                    System.out.println("Intermediate Result: " + result.getSentence().getText());
                }
            }

            @Override
            public void onComplete() {
                System.out.println("Recognition complete");
            }

            @Override
            public void onError(Exception e) {
                System.out.println("RecognitionCallback error: " + e.getMessage());
            }
        };
        try {
            recognizer.call(param, callback);
            // 创建音频格式
            AudioFormat audioFormat = new AudioFormat(16000, 16, 1, true, false);
            // 根据格式匹配默认录音设备
            TargetDataLine targetDataLine =
                    AudioSystem.getTargetDataLine(audioFormat);
            targetDataLine.open(audioFormat);
            // 开始录音
            targetDataLine.start();
            ByteBuffer buffer = ByteBuffer.allocate(1024);
            long start = System.currentTimeMillis();
            // 录音50s并进行实时转写
            while (System.currentTimeMillis() - start < 50000) {
                int read = targetDataLine.read(buffer.array(), 0, buffer.capacity());
                if (read > 0) {
                    buffer.limit(read);
                    // 将录音音频数据发送给流式识别服务
                    recognizer.sendAudioFrame(buffer);
                    buffer = ByteBuffer.allocate(1024);
                    // 录音速率有限,防止cpu占用过高,休眠一小会儿
                    Thread.sleep(20);
                }
            }
            recognizer.stop();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 任务结束后关闭 Websocket 连接
            recognizer.getDuplexApi().close(1000, "bye");
        }

        System.out.println(
                "[Metric] requestId: "
                        + recognizer.getLastRequestId()
                        + ", first package delay ms: "
                        + recognizer.getFirstPackageDelay()
                        + ", last package delay ms: "
                        + recognizer.getLastPackageDelay());
    }
}

双向流式调用:基于Flowable

提交单个语音实时转写任务,通过实现工作流(Flowable)的方式流式输出实时识别结果。 Flowable 是一个用于工作流和业务流程管理的开源框架,它基于 Apache 2.0 许可证发布。关于Flowable的使用,请参见Flowable API详情。
直接调用Recognition类的streamCall方法开始识别。streamCall方法返回一个Flowable<RecognitionResult>实例,您可以调用Flowable实例的blockingForEach、subscribe等方法处理识别结果。识别结果封装在RecognitionResult中。streamCall方法需要传入两个参数:
  • RecognitionParam实例(请求参数):通过它可以设置语音识别所需的模型、采样率、音频格式等参数。
  • Flowable<ByteBuffer>实例:您需要创建一个Flowable<ByteBuffer>类型的实例,并在其中实现解析音频流的方法。
import com.alibaba.dashscope.audio.asr.recognition.Recognition;
import com.alibaba.dashscope.audio.asr.recognition.RecognitionParam;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;
import io.reactivex.BackpressureStrategy;
import io.reactivex.Flowable;

import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.TargetDataLine;
import java.nio.ByteBuffer;

public class Main {
    public static void main(String[] args) throws NoApiKeyException {
        Constants.baseWebsocketApiUrl = "wss://maas.qianwenaiapi.com/api-ws/v1/inference";
        // 创建一个Flowable<ByteBuffer>
        Flowable<ByteBuffer> audioSource =
                Flowable.create(
                        emitter -> {
                            new Thread(
                                    () -> {
                                        try {
                                            // 创建音频格式
                                            AudioFormat audioFormat = new AudioFormat(16000, 16, 1, true, false);
                                            // 根据格式匹配默认录音设备
                                            TargetDataLine targetDataLine =
                                                    AudioSystem.getTargetDataLine(audioFormat);
                                            targetDataLine.open(audioFormat);
                                            // 开始录音
                                            targetDataLine.start();
                                            ByteBuffer buffer = ByteBuffer.allocate(1024);
                                            long start = System.currentTimeMillis();
                                            // 录音50s并进行实时转写
                                            while (System.currentTimeMillis() - start < 50000) {
                                                int read = targetDataLine.read(buffer.array(), 0, buffer.capacity());
                                                if (read > 0) {
                                                    buffer.limit(read);
                                                    // 将录音音频数据发送给流式识别服务
                                                    emitter.onNext(buffer);
                                                    buffer = ByteBuffer.allocate(1024);
                                                    // 录音速率有限,防止cpu占用过高,休眠一小会儿
                                                    Thread.sleep(20);
                                                }
                                            }
                                            // 通知结束转写
                                            emitter.onComplete();
                                        } catch (Exception e) {
                                            emitter.onError(e);
                                        }
                                    })
                                    .start();
                        },
                        BackpressureStrategy.BUFFER);

        // 创建Recognizer
        Recognition recognizer = new Recognition();
        // 创建RecognitionParam,audioFrames参数中传入上面创建的Flowable<ByteBuffer>
        RecognitionParam param = RecognitionParam.builder()
                // 若没有将API Key配置到环境变量中,需将apiKey替换为自己的API Key
                // .apiKey("yourApikey")
                .model("paraformer-realtime-v2")
                .format("pcm")
                .sampleRate(16000)
                // “language_hints”只支持paraformer-realtime-v2模型
                .parameter("language_hints", new String[]{"zh", "en"})
                .build();

        // 流式调用接口
        recognizer
                .streamCall(param, audioSource)
                .blockingForEach(
                        result -> {
                            // Subscribe to the output result
                            if (result.isSentenceEnd()) {
                                System.out.println("Final Result: " + result.getSentence().getText());
                            } else {
                                System.out.println("Intermediate Result: " + result.getSentence().getText());
                            }
                        });
        // 任务结束后关闭 Websocket 连接
        recognizer.getDuplexApi().close(1000, "bye");
        System.out.println(
                "[Metric] requestId: "
                        + recognizer.getLastRequestId()
                        + ", first package delay ms: "
                        + recognizer.getFirstPackageDelay()
                        + ", last package delay ms: "
                        + recognizer.getLastPackageDelay());
        System.exit(0);
    }
}

高并发调用

在DashScope Java SDK中,采用了OkHttp3的连接池技术,以减少重复建立连接的开销。详情请参见实时语音识别高并发场景。

请求参数

通过RecognitionParam的链式方法配置模型、采样率、音频格式等参数。配置完成的参数对象传入Recognition类的call/streamCall方法中使用。
RecognitionParam param = RecognitionParam.builder()
  .model("paraformer-realtime-v2")
  .format("pcm")
  .sampleRate(16000)
  // “language_hints”只支持paraformer-realtime-v2模型
  .parameter("language_hints", new String[]{"zh", "en"})
  .build();
参数类型默认值是否必须说明
modelString-是用于实时语音识别的模型。详情请参见模型列表。
sampleRateInteger-是设置待识别音频采样率(单位Hz)。 因模型而异:
  • paraformer-realtime-v2支持任意采样率。
  • paraformer-realtime-v1仅支持16000Hz采样。
  • paraformer-realtime-8k-v2仅支持8000Hz采样率。
  • paraformer-realtime-8k-v1仅支持8000Hz采样率。
formatString-是设置待识别音频格式。 支持的音频格式:pcm、wav、mp3、opus、speex、aac、amr。 提示: opus/speex:必须使用Ogg封装; wav:必须为PCM编码; amr:仅支持AMR-NB类型。
vocabularyIdString-否设置热词ID,若未设置则不生效。v2及更高版本模型设置热词ID时使用该字段。 在本次语音识别中,将应用与该热词ID对应的热词信息。具体使用方法请参见定制热词。
phraseIdString-否设置热词ID,若未设置则不生效。v1系列模型设置热词ID时使用该字段。 在本次语音识别中,将应用与该热词ID对应的热词信息。具体使用方法请参见Paraformer语音识别热词定制与管理。
disfluencyRemovalEnabledbooleanfalse否设置是否过滤语气词:
  • true:过滤语气词
  • false(默认):不过滤语气词
language_hintsString[]["zh", "en"]否设置待识别语言代码。如果无法提前确定语种,可不设置,模型会自动识别语种。 目前支持的语言代码:
  • zh: 中文
  • en: 英文
  • ja: 日语
  • yue: 粤语
  • ko: 韩语
  • de:德语
  • fr:法语
  • ru:俄语
该参数仅对支持多语言的模型生效(参见模型列表)。 说明: language_hints需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 1 请参见表格下方 示例 2 请参见表格下方
semantic_punctuation_enabledbooleanfalse否设置是否开启语义断句,默认关闭。
  • true:开启语义断句,关闭VAD(Voice Activity Detection,语音活动检测)断句。
  • false(默认):开启VAD(Voice Activity Detection,语音活动检测)断句,关闭语义断句。
语义断句准确性更高,适合会议转写场景;VAD(Voice Activity Detection,语音活动检测)断句延迟较低,适合交互场景。 通过调整semantic_punctuation_enabled参数,可以灵活切换语音识别的断句方式以适应不同场景需求。 该参数仅在模型为v2及更高版本时生效。 说明: semantic_punctuation_enabled需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 3 请参见表格下方 示例 4 请参见表格下方
max_sentence_silenceInteger800否设置VAD(Voice Activity Detection,语音活动检测)断句的静音时长阈值(单位为ms)。 当一段语音后的静音时长超过该阈值时,系统会判定该句子已结束。 参数范围为200ms至6000ms,默认值为800ms。 该参数仅在semantic_punctuation_enabled参数为false(VAD断句)且模型为v2及更高版本时生效。 说明: max_sentence_silence需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 5 请参见表格下方 示例 6 请参见表格下方
multi_threshold_mode_enabledbooleanfalse否该开关打开时(true)可以防止VAD断句切割过长。默认关闭。 该参数仅在semantic_punctuation_enabled参数为false(VAD断句)且模型为v2及更高版本时生效。 说明: multi_threshold_mode_enabled需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 7 请参见表格下方 示例 8 请参见表格下方
punctuation_prediction_enabledbooleantrue否设置是否在识别结果中自动添加标点:
  • true(默认):是
  • false:否
该参数仅在模型为v2及更高版本时生效。 说明: punctuation_prediction_enabled需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 9 请参见表格下方 示例 10 请参见表格下方
heartbeatbooleanfalse否当需要与服务端保持长连接时,可通过该开关进行控制:
  • true:在持续发送静音音频的情况下,可保持与服务端的连接不中断。
  • false(默认):即使持续发送静音音频,连接也将在一定时间后因超时而断开。
静音音频指的是在音频文件或数据流中没有声音信号的内容。静音音频可以通过多种方法生成,例如使用音频编辑软件如Audacity或Adobe Audition,或者通过命令行工具如FFmpeg。 该参数仅在模型为v2及更高版本时生效。 说明: 使用该字段时,SDK版本不能低于2.19.1。 heartbeat需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 11 请参见表格下方 示例 12 请参见表格下方
inverse_text_normalization_enabledbooleantrue否设置是否开启ITN(Inverse Text Normalization,逆文本正则化)。 默认开启(true)。开启后,中文数字将转换为阿拉伯数字。 该参数仅在模型为v2及更高版本时生效。 说明: inverse_text_normalization_enabled需要通过RecognitionParam实例的parameter方法或者parameters方法进行设置: 示例 13 请参见表格下方 示例 14 请参见表格下方
apiKeyString-否用户API Key。
示例 1(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("language_hints", new String[]{"zh", "en"})
 .build();
示例 2(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("language_hints", new String[]{"zh", "en"}))
 .build();
示例 3(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("semantic_punctuation_enabled", true)
 .build();
示例 4(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("semantic_punctuation_enabled", true))
 .build();
示例 5(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("max_sentence_silence", 800)
 .build();
示例 6(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("max_sentence_silence", 800))
 .build();
示例 7(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("multi_threshold_mode_enabled", true)
 .build();
示例 8(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("multi_threshold_mode_enabled", true))
 .build();
示例 9(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("punctuation_prediction_enabled", false)
 .build();
示例 10(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("punctuation_prediction_enabled", false))
 .build();
示例 11(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("heartbeat", true)
 .build();
示例 12(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("heartbeat", true))
 .build();
示例 13(说明):
通过parameter设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameter("inverse_text_normalization_enabled", false)
 .build();
示例 14(说明):
通过parameters设置
RecognitionParam param = RecognitionParam.builder()
 .model("paraformer-realtime-v2")
 .format("pcm")
 .sampleRate(16000)
 .parameters(Collections.singletonMap("inverse_text_normalization_enabled", false))
 .build();

关键接口

Recognition类

Recognition通过“import com.alibaba.dashscope.audio.asr.recognition.Recognition;”方式引入。它的关键接口如下:
接口/方法参数返回值描述
示例 1 请参见表格下方无基于回调形式的流式实时识别,该方法不会阻塞当前线程。
示例 2 请参见表格下方识别结果基于本地文件的非流式调用,该方法会阻塞当前线程直到全部音频读完,该方法要求所识别文件具有可读权限。
示例 3 请参见表格下方
  • param:请求参数
  • audioFrame:Flowable&lt;ByteBuffer&gt;实例
Flowable&lt;RecognitionResult&gt;基于Flowable的流式实时识别。
示例 4 请参见表格下方
  • audioFrame:二进制音频流,为ByteBuffer类型
无推送音频,每次推送的音频流不宜过大或过小,建议每包音频时长为100ms左右,大小在1KB~16KB之间。 识别结果通过回调接口(ResultCallback)的onEvent方法获取。
示例 5 请参见表格下方无无停止实时识别。 该方法会阻塞当前线程,直到回调实例ResultCallback的onComplete或者onError被调用之后才会解除对当前线程的阻塞。
示例 6 请参见表格下方code: WebSocket关闭码(Close Code) reason:关闭原因 这两个参数可参考The WebSocket Protocol文档进行配置true在任务结束后,无论是否出现异常都需要关闭WebSocket连接,避免造成连接泄漏。关于如何复用连接提升效率请参考实时语音识别高并发场景。
示例 7 请参见表格下方无requestId获取当前任务的requestId,在调用call、streamingCall开始新任务之后可以使用。 说明: 该方法自2.18.0版本及以后的SDK中才开始提供。
示例 8 请参见表格下方无首包延迟获取首包延迟,从发送第一包音频到收到首包识别结果延迟,在任务完成后使用。 说明: 该方法自2.18.0版本及以后的SDK中才开始提供。
示例 9 请参见表格下方无尾包延迟获得尾包延迟,发送stop指令到最后一包识别结果下发耗时,在任务完成后使用。 说明: 该方法自2.18.0版本及以后的SDK中才开始提供。
示例 1(接口/方法):
public void call(RecognitionParam param, final ResultCallback<RecognitionResult> callback)
示例 2(接口/方法):
public String call(RecognitionParam param, File file)
示例 3(接口/方法):
public Flowable<RecognitionResult> streamCall(RecognitionParam param, Flowable<ByteBuffer> audioFrame)
示例 4(接口/方法):
public void sendAudioFrame(ByteBuffer audioFrame)
示例 5(接口/方法):
public void stop()
示例 6(接口/方法):
recognizer.getDuplexApi().close(int code, String reason)
示例 7(接口/方法):
public String getLastRequestId()
示例 8(接口/方法):
public long getFirstPackageDelay()
示例 9(接口/方法):
public long getLastPackageDelay()

回调接口(ResultCallback)

双向流式调用时,服务端会通过回调的方式,将关键流程信息和数据返回给客户端。您需要实现回调方法,处理服务端返回的信息或者数据。 回调方法的实现,通过继承抽象类ResultCallback完成,继承该抽象类时,您可以指定泛型为RecognitionResult。RecognitionResult封装了服务器返回的数据结构。 由于Java支持连接复用,因此没有onClose和onOpen。

示例

ResultCallback<RecognitionResult> callback = new ResultCallback<RecognitionResult>() {
    @Override
    public void onEvent(RecognitionResult result) {
        System.out.println("RequestId为:" + result.getRequestId());
        // 在此实现处理语音识别结果的逻辑
    }

    @Override
    public void onComplete() {
        System.out.println("任务完成");
    }

    @Override
    public void onError(Exception e) {
        System.out.println("任务失败:" + e.getMessage());
    }
};
接口/方法参数返回值描述
示例 1 请参见表格下方result:实时识别结果(RecognitionResult)无当服务有回复时会被回调。
示例 2 请参见表格下方无无任务完成后该接口被回调。
示例 3 请参见表格下方e:异常信息无发生异常时该接口被回调。
示例 1(接口/方法):
public void onEvent(RecognitionResult result)
示例 2(接口/方法):
public void onComplete()
示例 3(接口/方法):
public void onError(Exception e)

响应结果

实时识别结果(RecognitionResult)

RecognitionResult代表一次实时识别的结果。
接口/方法参数返回值描述
示例 1 请参见表格下方无requestId获取requestId。
示例 2 请参见表格下方无是否是完整句子,即产生断句判断给定句子是否已经结束。
示例 3 请参见表格下方无单句信息(Sentence)获取单句信息,包括时间戳和文本信息等。
示例 1(接口/方法):
public String getRequestId()
示例 2(接口/方法):
public boolean isSentenceEnd()
示例 3(接口/方法):
public Sentence getSentence()

单句信息(Sentence)

接口/方法参数返回值描述
示例 1 请参见表格下方无句子开始时间,单位为ms返回句子开始时间。
示例 2 请参见表格下方无句子结束时间,单位为ms返回句子结束时间。
示例 3 请参见表格下方无识别文本返回识别文本。
示例 4 请参见表格下方无字时间戳信息(Word)的List集合返回字时间戳信息。
示例 5 请参见表格下方无当前句子的情感返回当前句子的情感:
  • positive:正面情感,如开心、满意
  • negative:负面情感,如愤怒、沉闷
  • neutral:无明显情感
情感识别遵循如下约束:
  • 仅限paraformer-realtime-8k-v2模型。
  • 必须关闭语义断句(可通过请求参数semantic_punctuation_enabled控制)。语义断句默认为关闭状态。
  • 只有在实时识别结果(RecognitionResult)的isSentenceEnd方法返回结果为true时才显示情感识别结果。
示例 6 请参见表格下方无当前句子识别情感的置信度返回当前句子识别情感的置信度,取值范围:[0.0,1.0],值越大表示置信度越高。 情感识别遵循如下约束:
  • 仅限paraformer-realtime-8k-v2模型。
  • 必须关闭语义断句(可通过请求参数semantic_punctuation_enabled控制)。语义断句默认为关闭状态。
  • 只有在实时识别结果(RecognitionResult)的isSentenceEnd方法返回结果为true时才显示情感识别结果。
示例 1(接口/方法):
public Long getBeginTime()
示例 2(接口/方法):
public Long getEndTime()
示例 3(接口/方法):
public String getText()
示例 4(接口/方法):
public List<Word> getWords()
示例 5(接口/方法):
public String getEmoTag()
示例 6(接口/方法):
public Double getEmoConfidence()

字时间戳信息(Word)

接口/方法参数返回值描述
示例 1 请参见表格下方无字开始时间,单位为ms返回字开始时间。
示例 2 请参见表格下方无字结束时间,单位为ms返回字结束时间。
示例 3 请参见表格下方无字返回识别的字。
示例 4 请参见表格下方无标点返回标点。
示例 1(接口/方法):
public long getBeginTime()
示例 2(接口/方法):
public long getEndTime()
示例 3(接口/方法):
public String getText()
示例 4(接口/方法):
public String getPunctuation()

错误码

如遇报错问题,请参见错误码进行排查。 若问题仍未解决,请加入开发者群反馈遇到的问题,并提供Request ID,以便进一步排查问题。

更多示例

更多示例,请参见GitHub。

常见问题

功能特性

Q:在长时间静默的情况下,如何保持与服务端长连接?

将请求参数heartbeat设置为true,并持续向服务端发送静音音频。 静音音频指的是在音频文件或数据流中没有声音信号的内容。静音音频可以通过多种方法生成,例如使用音频编辑软件如Audacity或Adobe Audition,或者通过命令行工具如FFmpeg。

Q:如何将音频格式转换为满足要求的格式?

可使用FFmpeg工具,更多用法请参见FFmpeg官网。
# 基础转换命令(万能模板)
# -i,作用:输入文件路径,常用值示例:audio.wav
# -c:a,作用:音频编码器,常用值示例:aac, libmp3lame, pcm_s16le
# -b:a,作用:比特率(音质控制),常用值示例:192k, 320k
# -ar,作用:采样率,常用值示例:44100 (CD), 48000, 16000
# -ac,作用:声道数,常用值示例:1(单声道), 2(立体声)
# -y,作用:覆盖已存在文件(无需值)
ffmpeg -i input_audio.ext -c:a 编码器名 -b:a 比特率 -ar 采样率 -ac 声道数 output.ext

# 例如:WAV → MP3(保持原始质量)
ffmpeg -i input.wav -c:a libmp3lame -q:a 0 output.mp3
# 例如:MP3 → WAV(16bit PCM标准格式)
ffmpeg -i input.mp3 -c:a pcm_s16le -ar 44100 -ac 2 output.wav
# 例如:M4A → AAC(提取/转换苹果音频)
ffmpeg -i input.m4a -c:a copy output.aac  # 直接提取不重编码
ffmpeg -i input.m4a -c:a aac -b:a 256k output.aac  # 重编码提高质量
# 例如:FLAC无损 → Opus(高压缩)
ffmpeg -i input.flac -c:a libopus -b:a 128k -vbr on output.opus

Q:是否支持查看每句话对应的时间范围?

支持。语音识别结果中会包含每句话的开始时间戳和结束时间戳,可通过它们确定每句话的时间范围。

Q:如何识别本地文件(录音文件)?

识别本地文件有两种方式:
  • 直接传入本地文件路径:此种方式在最终识别结束后获取完整识别结果,不适合即时反馈的场景。 参见非流式调用,在Recognition类的call方法中传入文件路径对录音文件直接进行识别。
  • 将本地文件转成二进制流进行识别:此种方式一边识别文件一边流式获取识别结果,适合即时反馈的场景。

故障排查

Q:无法识别语音(无识别结果)是什么原因?

  1. 请检查请求参数中的音频格式(format)和采样率(sampleRate/sample_rate)设置是否正确且符合参数约束。以下为常见错误示例:
    • 音频文件扩展名为 .wav,但实际为 MP3 格式,而请求参数 format 设置为 mp3(参数设置错误)。
    • 音频采样率为 3600Hz,但请求参数 sampleRate/sample_rate 设置为 48000(参数设置错误)。
    可以使用ffprobe工具获取音频的容器、编码、采样率、声道等信息:
ffprobe -v error -show_entries format=format_name -show_entries stream=codec_name,sample_rate,channels -of default=noprint_wrappers=1 input.xxx
  1. 使用paraformer-realtime-v2模型时,请检查language_hints设置的语言是否与音频实际语言一致。 例如:音频实际为中文,但language_hints设置为en(英文)。
  2. 若以上检查均无问题,可通过定制热词提升对特定词语的识别效果。