@cognigy/rest-api-client 0.13.1 → 0.14.0

package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js

@@ -15,7 +15,7 @@ exports.voiceConfigFields = [
         description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge in",
         defaultValue: 1,
         params: {
-            min: 0,
+            min: 1,
             max: 5,
             step: 1
         }
@@ -31,7 +31,7 @@ exports.voiceConfigFields = [
         key: "bargeInOnDtmf",
         type: "toggle",
         label: "Barge In On DTMF",
-        description: "Allows the user to interrupt bot output with DTMF. If you enable this feature, you also need to enable the sending of DTMF digits",
+        description: "Allows the user to interrupt bot output with DTMF. Enabling Barge in on DTMF will also enable DTMF capture.",
         defaultValue: false
     },
     {
@@ -44,6 +44,12 @@ exports.voiceConfigFields = [
             languageKey: "config.sttLanguage"
         }
     },
+    {
+        key: "sttLanguage",
+        type: "sttSelect",
+        defaultValue: "",
+        label: "_unused_"
+    },
     {
         key: "sttHints",
         type: "textArray",
@@ -51,13 +57,6 @@ exports.voiceConfigFields = [
         description: "Array of words or phrases to assist speech detection",
         defaultValue: [""]
     },
-    {
-        key: "sttVadEnabled",
-        type: "toggle",
-        label: "Enable Voice Activity Detection",
-        description: "Delay connection to cloud recognizer until speech is detected",
-        defaultValue: true
-    },
     {
         key: "sttDisablePunctuation",
         type: "toggle",
@@ -65,6 +64,13 @@ exports.voiceConfigFields = [
         description: "Prevents the STT response from the bot to include punctuation marks",
         defaultValue: false
     },
+    {
+        key: "sttVadEnabled",
+        type: "toggle",
+        label: "Enable Voice Activity Detection",
+        description: "Delay connection to cloud recognizer until speech is detected",
+        defaultValue: false
+    },
     {
         key: "sttVadMode",
         type: "slider",
@@ -116,6 +122,18 @@ exports.voiceConfigFields = [
             voiceKey: "config.ttsVoice"
         }
     },
+    {
+        key: "ttsVoice",
+        type: "ttsSelect",
+        defaultValue: "",
+        label: "_unused_"
+    },
+    {
+        key: "ttsLanguage",
+        type: "ttsSelect",
+        defaultValue: "",
+        label: "_unused_"
+    },
     {
         key: "userNoInputMode",
         type: "select",
@@ -125,13 +143,16 @@ exports.voiceConfigFields = [
         params: {
             options: [
                 {
-                    label: "Speak", value: "speech"
+                    label: "Speak",
+                    value: "speech"
                 },
                 {
-                    label: "Play File", value: "play"
+                    label: "Play File",
+                    value: "play"
                 },
                 {
-                    label: "Send Event", value: "event"
+                    label: "Send Event",
+                    value: "event"
                 }
             ]
         }
@@ -143,8 +164,8 @@ exports.voiceConfigFields = [
         description: "Define the timeout for user input in ms",
         defaultValue: 10000,
         params: {
-            min: 1000,
-        },
+            min: 1000
+        }
     },
     {
         key: "userNoInputRetries",
@@ -153,8 +174,8 @@ exports.voiceConfigFields = [
         description: "Define how often the bot should retry to get an input from a user before completing the call",
         defaultValue: 1,
         params: {
-            min: 0,
-        },
+            min: 0
+        }
     },
     {
         key: "userNoInputSpeech",
@@ -199,12 +220,12 @@ exports.voiceConfigFields = [
         defaultValue: 2000,
         params: {
             min: 1000,
-            max: 60000,
+            max: 60000
         },
         condition: {
             key: "dtmfEnable",
             value: true
-        },
+        }
     },
     {
         key: "dtmfMaxDigits",
@@ -213,7 +234,7 @@ exports.voiceConfigFields = [
         description: "Defines the maximum number of digits which can be entered by the user, the digits are being submitted automatically once this limit is reached",
         defaultValue: 1,
         params: {
-            min: 1,
+            min: 1
         },
         condition: {
             key: "dtmfEnable",
@@ -227,7 +248,7 @@ exports.voiceConfigFields = [
         description: "Defines the mininum number of digits before they are forwarded to the bot. This can be overridden by a submit digit",
         defaultValue: 1,
         params: {
-            min: 1,
+            min: 1
         },
         condition: {
             key: "dtmfEnable",
@@ -270,20 +291,99 @@ exports.voiceConfigFields = [
         description: "Defines the number of milliseconds of silence before the accumulated recognitions are send to the flow",
         defaultValue: 0,
         params: {
-            min: 0,
+            min: 0
         },
         condition: {
             key: "asrEnabled",
             value: true
         }
     },
+    {
+        key: "enableAdvancedSTTConfig",
+        type: "toggle",
+        label: "Enable Advanced STT Config",
+        description: "Advanced STT Configuration",
+        defaultValue: false,
+        condition: {
+            key: 'sttVendor',
+            value: 'microsoft'
+        }
+    },
+    {
+        key: "azureSttContextId",
+        type: "cognigyText",
+        label: "Azure STT Context ID",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "azureEnableAudioLogging",
+        type: "toggle",
+        label: "Enable Audio Logging",
+        description: "Enables recording and logging of audio from the user on Azure.",
+        defaultValue: false,
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "enableAdvancedTTSConfig",
+        type: "toggle",
+        label: "Enable Advanced TTS Config",
+        description: "Enable Advanced TTS Configuration",
+        defaultValue: false,
+        condition: {
+            key: "ttsVendor",
+            value: "microsoft",
+        }
+    },
+    {
+        key: "azureTtsDeploymentId",
+        type: "cognigyText",
+        label: "Azure Custom Voice Endpoint",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedTTSConfig",
+                    value: true
+                },
+                {
+                    key: "ttsVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    }
 ];
 exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "setSessionConfig",
     defaultLabel: "Set Session Config",
     summary: "Change configuration settings for the call session",
     appearance: {
-        color: design_1.nodeColor
+        color: design_1.nodeColor,
     },
     fields: exports.voiceConfigFields,
     sections: [
@@ -291,19 +391,29 @@ exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)(
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints", "sttDisablePunctuation", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"]
+            fields: [
+                "sttVendor",
+                "sttHints",
+                "sttDisablePunctuation",
+                "sttVadEnabled",
+                "sttVadMode",
+                "sttVadVoiceMs",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging"
+            ],
         },
         {
             key: "params_tts",
             label: "Synthesizer (TTS)",
             defaultCollapsed: true,
-            fields: ["ttsVendor"]
+            fields: ["ttsVendor", "enableAdvancedTTSConfig", "azureTtsDeploymentId"],
         },
         {
             key: "params_bargein",
             label: "Barge In",
             defaultCollapsed: true,
-            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"]
+            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"],
         },
         {
             key: "params_user_timeouts",
@@ -314,21 +424,27 @@ exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)(
                 "userNoInputSpeech",
                 "userNoInputUrl",
                 "userNoInputTimeout",
-                "userNoInputRetries"
-            ]
+                "userNoInputRetries",
+            ],
         },
         {
             key: "params_dtmf",
             label: "DTMF",
             defaultCollapsed: true,
-            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"]
+            fields: [
+                "dtmfEnable",
+                "dtmfInterDigitTimeout",
+                "dtmfMaxDigits",
+                "dtmfMinDigits",
+                "dtmfSubmitDigit",
+            ],
         },
         {
             key: "params_continuous_asr",
             label: "Continuous ASR",
             defaultCollapsed: true,
             fields: ["asrEnabled", "asrDigit", "asrTimeout"],
-        }
+        },
     ],
     form: [
         { type: "section", key: "params_tts" },
@@ -337,18 +453,19 @@ exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)(
         { type: "section", key: "params_user_timeouts" },
         { type: "section", key: "params_dtmf" },
         { type: "section", key: "params_continuous_asr" },
+        { type: "section", key: "params_azure_config" },
     ],
     function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
         try {
-            const payload = setSessionConfig_mapper_1.setSessionConfig.handleVGInput((0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, cognigy.api));
-            cognigy.api.say(null, {
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleVGInput((0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, api));
+            api.say(null, {
                 _cognigy: payload,
             });
         }
         catch (error) {
             throw new Error(`[VG2] Error on set session config node. Error message: ${error.message}`);
         }
-        ;
-    }
+    },
 });
 //# sourceMappingURL=setSessionConfig.js.map

package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js

@@ -12,7 +12,7 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "transfer",
     defaultLabel: "Transfer",
     preview: {
-        key: "referTo",
+        key: "transferTarget",
         type: "text",
     },
     appearance: {
@@ -20,7 +20,26 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     },
     fields: [
         {
-            key: "referTo",
+            key: "transferType",
+            label: "Transfer Type",
+            type: "select",
+            params: {
+                options: [
+                    {
+                        label: "Refer",
+                        value: "refer"
+                    },
+                    {
+                        label: "Dial",
+                        value: "dial"
+                    }
+                ]
+            },
+            defaultValue: "refer",
+            description: "Refer the call or create a new one",
+        },
+        {
+            key: "transferTarget",
             label: "Target",
             type: "cognigyText",
             params: {
@@ -29,6 +48,16 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             description: "E.164 syntax or a SIP URI are supported",
             defaultValue: "+49123456789",
         },
+        {
+            key: "transferReason",
+            label: "Reason",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "Reason for the transfer",
+            defaultValue: "Bot initiated a transfer.",
+        },
         {
             key: "useTransferSipHeaders",
             label: "Custom Transfer SIP Headers",
@@ -49,6 +78,37 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 value: true,
             },
         },
+        /* Dial specific */
+        {
+            key: "dialCallerId",
+            label: "Caller ID",
+            type: "text",
+            description: "The caller ID, some carriers like Twilio require a registered number for outgoing calls.",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "dialMusic",
+            label: "Dial Music",
+            type: "text",
+            description: "URL to a .wav or .mp3 audio file of custom audio or ringback to play to the caller while the outbound call is ringing",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "dialTranscriptionWebhook",
+            label: "Transcription Webhook",
+            type: "text",
+            description: "Webhook to receive an HTTP POST when an interim or final transcription is received. Uses the default recognizer.",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        }
     ],
     sections: [
         {
@@ -61,7 +121,27 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     form: [
         {
             type: "field",
-            key: "referTo",
+            key: "transferType",
+        },
+        {
+            type: "field",
+            key: "transferReason",
+        },
+        {
+            type: "field",
+            key: "transferTarget",
+        },
+        {
+            type: "field",
+            key: "dialCallerId",
+        },
+        {
+            type: "field",
+            key: "dialMusic",
+        },
+        {
+            type: "field",
+            key: "dialTranscriptionWebhook",
         },
         {
             type: "section",
@@ -70,15 +150,23 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     ],
     summary: "Transfer the call to another target",
     function: async ({ cognigy, config }) => {
-        const { api } = cognigy;
-        const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
+        const { api, input } = cognigy;
+        const { transferType, transferTarget, useTransferSipHeaders, transferSipHeaders, transferReason, dialMusic, dialTranscriptionWebhook, dialCallerId } = config;
         const transferParams = {
-            transferReason: "",
-            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            transferType,
+            transferReason,
+            transferTarget,
             useTransferSipHeaders,
             transferSipHeaders,
+            dialMusic,
+            dialCallerId,
+            dialTranscriptionWebhook,
         };
         try {
+            if (input.channel === "adminconsole") {
+                api.say("Transferring a call is not supported in the Interaction Panel, please use the VoiceGateway endpoint.", null);
+                return;
+            }
             if (useTransferSipHeaders &&
                 transferSipHeaders &&
                 !(0, helper_1.isValidJSON)(transferSipHeaders)) {

package/build/shared/charts/descriptors/voicegateway2/utils/helper.js

@@ -1,20 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidJSON = exports.cleanTarget = void 0;
-function cleanTarget(target) {
-    if (target.includes("@")) {
-        const sip = target.replace(/\s/g, "");
-        if (target.substring(0, 4) === "sip:")
+function cleanTarget(rawTarget, isPrefixRequired) {
+    if (rawTarget.includes("@")) {
+        // handle sip refer
+        const sip = rawTarget.replace(/\s/g, "");
+        if (rawTarget.substring(0, 4) === "sip:")
             return sip;
         return `sip:${sip}`;
     }
-    const cleanedNumber = target.replace(/\s|\(|\)|\-/g, "");
-    let number = cleanedNumber;
-    if (number.substring(0, 4) === "tel:")
-        number = number.substring(4);
-    if (number.substring(0, 2) === "00")
-        return `+${number.slice(2)}`;
-    return number;
+    // handle telephone refer
+    let processedTarget = rawTarget;
+    if (processedTarget.toLowerCase().startsWith("tel:")) {
+        // remove "tel:" first
+        processedTarget = processedTarget.slice(4);
+    }
+    // clear up invalid chars
+    processedTarget = processedTarget.replace(/\s|\(|\)|\-/g, "");
+    if (processedTarget.substring(0, 2) === "00") {
+        // replace "00" with "+"
+        processedTarget = `+${processedTarget.slice(2)}`;
+    }
+    return isPrefixRequired ? "tel:" + processedTarget : processedTarget;
 }
 exports.cleanTarget = cleanTarget;
 function isValidJSON(json) {

package/build/shared/charts/descriptors/voicegateway2/utils/strip-nulls.js

@@ -3,7 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripNulls = void 0;
 function stripNulls(data) {
     Object.entries(data).forEach(([key, value]) => {
-        if (typeof value === "undefined" || typeof value === null || (typeof value === "string" && value.length == 0)) {
+        if (typeof value === "undefined" ||
+            typeof value === null ||
+            (typeof value === "string" &&
+                value.length == 0)) {
             delete data[key];
         }
         if (typeof value === "object" && (typeof value !== "number" || typeof value !== "string")) {

package/build/shared/charts/helpers/generativeAI/getRephraseWithAIFields.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRephraseWithAISection = exports.getRephraseWithAIFields = void 0;
+/**
+ * @returns The fields for rephraseWithAI
+ */
+const getRephraseWithAIFields = () => {
+    const fields = [
+        {
+            key: "generativeAI_rephraseOutputMode",
+            type: "select",
+            label: "Rephrase Output",
+            params: {
+                required: true,
+                options: [
+                    {
+                        label: "None",
+                        value: "none"
+                    },
+                    {
+                        label: "Based on Previous User Inputs",
+                        value: "userInputs"
+                    },
+                    {
+                        label: "Based on Custom Input",
+                        value: "customInputs"
+                    },
+                ],
+            },
+            defaultValue: "none",
+        },
+        {
+            key: "generativeAI_amountOfLastUserInputs",
+            type: "slider",
+            label: "Number of Previous User Inputs",
+            params: {
+                min: 1,
+                max: 10,
+                step: 1,
+            },
+            defaultValue: 5,
+            condition: {
+                key: "generativeAI_rephraseOutputMode",
+                value: "userInputs",
+            },
+        },
+        {
+            key: "generativeAI_customInputs",
+            type: "cognigyTextArray",
+            label: "Custom Inputs",
+            condition: {
+                key: "generativeAI_rephraseOutputMode",
+                value: "customInputs",
+            },
+        },
+        {
+            key: "generativeAI_temperature",
+            type: "slider",
+            label: "Temperature",
+            params: {
+                min: 0,
+                max: 1,
+                step: 0.1,
+            },
+            defaultValue: 0.7,
+            condition: {
+                or: [
+                    {
+                        key: "generativeAI_rephraseOutputMode",
+                        value: "userInputs",
+                    },
+                    {
+                        key: "generativeAI_rephraseOutputMode",
+                        value: "customInputs",
+                    }
+                ],
+            },
+        },
+    ];
+    return fields;
+};
+exports.getRephraseWithAIFields = getRephraseWithAIFields;
+/**
+ * @returns The section for rephraseWithAI
+ */
+const getRephraseWithAISection = () => {
+    return {
+        key: "aiEnhancedOutput",
+        label: "AI-enhanced output",
+        defaultCollapsed: true,
+        fields: [
+            "generativeAI_rephraseOutputMode",
+            "generativeAI_amountOfLastUserInputs",
+            "generativeAI_customInputs",
+            "generativeAI_temperature",
+        ]
+    };
+};
+exports.getRephraseWithAISection = getRephraseWithAISection;
+//# sourceMappingURL=getRephraseWithAIFields.js.map

package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rephraseMultipleSentencesWithAI = exports.rephraseSentenceWithAI = void 0;
+const rephraseSentenceWithAI = async (sentence, config, api, organisationId) => {
+    const { generativeAI_rephraseOutputMode } = config;
+    if (generativeAI_rephraseOutputMode === "userInputs" || generativeAI_rephraseOutputMode === "customInputs") {
+        sentence = await api.rephraseSentenceWithAI(sentence, createRephraseSentenceWithAIOptions(config));
+    }
+    return sentence;
+};
+exports.rephraseSentenceWithAI = rephraseSentenceWithAI;
+const rephraseMultipleSentencesWithAI = async (sentences, config, api, organisationId) => {
+    const { generativeAI_rephraseOutputMode, generativeAI_amountOfLastUserInputs, generativeAI_customInputs, generativeAI_temperature } = config;
+    if (generativeAI_rephraseOutputMode === "userInputs" || generativeAI_rephraseOutputMode === "customInputs") {
+        sentences = await api.rephraseMultipleSentencesWithAI(sentences, createRephraseSentenceWithAIOptions(config));
+    }
+    return sentences;
+};
+exports.rephraseMultipleSentencesWithAI = rephraseMultipleSentencesWithAI;
+const createRephraseSentenceWithAIOptions = (params) => {
+    const options = {
+        promptType: params.promtType,
+        questionType: params.questionType,
+        temperature: params.generativeAI_temperature,
+        question: params.question,
+        answer: params.answer,
+    };
+    switch (params.generativeAI_rephraseOutputMode) {
+        case "none":
+            break;
+        case "userInputs":
+            options.useLastUserInputs = true;
+            options.amountOfUserInputs = params.generativeAI_amountOfLastUserInputs;
+            return options;
+        case "customInputs":
+            options.useLastUserInputs = false;
+            options.customInputs = params.generativeAI_customInputs;
+            return options;
+        default:
+            break;
+    }
+    return {};
+};
+//# sourceMappingURL=rephraseSentenceWithAi.js.map