Merge branch 'main' into feat/background_transcribe

jambonz · Dec 26, 2023 · c2a00fe · c2a00fe
2 parents 4a459da + 3e84748
commit c2a00fe
Show file tree

Hide file tree

Showing 8 changed files with 152 additions and 33 deletions.
diff --git a/lib/tasks/gather.js b/lib/tasks/gather.js
@@ -117,14 +117,6 @@ class TaskGather extends SttTask {
       this.logger.debug({hints: this.data.recognizer.hints, hintsBoost: this.data.recognizer.hintsBoost},
         'Gather:exec - applying global sttHints');
     }
-    if (cs.hasAltLanguages) {
-      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages.concat(cs.altLanguages);
-      this.logger.debug({altLanguages: this.data.recognizer?.altLanguages},
-        'Gather:exec - applying altLanguages');
-    }
-    if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
-      this.data.recognizer.punctuation = cs.globalSttPunctuation;
-    }
     if (!this.isContinuousAsr && cs.isContinuousAsr) {
       this.isContinuousAsr = true;
       this.asrTimeout = cs.asrTimeout * 1000;

diff --git a/lib/tasks/say.js b/lib/tasks/say.js
@@ -76,6 +76,8 @@ class TaskSay extends Task {
         voice = arr[1];
         model = arr[2];
       }
+    } else if (vendor === 'deepgram') {
+      model = voice;
     }
 
     /* allow for microsoft custom region voice and api_key to be specified as an override */

diff --git a/lib/tasks/stt-task.js b/lib/tasks/stt-task.js
@@ -93,19 +93,19 @@ class SttTask extends Task {
 
     if (cs.recognizer) {
       for (const k in cs.recognizer) {
-        if (typeof this.data.recognizer[k] === 'object' ||
+        if (Array.isArray(this.data.recognizer[k]) ||
+        Array.isArray(cs.recognizer[k])) {
+          this.data.recognizer[k] = [
+            ...this.data.recognizer[k],
+            ...cs.recognizer[k]
+          ];
+        } else if (typeof this.data.recognizer[k] === 'object' ||
         typeof cs.recognizer[k] === 'object'
         ) {
           this.data.recognizer[k] = {
             ...this.data.recognizer[k],
             ...cs.recognizer[k]
           };
-        } else if (Array.isArray(this.data.recognizer[k]) ||
-        Array.isArray(cs.recognizer[k])) {
-          this.data.recognizer[k] = [
-            ...this.data.recognizer[k],
-            ...cs.recognizer[k]
-          ];
         } else {
           this.data.recognizer[k] = cs.recognizer[k] || this.data.recognizer[k];
         }
@@ -129,6 +129,15 @@ class SttTask extends Task {
       this.notifyError({ msg: 'ASR error', details:'Cobalt requires a model to be specified'});
       throw new Error('Cobalt requires a model to be specified');
     }
+
+    if (cs.hasAltLanguages) {
+      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages.concat(cs.altLanguages);
+      this.logger.debug({altLanguages: this.altLanguages},
+        'STT:exec - applying altLanguages');
+    }
+    if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
+      this.data.recognizer.punctuation = cs.globalSttPunctuation;
+    }
   }
 
   async _initSpeechCredentials(cs, vendor, label) {

diff --git a/lib/tasks/transcribe.js b/lib/tasks/transcribe.js
@@ -65,14 +65,7 @@ class TaskTranscribe extends SttTask {
       this.logger.debug({hints: this.data.recognizer.hints, hintsBoost: this.data.recognizer.hintsBoost},
         'Transcribe:exec - applying global sttHints');
     }
-    if (cs.hasAltLanguages) {
-      this.data.recognizer.altLanguages = this.data.recognizer.altLanguages.concat(cs.altLanguages);
-      this.logger.debug({altLanguages: this.altLanguages},
-        'Transcribe:exec - applying altLanguages');
-    }
-    if (cs.hasGlobalSttPunctuation && !this.data.recognizer.punctuation) {
-      this.data.recognizer.punctuation = cs.globalSttPunctuation;
-    }
+
     try {
       await this._startTranscribing(cs, ep, 1);
       if (this.separateRecognitionPerChannel && ep2) {

diff --git a/lib/utils/transcription-utils.js b/lib/utils/transcription-utils.js
@@ -474,7 +474,8 @@ module.exports = (logger) => {
         ...(rOpts.hints?.length > 0 && typeof rOpts.hints[0] === 'object' &&
           {GOOGLE_SPEECH_HINTS: JSON.stringify(rOpts.hints)}),
         ...(typeof rOpts.hintsBoost === 'number' && {GOOGLE_SPEECH_HINTS_BOOST: rOpts.hintsBoost}),
-        ...(rOpts.altLanguages?.length > 0 &&
+        // When altLanguages is emptylist, we have to send value to freeswitch to clear the previous settings
+        ...(rOpts.altLanguages &&
           {GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
         ...(rOpts.interactionType &&
           {GOOGLE_SPEECH_METADATA_INTERACTION_TYPE: rOpts.interactionType}),
@@ -504,7 +505,8 @@ module.exports = (logger) => {
           {AZURE_SPEECH_HINTS: rOpts.hints.map((h) => h.trim()).join(',')}),
         ...(rOpts.hints?.length > 0 && typeof rOpts.hints[0] === 'object' &&
           {AZURE_SPEECH_HINTS: rOpts.hints.map((h) => h.phrase).join(',')}),
-        ...(rOpts.altLanguages && rOpts.altLanguages.length > 0 &&
+        // When altLanguages is emptylist, we have to send value to freeswitch to clear the previous settings
+        ...(rOpts.altLanguages &&
           {AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
         ...(rOpts.requestSnr && {AZURE_REQUEST_SNR: 1}),
         ...(rOpts.profanityOption && {AZURE_PROFANITY_OPTION: rOpts.profanityOption}),

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "^0.2.4",
     "@jambonz/realtimedb-helpers": "^0.8.7",
-    "@jambonz/speech-utils": "^0.0.31",
+    "@jambonz/speech-utils": "^0.0.33",
     "@jambonz/stats-collector": "^0.1.9",
     "@jambonz/time-series": "^0.2.8",
     "@jambonz/verb-specifications": "^0.0.46",

diff --git a/test/transcribe-tests.js b/test/transcribe-tests.js
@@ -312,6 +312,127 @@ test('\'transcribe\' test - google with asrTimeout', async(t) => {
     t.ok(obj.body.speech.alternatives[0].transcript.toLowerCase().startsWith('i\'d like to speak to customer support'),
       'transcribe: succeeds when using google credentials');
 
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'transcribe\' test - deepgram config options altLanguages', 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",
+          "altLanguages": [
+            "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_no_altLanguages";
+    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 config options altLanguages', 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",
+          "altLanguages": [
+            "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"],
+          "altLanguages": [],
+          "deepgramOptions": {
+            "apiKey": DEEPGRAM_API_KEY,
+          }
+        }
+      }
+    ];
+    let from = "gather_success_has_altLanguages";
+    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}`);