uneeq-js 2.49.1 → 2.50.0

package/dist/src/service/speech-handler.d.ts

@@ -14,6 +14,7 @@ export declare class SpeechHandler {
     private stream;
     private reconnectWs;
     private wsReconnectMessageQueue;
+    private storedTranscription;
     constructor(options: SpeechHandlerOptions);
     startRecognition(): void;
     stopRecognition(): void;

package/dist/src/types/SpeechHandlerOptions.d.ts

@@ -11,4 +11,5 @@ export interface SpeechHandlerOptions {
     locales: string;
     jwtToken: string;
     chatMetadata: ChatMetadata;
+    enableVad?: boolean;
 }

package/dist/src/types/UneeqOptions.d.ts

@@ -53,6 +53,12 @@ export interface UneeqOptions {
      * This option specifies what the default voice input mode will be.
      */
     voiceInputMode: VoiceInputMode | string;
+    /**
+     * This option specifies whether VAD should be used when voiceInputMode is set to SPEECH_RECOGNITION.
+     * If set to false, then pauseSpeechRecognition and resumeSpeechRecognition must be called to capture the users audio.
+     * If set to true, or omitted, then the users audio will be captured automatically.
+     */
+    enableVad?: boolean;
     /**
      * Resume user session if available.
      */

package/dist/umd/index.js

@@ -4074,7 +4074,8 @@ class Uneeq {
                     locales: this.options.speechToTextLocales || '',
                     hintPhrases: this.options.speechRecognitionHintPhrases || '',
                     jwtToken: token,
-                    chatMetadata: this.chatMetadata
+                    chatMetadata: this.chatMetadata,
+                    enableVad: this.options.enableVad
                 });
             }
             else {
@@ -13314,7 +13315,7 @@ exports.race = race;
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"uneeq-js","version":"2.49.1","description":"","main":"dist/index.js","types":"dist/src/index.d.ts","scripts":{"start":"npx webpack -w","test-local":"npx karma start karma.conf.js -logLevel=DEBUG","test":"npx karma start --browsers ChromeHeadless --single-run","test:windows":"karma start karma.conf.js","build":"webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js","lint":"npx tslint -p tsconfig.json --fix","docs":"npx typedoc --options"},"files":["dist","!dist/test"],"author":"","license":"ISC","dependencies":{"@stomp/stompjs":"^6.0.0","@uehreka/seriously":"^1.0.1","fast-text-encoding":"^1.0.0","intrinsic-scale":"^3.0.4","onnxruntime-web":"^1.15.1","promjs":"^0.4.1","ring-buffer-ts":"^1.2.0","rxjs":"^7.8.1","rxjs-compat":"^6.6.7","simple-peer":"^9.11.1","webrtc-adapter":"^8.2.3"},"devDependencies":{"@types/dom-mediacapture-record":"^1.0.16","@types/jasmine":"^2.8.8","@types/node":"^10.9.4","fetch-mock":"7.7.3","ignore-styles":"^5.0.1","jasmine":"^5.1.0","jasmine-core":"^5.1.0","karma":"^6.4.2","karma-chrome-launcher":"^3.2.0","karma-firefox-launcher":"^2.1.2","karma-jasmine":"^5.1.0","karma-jasmine-html-reporter":"^2.1.0","karma-requirejs":"^1.1.0","karma-typescript":"^5.5.4","karma-typescript-es6-transform":"^5.5.4","nock":"^9.6.1","requirejs":"^2.3.6","ts-loader":"^9.4.4","ts-node":"^7.0.1","tslint":"^5.11.0","tslint-no-focused-test":"^0.5.0","typedoc":"^0.18.0","typescript":"^5.1.6","webpack":"^5.88.2","webpack-cli":"^5.1.4"}}');
+module.exports = JSON.parse('{"name":"uneeq-js","version":"2.50.0","description":"","main":"dist/index.js","types":"dist/src/index.d.ts","scripts":{"start":"npx webpack -w","test-local":"npx karma start karma.conf.js -logLevel=DEBUG","test":"npx karma start --browsers ChromeHeadless --single-run","test:windows":"karma start karma.conf.js","build":"webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js","lint":"npx tslint -p tsconfig.json --fix","docs":"npx typedoc --options"},"files":["dist","!dist/test"],"author":"","license":"ISC","dependencies":{"@stomp/stompjs":"^6.0.0","@uehreka/seriously":"^1.0.1","fast-text-encoding":"^1.0.0","intrinsic-scale":"^3.0.4","onnxruntime-web":"^1.15.1","promjs":"^0.4.1","ring-buffer-ts":"^1.2.0","rxjs":"^7.8.1","rxjs-compat":"^6.6.7","simple-peer":"^9.11.1","webrtc-adapter":"^8.2.3"},"devDependencies":{"@types/dom-mediacapture-record":"^1.0.16","@types/jasmine":"^2.8.8","@types/node":"^10.9.4","fetch-mock":"7.7.3","ignore-styles":"^5.0.1","jasmine":"^5.1.0","jasmine-core":"^5.1.0","karma":"^6.4.2","karma-chrome-launcher":"^3.2.0","karma-firefox-launcher":"^2.1.2","karma-jasmine":"^5.1.0","karma-jasmine-html-reporter":"^2.1.0","karma-requirejs":"^1.1.0","karma-typescript":"^5.5.4","karma-typescript-es6-transform":"^5.5.4","nock":"^9.6.1","requirejs":"^2.3.6","ts-loader":"^9.4.4","ts-node":"^7.0.1","tslint":"^5.11.0","tslint-no-focused-test":"^0.5.0","typedoc":"^0.18.0","typescript":"^5.1.6","webpack":"^5.88.2","webpack-cli":"^5.1.4"}}');
 
 /***/ }),
 /* 242 */
@@ -51279,7 +51280,9 @@ class SpeechHandler {
         this.digitalHumanSpeaking = false;
         this.reconnectWs = true;
         this.wsReconnectMessageQueue = [];
+        this.storedTranscription = '';
         this.options.assetBasePath = this.options.assetBasePath || defaultAssetPath;
+        this.options.enableVad = this.options.enableVad === undefined ? true : this.options.enableVad;
         this.loadSavedAudioHeaders();
         this.loadScripts();
         this.handleAppMessages();
@@ -51288,7 +51291,7 @@ class SpeechHandler {
         this.initWebsocket(this.options);
     }
     stopRecognition() {
-        if (this.mediaRecorder) {
+        if (this.mediaRecorder && this.mediaRecorder.state === 'recording') {
             this.mediaRecorder.stop();
         }
         if (this.stream) {
@@ -51402,13 +51405,13 @@ class SpeechHandler {
         });
     }
     initVoiceActivityDetection(stream) {
-        logger_1.logger.log(this.logPrefix + 'Going to initialize VAD module.');
+        logger_1.logger.log(this.logPrefix + 'Going to initialize VAD module, with enableVad = ' + this.options.enableVad);
         real_time_vad_1.MicVAD.new({
             onSpeechStart: () => this.onVadSpeechStart(),
             onSpeechEnd: () => this.onVadSpeechEnd(),
             minSpeechFrames: 1,
-            positiveSpeechThreshold: 0.5,
-            negativeSpeechThreshold: 0.35,
+            positiveSpeechThreshold: this.options.enableVad ? 0.5 : 0,
+            negativeSpeechThreshold: this.options.enableVad ? 0.35 : 0,
             redemptionFrames: 8,
             assetBasePath: this.options.assetBasePath,
             stream: stream,
@@ -51546,18 +51549,39 @@ class SpeechHandler {
             }
         }
     }
+    /*
+     * If the recording is live (VAD), append final STT results until recording is no longer live,
+       then send it as a question.
+     */
     handleTranscriptionResult(result) {
         logger_1.logger.log(this.logPrefix + `Speech transcription (${result.confidence} confidence): ${result.transcript}`);
-        if (result.final) {
-            this.options.chatMetadata.userSpokenLocale = result.language_code;
-            this.options.api.avatarAsk(result.transcript, this.options.chatMetadata);
-        }
-        else if (this.digitalHumanSpeaking) {
-            this.options.api.stopSpeaking();
-            this.digitalHumanSpeaking = false;
+        try {
+            if (this.recordingLive) {
+                if (result.final) {
+                    this.storedTranscription += result.transcript;
+                }
+                else if (this.digitalHumanSpeaking) {
+                    this.options.api.stopSpeaking();
+                    this.digitalHumanSpeaking = false;
+                }
+            }
+            else {
+                if (result.final) {
+                    result.transcript = this.storedTranscription + result.transcript;
+                    this.options.chatMetadata.userSpokenLocale = result.language_code;
+                    this.options.api.avatarAsk(result.transcript, this.options.chatMetadata);
+                    this.options.messages.next(new MessageTypes_1.SpeechTranscriptionMessage(result));
+                    this.storedTranscription = '';
+                }
+            }
+            if (result.stability > transcriptionStabilityThreshold && !result.final) {
+                result.transcript = this.storedTranscription + result.transcript;
+                this.options.messages.next(new MessageTypes_1.SpeechTranscriptionMessage(result));
+            }
         }
-        if (result.stability > transcriptionStabilityThreshold || result.final) {
-            this.options.messages.next(new MessageTypes_1.SpeechTranscriptionMessage(result));
+        catch (err) {
+            this.options.messages.next(new MessageTypes_1.SessionErrorMessage('There was an issues processing speech transcription.'));
+            this.storedTranscription = '';
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uneeq-js",
-  "version": "2.49.1",
+  "version": "2.50.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",

package/readme.md

@@ -8,6 +8,12 @@ https://docs.uneeq.io/build-your-own-experience
 To use uneeq-js with a typescript version < 3.8, 'skipLibCheck' must be set to true.
 
 ## Release Notes
+#### 2.50.0
+* Added enableVad as an option which can be used to disable automated voice activity detection.
+
+#### 2.49.2
+* Fixed an issue that caused enableMicrophone(false) to error.
+
 #### 2.49.1
 * Fixed an issue that caused partial SpeechTranscriptionMessages to be sent.