全部产品
Search

搜索本产品

    Java SDK 2.0

    文档中心

    Java SDK 2.0

    更新时间： 2020-11-03

    提示:

    • 在使用SDK之前，请先确保已阅读了 接口说明文档。
    • 本文档中的SDK只适用于7月5日新发布的2.0版语音服务，如果您是之前开通的，要使用此SDK需要新开通2.0版服务。

    SDK 说明

    录音文件识别的Java Demo使用了阿里云Java SDK的CommonRequest用来提交录音文件识别请求和识别结果查询，采用的是RPC风格的POP API调用。阿里云Java SDK CommonRequest的使用方法请阅读 使用CommonRequest进行调用。

    注意： 阿里云Java SDK不支持Android开发。

    添加Java依赖

    您只需依赖阿里云Java SDK的核心库与阿里开源库fastjson即可。阿里云Java SDK的核心库版本支持3.5.0及以上（如果版本在4.0.0及以上，需要增加其对应的第三方依赖，根据错误提示补充即可）。

    1. <dependency>
    2.     <groupId>com.aliyun</groupId>
    3.     <artifactId>aliyun-java-sdk-core</artifactId>
    4.     <version>3.7.1</version>
    5. </dependency>
    6. <dependency>
    7.     <groupId>com.alibaba</groupId>
    8.     <artifactId>fastjson</artifactId>
    9.     <version>1.2.49</version>
    10. </dependency>

    Demo使用说明

    录音文件说明： Demo中使用的录音文件为PCM编码格式16000Hz采样率，控制台设置的模型为通用模型；如果使用其他录音文件，请填入对应的编码格式和采样率，并在控制台设置对应的模型，模型设置请阅读管理项目一节。

    nls-sample-16k.wav

    阿里云鉴权client

    使用过程中，所有的调用均通过阿里云账号来完成鉴权操作。通过传入阿里云账号的AccessKey ID和AccessKey Secret（获取方法请阅读开通服务一节），调用阿里云Java SDK，得到client，示例如下：

    1. final String accessKeyId = "您的AccessKey Id";
    2. final String accessKeySecret = "您的AccessKey Secret";
    3. /**
    4.  * 地域ID
    5.  */
    6. final String regionId = "ap-southeast-1";
    7. final String endpointName = "ap-southeast-1";
    8. final String product = "nls-filetrans";
    9. final String domain = "filetrans.ap-southeast-1.aliyuncs.com";
    11. IAcsClient client;
    12. // 设置endpoint
    13. DefaultProfile.addEndpoint(endpointName, regionId, product, domain);
    14. // 创建DefaultAcsClient实例并初始化
    15. DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
    16. client = new DefaultAcsClient(profile);

    录音文件识别请求调用接口

    Java Demo采用的是轮询的方式，提交录音文件识别请求，获取任务ID，供后续轮询使用。

    说明：参数设置请参考接口说明中的输入参数设置，只需设置JSON字符串中的参数，其他方法的参数值保持不变。

    1. /**
    2.  * 创建CommonRequest 设置请求参数
    3.  */
    4. CommonRequest postRequest = new CommonRequest();
    5. postRequest.setDomain("filetrans.ap-southeast-1.aliyuncs.com"); // 设置域名，固定值
    6. postRequest.setVersion("2019-08-23");         // 设置API的版本号，固定值
    7. postRequest.setAction("SubmitTask");          // 设置action，固定值
    8. postRequest.setProduct("nls-filetrans");      // 设置产品名称，固定值
    9. // 设置录音文件识别请求参数，以JSON字符串的格式设置到请求的Body中
    10. JSONObject taskObject = new JSONObject();
    11. taskObject.put("appkey", "您的appkey");    // 设置appkey，传入您控制台项目的appkey
    12. taskObject.put("file_link", "您的录音文件访问链接");  // 设置录音文件访问链接，传入您需要识别的录音文件的链接
    13. taskObject.put(KEY_VERSION, "4.0");  // 新接入请使用4.0版本，已接入(默认2.0)如需维持现状，请注释掉该参数设置
    14. String task = taskObject.toJSONString();
    15. postRequest.putBodyParameter("Task", task);  // 设置以上JSON字符串为Body参数
    16. postRequest.setMethod(MethodType.POST);      // 设置为POST方式的请求
    18. /**
    19.  * 提交录音文件识别请求
    20.  */
    21. String taskId = "";   // 获取录音文件识别请求任务的ID，以供识别结果查询使用
    22. CommonResponse postResponse = client.getCommonResponse(postRequest);
    23. if (postResponse.getHttpStatus() == 200) {
    24.     JSONObject result = JSONObject.parseObject(postResponse.getData());
    25.     String statusText = result.getString("StatusText");
    26.     if ("SUCCESS".equals(statusText)) {
    27.         System.out.println("录音文件识别请求成功响应： " + result.toJSONString());
    28.         taskId = result.getString("TaskId");
    29.     }
    30.     else {
    31.         System.out.println("录音文件识别请求失败： " + result.toJSONString());
    32.         return;
    33.     }
    34. }
    35. else {
    36.     System.err.println("录音文件识别请求失败，Http错误码：" + postResponse.getHttpStatus());
    37.     System.err.println("录音文件识别请求失败响应：" + JSONObject.toJSONString(postResponse));
    38.     return;
    39. }

    录音文件识别结果查询

    使用上面获得的任务ID，查询录音文件识别的结果。

    1. /**
    2.  * 创建CommonRequest 设置任务ID
    3.  */
    4. CommonRequest getRequest = new CommonRequest();
    5. getRequest.setDomain("filetrans.ap-southeast-1.aliyuncs.com");   // 设置域名，固定值
    6. getRequest.setVersion("2019-08-23");             // 设置API版本，固定值
    7. getRequest.setAction("GetTaskResult");           // 设置action，固定值
    8. getRequest.setProduct("nls-filetrans");          // 设置产品名称，固定值
    9. getRequest.putQueryParameter("TaskId", taskId);  // 设置任务ID为查询参数，传入任务ID
    10. getRequest.setMethod(MethodType.GET);            // 设置为GET方式的请求
    12. /**
    13.  * 提交录音文件识别结果查询请求
    14.  * 以轮询的方式进行识别结果的查询，直到服务端返回的状态描述为“SUCCESS”、“SUCCESS_WITH_NO_VALID_FRAGMENT”，或者为错误描述，则结束轮询。
    15.  */
    16. String statusText = "";
    17. while (true) {
    18.     CommonResponse getResponse = client.getCommonResponse(getRequest);
    19.     if (getResponse.getHttpStatus() != 200) {
    20.         System.err.println("识别结果查询请求失败，Http错误码： " + getResponse.getHttpStatus());
    21.         System.err.println("识别结果查询请求失败： " + getResponse.getData());
    22.         break;
    23.     }
    25.     JSONObject result = JSONObject.parseObject(getResponse.getData());
    26.     System.out.println("识别查询结果：" + result.toJSONString());
    27.     statusText = result.getString("StatusText");
    28.     if ("RUNNING".equals(statusText) || "QUEUEING".equals(statusText)) {
    29.         // 继续轮询
    30.         Thread.sleep(3000);
    31.     }
    32.     else {
    33.         break;
    34.     }
    35. }
    37. if ("SUCCESS".equals(statusText) || "SUCCESS_WITH_NO_VALID_FRAGMENT".equals(statusText)) {
    38.     System.out.println("录音文件识别成功！");
    39. }
    40. else {
    41.     System.err.println("录音文件识别失败！");
    42. }

    完整示例

    1. import com.alibaba.fastjson.JSONObject;
    2. import com.aliyuncs.CommonRequest;
    3. import com.aliyuncs.CommonResponse;
    4. import com.aliyuncs.DefaultAcsClient;
    5. import com.aliyuncs.IAcsClient;
    6. import com.aliyuncs.exceptions.ClientException;
    7. import com.aliyuncs.http.MethodType;
    8. import com.aliyuncs.profile.DefaultProfile;
    10. public class FileTransJavaDemo {
    12.     // 地域ID，常量内容，请勿改变
    13.     public static final String REGIONID = "ap-southeast-1";
    14.     public static final String ENDPOINTNAME = "ap-southeast-1";
    15.     public static final String PRODUCT = "nls-filetrans";
    16.     public static final String DOMAIN = "filetrans.ap-southeast-1.aliyuncs.com";
    17.     public static final String API_VERSION = "2019-08-23";
    18.     public static final String POST_REQUEST_ACTION = "SubmitTask";
    19.     public static final String GET_REQUEST_ACTION = "GetTaskResult";
    21.     // 请求参数key
    22.     public static final String KEY_APP_KEY = "appkey";
    23.     public static final String KEY_FILE_LINK = "file_link";
    24.     public static final String KEY_VERSION = "version";
    25.     public static final String KEY_ENABLE_WORDS = "enable_words";
    26.     // 响应参数key
    27.     public static final String KEY_TASK = "Task";
    28.     public static final String KEY_TASK_ID = "TaskId";
    29.     public static final String KEY_STATUS_TEXT = "StatusText";
    30.     public static final String KEY_RESULT = "Result";
    31.     // 状态值
    32.     public static final String STATUS_SUCCESS = "SUCCESS";
    33.     private static final String STATUS_RUNNING = "RUNNING";
    34.     private static final String STATUS_QUEUEING = "QUEUEING";
    37.     // 阿里云鉴权client
    38.     IAcsClient client;
    40.     public FileTransJavaDemo(String accessKeyId, String accessKeySecret) {
    41.         // 设置endpoint
    42.         try {
    43.             DefaultProfile.addEndpoint(ENDPOINTNAME, REGIONID, PRODUCT, DOMAIN);
    44.         } catch (ClientException e) {
    45.             e.printStackTrace();
    46.         }
    47.         // 创建DefaultAcsClient实例并初始化
    48.         DefaultProfile profile = DefaultProfile.getProfile(REGIONID, accessKeyId, accessKeySecret);
    49.         this.client = new DefaultAcsClient(profile);
    50.     }
    53.     public String submitFileTransRequest(String appKey, String fileLink) {
    54.         /**
    55.          * 1. 创建CommonRequest 设置请求参数
    56.          */
    57.         CommonRequest postRequest = new CommonRequest();
    58.         // 设置域名
    59.         postRequest.setDomain(DOMAIN);
    60.         // 设置API的版本号，格式为YYYY-MM-DD
    61.         postRequest.setVersion(API_VERSION);
    62.         // 设置action
    63.         postRequest.setAction(POST_REQUEST_ACTION);
    64.         // 设置产品名称
    65.         postRequest.setProduct(PRODUCT);
    67.         /**
    68.          * 2. 设置录音文件识别请求参数，以JSON字符串的格式设置到请求的Body中
    69.          */
    70.         JSONObject taskObject = new JSONObject();
    71.         // 设置appkey
    72.         taskObject.put(KEY_APP_KEY, appKey);
    73.         // 设置音频文件访问链接
    74.         taskObject.put(KEY_FILE_LINK, fileLink);
    75.         // 新接入请使用4.0版本，已接入(默认2.0)如需维持现状，请注释掉该参数设置
    76.         taskObject.put(KEY_VERSION, "4.0");
    77.         // 设置是否输出词信息，默认为false，开启时需要设置version为4.0及以上
    78.         taskObject.put(KEY_ENABLE_WORDS, true);
    79.         String task = taskObject.toJSONString();
    80.         System.out.println(task);
    81.         // 设置以上JSON字符串为Body参数
    82.         postRequest.putBodyParameter(KEY_TASK, task);
    83.         // 设置为POST方式的请求
    84.         postRequest.setMethod(MethodType.POST);
    86.         /**
    87.          * 3. 提交录音文件识别请求，获取录音文件识别请求任务的ID，以供识别结果查询使用
    88.          */
    89.         String taskId = null;
    90.         try {
    91.             CommonResponse postResponse = client.getCommonResponse(postRequest);
    92.             System.err.println("提交录音文件识别请求的响应：" + postResponse.getData());
    94.             if (postResponse.getHttpStatus() == 200) {
    95.                 JSONObject result = JSONObject.parseObject(postResponse.getData());
    96.                 String statusText = result.getString(KEY_STATUS_TEXT);
    97.                 if (STATUS_SUCCESS.equals(statusText)) {
    98.                     taskId = result.getString(KEY_TASK_ID);
    99.                 }
    100.             }
    101.         } catch (ClientException e) {
    102.             e.printStackTrace();
    103.         }
    105.         return taskId;
    106.     }
    108.     public String getFileTransResult(String taskId) {
    109.         /**
    110.          * 1. 创建CommonRequest 设置任务ID
    111.          */
    112.         CommonRequest getRequest = new CommonRequest();
    113.         // 设置域名
    114.         getRequest.setDomain(DOMAIN);
    115.         // 设置API版本
    116.         getRequest.setVersion(API_VERSION);
    117.         // 设置action
    118.         getRequest.setAction(GET_REQUEST_ACTION);
    119.         // 设置产品名称
    120.         getRequest.setProduct(PRODUCT);
    121.         // 设置任务ID为查询参数
    122.         getRequest.putQueryParameter(KEY_TASK_ID, taskId);
    123.         // 设置为GET方式的请求
    124.         getRequest.setMethod(MethodType.GET);
    126.         /**
    127.          * 2. 提交录音文件识别结果查询请求
    128.          * 以轮询的方式进行识别结果的查询，直到服务端返回的状态描述为“SUCCESS”,或者为错误描述，则结束轮询。
    129.          */
    130.         String result = null;
    131.         while (true) {
    132.             try {
    133.                 CommonResponse getResponse = client.getCommonResponse(getRequest);
    134.                 System.err.println("识别查询结果：" + getResponse.getData());
    136.                 if (getResponse.getHttpStatus() != 200) {
    137.                     break;
    138.                 }
    140.                 JSONObject rootObj = JSONObject.parseObject(getResponse.getData());
    141.                 String statusText = rootObj.getString(KEY_STATUS_TEXT);
    142.                 if (STATUS_RUNNING.equals(statusText) || STATUS_QUEUEING.equals(statusText)) {
    143.                     // 继续轮询，注意设置轮询时间间隔
    144.                     Thread.sleep(3000);
    145.                 }
    146.                 else {
    147.                     // 状态信息为成功，返回识别结果；状态信息为异常，返回空
    148.                     if (STATUS_SUCCESS.equals(statusText)) {
    149.                         result = rootObj.getString(KEY_RESULT);
    150.                        // 状态信息为成功，但没有识别结果，则可能是由于文件里全是静音、噪音等导致识别为空
    151.                         if(result == null) {
    152.                             result = "";
    153.                         }
    154.                     }
    155.                     break;
    156.                 }
    158.             } catch (Exception e) {
    159.                 e.printStackTrace();
    160.             }
    161.         }
    163.         return result;
    164.     }
    166.     public static void main(String args[]) throws Exception {
    167.         if (args.length < 3) {
    168.             System.err.println("FileTransJavaDemo need params: <AccessKey Id> <AccessKey Secret> <app-key>");
    169.         }
    171.         final String accessKeyId = args[0];
    172.         final String accessKeySecret = args[1];
    173.         final String appKey = args[2];
    175.         String fileLink = "https://aliyun-nls.oss-cn-hangzhou.aliyuncs.com/asr/fileASR/examples/nls-sample-16k.wav";
    177.         FileTransJavaDemo demo = new FileTransJavaDemo(accessKeyId, accessKeySecret);
    179.         // 第一步：提交录音文件识别请求，获取任务ID用于后续的识别结果轮询
    180.         String taskId = demo.submitFileTransRequest(appKey, fileLink);
    181.         if (taskId != null) {
    182.             System.out.println("录音文件识别请求成功，task_id: " + taskId);
    183.         }
    184.         else {
    185.             System.out.println("录音文件识别请求失败！");
    186.             return;
    187.         }
    189.         // 第二步：根据任务ID轮询识别结果
    190.         String result = demo.getFileTransResult(taskId);
    191.         if (result != null) {
    192.             System.out.println("录音文件识别结果查询成功：" + result);
    193.         }
    194.         else {
    195.             System.out.println("录音文件识别结果查询失败！");
    196.         }
    198.     }
    199. }

    补充说明：如果使用回调方式，请在task字符串中设置“enable_callback”、“callback_url”参数：

    1. taskObject.put("enable_callback", true);
    2. taskObject.put("callback_url", "回调地址");

    回调服务示例：该服务用于回调方式获取转写结果，仅供参考，假设设置的回调地址是：http://ip:port/filetrans/callback/result

    1. package com.example.filetrans;
    2. import com.alibaba.fastjson.JSONObject;
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. import org.springframework.web.bind.annotation.RequestMethod;
    5. import org.springframework.web.bind.annotation.RestController;
    6. import javax.servlet.ServletInputStream;
    7. import javax.servlet.http.HttpServletRequest;
    8. import java.io.IOException;
    9. import java.util.regex.Matcher;
    10. import java.util.regex.Pattern;
    12. @RequestMapping("/filetrans/callback")
    13. @RestController
    14. public class FiletransCallBack {
    16.     // 以4开头的状态码是客户端错误
    17.     private static final Pattern PATTERN_CLIENT_ERR = Pattern.compile("4105[0-9]*");
    19.     // 以5开头的状态码是服务端错误
    20.     private static final Pattern PATTERN_SERVER_ERR = Pattern.compile("5105[0-9]*");
    21.     // 必须是post的方式
    22.     @RequestMapping(value = "result", method = RequestMethod.POST)
    23.     public void GetResult(HttpServletRequest request) {
    24.         byte [] buffer = new byte[request.getContentLength()];
    25.         ServletInputStream in = null;
    26.         try {
    27.             in = request.getInputStream();
    28.             in.read(buffer, 0 ,request.getContentLength());
    29.             in.close();
    30.             // 获取json格式的文件转写结果
    31.             String result = new String(buffer);
    32.             JSONObject jsonResult = JSONObject.parseObject(result);
    33.             // 解析并输出相关结果内容
    34.             System.out.println("获取文件中转写回调结果:" + result);
    35.             System.out.println("TaskId: " + jsonResult.getString("TaskId"));
    36.             System.out.println("StatusCode: " + jsonResult.getString("StatusCode"));
    37.             System.out.println("StatusText: " + jsonResult.getString("StatusText"));
    38.             Matcher matcherClient = PATTERN_CLIENT_ERR.matcher(jsonResult.getString("StatusCode"));
    39.             Matcher matcherServer = PATTERN_SERVER_ERR.matcher(jsonResult.getString("StatusCode"));
    40.             // 以2开头状态码为正常状态码，回调方式方式正常状态只返回"21050000"
    41.             if("21050000".equals(jsonResult.getString("StatusCode"))) {
    42.                 System.out.println("RequestTime: " + jsonResult.getString("RequestTime"));
    43.                 System.out.println("SolveTime: " + jsonResult.getString("SolveTime"));
    44.                 System.out.println("BizDuration: " + jsonResult.getString("BizDuration"));
    45.                 System.out.println("Result.Sentences.size: " +
    46.                     jsonResult.getJSONObject("Result").getJSONArray("Sentences").size());
    47.                 for (int i = 0; i < jsonResult.getJSONObject("Result").getJSONArray("Sentences").size(); i++) {
    48.                     System.out.println("Result.Sentences[" + i + "].BeginTime: " +
    49.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("BeginTime"));
    50.                     System.out.println("Result.Sentences[" + i + "].EndTime: " +
    51.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("EndTime"));
    52.                     System.out.println("Result.Sentences[" + i + "].SilenceDuration: " +
    53.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("SilenceDuration"));
    54.                     System.out.println("Result.Sentences[" + i + "].Text: " +
    55.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("Text"));
    56.                     System.out.println("Result.Sentences[" + i + "].ChannelId: " +
    57.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("ChannelId"));
    58.                     System.out.println("Result.Sentences[" + i + "].SpeechRate: " +
    59.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("SpeechRate"));
    60.                     System.out.println("Result.Sentences[" + i + "].EmotionValue: " +
    61.                         jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("EmotionValue"));
    62.                 }
    63.             }
    64.             else if(matcherClient.matches()) {
    65.                 System.out.println("状态码以4开头表示客户端错误......");
    66.             }
    67.             else if(matcherServer.matches()) {
    68.                 System.out.println("状态码以5开头表示服务端错误......");
    69.             }
    70.             else {
    71.             }
    72.         } catch (IOException e) {
    73.             e.printStackTrace();
    74.         }
    75.     }
    76. }