fix config verb can override recognizer *Options (#558)

* fix config verb can override recognizer *Options

* wip

* clean up gather and transcribe

* fix failing testcase

* fix failing testcase

* fix failing testcase

lib/session/call-session.js

@@ -170,6 +170,18 @@ class CallSession extends Emitter {
     return this.application.notifier;
   }
 
+  /**
+   * syntheizer
+   */
+
+  get synthesizer() {
+    return this._synthesizer;
+  }
+
+  set synthesizer(synth) {
+    this._synthesizer = synth;
+  }
+
   /**
    * default vendor to use for speech synthesis if not provided in the app
    */
@@ -252,6 +264,16 @@ class CallSession extends Emitter {
   set fallbackSpeechRecognizerVendor(vendor) {
     this.application.fallback_speech_recognizer_vendor = vendor;
   }
+  /**
+   * recognizer
+   */
+  get recognizer() {
+    return this._recognizer;
+  }
+
+  set recognizer(rec) {
+    this._recognizer = rec;
+  }
   /**
    * default vendor to use for speech recognition if not provided in the app
    */

lib/tasks/config.js

@@ -109,6 +109,7 @@ class TaskConfig extends Task {
     });
 
     if (this.hasSynthesizer) {
+      cs.synthesizer = this.synthesizer;
       cs.speechSynthesisVendor = this.synthesizer.vendor !== 'default'
         ? this.synthesizer.vendor
         : cs.speechSynthesisVendor;
@@ -138,6 +139,7 @@ class TaskConfig extends Task {
       this.logger.info({synthesizer: this.synthesizer}, 'Config: updated synthesizer');
     }
     if (this.hasRecognizer) {
+      cs.recognizer = this.recognizer;
       cs.speechRecognizerVendor = this.recognizer.vendor !== 'default'
         ? this.recognizer.vendor
         : cs.speechRecognizerVendor;

lib/tasks/gather.js

@@ -103,7 +103,7 @@ class TaskGather extends SttTask {
 
   async exec(cs, {ep}) {
     this.logger.debug({options: this.data}, 'Gather:exec');
-    await super.exec(cs);
+    await super.exec(cs, {ep});
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
 
     if (cs.hasGlobalSttHints && !this.maskGlobalSttHints) {
@@ -141,59 +141,6 @@ class TaskGather extends SttTask {
       this.interim = true;
       this.logger.debug('Gather:exec - early hints match enabled');
     }
-
-    this.ep = ep;
-    if ('default' === this.vendor || !this.vendor) {
-      this.vendor = cs.speechRecognizerVendor;
-      if (this.data.recognizer) this.data.recognizer.vendor = this.vendor;
-    }
-    if ('default' === this.language || !this.language) {
-      this.language = cs.speechRecognizerLanguage;
-      if (this.data.recognizer) this.data.recognizer.language = this.language;
-    }
-    if ('default' === this.label || !this.label) {
-      this.label = cs.speechRecognizerLabel;
-      if (this.data.recognizer) this.data.recognizer.label = this.label;
-    }
-    // Fallback options
-    if ('default' === this.fallbackVendor || !this.fallbackVendor) {
-      this.fallbackVendor = cs.fallbackSpeechRecognizerVendor;
-      if (this.data.recognizer) this.data.recognizer.fallbackVendor = this.fallbackVendor;
-    }
-    if ('default' === this.fallbackLanguage || !this.fallbackLanguage) {
-      this.fallbackLanguage = cs.fallbackSpeechRecognizerLanguage;
-      if (this.data.recognizer) this.data.recognizer.fallbackLanguage = this.fallbackLanguage;
-    }
-    if ('default' === this.fallbackLabel || !this.fallbackLabel) {
-      this.fallbackLabel = cs.fallbackSpeechRecognizerLabel;
-      if (this.data.recognizer) this.data.recognizer.fallbackLabel = this.fallbackLabel;
-    }
-    if (!this.data.recognizer.vendor) {
-      this.data.recognizer.vendor = this.vendor;
-    }
-    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
-      // By default, application saves cobalt model in language
-      this.data.recognizer.model = cs.speechRecognizerLanguage;
-    }
-
-    if (this.needsStt && !this.sttCredentials) {
-      try {
-        this.sttCredentials = await this._initSpeechCredentials(cs, this.vendor, this.label);
-      } catch (error) {
-        if (this.fallbackVendor && this.isHandledByPrimaryProvider) {
-          await this._fallback();
-        } else {
-          throw error;
-        }
-      }
-    }
-
-    /* when using cobalt model is required */
-    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
-      this.notifyError({ msg: 'ASR error', details:'Cobalt requires a model to be specified'});
-      throw new Error('Cobalt requires a model to be specified');
-    }
-
     const startListening = async(cs, ep) => {
       this._startTimer();
       if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();

lib/tasks/stt-task.js

@@ -52,8 +52,81 @@ class SttTask extends Task {
 
   }
 
+  async exec(cs, {ep, ep2}) {
+    super.exec(cs);
+    this.ep = ep;
+    this.ep2 = ep2;
+    if ('default' === this.vendor || !this.vendor) {
+      this.vendor = cs.speechRecognizerVendor;
+      if (this.data.recognizer) this.data.recognizer.vendor = this.vendor;
+    }
+    if ('default' === this.language || !this.language) {
+      this.language = cs.speechRecognizerLanguage;
+      if (this.data.recognizer) this.data.recognizer.language = this.language;
+    }
+    if ('default' === this.label || !this.label) {
+      this.label = cs.speechRecognizerLabel;
+      if (this.data.recognizer) this.data.recognizer.label = this.label;
+    }
+    // Fallback options
+    if ('default' === this.fallbackVendor || !this.fallbackVendor) {
+      this.fallbackVendor = cs.fallbackSpeechRecognizerVendor;
+      if (this.data.recognizer) this.data.recognizer.fallbackVendor = this.fallbackVendor;
+    }
+    if ('default' === this.fallbackLanguage || !this.fallbackLanguage) {
+      this.fallbackLanguage = cs.fallbackSpeechRecognizerLanguage;
+      if (this.data.recognizer) this.data.recognizer.fallbackLanguage = this.fallbackLanguage;
+    }
+    if ('default' === this.fallbackLabel || !this.fallbackLabel) {
+      this.fallbackLabel = cs.fallbackSpeechRecognizerLabel;
+      if (this.data.recognizer) this.data.recognizer.fallbackLabel = this.fallbackLabel;
+    }
+    if (!this.data.recognizer.vendor) {
+      this.data.recognizer.vendor = this.vendor;
+    }
+    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
+      // By default, application saves cobalt model in language
+      this.data.recognizer.model = cs.speechRecognizerLanguage;
+    }
+
+    if (cs.recognizer) {
+      for (const k in cs.recognizer) {
+        if (Array.isArray(this.data.recognizer[k]) ||
+        Array.isArray(cs.recognizer[k]) ||
+        typeof this.data.recognizer[k] === 'object' ||
+        typeof cs.recognizer[k] === 'object'
+        ) {
+          this.data.recognizer[k] = {
+            ...this.data.recognizer[k],
+            ...cs.recognizer[k]
+          };
+        }  else {
+          this.data.recognizer[k] = cs.recognizer[k] || this.data.recognizer[k];
+        }
+      }
+    }
+
+    if (!this.sttCredentials) {
+      try {
+        this.sttCredentials = await this._initSpeechCredentials(this.cs, this.vendor, this.label);
+      } catch (error) {
+        if (this.fallbackVendor && this.isHandledByPrimaryProvider) {
+          await this._fallback();
+        } else {
+          throw error;
+        }
+      }
+    }
+
+    /* when using cobalt model is required */
+    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
+      this.notifyError({ msg: 'ASR error', details:'Cobalt requires a model to be specified'});
+      throw new Error('Cobalt requires a model to be specified');
+    }
+  }
+
   async _initSpeechCredentials(cs, vendor, label) {
-    const {getNuanceAccessToken, getIbmAccessToken} = this.cs.srf.locals.dbHelpers;
+    const {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;
     let credentials = cs.getSpeechCredentials(vendor, 'stt', label);
 
     if (!credentials) {

lib/tasks/transcribe.js

@@ -45,7 +45,7 @@ class TaskTranscribe extends SttTask {
   get name() { return TaskName.Transcribe; }
 
   async exec(cs, {ep, ep2}) {
-    super.exec(cs);
+    await super.exec(cs, {ep, ep2});
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
 
     if (cs.hasGlobalSttHints) {
@@ -63,60 +63,6 @@ class TaskTranscribe extends SttTask {
     if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
       this.data.recognizer.punctuation = cs.globalSttPunctuation;
     }
-
-    this.ep = ep;
-    this.ep2 = ep2;
-    if ('default' === this.vendor || !this.vendor) {
-      this.vendor = cs.speechRecognizerVendor;
-      if (this.data.recognizer) this.data.recognizer.vendor = this.vendor;
-    }
-    if ('default' === this.language || !this.language) {
-      this.language = cs.speechRecognizerLanguage;
-      if (this.data.recognizer) this.data.recognizer.language = this.language;
-    }
-    if ('default' === this.label || !this.label) {
-      this.label = cs.speechRecognizerLabel;
-      if (this.data.recognizer) this.data.recognizer.label = this.label;
-    }
-    // Fallback options
-    if ('default' === this.fallbackVendor || !this.fallbackVendor) {
-      this.fallbackVendor = cs.fallbackSpeechRecognizerVendor;
-      if (this.data.recognizer) this.data.recognizer.fallbackVendor = this.fallbackVendor;
-    }
-    if ('default' === this.fallbackLanguage || !this.fallbackLanguage) {
-      this.fallbackLanguage = cs.fallbackSpeechRecognizerLanguage;
-      if (this.data.recognizer) this.data.recognizer.fallbackLanguage = this.fallbackLanguage;
-    }
-    if ('default' === this.fallbackLabel || !this.fallbackLabel) {
-      this.fallbackLabel = cs.fallbackSpeechRecognizerLabel;
-      if (this.data.recognizer) this.data.recognizer.fallbackLabel = this.fallbackLabel;
-    }
-    if (!this.data.recognizer.vendor) {
-      this.data.recognizer.vendor = this.vendor;
-    }
-    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
-      // By default, application saves cobalt model in language
-      this.data.recognizer.model = cs.speechRecognizerLanguage;
-    }
-
-    if (!this.sttCredentials) {
-      try {
-        this.sttCredentials = await this._initSpeechCredentials(cs, this.vendor, this.label);
-      } catch (error) {
-        if (this.fallbackVendor && this.isHandledByPrimaryProvider) {
-          await this._fallback();
-        } else {
-          throw error;
-        }
-      }
-    }
-
-    /* when using cobalt model is required */
-    if (this.vendor === 'cobalt' && !this.data.recognizer.model) {
-      this.notifyError({ msg: 'ASR error', details:'Cobalt requires a model to be specified'});
-      throw new Error('Cobalt requires a model to be specified');
-    }
-
     try {
       await this._startTranscribing(cs, ep, 1);
       if (this.separateRecognitionPerChannel && ep2) {

test/transcribe-tests.js

@@ -137,6 +137,64 @@ test('\'transcribe\' test - aws', async(t) => {
   }
 });
 
+
+test('\'transcribe\' test - deepgram config options', async(t) => {
+  if (!DEEPGRAM_API_KEY ) {
+    t.pass('skipping deepgram tests');
+    return t.end();
+  }
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+    // GIVEN
+    let verbs = [
+      {
+        "verb": "config",
+        "recognizer": {
+          "vendor": "deepgram",
+          "language": "en-US",
+          "deepgramOptions": {
+            "model": "2-ea",
+            "tier": "nova",
+            "numerals": true,
+            "ner": true,
+            "vadTurnoff": 10,
+            "keywords": [
+              "CPT"
+            ]
+          }
+        }
+      },
+      {
+        "verb": "transcribe",
+        "transcriptionHook": "/transcriptionHook",
+        "recognizer": {
+          "vendor": "deepgram",
+          "hints": ["customer support", "sales", "human resources", "HR"],
+          "deepgramOptions": {
+            "apiKey": DEEPGRAM_API_KEY,
+          }
+        }
+      }
+    ];
+    let from = "gather_success";
+    await provisionCallHook(from, verbs);
+    // THEN
+    await sippUac('uac-gather-account-creds-success.xml', '172.38.0.10', from);
+    let obj = await getJSON(`http://127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().includes('like to speak to customer support'),
+      'transcribe: succeeds when using deepgram credentials');
+
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
 test('\'transcribe\' test - deepgram', async(t) => {
   if (!DEEPGRAM_API_KEY ) {
     t.pass('skipping deepgram tests');