mirror of
https://github.com/jambonz/verb-specifications.git
synced 2026-03-24 04:27:54 +00:00
Compare commits
266 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
161695ed43 | ||
|
|
b46cfe0c55 | ||
|
|
6f39ad2e2e | ||
|
|
66b63d8912 | ||
|
|
de5a2fdd1c | ||
|
|
8cb79d47cc | ||
|
|
11a0dce5ba | ||
|
|
ecf59041c5 | ||
|
|
abcb3ffa5d | ||
|
|
f5e7adcf66 | ||
|
|
f29b214208 | ||
|
|
2bf7561980 | ||
|
|
96db93fcdc | ||
|
|
142718104a | ||
|
|
9ac144ef71 | ||
|
|
337114035d | ||
|
|
253bd8a49c | ||
|
|
7a5c094bfc | ||
|
|
228f8773d3 | ||
|
|
c9cd50c559 | ||
|
|
fe095be5c8 | ||
|
|
71caf6bb53 | ||
|
|
887320fd5d | ||
|
|
f0ffdee9c6 | ||
|
|
1013db46d3 | ||
|
|
8771e3f22f | ||
|
|
ff757d3177 | ||
|
|
5745cc9a29 | ||
|
|
2b81fe20f0 | ||
|
|
60a33e11eb | ||
|
|
9717ce6d58 | ||
|
|
49ffe5f526 | ||
|
|
61590b66cc | ||
|
|
d8cf684bf6 | ||
|
|
e039261eb5 | ||
|
|
23e726ed3f | ||
|
|
e1bc5adc55 | ||
|
|
76e2486535 | ||
|
|
dfcf1de210 | ||
|
|
7d19707dec | ||
|
|
b4856e9d05 | ||
|
|
577191ed0d | ||
|
|
ee2ffff20d | ||
|
|
4c5b795498 | ||
|
|
7ecd46393c | ||
|
|
8fffe39195 | ||
|
|
23cb499244 | ||
|
|
fb94dc94cb | ||
|
|
30677b6cd1 | ||
|
|
4ea9cda0f8 | ||
|
|
a0b9f963c2 | ||
|
|
841a471faa | ||
|
|
44112f67b3 | ||
|
|
1f7c98c0ce | ||
|
|
276a55e672 | ||
|
|
840db61042 | ||
|
|
85e1b64ee4 | ||
|
|
8ed54e2d51 | ||
|
|
c24fb7996c | ||
|
|
6c24ad1145 | ||
|
|
af3955cb35 | ||
|
|
1ee29749c3 | ||
|
|
dea57e0910 | ||
|
|
f444a57bcd | ||
|
|
a9a2339821 | ||
|
|
95f3a06625 | ||
|
|
985476e8b1 | ||
|
|
1782db362e | ||
|
|
e654ee9e10 | ||
|
|
38d1d04c4a | ||
|
|
5cbd3886d1 | ||
|
|
de8dfc9202 | ||
|
|
637431468d | ||
|
|
4a817c97b2 | ||
|
|
ce44bf41d4 | ||
|
|
ab84583eff | ||
|
|
13901713b8 | ||
|
|
85fd68af16 | ||
|
|
5a5a397a68 | ||
|
|
b85c7ac743 | ||
|
|
82c6952f70 | ||
|
|
fc95fa3d02 | ||
|
|
6b3ee83d08 | ||
|
|
3700ba6607 | ||
|
|
09a76f44cb | ||
|
|
aa445c1edb | ||
|
|
57887a660c | ||
|
|
e9dace6495 | ||
|
|
762a9639bd | ||
|
|
2740eb9848 | ||
|
|
1a525e7a3e | ||
|
|
f16b49cc23 | ||
|
|
1cc7dae926 | ||
|
|
8c50bf8764 | ||
|
|
e2bffbe0a8 | ||
|
|
4b79b1408b | ||
|
|
900d517b8a | ||
|
|
104ca00a3d | ||
|
|
7b3dd92c18 | ||
|
|
43a2805ea8 | ||
|
|
f9e6755d8d | ||
|
|
264640bbc7 | ||
|
|
71d31952d6 | ||
|
|
6a80506a81 | ||
|
|
85b1c3a2f9 | ||
|
|
f59137ebad | ||
|
|
7b80ba6fd5 | ||
|
|
216e6954af | ||
|
|
027cce284d | ||
|
|
9a8194b360 | ||
|
|
0bcfa783b7 | ||
|
|
9a3fb68fe7 | ||
|
|
f2ea3f3913 | ||
|
|
6a75a8b98a | ||
|
|
2af0fd4415 | ||
|
|
46688934bc | ||
|
|
afce20a206 | ||
|
|
e80679fd07 | ||
|
|
aa86d0b3e6 | ||
|
|
60f4bcd97a | ||
|
|
cb8b51da4a | ||
|
|
d9fd63850b | ||
|
|
e57c81aeed | ||
|
|
610b14736a | ||
|
|
4a8517cab5 | ||
|
|
21bb3c2b73 | ||
|
|
e044621bbc | ||
|
|
6d8ffc9d80 | ||
|
|
941ba6aa8c | ||
|
|
1d8cf321a7 | ||
|
|
0d8b9de099 | ||
|
|
08e01efa7f | ||
|
|
1fdda56c39 | ||
|
|
8db0a91521 | ||
|
|
6432d9e64b | ||
|
|
c029a18c3e | ||
|
|
27b1a06944 | ||
|
|
0f9c096988 | ||
|
|
569b994356 | ||
|
|
9b639a9591 | ||
|
|
6242514b6e | ||
|
|
6f5884f7be | ||
|
|
d5bc910907 | ||
|
|
2f6696bbf8 | ||
|
|
2c19b34922 | ||
|
|
c5d977da50 | ||
|
|
a6f64710c1 | ||
|
|
3463528127 | ||
|
|
030eb5f847 | ||
|
|
f8d07d340a | ||
|
|
8a96b05f23 | ||
|
|
a6a942c1c6 | ||
|
|
85fa4714fb | ||
|
|
d047892fff | ||
|
|
11bb83f703 | ||
|
|
c5a263ee68 | ||
|
|
47f8a593f5 | ||
|
|
c9d2c9aa4d | ||
|
|
1ce577c8c9 | ||
|
|
dc0abfad02 | ||
|
|
1e9285b9d9 | ||
|
|
f3f048d94f | ||
|
|
a737d8bcbb | ||
|
|
c3d69e614e | ||
|
|
9277e053a6 | ||
|
|
954f9479c9 | ||
|
|
58385e791b | ||
|
|
85aaab5856 | ||
|
|
d70324485b | ||
|
|
2cf2c15586 | ||
|
|
f6ad050a32 | ||
|
|
ba02161f74 | ||
|
|
fabf9255ea | ||
|
|
3f1e7cbd3b | ||
|
|
ff6bea3168 | ||
|
|
4ea66245d4 | ||
|
|
faa99cdce3 | ||
|
|
d017e739b1 | ||
|
|
764383cf43 | ||
|
|
3f19ce4a24 | ||
|
|
1e6b24181c | ||
|
|
63aa94a9ec | ||
|
|
d4614c2ad1 | ||
|
|
7da6165b93 | ||
|
|
ad76081fa7 | ||
|
|
ce94e943d2 | ||
|
|
436fb557dc | ||
|
|
203b8600a8 | ||
|
|
b877ca52d0 | ||
|
|
cdb671d25d | ||
|
|
6ae0aff8b1 | ||
|
|
9a2a22dd88 | ||
|
|
369583d536 | ||
|
|
77d203ca80 | ||
|
|
9cb550f49e | ||
|
|
de88976293 | ||
|
|
60efb4b9af | ||
|
|
49ac048477 | ||
|
|
e653a62c49 | ||
|
|
f41aae81c6 | ||
|
|
5707f7d4d4 | ||
|
|
f75871dc46 | ||
|
|
98fa56bd3d | ||
|
|
e1b9abef9e | ||
|
|
22b118534b | ||
|
|
733a4760fe | ||
|
|
3deb8759db | ||
|
|
79cdfc73d4 | ||
|
|
9b7358d6b4 | ||
|
|
4bb25941bf | ||
|
|
42ff6170b6 | ||
|
|
873d8dc0c8 | ||
|
|
992a5fe897 | ||
|
|
6803a3e49d | ||
|
|
2d2145917e | ||
|
|
4fa8d46fd8 | ||
|
|
9690e14f64 | ||
|
|
49752d16ea | ||
|
|
9e141cba6a | ||
|
|
82e2bc5239 | ||
|
|
3a5b053248 | ||
|
|
d74364b1c2 | ||
|
|
213d7596d2 | ||
|
|
3d4df422e1 | ||
|
|
3531711991 | ||
|
|
f860074a24 | ||
|
|
65de44012a | ||
|
|
067a49bd2c | ||
|
|
4967efa745 | ||
|
|
61669e5574 | ||
|
|
e25ef7349e | ||
|
|
26f5609996 | ||
|
|
1a1436b612 | ||
|
|
ba9a9f9b60 | ||
|
|
93c368e894 | ||
|
|
185e4df06e | ||
|
|
c22e8c9cf0 | ||
|
|
1c3d86c807 | ||
|
|
7e986acc17 | ||
|
|
d5c535c02c | ||
|
|
6e819279d1 | ||
|
|
24e73a4dc6 | ||
|
|
cfd367f185 | ||
|
|
f472de9638 | ||
|
|
45a2a039cd | ||
|
|
4a345633a3 | ||
|
|
f14ff2e319 | ||
|
|
c85cb7e67e | ||
|
|
8ccb13f962 | ||
|
|
044ce2d4bb | ||
|
|
b483e04611 | ||
|
|
c1032638b2 | ||
|
|
72225385ae | ||
|
|
6ad9d2bce0 | ||
|
|
045df8a9fe | ||
|
|
f3ede17b80 | ||
|
|
2551dbe18e | ||
|
|
f4a887a67a | ||
|
|
874abac5e3 | ||
|
|
827ddcebf0 | ||
|
|
98043693be | ||
|
|
436c8e1861 | ||
|
|
21214eb2ce | ||
|
|
017b8cd0c3 | ||
|
|
8ae7419b7a | ||
|
|
11c34aa6fc |
@@ -1,4 +1,4 @@
|
||||
# verb-specificiations
|
||||
# verb-specifications
|
||||
Jambonz Verb Specification Utilities
|
||||
|
||||
#### Running the test suite
|
||||
|
||||
@@ -4,6 +4,27 @@ const _specData = require('./specs');
|
||||
const specs = new Map();
|
||||
for (const key in _specData) { specs.set(key, _specData[key]); }
|
||||
|
||||
/* verb synonyms and shortcuts: maps alias verb names to their canonical form,
|
||||
optionally injecting properties (e.g. vendor) into the verb data */
|
||||
const verbTransforms = new Map([
|
||||
['stream', {verb: 'listen'}],
|
||||
['s2s', {verb: 'llm'}],
|
||||
['openai_s2s', {verb: 'llm', properties: {vendor: 'openai'}}],
|
||||
['microsoft_s2s', {verb: 'llm', properties: {vendor: 'microsoft'}}],
|
||||
['google_s2s', {verb: 'llm', properties: {vendor: 'google'}}],
|
||||
['elevenlabs_s2s', {verb: 'llm', properties: {vendor: 'elevenlabs'}}],
|
||||
['deepgram_s2s', {verb: 'llm', properties: {vendor: 'deepgram'}}],
|
||||
['voiceagent_s2s', {verb: 'llm', properties: {vendor: 'voiceagent'}}],
|
||||
['ultravox_s2s', {verb: 'llm', properties: {vendor: 'ultravox'}}],
|
||||
]);
|
||||
|
||||
function applyVerbTransform(name, data) {
|
||||
const transform = verbTransforms.get(name);
|
||||
if (!transform) return {name, data};
|
||||
const newData = transform.properties ? {...transform.properties, ...data} : data;
|
||||
return {name: transform.verb, data: newData};
|
||||
}
|
||||
|
||||
function normalizeJambones(logger, obj) {
|
||||
if (!Array.isArray(obj)) {
|
||||
throw new Error('malformed jambonz payload: must be array');
|
||||
@@ -13,18 +34,22 @@ function normalizeJambones(logger, obj) {
|
||||
if (typeof tdata !== 'object') throw new Error('malformed jambonz payload: must be array of objects');
|
||||
if ('verb' in tdata) {
|
||||
// {verb: 'say', text: 'foo..bar'..}
|
||||
const name = tdata.verb;
|
||||
const o = {};
|
||||
Object.keys(tdata)
|
||||
.filter((k) => k !== 'verb')
|
||||
.forEach((k) => o[k] = tdata[k]);
|
||||
const {name, data} = applyVerbTransform(tdata.verb, o);
|
||||
const o2 = {};
|
||||
o2[name] = o;
|
||||
o2[name] = data;
|
||||
document.push(o2);
|
||||
}
|
||||
else if (Object.keys(tdata).length === 1) {
|
||||
// {'say': {..}}
|
||||
document.push(tdata);
|
||||
const key = Object.keys(tdata)[0];
|
||||
const {name, data} = applyVerbTransform(key, tdata[key]);
|
||||
const o2 = {};
|
||||
o2[name] = data;
|
||||
document.push(o2);
|
||||
}
|
||||
else {
|
||||
logger.info(tdata, 'malformed jambonz payload: missing verb property');
|
||||
@@ -58,7 +83,8 @@ function validateVerb(name, data, logger) {
|
||||
const dSpec = specData.properties[dKey];
|
||||
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('|')) {
|
||||
|
||||
2620
package-lock.json
generated
2620
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@jambonz/verb-specifications",
|
||||
"version": "0.0.15",
|
||||
"version": "0.1.5",
|
||||
"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",
|
||||
|
||||
656
specs.json
656
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,40 @@
|
||||
"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",
|
||||
"noiseIsolation": "#noiseIsolation",
|
||||
"turnTaking": "#turnTaking"
|
||||
},
|
||||
"required": []
|
||||
},
|
||||
"fillerNoise": {
|
||||
"properties": {
|
||||
"enable": "boolean",
|
||||
"url": "string",
|
||||
"startDelaySecs": "number"
|
||||
},
|
||||
"required": [
|
||||
"enable"
|
||||
]
|
||||
},
|
||||
"listenOptions": {
|
||||
"properties": {
|
||||
"enable": "boolean",
|
||||
@@ -58,7 +102,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 +128,7 @@
|
||||
"enable": "boolean",
|
||||
"sticky": "boolean",
|
||||
"actionHook": "object|string",
|
||||
"partialResultHook": "object|string",
|
||||
"input": "array",
|
||||
"finishOnKey": "string",
|
||||
"numDigits": "number",
|
||||
@@ -82,13 +142,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 +189,7 @@
|
||||
"name": "string",
|
||||
"actionHook": "object|string",
|
||||
"waitHook": "object|string",
|
||||
"priority": "number",
|
||||
"_": "object"
|
||||
},
|
||||
"required": [
|
||||
@@ -137,13 +227,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 +257,9 @@
|
||||
"timeout": "number",
|
||||
"recognizer": "#recognizer",
|
||||
"play": "#play",
|
||||
"say": "#say"
|
||||
"say": "#say",
|
||||
"fillerNoise": "#fillerNoise",
|
||||
"actionHookDelayAction": "#actionHookDelayAction"
|
||||
},
|
||||
"required": [
|
||||
]
|
||||
@@ -175,8 +269,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 +281,9 @@
|
||||
"statusEvents": "array",
|
||||
"statusHook": "object|string",
|
||||
"enterHook": "object|string",
|
||||
"record": "#record"
|
||||
"record": "#record",
|
||||
"listen": "#listen",
|
||||
"distributeDtmf": "boolean"
|
||||
},
|
||||
"required": [
|
||||
"name"
|
||||
@@ -194,6 +293,7 @@
|
||||
"properties": {
|
||||
"id": "string",
|
||||
"actionHook": "object|string",
|
||||
"onHoldHook": "object|string",
|
||||
"answerOnBridge": "boolean",
|
||||
"callerId": "string",
|
||||
"callerName": "string",
|
||||
@@ -204,13 +304,19 @@
|
||||
"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"
|
||||
@@ -221,15 +327,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", "ces"]
|
||||
},
|
||||
"lang": "string",
|
||||
"actionHook": "object|string",
|
||||
"eventHook": "object|string",
|
||||
"events": "[string]",
|
||||
"events": "array",
|
||||
"welcomeEvent": "string",
|
||||
"welcomeEventParams": "object",
|
||||
"noInputTimeout": "number",
|
||||
@@ -237,7 +345,8 @@
|
||||
"passDtmfAsTextInput": "boolean",
|
||||
"thinkingMusic": "string",
|
||||
"tts": "#synthesizer",
|
||||
"bargein": "boolean"
|
||||
"bargein": "boolean",
|
||||
"queryInput": "#queryInput"
|
||||
},
|
||||
"required": [
|
||||
"project",
|
||||
@@ -245,6 +354,16 @@
|
||||
"lang"
|
||||
]
|
||||
},
|
||||
"queryInput": {
|
||||
"properties": {
|
||||
"text": "string",
|
||||
"intent": "string",
|
||||
"event": "string",
|
||||
"dtmf": "string"
|
||||
},
|
||||
"required": [
|
||||
]
|
||||
},
|
||||
"dtmf": {
|
||||
"properties": {
|
||||
"id": "string",
|
||||
@@ -295,12 +414,43 @@
|
||||
"passDtmf": "boolean",
|
||||
"playBeep": "boolean",
|
||||
"disableBidirectionalAudio": "boolean",
|
||||
"bidirectionalAudio": "#bidirectionalAudio",
|
||||
"sampleRate": "number",
|
||||
"timeout": "number",
|
||||
"transcribe": "#transcribe",
|
||||
"url": "string",
|
||||
"wsAuth": "#auth",
|
||||
"earlyMedia": "boolean"
|
||||
"earlyMedia": "boolean",
|
||||
"channel": "number"
|
||||
},
|
||||
"required": [
|
||||
"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"
|
||||
@@ -360,8 +510,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"
|
||||
@@ -370,7 +526,8 @@
|
||||
"redirect": {
|
||||
"properties": {
|
||||
"id": "string",
|
||||
"actionHook": "object|string"
|
||||
"actionHook": "object|string",
|
||||
"statusHook": "object|string"
|
||||
},
|
||||
"required": [
|
||||
"actionHook"
|
||||
@@ -394,7 +551,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",
|
||||
@@ -415,11 +577,12 @@
|
||||
"properties": {
|
||||
"id": "string",
|
||||
"transcriptionHook": "string",
|
||||
"translationHook": "string",
|
||||
"recognizer": "#recognizer",
|
||||
"earlyMedia": "boolean"
|
||||
"earlyMedia": "boolean",
|
||||
"channel": "number"
|
||||
},
|
||||
"required": [
|
||||
"recognizer"
|
||||
]
|
||||
},
|
||||
"target": {
|
||||
@@ -442,7 +605,8 @@
|
||||
"vmail": "boolean",
|
||||
"tenant": "string",
|
||||
"trunk": "string",
|
||||
"overrideTo": "string"
|
||||
"overrideTo": "string",
|
||||
"proxy": "string"
|
||||
},
|
||||
"required": [
|
||||
"type"
|
||||
@@ -469,16 +633,22 @@
|
||||
"synthesizer": {
|
||||
"properties": {
|
||||
"vendor": "string",
|
||||
"label": "string",
|
||||
"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"
|
||||
@@ -487,8 +657,13 @@
|
||||
"recognizer": {
|
||||
"properties": {
|
||||
"vendor": "string",
|
||||
"label": "string",
|
||||
"language": "string",
|
||||
"fallbackVendor": "string",
|
||||
"fallbackLabel": "string",
|
||||
"fallbackLanguage": "string",
|
||||
"vad": "#vad",
|
||||
"autogeneratePrompt": "boolean",
|
||||
"hints": "array",
|
||||
"hintsBoost": "number",
|
||||
"altLanguages": "array",
|
||||
@@ -550,12 +725,25 @@
|
||||
"azureSttEndpointId": "string",
|
||||
"asrDtmfTerminationDigit": "string",
|
||||
"asrTimeout": "number",
|
||||
"fastRecognitionTimeout": "number",
|
||||
"minConfidence": "number",
|
||||
"nuanceOptions": "#nuanceOptions",
|
||||
"deepgramOptions": "#deepgramOptions",
|
||||
"ibmOptions": "#ibmOptions",
|
||||
"nvidiaOptions": "#nvidiaOptions",
|
||||
"sonioxOptions": "#sonioxOptions",
|
||||
"customOptions": "#customOptions"
|
||||
"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"
|
||||
@@ -565,11 +753,143 @@
|
||||
"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",
|
||||
"audioQueryAbsoluteTimeout": "number"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
@@ -602,18 +922,16 @@
|
||||
},
|
||||
"deepgramOptions": {
|
||||
"properties": {
|
||||
"deepgramSttUri": "string",
|
||||
"deepgramSttUseTls": "boolean",
|
||||
"apiKey": "string",
|
||||
"tier": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"enhanced",
|
||||
"base"
|
||||
]
|
||||
},
|
||||
"tier": "string",
|
||||
"model": "string",
|
||||
"customModel": "string",
|
||||
"version": "string",
|
||||
"punctuate": "boolean",
|
||||
"smartFormatting": "boolean",
|
||||
"noDelay": "boolean",
|
||||
"profanityFilter": "boolean",
|
||||
"redact": {
|
||||
"type": "string",
|
||||
@@ -633,9 +951,18 @@
|
||||
"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": {
|
||||
@@ -651,6 +978,173 @@
|
||||
"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",
|
||||
@@ -708,6 +1202,29 @@
|
||||
"required": [
|
||||
]
|
||||
},
|
||||
"assemblyAiOptions": {
|
||||
"properties": {
|
||||
"apiKey": "string",
|
||||
"serviceVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"v2",
|
||||
"v3"
|
||||
]
|
||||
},
|
||||
"speechModel": "string",
|
||||
"formatTurns": "boolean",
|
||||
"endOfTurnConfidenceThreshold": "number",
|
||||
"minEndOfTurnSilenceWhenConfident": "number",
|
||||
"maxTurnSilence": "number",
|
||||
"minTurnSilence": "number",
|
||||
"keyterms": "array",
|
||||
"prompt": "string",
|
||||
"languageDetection": "boolean",
|
||||
"vadThreshold": "number",
|
||||
"inactivityTimeout": "number"
|
||||
}
|
||||
},
|
||||
"resource": {
|
||||
"properties": {
|
||||
"externalReference": "#resourceReference",
|
||||
@@ -784,16 +1301,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"
|
||||
},
|
||||
@@ -808,5 +1336,63 @@
|
||||
"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",
|
||||
"llm": "#llm",
|
||||
"turnDetection": "string|object",
|
||||
"bargeIn": "#bargeInPipeline",
|
||||
"actionHook": "object|string",
|
||||
"eventHook": "object|string",
|
||||
"toolHook": "object|string",
|
||||
"greeting": "boolean",
|
||||
"earlyGeneration": "boolean"
|
||||
},
|
||||
"required": [
|
||||
"llm"
|
||||
]
|
||||
},
|
||||
"bargeInPipeline": {
|
||||
"properties": {
|
||||
"enable": "boolean",
|
||||
"minSpeechDuration": "number",
|
||||
"sticky": "boolean"
|
||||
}
|
||||
},
|
||||
"noiseIsolation" : {
|
||||
"properties": {
|
||||
"enable": "boolean",
|
||||
"vendor": "string",
|
||||
"level": "number",
|
||||
"model": "string"
|
||||
}
|
||||
},
|
||||
"turnTaking": {
|
||||
"properties": {
|
||||
"enable": "boolean",
|
||||
"vendor": "string",
|
||||
"threshold": "number",
|
||||
"model": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
const test = require('tape');
|
||||
const logger = require('pino')({level: process.env.JAMBONES_LOGLEVEL || 'error'});
|
||||
const { validate } = require('..');
|
||||
const { validate, normalizeJambones } = require('..');
|
||||
|
||||
test("validate correct verbs", async (t) => {
|
||||
|
||||
@@ -24,31 +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"
|
||||
@@ -95,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",
|
||||
@@ -110,14 +208,183 @@ 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",
|
||||
"audioQueryAbsoluteTimeout": 5
|
||||
},
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -162,6 +429,64 @@ 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": "config",
|
||||
"noiseIsolation": {
|
||||
"enable": true,
|
||||
"vendor": "krisp",
|
||||
"level": 3,
|
||||
"model": "custom-model"
|
||||
}
|
||||
},
|
||||
{
|
||||
"verb": "config",
|
||||
"turnTaking": {
|
||||
"enable": true,
|
||||
"vendor": "krisp",
|
||||
"threshold": 0.5,
|
||||
"model": "turn-taking-model"
|
||||
}
|
||||
},
|
||||
{
|
||||
"verb": "message",
|
||||
"to": "15083084809",
|
||||
@@ -220,6 +545,12 @@ test("validate correct verbs", async (t) => {
|
||||
"referTo": "+15083084809",
|
||||
"actionHook": "/action"
|
||||
},
|
||||
{
|
||||
"verb": "sip:refer",
|
||||
"referTo": "+15083084809",
|
||||
"referredByDisplayName": "Alice",
|
||||
"actionHook": "/action"
|
||||
},
|
||||
{
|
||||
"verb": "tag",
|
||||
"data": {
|
||||
@@ -236,6 +567,170 @@ test("validate correct verbs", async (t) => {
|
||||
"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": "s2s",
|
||||
"vendor": "openai",
|
||||
"llmOptions": {
|
||||
"model": "gpt-4o-realtime"
|
||||
}
|
||||
},
|
||||
{
|
||||
"verb": "openai_s2s",
|
||||
"llmOptions": {
|
||||
"model": "gpt-4o-realtime"
|
||||
}
|
||||
},
|
||||
{
|
||||
"verb": "google_s2s",
|
||||
"llmOptions": {
|
||||
"model": "gemini-2.0-flash"
|
||||
}
|
||||
},
|
||||
{
|
||||
"verb": "elevenlabs_s2s",
|
||||
"llmOptions": {
|
||||
"agentId": "agent-123"
|
||||
}
|
||||
},
|
||||
{
|
||||
"verb": "stream",
|
||||
"url": "wss://myrecorder.example.com/calls",
|
||||
"mixType": "stereo"
|
||||
},
|
||||
{
|
||||
"verb": "pipeline",
|
||||
"stt": {
|
||||
"vendor": "google",
|
||||
"language": "en-US"
|
||||
},
|
||||
"tts": {
|
||||
"vendor": "google",
|
||||
"language": "en-US"
|
||||
},
|
||||
"llm": {
|
||||
"vendor": "openai",
|
||||
"llmOptions": {
|
||||
"model": "gpt-4o"
|
||||
}
|
||||
},
|
||||
"actionHook": "/pipeline/action",
|
||||
"eventHook": "/pipeline/event",
|
||||
"toolHook": "/pipeline/tool"
|
||||
},
|
||||
{
|
||||
"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 {
|
||||
@@ -263,6 +758,110 @@ test('invalid test', async (t) => {
|
||||
} catch(err) {
|
||||
t.ok(1 == 1,'successfully validate verbs');
|
||||
}
|
||||
|
||||
|
||||
t.end();
|
||||
})
|
||||
});
|
||||
|
||||
test('verb synonyms: stream is synonym for listen', async (t) => {
|
||||
// "verb" format
|
||||
const result1 = normalizeJambones(logger, [
|
||||
{"verb": "stream", "url": "wss://example.com/calls", "mixType": "stereo"}
|
||||
]);
|
||||
t.equal(Object.keys(result1[0])[0], 'listen', 'stream verb is rewritten to listen');
|
||||
t.equal(result1[0].listen.url, 'wss://example.com/calls', 'data is preserved');
|
||||
|
||||
// object-key format
|
||||
const result2 = normalizeJambones(logger, [
|
||||
{"stream": {"url": "wss://example.com/calls"}}
|
||||
]);
|
||||
t.equal(Object.keys(result2[0])[0], 'listen', 'stream key is rewritten to listen');
|
||||
|
||||
// validate passes
|
||||
try {
|
||||
validate(logger, [{"verb": "stream", "url": "wss://example.com/calls"}]);
|
||||
t.pass('stream verb validates successfully');
|
||||
} catch (err) {
|
||||
t.fail('stream verb should validate: ' + err);
|
||||
}
|
||||
t.end();
|
||||
});
|
||||
|
||||
test('verb synonyms: s2s is synonym for llm', async (t) => {
|
||||
const result = normalizeJambones(logger, [
|
||||
{"verb": "s2s", "vendor": "openai", "llmOptions": {"model": "gpt-4o"}}
|
||||
]);
|
||||
t.equal(Object.keys(result[0])[0], 'llm', 's2s verb is rewritten to llm');
|
||||
t.equal(result[0].llm.vendor, 'openai', 'vendor is preserved');
|
||||
t.equal(result[0].llm.llmOptions.model, 'gpt-4o', 'llmOptions preserved');
|
||||
|
||||
try {
|
||||
validate(logger, [{"verb": "s2s", "vendor": "openai", "llmOptions": {"model": "gpt-4o"}}]);
|
||||
t.pass('s2s verb validates successfully');
|
||||
} catch (err) {
|
||||
t.fail('s2s verb should validate: ' + err);
|
||||
}
|
||||
t.end();
|
||||
});
|
||||
|
||||
test('vendor shortcuts: openai_s2s injects vendor', async (t) => {
|
||||
const result = normalizeJambones(logger, [
|
||||
{"verb": "openai_s2s", "llmOptions": {"model": "gpt-4o-realtime"}}
|
||||
]);
|
||||
t.equal(Object.keys(result[0])[0], 'llm', 'openai_s2s is rewritten to llm');
|
||||
t.equal(result[0].llm.vendor, 'openai', 'vendor is injected');
|
||||
t.equal(result[0].llm.llmOptions.model, 'gpt-4o-realtime', 'llmOptions preserved');
|
||||
|
||||
try {
|
||||
validate(logger, [{"verb": "openai_s2s", "llmOptions": {"model": "gpt-4o-realtime"}}]);
|
||||
t.pass('openai_s2s validates successfully');
|
||||
} catch (err) {
|
||||
t.fail('openai_s2s should validate: ' + err);
|
||||
}
|
||||
t.end();
|
||||
});
|
||||
|
||||
test('vendor shortcuts: all vendors work', async (t) => {
|
||||
const vendors = [
|
||||
'openai', 'microsoft', 'google', 'elevenlabs', 'deepgram', 'voiceagent', 'ultravox'
|
||||
];
|
||||
for (const vendor of vendors) {
|
||||
const verbName = `${vendor}_s2s`;
|
||||
const result = normalizeJambones(logger, [
|
||||
{"verb": verbName, "llmOptions": {}}
|
||||
]);
|
||||
t.equal(Object.keys(result[0])[0], 'llm', `${verbName} rewrites to llm`);
|
||||
t.equal(result[0].llm.vendor, vendor, `${verbName} injects vendor=${vendor}`);
|
||||
}
|
||||
t.end();
|
||||
});
|
||||
|
||||
test('vendor shortcuts: object-key format works', async (t) => {
|
||||
const result = normalizeJambones(logger, [
|
||||
{"google_s2s": {"llmOptions": {"model": "gemini-2.0-flash"}}}
|
||||
]);
|
||||
t.equal(Object.keys(result[0])[0], 'llm', 'google_s2s key is rewritten to llm');
|
||||
t.equal(result[0].llm.vendor, 'google', 'vendor is injected');
|
||||
t.equal(result[0].llm.llmOptions.model, 'gemini-2.0-flash', 'llmOptions preserved');
|
||||
t.end();
|
||||
});
|
||||
|
||||
test('vendor shortcuts: explicit vendor in data overrides injected vendor', async (t) => {
|
||||
const result = normalizeJambones(logger, [
|
||||
{"verb": "openai_s2s", "vendor": "custom", "llmOptions": {}}
|
||||
]);
|
||||
t.equal(result[0].llm.vendor, 'custom', 'explicit vendor takes precedence');
|
||||
t.end();
|
||||
});
|
||||
|
||||
test('non-synonym verbs are unchanged', async (t) => {
|
||||
const result = normalizeJambones(logger, [
|
||||
{"verb": "say", "text": "hello"}
|
||||
]);
|
||||
t.equal(Object.keys(result[0])[0], 'say', 'say verb is not transformed');
|
||||
|
||||
const result2 = normalizeJambones(logger, [
|
||||
{"llm": {"vendor": "openai", "llmOptions": {}}}
|
||||
]);
|
||||
t.equal(Object.keys(result2[0])[0], 'llm', 'llm verb is not transformed');
|
||||
t.end();
|
||||
});
|
||||
Reference in New Issue
Block a user