注意事項

• 在使用SDK前，請先閱讀接口說明，詳情請參見接口說明。

• 從2.1.0版本開始，原有nls-sdk-short-asr更名為nls-sdk-recognizer，升級時需確認已刪除nls-sdk-short-asr，并按編譯提示添加相應的回調方法。

下載安裝

1. 從Maven服務器下載最新版本SDK。

   <dependency>
       <groupId>com.alibaba.nls</groupId>
       <artifactId>nls-sdk-recognizer</artifactId>
       <version>2.2.1</version>
   </dependency>

   解壓ZIP文件，在pom目錄運行mvn package，會在target目錄生成可執行JAR：nls-example-recognizer-2.0.0-jar-with-dependencies.jar，將JAR包拷貝至目標服務器，用于快速驗證及服務壓測。

2. 服務驗證。

   運行如下代碼，并按提示提供相應參數。運行后在命令執行目錄生成logs/nls.log。

   java -cp nls-example-recognizer-2.0.0-jar-with-dependencies.jar com.alibaba.nls.client.SpeechRecognizerDemo

3. 服務壓測。

   運行如下代碼，并按提示提供相應參數。其中阿里云服務URL參數為： wss://nls-gateway-cn-shanghai.aliyuncs.com/ws/v1 ，語音文件為16k采樣率PCM格式文件，并發數根據您的購買情況進行選擇。

   java -jar nls-example-recognizer-2.0.0-jar-with-dependencies.jar

   重要

   自行壓測超過2路并發會產生費用。

關鍵接口

• NlsClient：語音處理客戶端，利用該客戶端可以進行一句話識別、實時語音識別和語音合成的語音處理任務。該客戶端為線程安全，建議全局僅創建一個實例。

• SpeechRecognizer：一句話識別處理類，通過該接口設置請求參數，發送請求及聲音數據。非線程安全。

• SpeechRecognizerListener：識別結果監聽類，監聽識別結果。非線程安全。

更多介紹，請參見Java API接口說明。

代碼示例

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import com.alibaba.nls.client.protocol.InputFormatEnum;
import com.alibaba.nls.client.protocol.NlsClient;
import com.alibaba.nls.client.protocol.SampleRateEnum;
import com.alibaba.nls.client.protocol.asr.SpeechRecognizer;
import com.alibaba.nls.client.protocol.asr.SpeechRecognizerListener;
import com.alibaba.nls.client.protocol.asr.SpeechRecognizerResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
 * 此示例演示了：
 *      ASR一句話識別API調用。
 *      動態獲取Token。獲取Token具體操作，請參見：http://m.bestwisewords.com/document_detail/450514.html
 *      通過本地文件模擬實時流發送。
 *      識別耗時計算。
 */
public class SpeechRecognizerDemo {
    private static final Logger logger = LoggerFactory.getLogger(SpeechRecognizerDemo.class);
    private String appKey;
    NlsClient client;
    public SpeechRecognizerDemo(String appKey, String id, String secret, String url) {
        this.appKey = appKey;
        //應用全局創建一個NlsClient實例，默認服務地址為阿里云線上服務地址。
        //獲取Token，實際使用時注意在accessToken.getExpireTime()過期前再次獲取。
        AccessToken accessToken = new AccessToken(id, secret);
        try {
            accessToken.apply();
            System.out.println("get token: " + accessToken.getToken() + ", expire time: " + accessToken.getExpireTime());
            if(url.isEmpty()) {
                client = new NlsClient(accessToken.getToken());
            }else {
                client = new NlsClient(url, accessToken.getToken());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    private static SpeechRecognizerListener getRecognizerListener(int myOrder, String userParam) {
        SpeechRecognizerListener listener = new SpeechRecognizerListener() {
            //識別出中間結果。僅當setEnableIntermediateResult為true時，才會返回該消息。
            @Override
            public void onRecognitionResultChanged(SpeechRecognizerResponse response) {
                //getName是獲取事件名稱，getStatus是獲取狀態碼，getRecognizedText是語音識別文本。
                System.out.println("name: " + response.getName() + ", status: " + response.getStatus() + ", result: " + response.getRecognizedText());
            }
            //識別完畢
            @Override
            public void onRecognitionCompleted(SpeechRecognizerResponse response) {
                //getName是獲取事件名稱，getStatus是獲取狀態碼，getRecognizedText是語音識別文本。
                System.out.println("name: " + response.getName() + ", status: " + response.getStatus() + ", result: " + response.getRecognizedText());
            }
            @Override
            public void onStarted(SpeechRecognizerResponse response) {
                System.out.println("myOrder: " + myOrder + "; myParam: " + userParam + "; task_id: " + response.getTaskId());
            }
            @Override
            public void onFail(SpeechRecognizerResponse response) {
                //task_id是調用方和服務端通信的唯一標識，當遇到問題時，需要提供此task_id。
                System.out.println("task_id: " + response.getTaskId() + ", status: " + response.getStatus() + ", status_text: " + response.getStatusText());
            }
        };
        return listener;
    }
    //根據二進制數據大小計算對應的同等語音長度
    //sampleRate僅支持8000或16000。
    public static int getSleepDelta(int dataSize, int sampleRate) {
        // 僅支持16位采樣。
        int sampleBytes = 16;
        // 僅支持單通道。
        int soundChannel = 1;
        return (dataSize * 10 * 8000) / (160 * sampleRate);
    }
    public void process(String filepath, int sampleRate) {
        SpeechRecognizer recognizer = null;
        try {
            //傳遞用戶自定義參數
            String myParam = "user-param";
            int myOrder = 1234;
            SpeechRecognizerListener listener = getRecognizerListener(myOrder, myParam);
            recognizer = new SpeechRecognizer(client, listener);
            recognizer.setAppKey(appKey);
            //設置音頻編碼格式。如果是OPUS文件，請設置為InputFormatEnum.OPUS。
            recognizer.setFormat(InputFormatEnum.PCM);
            //設置音頻采樣率
            if(sampleRate == 16000) {
                recognizer.setSampleRate(SampleRateEnum.SAMPLE_RATE_16K);
            } else if(sampleRate == 8000) {
                recognizer.setSampleRate(SampleRateEnum.SAMPLE_RATE_8K);
            }
            //設置是否返回中間識別結果
            recognizer.setEnableIntermediateResult(true);
            //設置是否打開語音檢測（即vad）
   recognizer.addCustomedParam("enable_voice_detection",true);
            //此方法將以上參數設置序列化為JSON發送給服務端，并等待服務端確認。
            long now = System.currentTimeMillis();
            recognizer.start();
            logger.info("ASR start latency : " + (System.currentTimeMillis() - now) + " ms");
            File file = new File(filepath);
            FileInputStream fis = new FileInputStream(file);
            byte[] b = new byte[3200];
            int len;
            while ((len = fis.read(b)) > 0) {
                logger.info("send data pack length: " + len);
                recognizer.send(b, len);
                //本案例用讀取本地文件的形式模擬實時獲取語音流，因為讀取速度較快，這里需要設置sleep時長。
                // 如果實時獲取語音則無需設置sleep時長，如果是8k采樣率語音第二個參數設置為8000。
                int deltaSleep = getSleepDelta(len, sampleRate);
                Thread.sleep(deltaSleep);
            }
            //通知服務端語音數據發送完畢，等待服務端處理完成。
            now = System.currentTimeMillis();
            //計算實際延遲，調用stop返回之后一般即是識別結果返回時間。
            logger.info("ASR wait for complete");
            recognizer.stop();
            logger.info("ASR stop latency : " + (System.currentTimeMillis() - now) + " ms");
            fis.close();
        } catch (Exception e) {
            System.err.println(e.getMessage());
        } finally {
            //關閉連接
            if (null != recognizer) {
                recognizer.close();
            }
        }
    }
    public void shutdown() {
        client.shutdown();
    }
    public static void main(String[] args) throws Exception {
        String appKey = System.getenv().get("NLS_APP_KEY");
        String id = System.getenv().get("ALIYUN_AK_ID");
        String secret = System.getenv().get("ALIYUN_AK_SECRET");
        String url = System.getenv().getOrDefault("NLS_GATEWAY_URL", "wss://nls-gateway-cn-shanghai.aliyuncs.com/ws/v1");
        SpeechRecognizerDemo demo = new SpeechRecognizerDemo(appKey, id, secret, url);
        //本案例使用本地文件模擬發送實時流數據。
        demo.process("./nls-sample-16k.wav", 16000);
        //demo.process("./nls-sample.opus", 16000);
        demo.shutdown();
    }
}

public void send(InputStream ins);
public void send(InputStream ins, int batchSize, int sleepInterval);
public void send(byte[] data);

public void send(ins, 3200, 100); // 16 kHz語音

recognizer.send(data); // 100 ms 語音數據
try {
 Thread.sleep(100);
} catch (InterruptedException e) {
 e.printStackTrace();
}

<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>20170516</version>
</dependency>

<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.2</version>
</dependency>