support deepgram river (#1273)

* support deepgram river

* wip

* rebase

* fix review comment

---------

Co-authored-by: Dave Horton <daveh@beachdognet.com>

lib/session/call-session.js

@@ -1160,6 +1160,12 @@ class CallSession extends Emitter {
             service_version: credential.service_version
           };
         }
+        else if ('deepgramriver' === vendor) {
+          return {
+            speech_credential_sid: credential.speech_credential_sid,
+            api_key: credential.api_key,
+          };
+        }
         else if ('voxist' === vendor) {
           return {
             speech_credential_sid: credential.speech_credential_sid,

lib/tasks/gather.js

@@ -11,6 +11,7 @@ const {
   NvidiaTranscriptionEvents,
   JambonzTranscriptionEvents,
   AssemblyAiTranscriptionEvents,
+  DeepgramRiverTranscriptionEvents,
   VoxistTranscriptionEvents,
   CartesiaTranscriptionEvents,
   OpenAITranscriptionEvents,
@@ -464,6 +465,16 @@ class TaskGather extends SttTask {
           this._onVendorConnectFailure.bind(this, cs, ep));
         break;
 
+      case 'deepgramriver':
+        this.bugname = `${this.bugname_prefix}deepgramriver_transcribe`;
+        this.addCustomEventListener(
+          ep, DeepgramRiverTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        this.addCustomEventListener(
+          ep, DeepgramRiverTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, DeepgramRiverTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep));
+        break;
+
       case 'soniox':
         this.bugname = `${this.bugname_prefix}soniox_transcribe`;
         this.addCustomEventListener(

lib/tasks/transcribe.js

@@ -6,6 +6,7 @@ const {
   AwsTranscriptionEvents,
   AzureTranscriptionEvents,
   DeepgramTranscriptionEvents,
+  DeepgramRiverTranscriptionEvents,
   SonioxTranscriptionEvents,
   CobaltTranscriptionEvents,
   IbmTranscriptionEvents,
@@ -241,6 +242,15 @@ class TaskTranscribe extends SttTask {
         //if (opts.DEEPGRAM_SPEECH_UTTERANCE_END_MS) this.isContinuousAsr = true;
 
         break;
+      case 'deepgramriver':
+        this.bugname = `${this.bugname_prefix}deepgramriver_transcribe`;
+        this.addCustomEventListener(ep, DeepgramRiverTranscriptionEvents.Transcription,
+          this._onTranscription.bind(this, cs, ep, channel));
+        this.addCustomEventListener(ep, DeepgramRiverTranscriptionEvents.Connect,
+          this._onVendorConnect.bind(this, cs, ep));
+        this.addCustomEventListener(ep, DeepgramRiverTranscriptionEvents.ConnectFailure,
+          this._onVendorConnectFailure.bind(this, cs, ep, channel));
+        break;
       case 'soniox':
         this.bugname = `${this.bugname_prefix}soniox_transcribe`;
         this.addCustomEventListener(ep, SonioxTranscriptionEvents.Transcription,

lib/utils/constants.json

@@ -96,6 +96,11 @@
     "ConnectFailure": "deepgram_transcribe::connect_failed",
     "Connect": "deepgram_transcribe::connect"
   },
+  "DeepgramRiverTranscriptionEvents": {
+    "Transcription": "deepgramriver_transcribe::transcription",
+    "ConnectFailure": "deepgramriver_transcribe::connect_failed",
+    "Connect": "deepgramriver_transcribe::connect"
+  },
   "SonioxTranscriptionEvents": {
     "Transcription": "soniox_transcribe::transcription",
     "Error": "soniox_transcribe::error"

lib/utils/db-utils.js

@@ -81,6 +81,10 @@ const speechMapper = (cred) => {
       obj.deepgram_tts_uri = o.deepgram_tts_uri;
       obj.deepgram_stt_use_tls = o.deepgram_stt_use_tls;
     }
+    else if ('deepgramriver' === obj.vendor) {
+      const o = JSON.parse(decrypt(credential));
+      obj.api_key = o.api_key;
+    }
     else if ('soniox' === obj.vendor) {
       const o = JSON.parse(decrypt(credential));
       obj.api_key = o.api_key;

lib/utils/transcription-utils.js

@@ -339,6 +339,25 @@ const normalizeDeepgram = (evt, channel, language, shortUtterance) => {
   };
 };
 
+const normalizeDeepgramRiver = (evt, channel, language, shortUtterance) => {
+  const copy = JSON.parse(JSON.stringify(evt));
+  return {
+    language_code: language,
+    channel_tag: channel,
+    is_final: evt.event === 'EndOfTurn',
+    alternatives: [
+      {
+        confidence: evt.end_of_turn_confidence,
+        transcript: evt.transcript,
+      }
+    ],
+    vendor: {
+      name: 'deepgramriver',
+      evt: copy
+    }
+  };
+};
+
 const normalizeNvidia = (evt, channel, language) => {
   const copy = JSON.parse(JSON.stringify(evt));
   const alternatives = (evt.alternatives || [])
@@ -650,6 +669,8 @@ module.exports = (logger) => {
     switch (vendor) {
       case 'deepgram':
         return normalizeDeepgram(evt, channel, language, shortUtterance);
+      case 'deepgramriver':
+        return normalizeDeepgramRiver(evt, channel, language, shortUtterance);
       case 'microsoft':
         return normalizeMicrosoft(evt, channel, language, punctuation);
       case 'google':
@@ -931,6 +952,21 @@ module.exports = (logger) => {
           {DEEPGRAM_SPEECH_KEYTERMS: deepgramOptions.keyterms.join(',')})
       };
     }
+    else if ('deepgramriver' === vendor) {
+      const {
+        preflightThreshold,
+        eotThreshold,
+        eotTimeoutMs,
+        mipOptOut
+      } = rOpts.deepgramOptions || {};
+      opts = {
+        DEEPGRAM_API_KEY: sttCredentials.api_key,
+        ...(preflightThreshold && {DEEPGRAM_SPEECH_PRELIGHT_THRESHOLD: preflightThreshold}),
+        ...(eotThreshold && {DEEPGRAM_SPEECH_EOT_THRESHOLD: eotThreshold}),
+        ...(eotTimeoutMs && {DEEPGRAM_SPEECH_EOT_TIMEOUT_MS: eotTimeoutMs}),
+        ...(mipOptOut && {DEEPGRAM_SPEECH_MIP_OPT_OUT: mipOptOut}),
+      };
+    }
     else if ('soniox' === vendor) {
       const {sonioxOptions = {}} = rOpts;
       const {storage = {}} = sonioxOptions;

package-lock.json

@@ -18,7 +18,7 @@
         "@jambonz/speech-utils": "^0.2.15",
         "@jambonz/stats-collector": "^0.1.10",
         "@jambonz/time-series": "^0.2.14",
-        "@jambonz/verb-specifications": "^0.0.110",
+        "@jambonz/verb-specifications": "^0.0.111",
         "@modelcontextprotocol/sdk": "^1.9.0",
         "@opentelemetry/api": "^1.8.0",
         "@opentelemetry/exporter-jaeger": "^1.23.0",
@@ -1268,11 +1268,15 @@
       }
     },
     "node_modules/@cartesia/cartesia-js/node_modules/form-data": {
-      "version": "4.0.1",
+      "version": "4.0.4",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz",
+      "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==",
       "license": "MIT",
       "dependencies": {
         "asynckit": "^0.4.0",
         "combined-stream": "^1.0.8",
+        "es-set-tostringtag": "^2.1.0",
+        "hasown": "^2.0.2",
         "mime-types": "^2.1.12"
       },
       "engines": {
@@ -1517,10 +1521,9 @@
       }
     },
     "node_modules/@jambonz/verb-specifications": {
-      "version": "0.0.110",
+      "version": "0.0.111",
-      "resolved": "https://registry.npmjs.org/@jambonz/verb-specifications/-/verb-specifications-0.0.110.tgz",
+      "resolved": "https://registry.npmjs.org/@jambonz/verb-specifications/-/verb-specifications-0.0.111.tgz",
-      "integrity": "sha512-7Alt78G4VIEZjioOZGVStZu92PW3KAybs67QHMNve7/eT5BZNVQFLKmJ2ZMjtcmmVZm0j/d1IrJmN0faNQ0z8w==",
+      "integrity": "sha512-P2lDki5wCHGPPXpPTeMdht4NfGujF6NrLyrI8o/4U6l+2elfc/1mKl/Lz/PWGo9rQM4mTOVIhkk9ECo0NvOVoA==",
-      "license": "MIT",
       "dependencies": {
         "debug": "^4.3.4",
         "pino": "^8.8.0"
@@ -2785,9 +2788,9 @@
       }
     },
     "node_modules/@types/node-fetch/node_modules/form-data": {
-      "version": "4.0.3",
+      "version": "4.0.4",
-      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.3.tgz",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz",
-      "integrity": "sha512-qsITQPfmvMOSAdeyZ+12I1c+CKSstAFAwu+97zrnWAbIr5u8wfsExUzCesVLC8NgHuRUqNN4Zy6UPWUTRGslcA==",
+      "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==",
       "license": "MIT",
       "dependencies": {
         "asynckit": "^0.4.0",
@@ -3102,20 +3105,20 @@
       }
     },
     "node_modules/axios": {
-      "version": "1.10.0",
+      "version": "1.11.0",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.10.0.tgz",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.11.0.tgz",
-      "integrity": "sha512-/1xYAC4MP/HEG+3duIhFr4ZQXR4sQXOIe+o6sdqzeykGLx6Upp/1p8MHqhINOvGeP7xyNHe7tsiJByc4SSVUxw==",
+      "integrity": "sha512-1Lx3WLFQWm3ooKDYZD1eXmoGO9fxYQjrycfHFC8P0sCfQVXyROp0p9PFWBehewBOdCwHc+f/b8I0fMto5eSfwA==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
-        "form-data": "^4.0.0",
+        "form-data": "^4.0.4",
         "proxy-from-env": "^1.1.0"
       }
     },
     "node_modules/axios/node_modules/form-data": {
-      "version": "4.0.3",
+      "version": "4.0.4",
-      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.3.tgz",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz",
-      "integrity": "sha512-qsITQPfmvMOSAdeyZ+12I1c+CKSstAFAwu+97zrnWAbIr5u8wfsExUzCesVLC8NgHuRUqNN4Zy6UPWUTRGslcA==",
+      "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==",
       "license": "MIT",
       "dependencies": {
         "asynckit": "^0.4.0",
@@ -4786,12 +4789,16 @@
       }
     },
     "node_modules/form-data": {
-      "version": "2.5.2",
+      "version": "2.5.5",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.5.tgz",
+      "integrity": "sha512-jqdObeR2rxZZbPSGL+3VckHMYtu+f9//KXBsVny6JSX/pa38Fy+bGjuG8eW/H6USNQWhLi8Num++cU2yOCNz4A==",
       "license": "MIT",
       "dependencies": {
         "asynckit": "^0.4.0",
-        "combined-stream": "^1.0.6",
+        "combined-stream": "^1.0.8",
-        "mime-types": "^2.1.12",
+        "es-set-tostringtag": "^2.1.0",
+        "hasown": "^2.0.2",
+        "mime-types": "^2.1.35",
         "safe-buffer": "^5.2.1"
       },
       "engines": {
@@ -5358,21 +5365,21 @@
       }
     },
     "node_modules/ibm-cloud-sdk-core": {
-      "version": "5.4.0",
+      "version": "5.4.2",
-      "resolved": "https://registry.npmjs.org/ibm-cloud-sdk-core/-/ibm-cloud-sdk-core-5.4.0.tgz",
+      "resolved": "https://registry.npmjs.org/ibm-cloud-sdk-core/-/ibm-cloud-sdk-core-5.4.2.tgz",
-      "integrity": "sha512-c4cwOuUDbMiFROYM/Ti1aC+Umi1v3TdvC2DO5zR7w44FYY/3xrs79+3DVPXt/nRhJeaMHN2L9XwlXsPSoVDHJA==",
+      "integrity": "sha512-5VFkKYU/vSIWFJTVt392XEdPmiEwUJqhxjn1MRO3lfELyU2FB+yYi8brbmXUgq+D1acHR1fpS7tIJ6IlnrR9Cg==",
       "license": "Apache-2.0",
       "dependencies": {
         "@types/debug": "^4.1.12",
         "@types/node": "^18.19.80",
         "@types/tough-cookie": "^4.0.0",
-        "axios": "^1.8.2",
+        "axios": "^1.11.0",
         "camelcase": "^6.3.0",
         "debug": "^4.3.4",
         "dotenv": "^16.4.5",
         "extend": "3.0.2",
         "file-type": "16.5.4",
-        "form-data": "4.0.0",
+        "form-data": "^4.0.4",
         "isstream": "0.1.2",
         "jsonwebtoken": "^9.0.2",
         "mime-types": "2.1.35",
@@ -5393,13 +5400,15 @@
       }
     },
     "node_modules/ibm-cloud-sdk-core/node_modules/form-data": {
-      "version": "4.0.0",
+      "version": "4.0.4",
-      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz",
-      "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
+      "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==",
       "license": "MIT",
       "dependencies": {
         "asynckit": "^0.4.0",
         "combined-stream": "^1.0.8",
+        "es-set-tostringtag": "^2.1.0",
+        "hasown": "^2.0.2",
         "mime-types": "^2.1.12"
       },
       "engines": {

package.json

@@ -34,7 +34,7 @@
     "@jambonz/speech-utils": "^0.2.15",
     "@jambonz/stats-collector": "^0.1.10",
     "@jambonz/time-series": "^0.2.14",
-    "@jambonz/verb-specifications": "^0.0.110",
+    "@jambonz/verb-specifications": "^0.0.111",
     "@modelcontextprotocol/sdk": "^1.9.0",
     "@opentelemetry/api": "^1.8.0",
     "@opentelemetry/exporter-jaeger": "^1.23.0",