Add pronunciation assessment REST API sample code in Node.js

Author: yinhew

PronunciationAssessment/Java/jre/src/com/microsoft/cognitiveservices/pronunciationassessment/Sample.java

@@ -58,7 +58,7 @@ public static void main(String[] args) throws Exception {
 		byte[] pronAssessmentParamsBase64 = Base64.getEncoder().encode(pronAssessmentParamsJson.getBytes("utf-8"));
 		String pronAssessmentParams = new String(pronAssessmentParamsBase64, "utf-8");
 
-		// build request
+		// build request (when re-run below code in short time, the connect can be cached and reused behind, with lower connecting time cost)
 		URL url = new URL("https://" + region + ".stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?language=en-us");
 		HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
 		connection.setRequestMethod("POST");

PronunciationAssessment/NodeJS/README.md

@@ -0,0 +1,25 @@
+# Pronunciation Assessment - Node.js Sample
+
+This sample shows how to call pronunciation assessment REST API in Node.js, with chunked (streaming) data uploading.
+
+## Prerequisites
+
+Here's what you'll need to run this sample:
+
+* Your favorite IDE or text editor
+* Node.js
+* An Azure subscription with Speech Services enabled. [Get one for free!](https://docs.microsoft.com/azure/cognitive-services/speech-service/get-started)
+
+## Code sample
+
+To use this sample, follow these instructions:
+
+* Create a new project using your favorite IDE or text editor
+* Copy the code from the sample into a file named `sample.js`
+* Run `npm install` to install dependencies
+* Set your subscription key and corresponding region
+* Run the sample: `node sample.js`
+
+## Resources
+
+* [REST API reference](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/rest-speech-to-text)

PronunciationAssessment/NodeJS/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "fs": "0.0.1-security",
+    "request": "^2.88.2"
+  }
+}

PronunciationAssessment/NodeJS/sample.js

@@ -0,0 +1,96 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license.
+//
+// Microsoft Cognitive Services (formerly Project Oxford): https://www.microsoft.com/cognitive-services
+//
+// Microsoft Cognitive Services (formerly Project Oxford) GitHub:
+// https://github.com/Microsoft/Cognitive-Speech-TTS
+//
+// Copyright (c) Microsoft Corporation
+// All rights reserved.
+//
+// MIT License:
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+const request = require("request");
+const fs = require("fs");
+
+var subscriptionKey = "{SubscriptionKey}" // replace this with your subscription key
+var region = "{Region}" // replace this with the region corresponding to your subscription key, e.g.westus, eastasia
+
+// build pronunciation assessment parameters
+var referenceText = "Good morning.";
+var pronAssessmentParamsJson = `{"ReferenceText":"${referenceText}","GradingSystem":"HundredMark","Dimension":"Comprehensive"}`;
+var pronAssessmentParams = Buffer.from(pronAssessmentParamsJson, 'utf-8').toString('base64');
+
+// build request
+var options = {
+    method: 'POST',
+    baseUrl: `https://${region}.stt.speech.microsoft.com/`,
+    url: 'speech/recognition/conversation/cognitiveservices/v1?language=en-us',
+    headers: {
+        'Accept': 'application/json;text/xml',
+        'Connection': 'Keep-Alive',
+        'Content-Type': 'audio/wav; codecs=audio/pcm; samplerate=16000',
+        'Transfer-Encoding': 'chunked',
+        'Expect': '100-continue',
+        'Ocp-Apim-Subscription-Key': subscriptionKey,
+        'Pronunciation-Assessment': pronAssessmentParams
+    }
+}
+
+var uploadFinishTime;
+
+var req = request.post(options);
+req.on("response", (resp) => {
+    resp.on("data", (chunk) => {
+        var result = chunk.toString('utf-8');
+        console.log("Pronunciation assessment result:\n");
+        console.log(result); // the result is a JSON string, you can parse it with JSON.parse() when consuming it
+        var getResponseTime = Date.now();
+        console.log(`\nLatency = ${getResponseTime - uploadFinishTime}ms`);
+    });
+});
+
+// a common wave header, with zero audio length
+// since stream data doesn't contain header, but the API requires header to fetch format information, so you need post this header as first chunk for each query
+const waveHeader16K16BitMono = Buffer.from([82, 73, 70, 70, 78, 128, 0, 0, 87, 65, 86, 69, 102, 109, 116, 32, 18, 0, 0, 0, 1, 0, 1, 0, 128, 62, 0, 0, 0, 125, 0, 0, 2, 0, 16, 0, 0, 0, 100, 97, 116, 97, 0, 0, 0, 0]);
+req.write(waveHeader16K16BitMono);
+
+// send request with chunked data
+var audioStream = fs.createReadStream("../GoodMorning.pcm", { highWaterMark: 1024 });
+audioStream.on("data", (data) => {
+    sleep(data.length / 32); // to simulate human speaking rate
+});
+audioStream.on("end", () => {
+    uploadFinishTime = Date.now();
+});
+
+audioStream.pipe(req);
+
+function sleep(milliseconds) {
+    var startTime = Date.now();
+    var endTime = Date.now();
+    while (endTime < startTime + milliseconds) {
+        endTime = Date.now();
+    }
+}