0.0.101

* add openai STT options

* wip

* allow apikey passed as param for openai stt

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/verb-specifications",
-  "version": "0.0.91",
+  "version": "0.0.101",
   "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

@@ -52,6 +52,7 @@
       "ttsStream": "#ttsStream",
       "record": "#recordOptions",
       "listen": "#listenOptions",
+      "stream": "#listenOptions",
       "transcribe": "#transcribeOptions",
       "amd": "#amd",
       "fillerNoise": "#fillerNoise",
@@ -289,6 +290,7 @@
       "exitMediaPath": "boolean",
       "boostAudioSignal": "number|string",
       "listen": "#listen",
+      "stream": "#listen",
       "target": ["#target"],
       "timeLimit": "number",
       "timeout": "number",
@@ -380,6 +382,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",
@@ -703,7 +733,8 @@
       "googleOptions": "#googleOptions",
       "customOptions": "#customOptions",
       "verbioOptions": "#verbioOptions",
-      "speechmaticsOptions": "#speechmaticsOptions"
+      "speechmaticsOptions": "#speechmaticsOptions",
+      "openaiOptions": "#openaiOptions"
     },
     "required": [
       "vendor"
@@ -752,6 +783,14 @@
           "AtStart",
           "Continuous"
         ]
+      },
+      "speechRecognitionMode": {
+        "type": "string",
+        "enum": [
+          "CONVERSATION",
+          "DICTATION",
+          "INTERACTIVE"
+        ]
       }
     },
     "required": [
@@ -826,6 +865,7 @@
       "version": "string",
       "punctuate": "boolean",
       "smartFormatting": "boolean",
+      "noDelay": "boolean",
       "profanityFilter": "boolean",
       "redact": {
         "type": "string",
@@ -845,11 +885,13 @@
       "search": "array",
       "replace": "array",
       "keywords": "array",
+      "keyterms": "array",
       "endpointing": "boolean | number",
       "utteranceEndMs": "number",
       "shortUtterance": "boolean",
       "vadTurnoff": "number",
-      "tag": "string"
+      "tag": "string",
+      "fillerWords" : "boolean"
     }
   },
   "sonioxOptions": {
@@ -880,6 +922,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",
@@ -892,6 +988,7 @@
   "sm_transcriptionConfig": {
     "properties": {
       "language": "string",
+      "domain": "string",
       "additional_vocab": "array",
       "diarization": "string",
       "speaker_diarization_config": "#sm_speakerDiarizationConfig",
@@ -1119,6 +1216,7 @@
     "properties": {
       "actionHook": "object|string",
       "thresholdWordCount": "number",
+      "digitCount": "number",
       "timers": "#amdTimers",
       "recognizer": "#recognizer"
     },

test/jambonz-verb-test.js

@@ -205,7 +205,8 @@ test("validate correct verbs", async (t) => {
         "hintsBoost": 10,
         "fastRecognitionTimeout": 2000,
         "deepgramOptions": {
-          "endpointing": 500
+          "endpointing": 500,
+          "noDelay": true,
         }
       },
       "say": {