介面說明

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
                  }],
                    "emo_tag": "neutral",
                    "emo_confidence": 0.931
          }
  }
  

  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]。值越大表示信賴度越高。
  emo_tag	String	當前句子的情感，包含positive(正面情感，如開心、滿意）、negative(負面情感，如憤怒、沉悶、失望）、neutral (無明顯情感）三種類別。
  emo_confidence	Double	當前句子識別情感的信賴度，取值範圍：[0.0,1.0]。值越大表示信賴度越高。

  Words對象參數說明：

  參數	類型	說明

  參數	類型	說明
  text	String	文本。
  startTime	Integer	詞開始時間，單位為毫秒。
  endTime	Integer	詞結束時間，單位為毫秒。

4. 結束識別

通知服務端語音資料發送完成，服務端識別結束後通知用戶端識別完畢。