全部产品

Java SDK 2.0

更新时间:2019-07-19 17:54:58

提示:

  • 在使用SDK之前,请先确保已阅读了接口说明文档
  • 从2.1.0版本开始原有nls-sdk-short-asr 更名为 nls-sdk-recognizer.升级时需确认删除掉nls-sdk-short-asr,并按编译提示添加相应回调方法即可。

下载安装

可从maven 服务器下载最新版本SDK:

  1. <dependency>
  2. <groupId>com.alibaba.nls</groupId>
  3. <artifactId>nls-sdk-recognizer</artifactId>
  4. <version>2.1.0</version>
  5. </dependency>

使用方式参见下面代码示例。Demo 源码下载链接

demo 解压后,在pom 目录运行mvn package ,会在target目录生成可执行jar:nls-example-recognizer-2.0.0-jar-with-dependencies.jar 将此jar拷贝到目标服务器,可用于快速验证及压测服务。

服务验证

java -cp nls-example-recognizer-2.0.0-jar-with-dependencies.jar com.alibaba.nls.client.SpeechRecognizerDemo并按提示提供相应参数,运行后在命令执行目录生成logs/nls.log

服务压测

java -jar nls-example-recognizer-2.0.0-jar-with-dependencies.jar并按提示提供相应参数,其中阿里云服务url参数为: wss://nls-gateway.cn-shanghai.aliyuncs.com/ws/v1 ,语音文件请提供16k采样率 pcm 格式文件,并发数根据用户已购买并发谨慎选择。

温馨提示:自行压测超过2并发会产生费用。

关键接口

  • NlsClient:语音处理client,相当于所有语音相关处理类的factory,全局创建一个实例即可。线程安全。
  • SpeechRecognizer:一句话识别处理类,设置请求参数,发送请求及声音数据。非线程安全。
  • SpeechRecognizerListener:识别结果监听类,监听识别结果。非线程安全。

更多介绍参见API文档链接: Java API接口说明

SDK 调用注意事项

  1. NlsClient对象创建一次可以重复使用,每次创建消耗性能。NlsClient使用了netty的框架,创建时比较消耗时间和资源,但创建之后可以重复利用。建议调用程序将NlsClient的创建和关闭与程序本身的生命周期结合。
  2. SpeechRecognizer对象不能重复使用,一个识别任务对应一个SpeechRecognizer对象。例如有N个音频文件,则要进行N次识别任务,创建N个SpeechRecognizer对象。
  3. 实现的SpeechRecognizerListener对象和SpeechRecognizer对象是一一对应的,不能将一个SpeechRecognizerListener对象设置到多个SpeechRecognizer对象中,否则不能区分是哪个识别任务。
  4. Java SDK依赖了Netty网络库,版本需设置为4.1.17.Final及以上。如果您的应用中依赖了Netty,请确保版本符合要求。

代码示例

说明1:Demo中使用的音频文件为16000Hz采样率,请在管控台中将appKey对应项目的模型设置为通用模型,以获取正确的识别结果;如果使用其他音频,请设置为支持该音频场景的模型,模型设置请阅读管理项目一节。

nls-sample-16k.wav

说明2:Demo中使用了SDK内置的默认一句话识别服务的外网访问URL,如果您使用阿里云上海ECS并想使用内网访问URL,则在创建NlsClient对象时,设置内网访问的URL:

  1. client = new NlsClient("ws://nls-gateway.cn-shanghai-internal.aliyuncs.com/ws/v1", accessToken);

说明3:更多代码细节和多线程调用示例请参考SDK的示例程序。

示例:

  1. import java.io.File;
  2. import java.io.FileInputStream;
  3. import java.io.IOException;
  4. import com.alibaba.nls.client.protocol.InputFormatEnum;
  5. import com.alibaba.nls.client.protocol.NlsClient;
  6. import com.alibaba.nls.client.protocol.SampleRateEnum;
  7. import com.alibaba.nls.client.protocol.asr.SpeechRecognizer;
  8. import com.alibaba.nls.client.protocol.asr.SpeechRecognizerListener;
  9. import com.alibaba.nls.client.protocol.asr.SpeechRecognizerResponse;
  10. import org.slf4j.Logger;
  11. import org.slf4j.LoggerFactory;
  12. /**
  13. * 此示例演示了
  14. * ASR一句话识别API调用
  15. * 动态获取token
  16. * 通过本地文件模拟实时流发送
  17. * 识别耗时计算
  18. * (仅作演示,需用户根据实际情况实现)
  19. */
  20. public class SpeechRecognizerDemo {
  21. private static final Logger logger = LoggerFactory.getLogger(SpeechRecognizerDemo.class);
  22. private String appKey;
  23. NlsClient client;
  24. public SpeechRecognizerDemo(String appKey, String id, String secret, String url) {
  25. this.appKey = appKey;
  26. //TODO 重要提示 创建NlsClient实例,应用全局创建一个即可,生命周期可和整个应用保持一致,默认服务地址为阿里云线上服务地址
  27. //TODO 这里简单演示了获取token 的代码,该token会过期,实际使用时注意在accessToken.getExpireTime()过期前再次获取token
  28. AccessToken accessToken = new AccessToken(id, secret);
  29. try {
  30. accessToken.apply();
  31. System.out.println("get token: " + accessToken.getToken() + ", expire time: " + accessToken.getExpireTime());
  32. // TODO 创建NlsClient实例,应用全局创建一个即可
  33. if(url.isEmpty()) {
  34. client = new NlsClient(accessToken.getToken());
  35. }else {
  36. client = new NlsClient(url, accessToken.getToken());
  37. }
  38. } catch (IOException e) {
  39. e.printStackTrace();
  40. }
  41. }
  42. private static SpeechRecognizerListener getRecognizerListener(int myOrder, String userParam) {
  43. SpeechRecognizerListener listener = new SpeechRecognizerListener() {
  44. //识别出中间结果.服务端识别出一个字或词时会返回此消息.仅当setEnableIntermediateResult(true)时,才会有此类消息返回
  45. @Override
  46. public void onRecognitionResultChanged(SpeechRecognizerResponse response) {
  47. //事件名称 RecognitionResultChanged、 状态码(20000000 表示识别成功)、语音识别文本
  48. System.out.println("name: " + response.getName() + ", status: " + response.getStatus() + ", result: " + response.getRecognizedText());
  49. }
  50. //识别完毕
  51. @Override
  52. public void onRecognitionCompleted(SpeechRecognizerResponse response) {
  53. //事件名称 RecognitionCompleted, 状态码 20000000 表示识别成功, getRecognizedText是识别结果文本
  54. System.out.println("name: " + response.getName() + ", status: " + response.getStatus() + ", result: " + response.getRecognizedText());
  55. }
  56. @Override
  57. public void onStarted(SpeechRecognizerResponse response) {
  58. System.out.println("myOrder: " + myOrder + "; myParam: " + userParam + "; task_id: " + response.getTaskId());
  59. }
  60. @Override
  61. public void onFail(SpeechRecognizerResponse response) {
  62. // TODO 重要提示: task_id很重要,是调用方和服务端通信的唯一ID标识,当遇到问题时,需要提供此task_id以便排查
  63. System.out.println("task_id: " + response.getTaskId() + ", status: " + response.getStatus() + ", status_text: " + response.getStatusText());
  64. }
  65. };
  66. return listener;
  67. }
  68. /// 根据二进制数据大小计算对应的同等语音长度
  69. /// sampleRate 仅支持8000或16000
  70. public static int getSleepDelta(int dataSize, int sampleRate) {
  71. // 仅支持16位采样
  72. int sampleBytes = 16;
  73. // 仅支持单通道
  74. int soundChannel = 1;
  75. return (dataSize * 10 * 8000) / (160 * sampleRate);
  76. }
  77. public void process(String filepath, int sampleRate) {
  78. SpeechRecognizer recognizer = null;
  79. try {
  80. // 传递用户自定义参数
  81. String myParam = "user-param";
  82. int myOrder = 1234;
  83. SpeechRecognizerListener listener = getRecognizerListener(myOrder, myParam);
  84. recognizer = new SpeechRecognizer(client, listener);
  85. recognizer.setAppKey(appKey);
  86. //设置音频编码格式 TODO 如果是opus文件,请设置为 InputFormatEnum.OPUS
  87. recognizer.setFormat(InputFormatEnum.PCM);
  88. //设置音频采样率
  89. if(sampleRate == 16000) {
  90. recognizer.setSampleRate(SampleRateEnum.SAMPLE_RATE_16K);
  91. } else if(sampleRate == 8000) {
  92. recognizer.setSampleRate(SampleRateEnum.SAMPLE_RATE_8K);
  93. }
  94. //设置是否返回中间识别结果
  95. recognizer.setEnableIntermediateResult(true);
  96. //此方法将以上参数设置序列化为json发送给服务端,并等待服务端确认
  97. long now = System.currentTimeMillis();
  98. recognizer.start();
  99. logger.info("ASR start latency : " + (System.currentTimeMillis() - now) + " ms");
  100. File file = new File(filepath);
  101. FileInputStream fis = new FileInputStream(file);
  102. byte[] b = new byte[3200];
  103. int len;
  104. while ((len = fis.read(b)) > 0) {
  105. logger.info("send data pack length: " + len);
  106. recognizer.send(b);
  107. // TODO 重要提示:这里是用读取本地文件的形式模拟实时获取语音流并发送的,因为read很快,所以这里需要sleep
  108. // TODO 如果是真正的实时获取语音,则无需sleep, 如果是8k采样率语音,第二个参数改为8000
  109. int deltaSleep = getSleepDelta(len, sampleRate);
  110. Thread.sleep(deltaSleep);
  111. }
  112. //通知服务端语音数据发送完毕,等待服务端处理完成
  113. now = System.currentTimeMillis();
  114. // TODO 计算实际延迟: stop返回之后一般即是识别结果返回时间
  115. logger.info("ASR wait for complete");
  116. recognizer.stop();
  117. logger.info("ASR stop latency : " + (System.currentTimeMillis() - now) + " ms");
  118. fis.close();
  119. } catch (Exception e) {
  120. System.err.println(e.getMessage());
  121. } finally {
  122. //关闭连接
  123. if (null != recognizer) {
  124. recognizer.close();
  125. }
  126. }
  127. }
  128. public void shutdown() {
  129. client.shutdown();
  130. }
  131. public static void main(String[] args) throws Exception {
  132. String appKey = null; // "填写你的appkey";
  133. String id = null; // "填写你在阿里云网站上的AccessKeyId";
  134. String secret = null; // "填写你在阿里云网站上的AccessKeySecret";
  135. String url = ""; // 默认即可,默认值:wss://nls-gateway.cn-shanghai.aliyuncs.com/ws/v1
  136. if (args.length == 3) {
  137. appKey = args[0];
  138. id = args[1];
  139. secret = args[2];
  140. } else if (args.length == 4) {
  141. appKey = args[0];
  142. id = args[1];
  143. secret = args[2];
  144. url = args[3];
  145. } else {
  146. System.err.println("run error, need params(url is optional): " + "<app-key> <AccessKeyId> <AccessKeySecret> [url]");
  147. System.exit(-1);
  148. }
  149. SpeechRecognizerDemo demo = new SpeechRecognizerDemo(appKey, id, secret, url);
  150. // TODO 重要提示: 这里用一个本地文件来模拟发送实时流数据,实际使用时,用户可以从某处实时采集或接收语音流并发送到ASR服务端
  151. demo.process("./nls-sample-16k.wav", 16000);
  152. //demo.process("./nls-sample.opus", 16000);
  153. demo.shutdown();
  154. }
  155. }