add statusHook to redirect

* support houndify stt

* add testcase

* wip

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/verb-specifications",
-  "version": "0.0.86",
+  "version": "0.0.123",
   "description": "Jambonz Verb Specification Utilities",
   "main": "index.js",
   "scripts": {
@@ -20,7 +20,7 @@
   "devDependencies": {
     "eslint": "^7.32.0",
     "eslint-plugin-promise": "^4.3.1",
-    "tape": "^5.6.1"
+    "tape": "^5.7.5"
   },
   "dependencies": {
     "debug": "^4.3.4",

specs.json

@@ -1,4 +1,13 @@
 {
+  "alert" : {
+    "properties": {
+      "id": "string",
+      "message": "string"
+    },
+    "required": [
+      "message"
+    ]
+  },
   "answer": {
     "properties": {
       "id": "string"
@@ -34,6 +43,7 @@
       "id": "string",
       "referTo": "string",
       "referredBy": "string",
+      "referredByDisplayName": "string",
       "headers": "object",
       "actionHook": "object|string",
       "eventHook": "object|string"
@@ -48,19 +58,25 @@
       "synthesizer": "#synthesizer",
       "recognizer": "#recognizer",
       "bargeIn": "#bargeIn",
+      "ttsStream": "#ttsStream",
       "record": "#recordOptions",
       "listen": "#listenOptions",
+      "stream": "#listenOptions",
       "transcribe": "#transcribeOptions",
       "amd": "#amd",
       "fillerNoise": "#fillerNoise",
       "notifyEvents": "boolean",
+      "notifySttLatency": "boolean",
       "reset": "string|array",
       "onHoldMusic": "string",
       "actionHookDelayAction": "#actionHookDelayAction",
       "sipRequestWithinDialogHook": "object|string",
       "boostAudioSignal": "number|string",
       "vad":"#vad",
-      "referHook": "object|string"
+      "referHook": "object|string",
+      "earlyMedia": "boolean",
+      "autoStreamTts": "boolean",
+      "disableTtsCache": "boolean"
     },
     "required": []
   },
@@ -96,6 +112,15 @@
       "enable"
     ]
   },
+  "ttsStream": {
+    "properties": {
+      "enable": "boolean",
+      "synthesizer": "#synthesizer"
+    },
+    "required": [
+      "enable"
+    ]
+  },
   "bargeIn": {
     "properties": {
       "enable": "boolean",
@@ -200,13 +225,15 @@
     "properties": {
       "id": "string",
       "text": "string|array",
+      "instructions": "string",
+      "stream": "boolean",
       "loop": "number|string",
       "synthesizer": "#synthesizer",
       "earlyMedia": "boolean",
-      "disableTtsCache": "boolean"
+      "disableTtsCache": "boolean",
+      "closeStreamOnEmpty": "boolean"
     },
     "required": [
-      "text"
     ]
   },
   "gather": {
@@ -252,7 +279,8 @@
       "statusEvents": "array",
       "statusHook": "object|string",
       "enterHook": "object|string",
-      "record": "#record"
+      "record": "#record",
+      "distributeDtmf": "boolean"
     },
     "required": [
       "name"
@@ -276,6 +304,7 @@
       "exitMediaPath": "boolean",
       "boostAudioSignal": "number|string",
       "listen": "#listen",
+      "stream": "#listen",
       "target": ["#target"],
       "timeLimit": "number",
       "timeout": "number",
@@ -283,7 +312,8 @@
       "transcribe": "#transcribe",
       "amd": "#amd",
       "dub": ["#dub"],
-      "tag": "object"
+      "tag": "object",
+      "forwardPAI": "boolean"
     },
     "required": [
       "target"
@@ -367,6 +397,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",
@@ -400,6 +458,7 @@
       "model": "string",
       "auth": "object",
       "connectOptions": "object",
+      "mcpServers": ["#mcpServer"],
       "actionHook": "object|string",
       "eventHook": "object|string",
       "toolHook": "object|string",
@@ -408,11 +467,19 @@
     },
     "required": [
       "vendor",
-      "model",
-      "auth",
       "llmOptions"
     ]
   },
+  "mcpServer": {
+    "properties": {
+      "url": "string",
+      "auth": "object",
+      "roots": ["#root"]
+    },
+    "required": [
+      "url"
+    ]
+  },
   "message": {
     "properties": {
       "id": "string",
@@ -467,6 +534,11 @@
         "type": "string",
         "enum": ["startCallRecording", "stopCallRecording", "pauseCallRecording", "resumeCallRecording"]
       },
+      "type" : {
+        "type" : "string",
+        "enum" : ["cloud", "siprec"]
+
+      },
       "recordingID": "string",
       "siprecServerURL": "string|array",
       "headers": "object"
@@ -478,7 +550,8 @@
   "redirect": {
     "properties": {
       "id": "string",
-      "actionHook": "object|string"
+      "actionHook": "object|string",
+      "statusHook": "object|string"
     },
     "required": [
       "actionHook"
@@ -506,7 +579,8 @@
       "amd": "#amd",
       "dual_streams": "boolean",
       "sipRequestWithinDialogHook": "string",
-      "referHook": "object|string"
+      "referHook": "object|string",
+      "timeLimit": "number"
     },
     "required": [
       "call_hook",
@@ -533,7 +607,6 @@
       "channel": "number"
     },
     "required": [
-      "transcriptionHook"
     ]
   },
   "target": {
@@ -689,7 +762,11 @@
       "googleOptions": "#googleOptions",
       "customOptions": "#customOptions",
       "verbioOptions": "#verbioOptions",
-      "speechmaticsOptions": "#speechmaticsOptions"
+      "speechmaticsOptions": "#speechmaticsOptions",
+      "openaiOptions": "#openaiOptions",
+      "houndifyOptions": "#houndifyOptions",
+      "gladiaOptions": "object",
+      "elevenlabsOptions": "#elevenlabsOptions"
     },
     "required": [
       "vendor"
@@ -732,12 +809,21 @@
     "properties": {
       "speechSegmentationSilenceTimeoutMs": "number",
       "postProcessing" : "string",
+      "audioLogging" : "boolean",
       "languageIdMode": {
         "type": "string",
         "enum": [
           "AtStart",
           "Continuous"
         ]
+      },
+      "speechRecognitionMode": {
+        "type": "string",
+        "enum": [
+          "CONVERSATION",
+          "DICTATION",
+          "INTERACTIVE"
+        ]
       }
     },
     "required": [
@@ -759,6 +845,61 @@
       "transcriptNormalization": "array"
     }
   },
+  "houndifyOptions": {
+    "properties": {
+      "requestInfo": "object",
+      "sampleRate": "number",
+      "latitude": "number",
+      "longitude": "number",
+      "city": "string",
+      "state": "string",
+      "country": "string",
+      "timeZone": "string",
+      "domain": "string",
+      "audioEndpoint": "string",
+      "maxSilenceSeconds": "number",
+      "maxSilenceAfterFullQuerySeconds": "number",
+      "maxSilenceAfterPartialQuerySeconds": "number",
+      "vadSensitivity": "number",
+      "vadTimeout": "number",
+      "vadMode": "string",
+      "vadVoiceMs": "number",
+      "vadSilenceMs": "number",
+      "vadDebug": "boolean",
+      "audioFormat": "string",
+      "enableNoiseReduction": "boolean",
+      "enableProfanityFilter": "boolean",
+      "enablePunctuation": "boolean",
+      "enableCapitalization": "boolean",
+      "confidenceThreshold": "number",
+      "enableDisfluencyFilter": "boolean",
+      "maxResults": "number",
+      "enableWordTimestamps": "boolean",
+      "maxAlternatives": "number",
+      "partialTranscriptInterval": "number",
+      "sessionTimeout": "number",
+      "connectionTimeout": "number",
+      "customVocabulary": "array",
+      "languageModel": "string"
+    }
+  },
+  "elevenlabsOptions": {
+    "properties": {
+      "includeTimestamps": "boolean",
+      "commitStrategy": {
+        "type": "string",
+        "enum": [
+          "manual",
+          "vad"
+        ]
+      },
+      "vadSilenceThresholdSecs": "number",
+      "vadThreshold": "number",
+      "minSpeechDurationMs": "number",
+      "minSilenceDurationMs": "number",
+      "enableLogging": "boolean"
+    }
+  },
   "cobaltOptions": {
     "properties": {
       "serverUri": "string",
@@ -812,6 +953,7 @@
       "version": "string",
       "punctuate": "boolean",
       "smartFormatting": "boolean",
+      "noDelay": "boolean",
       "profanityFilter": "boolean",
       "redact": {
         "type": "string",
@@ -831,11 +973,18 @@
       "search": "array",
       "replace": "array",
       "keywords": "array",
+      "keyterms": "array",
       "endpointing": "boolean | number",
       "utteranceEndMs": "number",
       "shortUtterance": "boolean",
       "vadTurnoff": "number",
-      "tag": "string"
+      "tag": "string",
+      "fillerWords" : "boolean",
+      "eotThreshold": "number",
+      "eotTimeoutMs": "number",
+      "mipOptOut": "boolean",
+      "entityPrompt": "string",
+      "eagerEotThreshold":"number"
     }
   },
   "sonioxOptions": {
@@ -866,6 +1015,60 @@
     "required": [
     ]
   },
+  "openaiOptions": {
+    "properties": {
+      "apiKey": "string",
+      "model": "string",
+      "prompt": "string",
+      "promptTemplates": "#promptTemplates",
+      "language": "string",
+      "input_audio_noise_reduction": {
+        "type": "string",
+        "enum": [
+          "near_field",
+          "far_field"
+        ]
+      },
+      "turn_detection": "#turnDetection"
+    },
+    "required": [
+    ]
+  },
+  "promptTemplates": {
+    "properties": {
+      "hintsTemplate": "string",
+      "conversationHistoryTemplate": "string"
+    },
+    "required": [
+    ]
+  },
+  "turnDetection": {
+    "properties": {
+      "type": {
+        "type": "string",
+        "enum": [
+          "none",
+          "server_vad",
+          "semantic_vad"
+        ]
+      },
+      "eagerness": {
+        "type": "string",
+        "enum": [
+          "low",
+          "medium",
+          "high",
+          "auto"
+        ]
+      },
+      "threshold": "number",
+      "prefix_padding_ms": "number",
+      "silence_duration_ms": "number"
+    },
+    "required": [
+      "type"
+    ]
+  },
   "speechmaticsOptions": {
     "properties": {
       "transcription_config": "#sm_transcriptionConfig",
@@ -878,6 +1081,7 @@
   "sm_transcriptionConfig": {
     "properties": {
       "language": "string",
+      "domain": "string",
       "additional_vocab": "array",
       "diarization": "string",
       "speaker_diarization_config": "#sm_speakerDiarizationConfig",
@@ -1014,7 +1218,18 @@
   },
   "assemblyAiOptions": {
     "properties": {
-      "apiKey": "string"
+      "apiKey": "string",
+      "serviceVersion": {
+        "type": "string",
+        "enum": [
+          "v2",
+          "v3"
+        ]
+      },
+      "formatTurns": "boolean",
+      "endOfTurnConfidenceThreshold": "number",
+      "minEndOfTurnSilenceWhenConfident": "number",
+      "maxTurnSilence": "number"
     }
   },
   "resource": {
@@ -1095,16 +1310,25 @@
       "voiceMs": "number",
       "silenceMs": "number",
       "strategy": "string",
-      "mode": "number"
+      "mode": "number",
+      "vendor": {
+        "type": "string",
+        "enum": [
+          "webrtc",
+          "silero"
+        ]
+      },
+      "threshold": "number",
+      "speechPadMs": "number"
     },
     "required": [
-      "enable"
     ]
   },
   "amd": {
     "properties": {
       "actionHook": "object|string",
       "thresholdWordCount": "number",
+      "digitCount": "number",
       "timers": "#amdTimers",
       "recognizer": "#recognizer"
     },
@@ -1136,5 +1360,36 @@
       "streaming": "boolean",
       "sampleRate": "number"
     }
+  },
+  "pipeline": {
+    "properties": {
+      "id": "string",
+      "stt": "#recognizer",
+      "tts": "#synthesizer",
+      "vad": "#vad",
+      "turnDetection": "#turnDetectionPipeline",
+      "llm": "#llm",
+      "preflightLlm": "boolean",
+      "actionHook": "object|string",
+      "eventHook": "object|string"
+    },
+    "required": [
+      "stt",
+      "llm",
+      "tts"
+    ]
+  },
+  "turnDetectionPipeline": {
+    "properties": {
+      "vendor": {
+        "type": "string",
+        "enum": ["krisp"]
+      },
+      "threshold": "number",
+      "eagerEotThreshold": "number"
+    },
+    "required": [
+      "vendor"
+    ]
   }
 }

test/jambonz-verb-test.js

@@ -72,12 +72,18 @@ test("validate correct verbs", async (t) => {
     },
     {
       "verb": "config",
+      "notifySttLatency": true,
       "recognizer": {
         "vendor": "google",
         "language": "de-DE",
         "label": "label1",
         "assemblyAiOptions": {
-          "apiKey": "apikey"
+          "apiKey": "apikey",
+          "serviceVersion": "v3",
+          "formatTurns": true,
+          "endOfTurnConfidenceThreshold": 0.5,
+          "minEndOfTurnSilenceWhenConfident": 500,
+          "maxTurnSilence": 2000
         }
       }
     },
@@ -139,6 +145,7 @@ test("validate correct verbs", async (t) => {
       "callerName": "Tom",
       "answerOnBridge": true,
       "dtmfCapture": ["*2", "*3"],
+      "timeLimit": 10,
       "dtmfHook": {
         "url": "/dtmf",
         "method": "GET"
@@ -204,7 +211,12 @@ test("validate correct verbs", async (t) => {
         "hintsBoost": 10,
         "fastRecognitionTimeout": 2000,
         "deepgramOptions": {
-          "endpointing": 500
+          "endpointing": 500,
+          "noDelay": true,
+          "eotThreshold": 500,
+          "eotTimeoutMs": 5000,
+          "eagerEotThreshold": 200,
+          "mipOptOut": true
         }
       },
       "say": {
@@ -219,6 +231,10 @@ test("validate correct verbs", async (t) => {
           "fallbackVoice": "voice"
         }
       },
+      "say": {
+        "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
+        "instructions": "Voice: High-energy, upbeat, and encouraging, projecting enthusiasm and motivation."
+      },
       "say": {
         "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
         "synthesizer": {
@@ -263,6 +279,69 @@ 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": "houndify",
+        "language": "en-US",
+        "houndifyOptions": {
+          "requestInfo": {
+            "Latitude": 30.6,
+            "Longitude": 30.6,
+            "City": "Huston"
+          },
+          "sampleRate": 16000,
+          "latitude": 30.6,
+          "longitude": 30.6,
+          "city": "Huston",
+          "state": "CA",
+          "country": "US",
+          "timeZone": "GMT",
+          "domain": "Voice",
+          "audioEndpoint": "https://api.houndify.com/v1/audio",
+          "maxSilenceSeconds": 5,
+          "maxSilenceAfterFullQuerySeconds": 3,
+          "maxSilenceAfterPartialQuerySeconds": 2,
+          "vadSensitivity": 0.5,
+          "vadTimeout": 1000,
+          "vadMode": "auto",
+          "vadVoiceMs": 250,
+          "vadSilenceMs": 500,
+          "vadDebug": true,
+          "audioFormat": "PCM16",
+          "enableNoiseReduction": true,
+          "enableProfanityFilter": false,
+          "enablePunctuation": true,
+          "enableCapitalization": true,
+          "confidenceThreshold": 0.7,
+          "enableDisfluencyFilter": true,
+          "maxResults": 5,
+          "enableWordTimestamps": true,
+          "maxAlternatives": 3,
+          "partialTranscriptInterval": 100,
+          "sessionTimeout": 30000,
+          "connectionTimeout": 5000,
+          "customVocabulary": ["jambonz", "telephony", "voip"],
+          "languageModel": "enhanced"
+        },
+        "gladiaOptions": {
+          "post_processing": {
+            "summarization": false,
+            "summarization_config": {
+              "type": "general"
+            },
+            "chapterization": false
+          },
+        }
+      },
+    },
     {
       "verb": "gather",
       "actionHook": "http://example.com/collect",
@@ -372,6 +451,10 @@ test("validate correct verbs", async (t) => {
        }
       }
     },
+    {
+      "verb": "config",
+      "autoStreamTts": true
+    },
     {
       "verb": "config",
       "vad": {
@@ -379,7 +462,10 @@ test("validate correct verbs", async (t) => {
         "voiceMs": 250,
         "silenceMs": 150,
         "strategy": "one-shot",
-        "mode": 2
+        "mode": 2,
+        "vendor": "webrtc",
+        "threshold": 0.5,
+        "speechPadMs": 1000
       }
     },
     {
@@ -440,6 +526,12 @@ test("validate correct verbs", async (t) => {
       "referTo": "+15083084809",
       "actionHook": "/action"
     },
+    {
+      "verb": "sip:refer",
+      "referTo": "+15083084809",
+      "referredByDisplayName": "Alice",
+      "actionHook": "/action"
+    },
     {
       "verb": "tag",
       "data": {
@@ -457,6 +549,24 @@ test("validate correct verbs", async (t) => {
         "interim": true
       }
     },
+    {
+      "verb": "transcribe",
+      "transcriptionHook": "http://example.com/transcribe",
+      "recognizer": {
+        "vendor": "nvidia",
+        "language" : "en-US",
+        "interim": true,
+        "elevenlabsOptions": {
+          "includeTimestamps": true,
+          "commitStrategy": "vad",
+          "vadSilenceThresholdSecs": 0.8,
+          "vadThreshold": 0.5,
+          "minSpeechDurationMs": 300,
+          "minSilenceDurationMs": 500,
+          "enableLogging": false
+        }
+      }
+    },
     {
       "verb": "transcribe",
       "transcriptionHook": "http://example.com/transcribe",
@@ -512,7 +622,28 @@ test("validate correct verbs", async (t) => {
         "actionHook": "/answeringMachineDetection",
     
       },
-      "dual_streams": true
+      "dual_streams": true,
+      "timeLimit" : 10
+    },
+    {
+      "verb": "llm",
+      "vendor": 'ultravox',
+      "model": 'fixie-ai/ultravox',
+      "auth": {
+        "apiKey": "sk-1234567890abcdefg"
+      },
+      "llmOptions": {
+        "firstSpeaker": 'FIRST_SPEAKER_AGENT',
+      },
+      "mcpServers": [
+        {
+          "url": 'https://mcp.example.com',
+          "auth": {
+            "username": 'username',
+            "password": 'password'
+          }
+        }
+      ]
     }
   ];
   try {