全部产品
阿里云办公

Java SDK 2.0

更新时间:2018-11-15 10:20:38

版本提示

本文档中的SDK只适用于7月5日新发布的2.0版语音服务,如果您是之前开通的,要使用此SDK需要新开通2.0版服务

下载安装

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

  1. <dependency>
  2. <groupId>com.alibaba.nls</groupId>
  3. <artifactId>nls-sdk-short-asr</artifactId>
  4. <version>2.0.3</version>
  5. </dependency>

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

关键接口

  • 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对象中,否则不能区分是哪个识别任务。

代码示例

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

nls-sample-16k.wav

示例

  1. import com.alibaba.nls.client.protocol.InputFormatEnum;
  2. import com.alibaba.nls.client.protocol.NlsClient;
  3. import com.alibaba.nls.client.protocol.SampleRateEnum;
  4. import com.alibaba.nls.client.protocol.asr.SpeechRecognizer;
  5. import com.alibaba.nls.client.protocol.asr.SpeechRecognizerResponse;
  6. import com.alibaba.nls.client.protocol.asr.SpeechRecognizerListener;
  7. import java.io.InputStream;
  8. /**
  9. * SpeechRecognizerDemo class
  10. *
  11. * 一句话识别Demo
  12. */
  13. public class SpeechRecognizerDemo {
  14. private String appKey;
  15. private String accessToken;
  16. NlsClient client;
  17. /**
  18. * @param appKey
  19. * @param token
  20. */
  21. public SpeechRecognizerDemo(String appKey, String token) {
  22. this.appKey = appKey;
  23. this.accessToken = token;
  24. // Step0 创建NlsClient实例,应用全局创建一个即可,默认服务地址为阿里云线上服务地址
  25. client = new NlsClient(accessToken);
  26. }
  27. private static SpeechRecognizerListener getRecognizerListener() {
  28. SpeechRecognizerListener listener = new SpeechRecognizerListener() {
  29. // 识别出中间结果.服务端识别出一个字或词时会返回此消息.仅当setEnableIntermediateResult(true)时,才会有此类消息返回
  30. @Override
  31. public void onRecognitionResultChanged(SpeechRecognizerResponse response) {
  32. // 事件名称 RecognitionResultChanged
  33. System.out.println("name: " + response.getName() +
  34. // 状态码 20000000 表示识别成功
  35. ", status: " + response.getStatus() +
  36. // 一句话识别的中间结果
  37. ", result: " + response.getRecognizedText());
  38. }
  39. // 识别完毕
  40. @Override
  41. public void onRecognitionCompleted(SpeechRecognizerResponse response) {
  42. // 事件名称 RecognitionCompleted
  43. System.out.println("name: " + response.getName() +
  44. // 状态码 20000000 表示识别成功
  45. ", status: " + response.getStatus() +
  46. // 一句话识别的完整结果
  47. ", result: " + response.getRecognizedText());
  48. }
  49. };
  50. return listener;
  51. }
  52. public void process(InputStream ins) {
  53. SpeechRecognizer recognizer = null;
  54. try {
  55. // Step1 创建实例,建立连接
  56. recognizer = new SpeechRecognizer(client, getRecognizerListener());
  57. recognizer.setAppKey(appKey);
  58. // 设置音频编码格式
  59. recognizer.setFormat(InputFormatEnum.PCM);
  60. // 设置音频采样率
  61. recognizer.setSampleRate(SampleRateEnum.SAMPLE_RATE_16K);
  62. // 设置是否返回中间识别结果
  63. recognizer.setEnableIntermediateResult(true);
  64. // Step2 此方法将以上参数设置序列化为json发送给服务端,并等待服务端确认
  65. recognizer.start();
  66. // Step3 语音数据来自声音文件用此方法,控制发送速率;若语音来自实时录音,不需控制发送速率直接调用 recognizer.sent(ins)即可
  67. recognizer.send(ins, 6400, 200);
  68. // Step4 通知服务端语音数据发送完毕,等待服务端处理完成
  69. recognizer.stop();
  70. } catch (Exception e) {
  71. System.err.println(e.getMessage());
  72. } finally {
  73. // Step5 关闭连接
  74. if (null != recognizer) {
  75. recognizer.close();
  76. }
  77. }
  78. }
  79. public void shutdown() {
  80. client.shutdown();
  81. }
  82. public static void main(String[] args) {
  83. if (args.length < 2) {
  84. System.err.println("SpeechRecognizerDemo need params: <app-key> <token>");
  85. System.exit(-1);
  86. }
  87. String appKey = args[0];
  88. String token = args[1];
  89. SpeechRecognizerDemo demo = new SpeechRecognizerDemo(appKey, token);
  90. InputStream ins = SpeechRecognizerDemo.class.getResourceAsStream("/nls-sample-16k.wav");
  91. if (null == ins) {
  92. System.err.println("open the audio file failed!");
  93. System.exit(-1);
  94. }
  95. demo.process(ins);
  96. demo.shutdown();
  97. }
  98. }