support dial translate with s2s services

added speechRecognitionMode in azureOptions as enum

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@jambonz/verb-specifications",
-  "version": "0.0.71",
+  "version": "0.0.95",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@jambonz/verb-specifications",
-      "version": "0.0.71",
+      "version": "0.0.95",
       "license": "MIT",
       "dependencies": {
         "debug": "^4.3.4",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/verb-specifications",
-  "version": "0.0.71",
+  "version": "0.0.95",
   "description": "Jambonz Verb Specification Utilities",
   "main": "index.js",
   "scripts": {

specs.json

@@ -34,6 +34,7 @@
       "id": "string",
       "referTo": "string",
       "referredBy": "string",
+      "referredByDisplayName": "string",
       "headers": "object",
       "actionHook": "object|string",
       "eventHook": "object|string"
@@ -48,8 +49,10 @@
       "synthesizer": "#synthesizer",
       "recognizer": "#recognizer",
       "bargeIn": "#bargeIn",
+      "ttsStream": "#ttsStream",
       "record": "#recordOptions",
       "listen": "#listenOptions",
+      "stream": "#listenOptions",
       "transcribe": "#transcribeOptions",
       "amd": "#amd",
       "fillerNoise": "#fillerNoise",
@@ -59,7 +62,9 @@
       "actionHookDelayAction": "#actionHookDelayAction",
       "sipRequestWithinDialogHook": "object|string",
       "boostAudioSignal": "number|string",
-      "vad":"#vad"
+      "vad":"#vad",
+      "referHook": "object|string",
+      "earlyMedia": "boolean"
     },
     "required": []
   },
@@ -95,6 +100,15 @@
       "enable"
     ]
   },
+  "ttsStream": {
+    "properties": {
+      "enable": "boolean",
+      "synthesizer": "#synthesizer"
+    },
+    "required": [
+      "enable"
+    ]
+  },
   "bargeIn": {
     "properties": {
       "enable": "boolean",
@@ -199,13 +213,14 @@
     "properties": {
       "id": "string",
       "text": "string|array",
+      "stream": "boolean",
       "loop": "number|string",
       "synthesizer": "#synthesizer",
       "earlyMedia": "boolean",
-      "disableTtsCache": "boolean"
+      "disableTtsCache": "boolean",
+      "closeStreamOnEmpty": "boolean"
     },
     "required": [
-      "text"
     ]
   },
   "gather": {
@@ -272,8 +287,10 @@
       "dtmfHook": "object|string",
       "headers": "object",
       "anchorMedia": "boolean",
+      "exitMediaPath": "boolean",
       "boostAudioSignal": "number|string",
       "listen": "#listen",
+      "stream": "#listen",
       "target": ["#target"],
       "timeLimit": "number",
       "timeout": "number",
@@ -281,7 +298,8 @@
       "transcribe": "#transcribe",
       "amd": "#amd",
       "dub": ["#dub"],
-      "tag": "object"
+      "tag": "object",
+      "translate": "#translate"
     },
     "required": [
       "target"
@@ -292,15 +310,17 @@
       "id": "string",
       "credentials": "object|string",
       "project": "string",
+      "agent": "string",
       "environment": "string",
-      "region": {
+      "region": "string",
+      "model": {
         "type": "string",
-        "enum": ["europe-west1", "europe-west2", "australia-southeast1", "asia-northeast1"]
+        "enum": ["es", "cx"]
       },
       "lang": "string",
       "actionHook": "object|string",
       "eventHook": "object|string",
-      "events": "[string]",
+      "events": "array",
       "welcomeEvent": "string",
       "welcomeEventParams": "object",
       "noInputTimeout": "number",
@@ -308,7 +328,8 @@
       "passDtmfAsTextInput": "boolean",
       "thinkingMusic": "string",
       "tts": "#synthesizer",
-      "bargein": "boolean"
+      "bargein": "boolean",
+      "queryInput": "#queryInput"
     },
     "required": [
       "project",
@@ -316,6 +337,16 @@
       "lang"
     ]
   },
+  "queryInput": {
+    "properties": {
+      "text": "string",
+      "intent": "string",
+      "event": "string",
+      "dtmf": "string"
+    },
+    "required": [
+    ]
+  },
   "dtmf": {
     "properties": {
       "id": "string",
@@ -352,6 +383,34 @@
     ]
   },
   "listen": {
+    "properties": {
+      "id": "string",
+      "actionHook": "object|string",
+      "auth": "#auth",
+      "finishOnKey": "string",
+      "maxLength": "number",
+      "metadata": "object",
+      "mixType": {
+        "type": "string",
+        "enum": ["mono", "stereo", "mixed"]
+      },
+      "passDtmf": "boolean",
+      "playBeep": "boolean",
+      "disableBidirectionalAudio": "boolean",
+      "bidirectionalAudio": "#bidirectionalAudio",
+      "sampleRate": "number",
+      "timeout": "number",
+      "transcribe": "#transcribe",
+      "url": "string",
+      "wsAuth": "#auth",
+      "earlyMedia": "boolean",
+      "channel": "number"
+    },
+    "required": [
+      "url"
+    ]
+  },
+  "stream": {
     "properties": {
       "id": "string",
       "actionHook": "object|string",
@@ -378,6 +437,26 @@
       "url"
     ]
   },
+  "llm": {
+    "properties": {
+      "id": "string",
+      "vendor": "string",
+      "model": "string",
+      "auth": "object",
+      "connectOptions": "object",
+      "actionHook": "object|string",
+      "eventHook": "object|string",
+      "toolHook": "object|string",
+      "events": "array",
+      "llmOptions": "object"
+    },
+    "required": [
+      "vendor",
+      "model",
+      "auth",
+      "llmOptions"
+    ]
+  },
   "message": {
     "properties": {
       "id": "string",
@@ -470,7 +549,9 @@
       "timeout": "number",
       "amd": "#amd",
       "dual_streams": "boolean",
-      "sipRequestWithinDialogHook": "string"
+      "sipRequestWithinDialogHook": "string",
+      "referHook": "object|string",
+      "timeLimit": "number"
     },
     "required": [
       "call_hook",
@@ -491,6 +572,7 @@
     "properties": {
       "id": "string",
       "transcriptionHook": "string",
+      "translationHook": "string",
       "recognizer": "#recognizer",
       "earlyMedia": "boolean",
       "channel": "number"
@@ -556,7 +638,7 @@
       "fallbackVoice": "string|object",
       "engine": {
         "type": "string",
-        "enum": ["standard", "neural"]
+        "enum": ["standard", "neural", "generative", "long-form"]
       },
       "gender": {
         "type": "string",
@@ -639,6 +721,7 @@
       "asrDtmfTerminationDigit": "string",
       "asrTimeout": "number",
       "fastRecognitionTimeout": "number",
+      "minConfidence": "number",
       "nuanceOptions": "#nuanceOptions",
       "deepgramOptions": "#deepgramOptions",
       "ibmOptions": "#ibmOptions",
@@ -649,7 +732,9 @@
       "azureOptions": "#azureOptions",
       "assemblyAiOptions": "#assemblyAiOptions",
       "googleOptions": "#googleOptions",
-      "customOptions": "#customOptions"
+      "customOptions": "#customOptions",
+      "verbioOptions": "#verbioOptions",
+      "speechmaticsOptions": "#speechmaticsOptions"
     },
     "required": [
       "vendor"
@@ -659,6 +744,7 @@
     "properties": {
       "authToken": "string",
       "uri": "string",
+      "sampleRate": "number",
       "options": "object"
     },
     "required": [
@@ -690,12 +776,21 @@
   "azureOptions": {
     "properties": {
       "speechSegmentationSilenceTimeoutMs": "number",
+      "postProcessing" : "string",
       "languageIdMode": {
         "type": "string",
         "enum": [
           "AtStart",
           "Continuous"
         ]
+      },
+      "speechRecognitionMode": {
+        "type": "string",
+        "enum": [
+          "CONVERSATION",
+          "DICTATION",
+          "INTERACTIVE"
+        ]
       }
     },
     "required": [
@@ -793,7 +888,8 @@
       "utteranceEndMs": "number",
       "shortUtterance": "boolean",
       "vadTurnoff": "number",
-      "tag": "string"
+      "tag": "string",
+      "fillerWords" : "boolean"
     }
   },
   "sonioxOptions": {
@@ -809,6 +905,111 @@
     "required": [
     ]
   },
+  "verbioOptions": {
+    "properties": {
+      "enable_formatting": "boolean",
+      "enable_diarization": "boolean",
+      "topic": "number",
+      "inline_grammar": "string",
+      "grammar_uri": "string",
+      "label": "string",
+      "recognition_timeout": "number",
+      "speech_complete_timeout": "number",
+      "speech_incomplete_timeout": "number"
+    },
+    "required": [
+    ]
+  },
+  "speechmaticsOptions": {
+    "properties": {
+      "transcription_config": "#sm_transcriptionConfig",
+      "translation_config": "#sm_translationConfig",
+      "audio_events_config_config": "#sm_audioEventsConfig"
+    },
+    "required": [
+    ]
+  },
+  "sm_transcriptionConfig": {
+    "properties": {
+      "language": "string",
+      "domain": "string",
+      "additional_vocab": "array",
+      "diarization": "string",
+      "speaker_diarization_config": "#sm_speakerDiarizationConfig",
+      "enable_partials": "boolean",
+      "max_delay": "number",
+      "max_delay_mode": {
+        "type": "string",
+        "enum": [
+          "fixed",
+          "flexible"
+        ]
+      },
+      "output_locale": "string",
+      "punctuation_overrides": "#sm_puctuationOverrides",
+      "operating_point": "string",
+      "enable_entities": "boolean",
+      "audio_filtering_config": "#sm_audioFilteringConfig",
+      "transcript_filtering_config": "#sm_transcriptFilteringConfig"
+    },
+    "required": [
+    ]
+  },
+  "sm_speakerDiarizationConfig": {
+    "properties": {
+      "speaker_sensitivity": "number",
+      "max_speakers": "number"
+    },
+    "required": [
+    ]
+  },
+  "sm_puctuationOverrides": {
+    "properties": {
+      "permitted_marks": "array",
+      "sensitivity": "number"
+    },
+    "required": [
+    ]
+  },
+  "sm_audioFilteringConfig": {
+    "properties": {
+      "volume_threshold": "number"
+    },
+    "required": [
+      "volume_threshold"
+    ]
+  },
+  "sm_transcriptFilteringConfig": {
+    "properties": {
+      "remove_disfluencies": "boolean"
+    },
+    "required": [
+      "remove_disfluencies"
+    ]
+  },
+  "sm_translationConfig": {
+    "properties": {
+      "target_languages": "array",
+      "enable_partials": "boolean"
+    },
+    "required": [
+      "target_languages"
+    ]
+  },
+  "sm_audioEventsConfig": {
+    "properties": {
+      "types": {
+        "type": "array",
+        "enum": [
+          "applause",
+          "music",
+          "laughter"
+        ]
+      }
+    },
+    "required": [
+    ]
+  },
   "sonioxStorage": {
     "properties": {
       "id": "string",
@@ -980,7 +1181,8 @@
       "noResponseTimeout": "number",
       "noResponseGiveUpTimeout": "number",
       "retries": "number",
-      "actions": "array"
+      "actions": "array",
+      "giveUpActions": "array"
     }
   },
   "bidirectionalAudio" : {
@@ -989,5 +1191,19 @@
       "streaming": "boolean",
       "sampleRate": "number"
     }
+  },
+  "translate": {
+    "properties": {
+      "callerLanguage": "string",
+      "calleeLanguage": "string",
+      "gain": "#gain",
+      "llm": "#llm"
+    }
+  },
+  "gain": {
+    "properties": {
+      "naturalVoice": "string",
+      "translatedVoice": "string"
+    }
   }
 }

test/jambonz-verb-test.js

@@ -81,6 +81,16 @@ test("validate correct verbs", async (t) => {
         }
       }
     },
+    {
+      "verb": "config",
+      "referHook": "https://referhook.com"
+    },
+    {
+      "verb": "config",
+      "referHook": {
+        "url": "https://referhook.com"
+      }
+    },
     {
       "verb": "config",
       "recognizer": {
@@ -129,6 +139,7 @@ test("validate correct verbs", async (t) => {
       "callerName": "Tom",
       "answerOnBridge": true,
       "dtmfCapture": ["*2", "*3"],
+      "timeLimit": 10,
       "dtmfHook": {
         "url": "/dtmf",
         "method": "GET"
@@ -155,7 +166,23 @@ test("validate correct verbs", async (t) => {
           "type": "user",
           "name": "spike@sip.example.com"
         }
-      ]
+      ],
+      "translate": {
+        "callerLanguage": "en-US",
+        "calleeLanguage": "vn-VN",
+        "gain": {
+            "naturalVoice": "-10db",
+            "translatedVoice": "+2dB"
+        },
+        "llm": {
+          "model": 'openai',
+          "vendor": "openai",
+          "auth": {
+            "apiKey": "API key"
+          },
+          "llmOptions": {}
+        }
+      }
     },
     {
       "verb": "dialogflow",
@@ -228,6 +255,31 @@ test("validate correct verbs", async (t) => {
         }
       }
     },
+    {
+      "verb": "gather",
+      "actionHook": "http://example.com/collect",
+      "input": ["digits", "speech"],
+      "bargein": true,
+      "dtmfBargein": true,
+      "finishOnKey": "#",
+      "numDigits": 5,
+      "timeout": 8,
+      "recognizer": {
+        "vendor": "verbio",
+        "language": "en-US",
+        "verbioOptions": {
+          "enable_formatting": true,
+          "enable_diarization": true,
+          "topic": 0,
+          "inline_grammar": "this is inline grammar",
+          "grammar_uri": "https://grammar_uri.com",
+          "label": "label",
+          "recognition_timeout": 500,
+          "speech_complete_timeout": 500,
+          "speech_incomplete_timeout": 500,
+        }
+      },
+    },
     {
       "verb": "gather",
       "actionHook": "http://example.com/collect",
@@ -405,6 +457,12 @@ test("validate correct verbs", async (t) => {
       "referTo": "+15083084809",
       "actionHook": "/action"
     },
+    {
+      "verb": "sip:refer",
+      "referTo": "+15083084809",
+      "referredByDisplayName": "Alice",
+      "actionHook": "/action"
+    },
     {
       "verb": "tag",
       "data": {
@@ -422,6 +480,17 @@ test("validate correct verbs", async (t) => {
         "interim": true
       }
     },
+    {
+      "verb": "transcribe",
+      "transcriptionHook": "http://example.com/transcribe",
+      "recognizer": {
+        "vendor": "nvidia",
+        "language" : "en-US",
+        "customOptions": {
+          "sampleRate": 16000
+        }
+      }
+    },
     {
       "verb": "transcribe",
       "transcriptionHook": "http://example.com/transcribe",
@@ -466,7 +535,8 @@ test("validate correct verbs", async (t) => {
         "actionHook": "/answeringMachineDetection",
     
       },
-      "dual_streams": true
+      "dual_streams": true,
+      "timeLimit" : 10
     }
   ];
   try {