0.0.126

* support houndify stt

* add testcase

* wip

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 jambonz
+Copyright (c) 2023 Drachtio Communications Services, LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# verb-specificiations
+# verb-specifications
 Jambonz Verb Specification Utilities
 
 #### Running the test suite

index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ...require('./jambonz-app-json-validation'),
+  specs: require('./specs')
+};

jambonz-app-json-validation.js

@@ -1,4 +1,5 @@
 const assert = require('assert');
+const debug = require('debug')('jambonz:app-json-validation');
 const _specData = require('./specs');
 const specs = new Map();
 for (const key in _specData) { specs.set(key, _specData[key]); }
@@ -30,7 +31,7 @@ function normalizeJambones(logger, obj) {
       throw new Error('malformed jambonz payload: missing verb property');
     }
   }
-  logger.debug({ document }, `normalizeJambones: returning document with ${document.length} tasks`);
+  debug({ document }, `normalizeJambones: returning document with ${document.length} tasks`);
   return document;
 }
 
@@ -44,7 +45,7 @@ function validate(logger, obj) {
 }
 
 function validateVerb(name, data, logger) {
-  logger.debug(`validating ${name} with data ${JSON.stringify(data)}`);
+  debug(`validating ${name} with data ${JSON.stringify(data)}`);
   // validate the instruction is supported
   if (!specs.has(name)) throw new Error(`invalid instruction: ${name}`);
 
@@ -55,9 +56,10 @@ function validateVerb(name, data, logger) {
     if (dKey in specData.properties) {
       const dVal = data[dKey];
       const dSpec = specData.properties[dKey];
-      logger.debug(`Task:validate validating property ${dKey} with value ${JSON.stringify(dVal)}`);
+      debug(`Task:validate validating property ${dKey} with value ${JSON.stringify(dVal)}`);
 
-      if (typeof dSpec === 'string' && dSpec === 'array') {
+      if (typeof dVal === 'undefined') continue;
+      else if (typeof dSpec === 'string' && dSpec === 'array') {
         if (!Array.isArray(dVal)) throw new Error(`${name}: property ${dKey} is not an array`);
       }
       else if (typeof dSpec === 'string' && dSpec.includes('|')) {
@@ -110,4 +112,4 @@ function validateVerb(name, data, logger) {
   if (required.length > 0) throw new Error(`${name}: missing value for ${required}`);
 }
 
-module.exports = { normalizeJambones, validate };
+module.exports = { normalizeJambones, validate, validateVerb };

package.json

@@ -1,12 +1,11 @@
 {
-  "name": "verb-specifications",
+  "name": "@jambonz/verb-specifications",
-  "version": "0.0.1",
+  "version": "0.0.126",
   "description": "Jambonz Verb Specification Utilities",
   "main": "index.js",
   "scripts": {
     "test": "node test/",
     "jslint": "eslint index.js"
-
   },
   "repository": {
     "type": "git",
@@ -21,9 +20,10 @@
   "devDependencies": {
     "eslint": "^7.32.0",
     "eslint-plugin-promise": "^4.3.1",
-    "tape": "^5.6.1"
+    "tape": "^5.7.5"
   },
   "dependencies": {
+    "debug": "^4.3.4",
     "pino": "^8.8.0"
   }
 }

specs.json

@@ -1,4 +1,20 @@
 {
+  "alert" : {
+    "properties": {
+      "id": "string",
+      "message": "string"
+    },
+    "required": [
+      "message"
+    ]
+  },
+  "answer": {
+    "properties": {
+      "id": "string"
+    },
+    "required": [
+    ]
+  },
   "sip:decline": {
     "properties": {
       "id": "string",
@@ -27,6 +43,7 @@
       "id": "string",
       "referTo": "string",
       "referredBy": "string",
+      "referredByDisplayName": "string",
       "headers": "object",
       "actionHook": "object|string",
       "eventHook": "object|string"
@@ -41,13 +58,38 @@
       "synthesizer": "#synthesizer",
       "recognizer": "#recognizer",
       "bargeIn": "#bargeIn",
+      "ttsStream": "#ttsStream",
       "record": "#recordOptions",
       "listen": "#listenOptions",
+      "stream": "#listenOptions",
+      "transcribe": "#transcribeOptions",
       "amd": "#amd",
-      "notifyEvents": "boolean"
+      "fillerNoise": "#fillerNoise",
+      "notifyEvents": "boolean",
+      "notifySttLatency": "boolean",
+      "reset": "string|array",
+      "onHoldMusic": "string",
+      "actionHookDelayAction": "#actionHookDelayAction",
+      "sipRequestWithinDialogHook": "object|string",
+      "boostAudioSignal": "number|string",
+      "vad":"#vad",
+      "referHook": "object|string",
+      "earlyMedia": "boolean",
+      "autoStreamTts": "boolean",
+      "disableTtsCache": "boolean"
     },
     "required": []
   },
+  "fillerNoise": {
+    "properties": {
+      "enable": "boolean",
+      "url": "string",
+      "startDelaySecs": "number"
+    },
+    "required": [
+      "enable"
+    ]
+  },
   "listenOptions": {
     "properties": {
       "enable": "boolean",
@@ -58,7 +100,22 @@
         "type": "string",
         "enum": ["mono", "stereo", "mixed"]
       },
-      "metadata": "object"
+      "metadata": "object",
+      "maxLength": "number",
+      "passDtmf": "boolean",
+      "playBeep": "boolean",
+      "disableBidirectionalAudio": "boolean",
+      "bidirectionalAudio": "#bidirectionalAudio",
+      "timeout": "number"
+    },
+    "required": [
+      "enable"
+    ]
+  },
+  "ttsStream": {
+    "properties": {
+      "enable": "boolean",
+      "synthesizer": "#synthesizer"
     },
     "required": [
       "enable"
@@ -69,6 +126,7 @@
       "enable": "boolean",
       "sticky": "boolean",
       "actionHook": "object|string",
+      "partialResultHook": "object|string",
       "input": "array",
       "finishOnKey": "string",
       "numDigits": "number",
@@ -82,13 +140,42 @@
       "enable"
     ]
   },
+  "transcribeOptions": {
+    "properties": {
+      "enable": "boolean",
+      "transcriptionHook": "string",
+      "recognizer": "#recognizer"
+    },
+    "required": [
+      "enable"
+    ]
+  },
+  "dub": {
+    "properties": {
+      "id": "string",
+      "action": {
+        "type": "string",
+        "enum": ["addTrack", "removeTrack", "silenceTrack", "playOnTrack", "sayOnTrack"]
+      },
+      "track": "string",
+      "play": "string",
+      "say": "string|object",
+      "loop": "boolean",
+      "gain": "number|string"
+    },
+    "required": [
+      "action",
+      "track"
+    ]
+  },
   "dequeue": {
     "properties": {
       "id": "string",
       "name": "string",
       "actionHook": "object|string",
       "timeout": "number",
-      "beep": "boolean"
+      "beep": "boolean",
+      "callSid": "string"
     },
     "required": [
       "name"
@@ -100,6 +187,7 @@
       "name": "string",
       "actionHook": "object|string",
       "waitHook": "object|string",
+      "priority": "number",
       "_": "object"
     },
     "required": [
@@ -137,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": {
@@ -165,7 +255,9 @@
       "timeout": "number",
       "recognizer": "#recognizer",
       "play": "#play",
-      "say": "#say"
+      "say": "#say",
+      "fillerNoise": "#fillerNoise",
+      "actionHookDelayAction": "#actionHookDelayAction"
     },
     "required": [
     ]
@@ -175,8 +267,11 @@
       "id": "string",
       "name": "string",
       "beep": "boolean",
+      "memberTag": "string",
+      "speakOnlyTo": "string",
       "startConferenceOnEnter": "boolean",
       "endConferenceOnExit": "boolean",
+      "endConferenceDuration": "number",
       "maxParticipants": "number",
       "joinMuted": "boolean",
       "actionHook": "object|string",
@@ -184,7 +279,9 @@
       "statusEvents": "array",
       "statusHook": "object|string",
       "enterHook": "object|string",
-      "record": "#record"
+      "record": "#record",
+      "listen": "#listen",
+      "distributeDtmf": "boolean"
     },
     "required": [
       "name"
@@ -194,21 +291,30 @@
     "properties": {
       "id": "string",
       "actionHook": "object|string",
+      "onHoldHook": "object|string",
       "answerOnBridge": "boolean",
       "callerId": "string",
+      "callerName": "string",
       "confirmHook": "object|string",
       "referHook": "object|string",
       "dialMusic": "string",
       "dtmfCapture": "object",
       "dtmfHook": "object|string",
       "headers": "object",
+      "anchorMedia": "boolean",
+      "exitMediaPath": "boolean",
+      "boostAudioSignal": "number|string",
       "listen": "#listen",
+      "stream": "#listen",
       "target": ["#target"],
       "timeLimit": "number",
       "timeout": "number",
       "proxy": "string",
       "transcribe": "#transcribe",
-      "amd": "#amd"
+      "amd": "#amd",
+      "dub": ["#dub"],
+      "tag": "object",
+      "forwardPAI": "boolean"
     },
     "required": [
       "target"
@@ -219,15 +325,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",
@@ -235,7 +343,8 @@
       "passDtmfAsTextInput": "boolean",
       "thinkingMusic": "string",
       "tts": "#synthesizer",
-      "bargein": "boolean"
+      "bargein": "boolean",
+      "queryInput": "#queryInput"
     },
     "required": [
       "project",
@@ -243,6 +352,16 @@
       "lang"
     ]
   },
+  "queryInput": {
+    "properties": {
+      "text": "string",
+      "intent": "string",
+      "event": "string",
+      "dtmf": "string"
+    },
+    "required": [
+    ]
+  },
   "dtmf": {
     "properties": {
       "id": "string",
@@ -293,6 +412,35 @@
       "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",
+      "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",
@@ -304,6 +452,35 @@
       "url"
     ]
   },
+  "llm": {
+    "properties": {
+      "id": "string",
+      "vendor": "string",
+      "model": "string",
+      "auth": "object",
+      "connectOptions": "object",
+      "mcpServers": ["#mcpServer"],
+      "actionHook": "object|string",
+      "eventHook": "object|string",
+      "toolHook": "object|string",
+      "events": "array",
+      "llmOptions": "object"
+    },
+    "required": [
+      "vendor",
+      "llmOptions"
+    ]
+  },
+  "mcpServer": {
+    "properties": {
+      "url": "string",
+      "auth": "object",
+      "roots": ["#root"]
+    },
+    "required": [
+      "url"
+    ]
+  },
   "message": {
     "properties": {
       "id": "string",
@@ -358,8 +535,14 @@
         "type": "string",
         "enum": ["startCallRecording", "stopCallRecording", "pauseCallRecording", "resumeCallRecording"]
       },
+      "type" : {
+        "type" : "string",
+        "enum" : ["cloud", "siprec"]
+
+      },
       "recordingID": "string",
-      "siprecServerURL": "string"
+      "siprecServerURL": "string|array",
+      "headers": "object"
     },
     "required": [
       "action"
@@ -368,7 +551,8 @@
   "redirect": {
     "properties": {
       "id": "string",
-      "actionHook": "object|string"
+      "actionHook": "object|string",
+      "statusHook": "object|string"
     },
     "required": [
       "actionHook"
@@ -382,6 +566,7 @@
       "call_hook": "object|string",
       "call_status_hook": "object|string",
       "from": "string",
+      "callerName": "string",
       "fromHost": "string",
       "speech_synthesis_vendor": "string",
       "speech_synthesis_voice": "string",
@@ -391,7 +576,12 @@
       "tag": "object",
       "to": "#target",
       "headers": "object",
-      "timeout": "number"
+      "timeout": "number",
+      "amd": "#amd",
+      "dual_streams": "boolean",
+      "sipRequestWithinDialogHook": "string",
+      "referHook": "object|string",
+      "timeLimit": "number"
     },
     "required": [
       "call_hook",
@@ -412,11 +602,12 @@
     "properties": {
       "id": "string",
       "transcriptionHook": "string",
+      "translationHook": "string",
       "recognizer": "#recognizer",
-      "earlyMedia": "boolean"
+      "earlyMedia": "boolean",
+      "channel": "number"
     },
     "required": [
-      "recognizer"
     ]
   },
   "target": {
@@ -439,7 +630,8 @@
       "vmail": "boolean",
       "tenant": "string",
       "trunk": "string",
-      "overrideTo": "string"
+      "overrideTo": "string",
+      "proxy": "string"
     },
     "required": [
       "type"
@@ -465,20 +657,23 @@
   },
   "synthesizer": {
     "properties": {
-      "vendor": {
+      "vendor": "string",
-        "type": "string",
+      "label": "string",
-        "enum": ["google", "aws", "polly", "microsoft", "nuance", "ibm", "default"]
-      },
       "language": "string",
-      "voice": "string",
+      "voice": "string|object",
+      "fallbackVendor": "string",
+      "fallbackLabel": "string",
+      "fallbackLanguage": "string",
+      "fallbackVoice": "string|object",
       "engine": {
         "type": "string",
-        "enum": ["standard", "neural"]
+        "enum": ["standard", "neural", "generative", "long-form"]
       },
       "gender": {
         "type": "string",
         "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      }
+      },
+      "options": "object"
     },
     "required": [
       "vendor"
@@ -486,11 +681,12 @@
   },
   "recognizer": {
     "properties": {
-      "vendor": {
+      "vendor": "string",
-        "type": "string",
+      "label": "string",
-        "enum": ["google", "aws", "microsoft", "nuance", "deepgram", "ibm", "default"]
-      },
       "language": "string",
+      "fallbackVendor": "string",
+      "fallbackLabel": "string",
+      "fallbackLanguage": "string",
       "vad": "#vad",
       "hints": "array",
       "hintsBoost": "number",
@@ -553,14 +749,183 @@
       "azureSttEndpointId": "string",
       "asrDtmfTerminationDigit": "string",
       "asrTimeout": "number",
+      "fastRecognitionTimeout": "number",
+      "minConfidence": "number",
       "nuanceOptions": "#nuanceOptions",
       "deepgramOptions": "#deepgramOptions",
-      "ibmOptions": "#ibmOptions"
+      "ibmOptions": "#ibmOptions",
+      "nvidiaOptions": "#nvidiaOptions",
+      "sonioxOptions": "#sonioxOptions",
+      "cobaltOptions": "#cobaltOptions",
+      "awsOptions": "#awsOptions",
+      "azureOptions": "#azureOptions",
+      "assemblyAiOptions": "#assemblyAiOptions",
+      "googleOptions": "#googleOptions",
+      "customOptions": "#customOptions",
+      "verbioOptions": "#verbioOptions",
+      "speechmaticsOptions": "#speechmaticsOptions",
+      "openaiOptions": "#openaiOptions",
+      "houndifyOptions": "#houndifyOptions",
+      "gladiaOptions": "object",
+      "elevenlabsOptions": "#elevenlabsOptions"
     },
     "required": [
       "vendor"
     ]
   },
+  "customOptions": {
+    "properties": {
+      "authToken": "string",
+      "uri": "string",
+      "sampleRate": "number",
+      "options": "object"
+    },
+    "required": [
+    ]
+  },
+  "awsOptions": {
+    "properties": {
+      "accessKey": "string",
+      "secretKey": "string",
+      "securityToken": "string",
+      "region": "string",
+      "vocabularyName": "string",
+      "vocabularyFilterName": "string",
+      "vocabularyFilterMethod": {
+        "type": "string",
+        "enum": [
+          "remove",
+          "mask",
+          "tag"
+        ]
+      },
+      "languageModelName": "string",
+      "piiEntityTypes": "array",
+      "piiIdentifyEntities": "boolean"
+    },
+    "required": [
+    ]
+  },
+  "azureOptions": {
+    "properties": {
+      "speechSegmentationSilenceTimeoutMs": "number",
+      "postProcessing" : "string",
+      "audioLogging" : "boolean",
+      "languageIdMode": {
+        "type": "string",
+        "enum": [
+          "AtStart",
+          "Continuous"
+        ]
+      },
+      "speechRecognitionMode": {
+        "type": "string",
+        "enum": [
+          "CONVERSATION",
+          "DICTATION",
+          "INTERACTIVE"
+        ]
+      }
+    },
+    "required": [
+    ]
+  },
+  "googleOptions" : {
+    "properties": {
+      "serviceVersion": {
+        "type": "string",
+        "enum": [
+          "v1",
+          "v2"
+        ]
+      },
+      "recognizerId": "string",
+      "speechStartTimeoutMs": "number",
+      "speechEndTimeoutMs": "number",
+      "enableVoiceActivityEvents": "boolean",
+      "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",
+      "enableConfusionNetwork": "boolean",
+      "metadata": "string",
+      "compiledContextData": "string",
+      "wordTimeOffsets": "boolean",
+      "contextToken": "string"
+    },
+    "required": [
+    ]
+  },
+  "nvidiaOptions": {
+    "properties": {
+      "rivaUri": "string",
+      "maxAlternatives": "number",
+      "profanityFilter": "boolean",
+      "punctuation": "boolean",
+      "wordTimeOffsets": "boolean",
+      "verbatimTranscripts": "boolean",
+      "customConfiguration": "object"
+    },
+    "required": [
+    ]
+  },
   "ibmOptions": {
     "properties": {
       "sttApiKey": "string",
@@ -580,30 +945,16 @@
   },
   "deepgramOptions": {
     "properties": {
+      "deepgramSttUri": "string",
+      "deepgramSttUseTls": "boolean",
       "apiKey": "string",
-      "tier": {
+      "tier": "string",
-        "type": "string",
+      "model": "string",
-        "enum": [
-          "enhanced",
-          "base"
-        ]
-      },
-      "model": {
-        "type": "string",
-        "enum": [
-          "general",
-          "meeting",
-          "phonecall",
-          "voicemail",
-          "finance",
-          "conversationalai",
-          "video",
-          "custom"
-        ]
-      },
       "customModel": "string",
       "version": "string",
       "punctuate": "boolean",
+      "smartFormatting": "boolean",
+      "noDelay": "boolean",
       "profanityFilter": "boolean",
       "redact": {
         "type": "string",
@@ -623,11 +974,212 @@
       "search": "array",
       "replace": "array",
       "keywords": "array",
-      "endpointing": "boolean",
+      "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": {
+    "properties": {
+      "apiKey": "string",
+      "model": "string",
+      "endpointDetection": "boolean",
+      "profanityFilter": "boolean",
+      "speechContext": "string",
+      "clientRequestReference": "string",
+      "storage": "#sonioxStorage"
+    },
+    "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": [
+    ]
+  },
+  "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",
+      "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",
+      "conversation_config": "#sm_conversationConfig",
+      "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_conversationConfig": {
+    "properties": {
+      "end_of_utterance_silence_trigger": "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",
+      "title": "string",
+      "disableStoreAudio": "boolean",
+      "disableStoreTranscript": "boolean",
+      "disableSearch": "boolean",
+      "metadata": "object"
+    },
+    "required": [
+    ]
+  },
   "nuanceOptions": {
     "properties": {
       "clientId": "string",
@@ -673,13 +1225,29 @@
     "required": [
     ]
   },
+  "assemblyAiOptions": {
+    "properties": {
+      "apiKey": "string",
+      "serviceVersion": {
+        "type": "string",
+        "enum": [
+          "v2",
+          "v3"
+        ]
+      },
+      "formatTurns": "boolean",
+      "endOfTurnConfidenceThreshold": "number",
+      "minEndOfTurnSilenceWhenConfident": "number",
+      "maxTurnSilence": "number"
+    }
+  },
   "resource": {
     "properties": {
       "externalReference": "#resourceReference",
       "inlineWordset": "string",
       "builtin": "string",
       "inlineGrammar": "string",
-      "wakeupWord": "[string]",
+      "wakeupWord": "array",
       "weightName": {
         "type": "string",
         "enum": [
@@ -749,16 +1317,27 @@
     "properties": {
       "enable": "boolean",
       "voiceMs": "number",
-      "mode": "number"
+      "silenceMs": "number",
+      "strategy": "string",
+      "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"
     },
@@ -773,5 +1352,53 @@
       "toneTimeoutMs": "number",
       "greetingCompletionTimeoutMs": "number"
     }
+  },
+  "actionHookDelayAction" : {
+    "properties": {
+      "enabled": "boolean",
+      "noResponseTimeout": "number",
+      "noResponseGiveUpTimeout": "number",
+      "retries": "number",
+      "actions": "array",
+      "giveUpActions": "array"
+    }
+  },
+  "bidirectionalAudio" : {
+    "properties": {
+      "enabled": "boolean",
+      "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

@@ -1,6 +1,6 @@
 const test = require('tape');
 const logger = require('pino')({level: process.env.JAMBONES_LOGLEVEL || 'error'});
-const { validate } = require('../jambonz-app-json-validation');
+const { validate } = require('..');
 
 test("validate correct verbs", async (t) => {
 
@@ -24,30 +24,128 @@ test("validate correct verbs", async (t) => {
       "verb": "config",
       "synthesizer": {
         "voice": "Jenny",
-        "vendor": "google"
+        "vendor": "google",
+        "label": "label1"
       },
       "recognizer": {
         "vendor": "google",
-        "language": "de-DE"
+        "language": "de-DE",
+        "label": "label1"
       },
       "bargeIn": {
         "enable": true,
         "input" : ["speech"],
         "actionHook": "/userInput"
+      },
+      "transcribe": {
+        "enable": true,
+        "transcriptionHook": "http://server.com/hook",
+        "recognizer": {
+          "vendor": "google",
+          "language": "de-DE",
+        }
+      },
+      "onHoldMusic": "http://server.com/hold",
+      "actionHookDelayAction": {
+        "enabled": true,
+        "noResponseTimeout": 5,
+        "noResponseGiveUpTimeout": 10,
+        "retries": 3,
+        "actions": [
+          {
+            "verb": "say",
+            "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
+            "synthesizer": {
+              "vendor": "google",
+              "language": "en-US"
+            }
+          },
+          {
+            "verb": "play",
+            "url": "https://example.com/example.mp3",
+            "timeoutSecs": 10,
+            "seekOffset": 8000,
+            "actionHook": "/play/action"
+          }
+        ]
+      }
+    },
+    {
+      "verb": "config",
+      "notifySttLatency": true,
+      "recognizer": {
+        "vendor": "google",
+        "language": "de-DE",
+        "label": "label1",
+        "assemblyAiOptions": {
+          "apiKey": "apikey",
+          "serviceVersion": "v3",
+          "formatTurns": true,
+          "endOfTurnConfidenceThreshold": 0.5,
+          "minEndOfTurnSilenceWhenConfident": 500,
+          "maxTurnSilence": 2000
+        }
+      }
+    },
+    {
+      "verb": "config",
+      "referHook": "https://referhook.com"
+    },
+    {
+      "verb": "config",
+      "referHook": {
+        "url": "https://referhook.com"
+      }
+    },
+    {
+      "verb": "config",
+      "recognizer": {
+        "vendor": "google",
+        "language": "de-DE",
+        "label": "label1",
+        "azureOptions": {
+          "languageIdMode": "Continuous"
+        }
+      }
+    },
+    {
+      "verb": "config",
+      "record": {
+      "action": "startCallRecording",
+      "siprecServerURL": ["sip:srs@recording.example.com","sip:srs@recording.example.com"],
+      "headers" : {
+        "X-Header1": "Value1",
+        "X-Header2": "Value2"
+      }
+      }
+    },
+    {
+      "verb": "config",
+      "sipRequestWithinDialogHook": "https://jambonz.or/sipIndialogActionHook"
+    },
+    {
+      "verb": "config",
+      "record": {
+      "action": "startCallRecording",
+      "siprecServerURL": "sip:srs@recording.example.com"
       }
     },
     {
       "verb": "dequeue",
       "name": "support",
       "beep": true,
-      "timeout": 60
+      "timeout": 60,
+      "callSid": "call_sid1234"
     },
     {
       "verb": "dial",
       "actionHook": "/outdial",
+      "onHoldHook": "/onHoldHook",
       "callerId": "+16173331212",
+      "callerName": "Tom",
       "answerOnBridge": true,
       "dtmfCapture": ["*2", "*3"],
+      "timeLimit": 10,
       "dtmfHook": {
         "url": "/dtmf",
         "method": "GET"
@@ -94,7 +192,8 @@ test("validate correct verbs", async (t) => {
       "verb": "enqueue",
       "name": "support",
       "actionHook": "/queue-action",
-      "waitHook": "/queue-wait"
+      "waitHook": "/queue-wait",
+      "priority": 50
     },
     {
       "verb": "gather",
@@ -109,14 +208,182 @@ test("validate correct verbs", async (t) => {
         "vendor": "google",
         "language": "en-US",
         "hints": ["sales", "support"],
-        "hintsBoost": 10
+        "hintsBoost": 10,
+        "fastRecognitionTimeout": 2000,
+        "deepgramOptions": {
+          "endpointing": 500,
+          "noDelay": true,
+          "eotThreshold": 500,
+          "eotTimeoutMs": 5000,
+          "eagerEotThreshold": 200,
+          "mipOptOut": true
+        }
       },
       "say": {
         "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
         "synthesizer": {
           "vendor": "google",
-          "language": "en-US"
+          "language": "en-US",
+          "label": "label1",
+          "fallbackVendor": "google",
+          "fallbackLanguage": "en-US",
+          "fallbackLabel": "label1",
+          "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": {
+          "vendor": "google",
+          "language": "en-US",
+          "voice": {
+            "reportedUsage":"REALTIME",
+            "model":"path/to/model",
+           },
+          "fallbackVendor": "google",
+          "fallbackLanguage": "en-US",
+          "fallbackLabel": "label1",
+          "fallbackVoice": {
+            "reportedUsage":"REALTIME",
+            "model":"path/to/model",
+           }
+        }
+      }
+    },
+    {
+      "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",
+      "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",
+      "input": ["digits", "speech"],
+      "bargein": true,
+      "dtmfBargein": true,
+      "finishOnKey": "#",
+      "numDigits": 5,
+      "timeout": 8,
+      "recognizer": {
+        "vendor": "google",
+        "language": "en-US",
+        "fallbackVendor": "google",
+        "fallbackLanguage": "en-US",
+        "fallbackLabel": "label1",
+        "hints": ["sales", "support"],
+        "hintsBoost": 10,
+        "deepgramOptions": {
+          "endpointing": true
+        }
+      },
+      "actionHookDelayAction": {
+        "noResponseTimeout": 5,
+        "noResponseGiveUpTimeout": 10,
+        "retries": 3,
+        "actions": [
+          {
+            "verb": "say",
+            "text": "To speak to Sales press 1 or say Sales.  To speak to customer support press 2 or say Support",
+            "synthesizer": {
+              "vendor": "google",
+              "language": "en-US"
+            }
+          },
+          {
+            "verb": "play",
+            "url": "https://example.com/example.mp3",
+            "timeoutSecs": 10,
+            "seekOffset": 8000,
+            "actionHook": "/play/action"
+          }
+        ]
       }
     },
     {
@@ -161,6 +428,46 @@ test("validate correct verbs", async (t) => {
       "url": "wss://myrecorder.example.com/calls",
       "mixType" : "stereo"
     },
+    {
+      "verb": "listen",
+      "url": "wss://myrecorder.example.com/calls",
+      "mixType" : "stereo",
+      "bidirectionalAudio": {
+        enabled: true,
+        streaming: true,
+        sampleRate: 8000
+     }
+    },
+    {
+      "verb": "config",
+      "listen": {
+        "enable": true,
+        "url": "wss://myrecorder.example.com/calls",
+        "mixType" : "stereo",
+        "bidirectionalAudio": {
+          enabled: true,
+          streaming: true,
+          sampleRate: 8000
+       }
+      }
+    },
+    {
+      "verb": "config",
+      "autoStreamTts": true
+    },
+    {
+      "verb": "config",
+      "vad": {
+        "enable": true,
+        "voiceMs": 250,
+        "silenceMs": 150,
+        "strategy": "one-shot",
+        "mode": 2,
+        "vendor": "webrtc",
+        "threshold": 0.5,
+        "speechPadMs": 1000
+      }
+    },
     {
       "verb": "message",
       "to": "15083084809",
@@ -219,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": {
@@ -231,10 +544,124 @@ test("validate correct verbs", async (t) => {
       "verb": "transcribe",
       "transcriptionHook": "http://example.com/transcribe",
       "recognizer": {
-        "vendor": "google",
+        "vendor": "nvidia",
         "language" : "en-US",
         "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",
+      "recognizer": {
+        "vendor": "nvidia",
+        "language" : "en-US",
+        "customOptions": {
+          "sampleRate": 16000
+        }
+      }
+    },
+    {
+      "verb": "transcribe",
+      "transcriptionHook": "http://example.com/transcribe",
+      "recognizer": {
+        "vendor": "nvidia",
+        "language" : "en-US",
+        "interim": true,
+        "googleOptions": {
+          "serviceVersion": "v2",
+          "speechStartTimeoutMs": 500,
+          "speechEndTimeoutMs": 1000,
+          "enableVoiceActivityEvents": true,
+          "transcriptNormalization" : [
+            {
+              "search": "dog",
+              "replace": "cat",
+              "case_sensitive": true
+            }
+          ]
+        }
+      }
+    },
+    {
+      "verb": "rest:dial",
+      "account_sid": "1291964182631236912836123912",
+      "call_hook": {
+        "url": "http://127.0.0.1:3100/",
+        "method": "POST",
+        "username": "username",
+        "password": "password",
+      },
+      "from": "15583084810",
+      "to": {
+        "type": "phone",
+        "number": "15583084809",
+      },
+      "tag": {
+        "customer": "acme",
+        "referenceId": "deadbeef",
+      },
+      "amd": {
+        "actionHook": "/answeringMachineDetection",
+    
+      },
+      "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'
+          }
+        }
+      ]
+    },
+    {
+      "verb": "transcribe",
+      "transcriptionHook": "http://example.com/transcribe",
+      "recognizer": {
+        "vendor": "speechmatics",
+        "language": "en",
+        "speechmaticsOptions": {
+          "transcription_config": {
+            "language": "en",
+            "enable_partials": true,
+            "max_delay": 2,
+            "conversation_config": {
+              "end_of_utterance_silence_trigger": 0.5
+            }
+          }
+        }
+      }
     }
   ];
   try {