java sdk是什么?

java sdk 使用说明



功能介绍


kws(关键词服务)的java sdk 同asr实时长语音sdk。针对kws的功能，主要提供了关键词表增删改查的util类，以及用来设置keyword_list_id(关键词表id)的参数。

SDK下载地址


java sdk

相关接口说明

• 关键词表维护接口:om.alibaba.idst.nls.utils.KwsMngUtil

该类中包含了所有增删改查的静态方法，调用方式参见下面代码示例。

• 关键词表id设置接口:public void setKeyWordListId(String keyWordListId)

该方法位于NlsRequest中，NlsRequest的其它方法说明参见实时asr java sdk文档，调用方式参加下面代码示例。

关键词表维护代码示例

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

1. public static void main(String[] args) {
2.         String akId = args[0];
3.         String akSecret = args[1];
4.         String json = "{\n"
5.             + "    \"keywords\": [\n"
6.             + "        {\"keyword\":\"张三\"},\n"
7.             + "        {\"keyword\":\"李四\"}\n"
8.             + "    ]\n"
9.             + "}";
10.         String updateJson = "{\n"
11.             + "    \"keywords\": [\n"
12.             + "        {\"keyword\":\"张四\"},\n"
13.             + "        {\"keyword\":\"李三\"}\n"
14.             + "    ]\n"
15.             + "}";
16.         String response = KwsMngUtil.create(akId, akSecret, json);
17.         logger.info("create response:{}", response);
18.         String keywordListId = (String)JSONPath.read(response, "$.keyword_list_id");
19.         response=KwsMngUtil.update(akId, akSecret, keywordListId,updateJson);
20.         logger.info("update response:{}", response);
21.         response = KwsMngUtil.get(akId, akSecret, keywordListId);
22.         logger.info("get response:{}", response);
23.         response = KwsMngUtil.delete(akId, akSecret, keywordListId);
24.         logger.info("delete :{}, response:{}", keywordListId, response);
26.     }

关键词识别代码示例

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

1. package com.alibaba.idst.nls;
3. import com.alibaba.fastjson.JSON;
4. import com.alibaba.idst.nls.event.NlsEvent;
5. import com.alibaba.idst.nls.event.NlsListener;
6. import com.alibaba.idst.nls.protocol.NlsRequest;
7. import com.alibaba.idst.nls.protocol.NlsResponse;
9. import java.io.File;
10. import java.io.FileInputStream;
12. import org.slf4j.Logger;
13. import org.slf4j.LoggerFactory;
15. /**
16. * Created by songsong.sss on 16/6/22.
17. */
18. public class RealtimeDemo implements NlsListener {
19.     private NlsClient client = new NlsClient();
20.     private static final String asrSC = "pcm";
22.     static Logger logger = LoggerFactory.getLogger(RealtimeDemo.class);
23.     public String filePath = "";
24.     public String appKey = "";
25.     String ak_id = "";
26.     String ak_secret = "";
28.     public RealtimeDemo() {
29.     }
31.     public void shutDown() {
32.         logger.debug("close NLS client manually!");
33.         client.close();
34.         logger.debug("demo done");
35.     }
37.     public void start() {
38.         logger.debug("init Nls client...");
39.         client.init();
40.     }
43.     public void hearIt() {
44.         logger.debug("open audio file...");
45.         FileInputStream fis = null;
46.         try {
47.             File file = new File(filePath);
48.             fis = new FileInputStream(file);
49.         } catch (Exception e) {
50.             e.printStackTrace();
51.         }
53.         if(fis != null) {
54.             logger.debug("create NLS future");
55.             try {
56.                 NlsRequest req = new NlsRequest();
57.                 req.setAppkey(appKey);
58.                 req.setFormat(asrSC);
59.                 req.setResponseMode("streaming");
60.                 req.setSampleRate(16000);
61.                 //用户根据[热词文档](~~49179~~) 设置自定义热词。
62.                 //通过设置VocabularyId调用热词。
63.                 //req.setVocabularyId("");
64.                 //设置关键词库ID 使用时请修改为自定义的词库ID
65.                 req.setKeyWordListId("c1391f1c1f1b4002936893c6d97592f3");
66.                 // the id and the id secret
67.                 req.authorize(ak_id, ak_secret);
68.                 NlsFuture future = client.createNlsFuture(req,this);
69.                 logger.debug("call NLS service");
70.                 byte[] b = new byte[8000];
71.                 int len = 0;
72.                 while((len = fis.read(b)) > 0) {
73.                     future.sendVoice(b, 0, len);
74.                     Thread.sleep(200);
75.                 }
76.                 logger.debug("send finish signal!");
77.                 future.sendFinishSignal();
79.                 logger.debug("main thread enter waiting .");
80.                 future.await(100000);
83.             } catch(Exception e) {
84.                 e.printStackTrace();
85.             }
86.             logger.debug("calling NLS service end");
87.         }
88.     }
90.     @Override
91.     public void onMessageReceived(NlsEvent e) {
92.         NlsResponse response = e.getResponse();
93.         response.getFinish();
94.         if (response.result != null) {
95.             logger.debug("status code = {},get finish is {},get recognize result: {}",
96.                 response.getStatusCode(), response.getFinish(), response.getResult());
97.             if (response.getQuality() != null) {
98.                 logger.info("Sentence {} is over. Get ended sentence recognize result: {}, voice quality is {}",
99.                     response.result.getSentence_id(), response.getResult(), JSON
100.                         .toJSONString(response.getQuality()));
101.             }
102.         } else {
103.             logger.info(JSON.toJSONString(response));
104.         }
105.     }
107.     @Override
108.     public void onOperationFailed(NlsEvent e) {
109.         logger.error("status code is {}, on operation failed: {}",e.getResponse().getStatusCode(),e.getErrorMessage());
111.     }
113.     @Override
114.     public void onChannelClosed(NlsEvent e) {
115.         logger.debug("on websocket closed.");
116.     }
118.     /**
119.      * @param args
120.      */
121.     public static void main(String[] args) {
122.         RealtimeDemo lun = new RealtimeDemo();
124.         logger.info("start ....");
125.         if (args.length < 4) {
126.             logger.debug("RealtimeDemo need params: <app-key> <Id> <Secret> <opu-file> ");
127.             System.exit(-1);
128.         }
129.         lun.appKey = args[0];
130.         lun.ak_id = args[1];
131.         lun.ak_secret = args[2];
132.         lun.filePath = args[3];
133.         lun.start();
134.         lun.hearIt();
135.         lun.shutDown();
136.     }
138. }

关键词识别结果说明

1. 如果没有设置keyword_list_id,即没有调用req.setKeyWordListId，则返回结果与实时asr返回结果一样；
2. 如果设置了keyword_list_id，没有命中，返回json形式为：<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); overflow: auto; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; font-size-adjust: none; font-stretch: normal;' prettyprinted?="" linenums="">{
3. "version": "1.0",
4. "request_id": "ee621386178e4ae4a2d8171e6c31a4bf",
5. "status_code": 200,
6. "finish": 0,
7. "result": {
8.      "sentence_id": 1,
9.      "begin_time": 300,
10.      "end_time": 3600,
11.      "status_code": 0
12. }
13. }

如果设置了keyword_list_id，且有命中，返回json形式为：<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); overflow: auto; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; font-size-adjust: none; font-stretch: normal;' prettyprinted?="" linenums="">

1. {
2. "version": "1.0",
3. "request_id": "ee621386178e4ae4a2d8171e6c31a4bf",
4. "status_code": 200,
5. "finish": 0,
6. "result": {
7.     "sentence_id": 1,
8.     "begin_time": 300,
9.     "end_time": 3600,
10.     "status_code": 0,
11.     "keywords":[
12.         {"keyword":"张三", "confidence":0.5，"start_time": 1, "end_time": 10},
13.         {"keyword":"李四", "confidence":0.6，"start_time": 1, "end_time": 10}
14.     ]
15. }
16. }

keywords参数说明

字段	类型	说明
keyword	String	查询出来的关键词
confidence	float	匹配度，范围0-1
start_time	Long	开始时间，单位ms
end_time	Long	结束时间，单位ms