提示:
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及以上,需要增加其对应的第三方依赖,根据错误提示补充即可)。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>3.7.1</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.49</version>
</dependency>
Demo使用说明
录音文件说明: Demo中使用的录音文件为PCM编码格式16000Hz采样率,控制台设置的模型为通用模型;如果使用其他录音文件,请填入对应的编码格式和采样率,并在控制台设置对应的模型,模型设置请阅读管理项目一节。
nls-sample-16k.wav
阿里云鉴权client
使用过程中,所有的调用均通过阿里云账号来完成鉴权操作。通过传入阿里云账号的AccessKey ID和AccessKey Secret(获取方法请阅读开通服务一节),调用阿里云Java SDK,得到client,示例如下:
final String accessKeyId = "您的AccessKey Id";
final String accessKeySecret = "您的AccessKey Secret";
/**
* 地域ID
*/
final String regionId = "ap-southeast-1";
final String endpointName = "ap-southeast-1";
final String product = "nls-filetrans";
final String domain = "filetrans.ap-southeast-1.aliyuncs.com";
IAcsClient client;
// 设置endpoint
DefaultProfile.addEndpoint(endpointName, regionId, product, domain);
// 创建DefaultAcsClient实例并初始化
DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
client = new DefaultAcsClient(profile);
录音文件识别请求调用接口
Java Demo采用的是轮询的方式,提交录音文件识别请求,获取任务ID,供后续轮询使用。
说明:参数设置请参考接口说明中的输入参数设置,只需设置JSON字符串中的参数,其他方法的参数值保持不变。
/**
* 创建CommonRequest 设置请求参数
*/
CommonRequest postRequest = new CommonRequest();
postRequest.setDomain("filetrans.ap-southeast-1.aliyuncs.com"); // 设置域名,固定值
postRequest.setVersion("2019-08-23"); // 设置API的版本号,固定值
postRequest.setAction("SubmitTask"); // 设置action,固定值
postRequest.setProduct("nls-filetrans"); // 设置产品名称,固定值
// 设置录音文件识别请求参数,以JSON字符串的格式设置到请求的Body中
JSONObject taskObject = new JSONObject();
taskObject.put("appkey", "您的appkey"); // 设置appkey,传入您控制台项目的appkey
taskObject.put("file_link", "您的录音文件访问链接"); // 设置录音文件访问链接,传入您需要识别的录音文件的链接
taskObject.put(KEY_VERSION, "4.0"); // 新接入请使用4.0版本,已接入(默认2.0)如需维持现状,请注释掉该参数设置
String task = taskObject.toJSONString();
postRequest.putBodyParameter("Task", task); // 设置以上JSON字符串为Body参数
postRequest.setMethod(MethodType.POST); // 设置为POST方式的请求
/**
* 提交录音文件识别请求
*/
String taskId = ""; // 获取录音文件识别请求任务的ID,以供识别结果查询使用
CommonResponse postResponse = client.getCommonResponse(postRequest);
if (postResponse.getHttpStatus() == 200) {
JSONObject result = JSONObject.parseObject(postResponse.getData());
String statusText = result.getString("StatusText");
if ("SUCCESS".equals(statusText)) {
System.out.println("录音文件识别请求成功响应: " + result.toJSONString());
taskId = result.getString("TaskId");
}
else {
System.out.println("录音文件识别请求失败: " + result.toJSONString());
return;
}
}
else {
System.err.println("录音文件识别请求失败,Http错误码:" + postResponse.getHttpStatus());
System.err.println("录音文件识别请求失败响应:" + JSONObject.toJSONString(postResponse));
return;
}
录音文件识别结果查询
使用上面获得的任务ID,查询录音文件识别的结果。
/**
* 创建CommonRequest 设置任务ID
*/
CommonRequest getRequest = new CommonRequest();
getRequest.setDomain("filetrans.ap-southeast-1.aliyuncs.com"); // 设置域名,固定值
getRequest.setVersion("2019-08-23"); // 设置API版本,固定值
getRequest.setAction("GetTaskResult"); // 设置action,固定值
getRequest.setProduct("nls-filetrans"); // 设置产品名称,固定值
getRequest.putQueryParameter("TaskId", taskId); // 设置任务ID为查询参数,传入任务ID
getRequest.setMethod(MethodType.GET); // 设置为GET方式的请求
/**
* 提交录音文件识别结果查询请求
* 以轮询的方式进行识别结果的查询,直到服务端返回的状态描述为“SUCCESS”、“SUCCESS_WITH_NO_VALID_FRAGMENT”,或者为错误描述,则结束轮询。
*/
String statusText = "";
while (true) {
CommonResponse getResponse = client.getCommonResponse(getRequest);
if (getResponse.getHttpStatus() != 200) {
System.err.println("识别结果查询请求失败,Http错误码: " + getResponse.getHttpStatus());
System.err.println("识别结果查询请求失败: " + getResponse.getData());
break;
}
JSONObject result = JSONObject.parseObject(getResponse.getData());
System.out.println("识别查询结果:" + result.toJSONString());
statusText = result.getString("StatusText");
if ("RUNNING".equals(statusText) || "QUEUEING".equals(statusText)) {
// 继续轮询
Thread.sleep(3000);
}
else {
break;
}
}
if ("SUCCESS".equals(statusText) || "SUCCESS_WITH_NO_VALID_FRAGMENT".equals(statusText)) {
System.out.println("录音文件识别成功!");
}
else {
System.err.println("录音文件识别失败!");
}
完整示例
import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.CommonRequest;
import com.aliyuncs.CommonResponse;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.profile.DefaultProfile;
public class FileTransJavaDemo {
// 地域ID,常量内容,请勿改变
public static final String REGIONID = "ap-southeast-1";
public static final String ENDPOINTNAME = "ap-southeast-1";
public static final String PRODUCT = "nls-filetrans";
public static final String DOMAIN = "filetrans.ap-southeast-1.aliyuncs.com";
public static final String API_VERSION = "2019-08-23";
public static final String POST_REQUEST_ACTION = "SubmitTask";
public static final String GET_REQUEST_ACTION = "GetTaskResult";
// 请求参数key
public static final String KEY_APP_KEY = "appkey";
public static final String KEY_FILE_LINK = "file_link";
public static final String KEY_VERSION = "version";
public static final String KEY_ENABLE_WORDS = "enable_words";
// 响应参数key
public static final String KEY_TASK = "Task";
public static final String KEY_TASK_ID = "TaskId";
public static final String KEY_STATUS_TEXT = "StatusText";
public static final String KEY_RESULT = "Result";
// 状态值
public static final String STATUS_SUCCESS = "SUCCESS";
private static final String STATUS_RUNNING = "RUNNING";
private static final String STATUS_QUEUEING = "QUEUEING";
// 阿里云鉴权client
IAcsClient client;
public FileTransJavaDemo(String accessKeyId, String accessKeySecret) {
// 设置endpoint
try {
DefaultProfile.addEndpoint(ENDPOINTNAME, REGIONID, PRODUCT, DOMAIN);
} catch (ClientException e) {
e.printStackTrace();
}
// 创建DefaultAcsClient实例并初始化
DefaultProfile profile = DefaultProfile.getProfile(REGIONID, accessKeyId, accessKeySecret);
this.client = new DefaultAcsClient(profile);
}
public String submitFileTransRequest(String appKey, String fileLink) {
/**
* 1. 创建CommonRequest 设置请求参数
*/
CommonRequest postRequest = new CommonRequest();
// 设置域名
postRequest.setDomain(DOMAIN);
// 设置API的版本号,格式为YYYY-MM-DD
postRequest.setVersion(API_VERSION);
// 设置action
postRequest.setAction(POST_REQUEST_ACTION);
// 设置产品名称
postRequest.setProduct(PRODUCT);
/**
* 2. 设置录音文件识别请求参数,以JSON字符串的格式设置到请求的Body中
*/
JSONObject taskObject = new JSONObject();
// 设置appkey
taskObject.put(KEY_APP_KEY, appKey);
// 设置音频文件访问链接
taskObject.put(KEY_FILE_LINK, fileLink);
// 新接入请使用4.0版本,已接入(默认2.0)如需维持现状,请注释掉该参数设置
taskObject.put(KEY_VERSION, "4.0");
// 设置是否输出词信息,默认为false,开启时需要设置version为4.0及以上
taskObject.put(KEY_ENABLE_WORDS, true);
String task = taskObject.toJSONString();
System.out.println(task);
// 设置以上JSON字符串为Body参数
postRequest.putBodyParameter(KEY_TASK, task);
// 设置为POST方式的请求
postRequest.setMethod(MethodType.POST);
/**
* 3. 提交录音文件识别请求,获取录音文件识别请求任务的ID,以供识别结果查询使用
*/
String taskId = null;
try {
CommonResponse postResponse = client.getCommonResponse(postRequest);
System.err.println("提交录音文件识别请求的响应:" + postResponse.getData());
if (postResponse.getHttpStatus() == 200) {
JSONObject result = JSONObject.parseObject(postResponse.getData());
String statusText = result.getString(KEY_STATUS_TEXT);
if (STATUS_SUCCESS.equals(statusText)) {
taskId = result.getString(KEY_TASK_ID);
}
}
} catch (ClientException e) {
e.printStackTrace();
}
return taskId;
}
public String getFileTransResult(String taskId) {
/**
* 1. 创建CommonRequest 设置任务ID
*/
CommonRequest getRequest = new CommonRequest();
// 设置域名
getRequest.setDomain(DOMAIN);
// 设置API版本
getRequest.setVersion(API_VERSION);
// 设置action
getRequest.setAction(GET_REQUEST_ACTION);
// 设置产品名称
getRequest.setProduct(PRODUCT);
// 设置任务ID为查询参数
getRequest.putQueryParameter(KEY_TASK_ID, taskId);
// 设置为GET方式的请求
getRequest.setMethod(MethodType.GET);
/**
* 2. 提交录音文件识别结果查询请求
* 以轮询的方式进行识别结果的查询,直到服务端返回的状态描述为“SUCCESS”,或者为错误描述,则结束轮询。
*/
String result = null;
while (true) {
try {
CommonResponse getResponse = client.getCommonResponse(getRequest);
System.err.println("识别查询结果:" + getResponse.getData());
if (getResponse.getHttpStatus() != 200) {
break;
}
JSONObject rootObj = JSONObject.parseObject(getResponse.getData());
String statusText = rootObj.getString(KEY_STATUS_TEXT);
if (STATUS_RUNNING.equals(statusText) || STATUS_QUEUEING.equals(statusText)) {
// 继续轮询,注意设置轮询时间间隔
Thread.sleep(3000);
}
else {
// 状态信息为成功,返回识别结果;状态信息为异常,返回空
if (STATUS_SUCCESS.equals(statusText)) {
result = rootObj.getString(KEY_RESULT);
// 状态信息为成功,但没有识别结果,则可能是由于文件里全是静音、噪音等导致识别为空
if(result == null) {
result = "";
}
}
break;
}
} catch (Exception e) {
e.printStackTrace();
}
}
return result;
}
public static void main(String args[]) throws Exception {
if (args.length < 3) {
System.err.println("FileTransJavaDemo need params: <AccessKey Id> <AccessKey Secret> <app-key>");
}
final String accessKeyId = args[0];
final String accessKeySecret = args[1];
final String appKey = args[2];
String fileLink = "https://aliyun-nls.oss-cn-hangzhou.aliyuncs.com/asr/fileASR/examples/nls-sample-16k.wav";
FileTransJavaDemo demo = new FileTransJavaDemo(accessKeyId, accessKeySecret);
// 第一步:提交录音文件识别请求,获取任务ID用于后续的识别结果轮询
String taskId = demo.submitFileTransRequest(appKey, fileLink);
if (taskId != null) {
System.out.println("录音文件识别请求成功,task_id: " + taskId);
}
else {
System.out.println("录音文件识别请求失败!");
return;
}
// 第二步:根据任务ID轮询识别结果
String result = demo.getFileTransResult(taskId);
if (result != null) {
System.out.println("录音文件识别结果查询成功:" + result);
}
else {
System.out.println("录音文件识别结果查询失败!");
}
}
}
补充说明:如果使用回调方式,请在task字符串中设置“enable_callback”、“callback_url”参数:
taskObject.put("enable_callback", true);
taskObject.put("callback_url", "回调地址");
回调服务示例:该服务用于回调方式获取转写结果,仅供参考,假设设置的回调地址是:http://ip:port/filetrans/callback/result
package com.example.filetrans;
import com.alibaba.fastjson.JSONObject;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
@RequestMapping("/filetrans/callback")
@RestController
public class FiletransCallBack {
// 以4开头的状态码是客户端错误
private static final Pattern PATTERN_CLIENT_ERR = Pattern.compile("4105[0-9]*");
// 以5开头的状态码是服务端错误
private static final Pattern PATTERN_SERVER_ERR = Pattern.compile("5105[0-9]*");
// 必须是post的方式
@RequestMapping(value = "result", method = RequestMethod.POST)
public void GetResult(HttpServletRequest request) {
byte [] buffer = new byte[request.getContentLength()];
ServletInputStream in = null;
try {
in = request.getInputStream();
in.read(buffer, 0 ,request.getContentLength());
in.close();
// 获取json格式的文件转写结果
String result = new String(buffer);
JSONObject jsonResult = JSONObject.parseObject(result);
// 解析并输出相关结果内容
System.out.println("获取文件中转写回调结果:" + result);
System.out.println("TaskId: " + jsonResult.getString("TaskId"));
System.out.println("StatusCode: " + jsonResult.getString("StatusCode"));
System.out.println("StatusText: " + jsonResult.getString("StatusText"));
Matcher matcherClient = PATTERN_CLIENT_ERR.matcher(jsonResult.getString("StatusCode"));
Matcher matcherServer = PATTERN_SERVER_ERR.matcher(jsonResult.getString("StatusCode"));
// 以2开头状态码为正常状态码,回调方式方式正常状态只返回"21050000"
if("21050000".equals(jsonResult.getString("StatusCode"))) {
System.out.println("RequestTime: " + jsonResult.getString("RequestTime"));
System.out.println("SolveTime: " + jsonResult.getString("SolveTime"));
System.out.println("BizDuration: " + jsonResult.getString("BizDuration"));
System.out.println("Result.Sentences.size: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").size());
for (int i = 0; i < jsonResult.getJSONObject("Result").getJSONArray("Sentences").size(); i++) {
System.out.println("Result.Sentences[" + i + "].BeginTime: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("BeginTime"));
System.out.println("Result.Sentences[" + i + "].EndTime: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("EndTime"));
System.out.println("Result.Sentences[" + i + "].SilenceDuration: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("SilenceDuration"));
System.out.println("Result.Sentences[" + i + "].Text: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("Text"));
System.out.println("Result.Sentences[" + i + "].ChannelId: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("ChannelId"));
System.out.println("Result.Sentences[" + i + "].SpeechRate: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("SpeechRate"));
System.out.println("Result.Sentences[" + i + "].EmotionValue: " +
jsonResult.getJSONObject("Result").getJSONArray("Sentences").getJSONObject(i).getString("EmotionValue"));
}
}
else if(matcherClient.matches()) {
System.out.println("状态码以4开头表示客户端错误......");
}
else if(matcherServer.matches()) {
System.out.println("状态码以5开头表示服务端错误......");
}
else {
}
} catch (IOException e) {
e.printStackTrace();
}
}
}