接口说明

1. 鉴权

客户端与服务端建立WebSocket连接时，使用Token进行鉴权。关于Token获取请参见获取Token概述。

2. 开始识别

客户端发起请求，服务端确认请求有效。其中在请求消息中需要进行参数设置，各参数由SDK中SpeechTranscriber对象的set方法设置，各参数含义如下：

自定义过滤词调用示例如下：

            // 以实时转写为例，
            JSONObject root = new JSONObject();
            root.put("system_reserved_filter", true);

            // 将以下词语替换成空
            JSONObject root1 = new JSONObject();
            JSONArray array1 = new JSONArray();
            array1.add("开始");
            array1.add("发生");
            root1.put("word_list", array1);

            // 将以下词语替换成*
            JSONObject root2 = new JSONObject();
            JSONArray array2 = new JSONArray();
            array2.add("测试");
            root2.put("word_list", array2);

						// 可以全部设置，也可以部分设置
            root.put("filter_with_empty", root1);
            root.put("filter_with_signed", root2);

            transcriber.addCustomedParam("special_word_filter", root);

3. 接收识别结果

客户端循环发送语音数据，持续接收识别结果：

• SentenceBegin事件表示服务端检测到了一句话的开始。实时语音识别服务的智能断句功能会判断出一句话的开始与结束，举例如下：

  {
          "header": {
                  "namespace": "SpeechTranscriber",
                  "name": "SentenceBegin",
                  "status": 20000000,
                  "message_id": "a426f3d4618447519c9d85d1a0d1****",
                  "task_id": "5ec521b5aa104e3abccf3d361822****",
                  "status_text": "Gateway:SUCCESS:Success."
          },
          "payload": {
                  "index": 1,
                  "time": 0
          }
  }

  header对象参数说明：

  参数	类型	说明
  namespace	String	消息所属的命名空间。
  name	String	消息名称，SentenceBegin表示一个句子的开始。
  status	Integer	状态码，表示请求是否成功，见服务状态码。
  status_text	String	状态消息。
  task_id	String	任务全局唯一ID，请记录该值，便于排查问题。
  message_id	String	本次消息的ID。

  payload对象参数说明：

  参数	类型	说明
  index	Integer	句子编号，从1开始递增。
  time	Integer	当前已处理的音频时长，单位是毫秒。

• TranscriptionResultChanged事件表示识别结果发生了变化。仅当enable_intermediate_result取值为true时会多次返回此消息，即一句话的中间识别结果，举例如下：

  {
          "header": {
                  "namespace": "SpeechTranscriber",
                  "name": "TranscriptionResultChanged",
                  "status": 20000000,
                  "message_id": "dc21193fada84380a3b6137875ab****",
                  "task_id": "5ec521b5aa104e3abccf3d361822****",
                  "status_text": "Gateway:SUCCESS:Success."
          },
          "payload": {
                  "index": 1,
                  "time": 1835,
                  "result": "北京的天",
                  "confidence": 1.0,
                  "words": [{
                          "text": "北京",
                          "startTime": 630,
                          "endTime": 930
                  }, {
                          "text": "的",
                          "startTime": 930,
                          "endTime": 1110
                  }, {
                          "text": "天",
                          "startTime": 1110,
                          "endTime": 1140
                  }]
          }
  }       

  header对象参数同上述表格说明，name为TranscriptionResultChanged：表示句子的中间识别结果。

  payload对象参数说明：

  参数	类型	说明
  index	Integer	句子编号，从1开始递增。
  time	Integer	当前已处理的音频时长，单位是毫秒。
  result	String	当前句子的识别结果。
  words	List< Word >	当前句子的词信息，需要将enable_words设置为true。
  confidence	Double	当前句子识别结果的置信度，取值范围：[0.0,1.0]。值越大表示置信度越高。

• SentenceEnd事件表示服务端检测到了一句话的结束，并附带返回该句话的识别结果，举例如下：

  {
          "header": {
                  "namespace": "SpeechTranscriber",
                  "name": "SentenceEnd",
                  "status": 20000000,
                  "message_id": "c3a9ae4b231649d5ae05d4af36fd****",
                  "task_id": "5ec521b5aa104e3abccf3d361822****",
                  "status_text": "Gateway:SUCCESS:Success."
          },
          "payload": {
                  "index": 1,
                  "time": 1820,
                  "begin_time": 0,
                  "result": "北京的天气。",
                  "confidence": 1.0,
                  "words": [{
                          "text": "北京",
                          "startTime": 630,
                          "endTime": 930
                  }, {
                          "text": "的",
                          "startTime": 930,
                          "endTime": 1110
                  }, {
                          "text": "天气",
                          "startTime": 1110,
                          "endTime": 1380
                  }]
          }
  }
  

  header对象参数同上述表格说明，name为SentenceEnd表示识别到句子的结束。

  payload对象参数说明：

  参数	类型	说明
  index	Integer	句子编号，从1开始递增。
  time	Integer	当前已处理的音频时长，单位是毫秒。
  begin_time	Integer	当前句子对应的SentenceBegin事件的时间，单位是毫秒。
  result	String	当前的识别结果。
  words	List< Word >	当前句子的词信息，需要将enable_words设置为true。
  confidence	Double	当前句子识别结果的置信度，取值范围：[0.0,1.0]。值越大表示置信度越高。

  Words对象参数说明：

  参数	类型	说明
  text	String	文本。
  startTime	Integer	词开始时间，单位为毫秒。
  endTime	Integer	词结束时间，单位为毫秒。

4. 结束识别

通知服务端语音数据发送完成，服务端识别结束后通知客户端识别完毕。