# 语音转写 Java SDK 文档

# 1、简介

语音转写（Long Form Automatic Speech Recognition）：基于科大讯飞独立研究的深度全序列卷积神经网络语音识别框架（Deep Fully Convolutional Neural Network, DFCNN），针对语音的长时相关性进行语言建模，将音频数据转换成文本数据，为后续的信息处理和数据挖掘提供基础。 具体表现形式为，将多种格式的长段音频文件（5小时以内）转换成包含时间戳、词句置信度、词属性以及句子标志的文字信息。文字信息提供分词形式以及整段文字形式以及发音人分离功能。

转写的是已录制音频（非实时），音频文件上传成功后进入等待队列，待转写成功后用户即可获取结果，返回结果时间受音频时长以及排队任务量的影响。如遇转写耗时比平时延长，大概率表示当前时间段出现转写高峰，即有任务积压排队，属正常现象，请耐心等待。
为使转写服务更加通畅，请尽量转写5分钟以上的音频文件，上传大量的短音频易引起网络和服务器资源紧张，从而导致任务排队积压。
另外，语音转写是SLA协议对象服务之一，我们对付费用户承诺有效任务耗时最大不超过12小时，赔偿标准等详情请参考SLA协议。

SDK下载请点击 语音转写Java SDK下载，开发文档详见下方。

# 2、SDK集成指南

# 2.1 Demo运行步骤

# 2.1.1 创建账号&应用

进入讯飞开放平台主页https://www.ai-nanchang.cn/或者对应的产品页，点击右上角登录或者注册按钮，完成登录操作。

进入控制台“我的应用”列表页，点击左上角“创建新应用”，并填写相关应用信息，个人实名认证用户可创建5个应用，企业实名认证用户可创建20个应用，若创建更多应用用户可选择企业实名认证。

# 2.1.2 开通&购买服务

创建完应用之后，在当前应用下，选择“语音转写”，然后在控制台下方点击领取试用时长或者购买正式时长。

# 2.1.3 获取appid和secret_key以及SDK下载

购买完成后，在“控制台”的对应的应用上，进入语音转写一栏，选择Java SDK下载。若为WebAPI，可以直接点开技术文档查看接口文档，另外在服务的产品页“语音转写”服务管理中，可以查看密钥，请牢记应用唯一标识appid和转写服务访问密钥secret_key！

# 2.1.4 demo运行方式

下载的demo为标准maven工程。工程内已包含Java SDK的对应jar包，并且pom文件中已经配置好相应的依赖关系。找到代码中LfasrSDKDemo类，替换代码中的appid、secret_key。然后运行其main方法即可。

# 2.2 项目集成步骤

# 2.2.1 sdk包说明

获取到的Java SDK包结构如下：

src

	-- main

		-- java

			-- com.iflytek.lfasr.demo

				-- LfasrSDKDemo

		-- resources

			-- audio

				-- lfasr.wav

			-- lib

				-- lfasr-sdk-3.0.0.jar

pom.xml

LfasrSDKDemo：为demo程序，包含各种用法示例；

lfasr.wav：为示例音频；

lfasr-sdk-3.0.0.jar：为语音转写Java SDK的jar包。

# 2.2.2 sdk导入

熟悉demo中使用方法后，可以将Java SDK集成到自己的应用工程中。

1、将上面 lfasr-sdk-3.0.0.jar 包放入目标工程；

2、参照demo示例调用方式编写代码即可。

# 2.3 参数与说明

# 2.3.1 Java开发接口说明

SDK入口程序类：LfasrClient，通过 LfasrClient.getInstance(......); 创建客户端实例。

# 1、SDK接口列表

# 2、可配置参数

# 3、类型说明

Message 响应消息类

# 2.3.2 调用样例

//1、创建客户端实例
LfasrClient lfasrClient = LfasrClient.getInstance(APP_ID, SECRET_KEY);

//2、上传音频文件
Message task = lfasrClient.upload(AUDIO_FILE_PATH);
String taskId = task.getData();
System.out.println("转写任务 taskId：" + taskId);

//3、查看转写进度
int status = 0;
while (status != 9) {
    Message message = lfasrClient.getProgress(taskId);
    JSONObject object = JSON.parseObject(message.getData());
    status = object.getInteger("status");
    System.out.println(message.getData());
    TimeUnit.SECONDS.sleep(2);
}
//4、获取结果
Message result = lfasrClient.getResult(taskId);
System.out.println("转写结果: \n" + result.getData());

# 2.3.3 结果解析

# 2.3.4 错误码

# 2.3.5 状态码

# 2.4 实践指南

（1）输入音频的格式&比特率

如若条件允许，请尽量使用pcm，alaw或者ulaw编码的原始wav音频或者无损音频压缩编码（FLAC）来录制以及传输音频。

如果有压缩需求，在原始音频比特率较高（大于16kHz16bit）的情况下，可以采用任意系统支持的格式；而在原始音频比特率较低（小于16kHz16bit）的情况下，建议采用压缩比小于10的opus，使用其他有损编码，如mp3，m4a等会减弱识别准确率。

注，无压缩的pcm音频：比特率（bps）=采样率（kHz）*位数（bit）*声道数；其他类型音频的比特率可由查看其音频属性获得。

（2）背景音和噪声

录音时尽量使用靠近并且指向发声方向的麦克风（例如耳麦）；对于已录制音频，建议只摘取人说话声音，避免背景音混叠；对于已经录制好的音频，由于转写引擎在转写之前会对音频进行降噪操作，因此不建议您采用额外的降噪处理。

（3）多人同时发音情况

当对多个发音人同时采集音频时，建议对音频进行预先切分，每次请求识别的音频只含有一位发音人的语音。因为当多人同时发音或多人发音音量有区别时，部分语音有可能会被视为背景噪音而剔除。

（4）有效音频的上传

为了避免您的时长损失，请上传普通播放器可播放的音频。如果上传加密、损坏的音频，或者更改音频后缀，可能会造成转写失败或者输出乱码结果。

（5）音频幅值

音频的帧平均幅度值在5000~20000之间为最佳。不需要刻意录制更高幅度值的音频，否则有可能造成截幅，降低识别率。

（6）音频时长

语音转写最大的特点为具有长时记忆功能，即时间越长的音频，其准确率会越高。建议使用大于1分钟的音频进行转写。

# 2.5 教学视频

教学视频

# 3、常见问题

# 语音转写支不支持并发？

答：支持，要保证同一个appid每秒请求接口次数最大值在20次以下。

# 语音转写可以试用吗？

答：平台免费赠送的时长为5小时，供开发者测试使用，每个账户限领取1次（应用控制台领取即可），有效期为自生效日起30天。

# 语音转写的返回速度有多快？

答：关于返回时长快慢，需要看当时的转写任务量以及是否是高峰期，如任务积压，排队处理需要时间，时间上会长些。
另外语音转写是SLA协议对象服务之一，我们对付费用户承诺有效任务耗时最大不超过12小时，赔偿标准等详情请参考SLA协议。

# 语音转写支持哪些应用平台？

答：语音转写支持Java和WebAPI接口。

# 语音转写支持哪些音频格式？

答：目前语音转写支持的音频格式为：已录制音频，wav,flac,opus,m4a,mp3，单声道&多声道，支持语种：中文普通话、英语；采样率：8KHz,16KHz；采样精度：8bits,16bits

# 语音转写电话版和标准版什么区别？

答：目前电话版和标准版已经合并为统一的版本，电话版老用户的时长可以继续使用。合并后的版本支持多发音人分离，具体参数调整请参考开发文档。

# 语音转写支持什么语言？

答：支持语种：中文普通话、英语