@cognigy/rest-api-client 2025.12.0 → 2025.13.0

package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createToolDefinitions = void 0;
+const createSystemMessage_1 = require("./createSystemMessage");
+/**
+ * Creates the tool definitions for the AI Agent Job and LLM Prompt v2 Nodes
+ * @param childConfigs Child node configurations
+ * @param api Cognigy API
+ * @param useStrict Whether to use strict mode for the tools
+ * @returns An object containing the tool definitions
+ */
+const createToolDefinitions = async (childConfigs, api, useStrict) => {
+    var _a, _b, _c;
+    // Create Tools JSON
+    /** This is the list of tools that are used in the AI Agent Job */
+    const tools = [];
+    /** Array of tool IDs for deduping */
+    const toolIds = [];
+    /** Map of MCP tool IDs to their respective node IDs they were loaded from */
+    const toolMap = new Map();
+    /** Array of tool names for listing in the debug message */
+    const toolNames = [];
+    // if no child configs are provided, return empty tool definitions
+    if (!childConfigs || childConfigs.length === 0) {
+        return {
+            toolIds: [],
+            toolNames: [],
+            toolMap: new Map(),
+            tools: [],
+        };
+    }
+    // Loop through all child nodes and create the tools
+    for (const child of childConfigs) {
+        if (child.type === "aiAgentJobDefault" || child.type === "llmPromptDefault") {
+            continue;
+        }
+        const toolId = child.config.toolId;
+        if ((child.type === "aiAgentJobTool" || child.type === "llmPromptTool") &&
+            (!child.config.condition || !!api.parseCognigyScriptCondition(child.config.condition))) {
+            if (!toolId) {
+                throw new Error(`Tool ID is missing in Tool Node configuration.`);
+            }
+            const parsedToolId = api.parseCognigyScriptText(toolId);
+            if (!(0, createSystemMessage_1.validateToolId)(parsedToolId)) {
+                throw new Error(`Tool ID ${parsedToolId} is not valid. Please use only alphanumeric characters, dashes and underscores.`);
+            }
+            if (toolIds.includes(parsedToolId)) {
+                throw new Error(`Tool ID ${parsedToolId} is not unique. Please ensure each tool has a unique id.`);
+            }
+            toolIds.push(parsedToolId);
+            toolNames.push(parsedToolId);
+            const tool = {
+                type: "function",
+                function: {
+                    name: parsedToolId,
+                    description: api.parseCognigyScriptText(child.config.description),
+                },
+            };
+            if (useStrict) {
+                tool.function.strict = true;
+            }
+            if (child.config.useParameters) {
+                tool.function.parameters = child.config.parameters;
+            }
+            tools.push(tool);
+        }
+        if ((child.type === "aiAgentJobMCPTool" || child.type === "llmPromptMCPTool") &&
+            (!child.config.condition || !!api.parseCognigyScriptCondition(child.config.condition))) {
+            if (!child.config.mcpServerUrl) {
+                throw new Error(`MCP Server URL is missing in Tool Node configuration.`);
+            }
+            const mcpServerUrl = child.config.mcpServerUrl;
+            const timeout = child.config.timeout;
+            const cacheTools = child.config.cacheTools;
+            const sendDebug = child.config.debugMessageFetchedTools;
+            const toolFilter = child.config.toolFilter;
+            let mcpTools = null;
+            try {
+                mcpTools = await api.fetchMcpTools({
+                    mcpServerUrl,
+                    timeout,
+                    cacheTools,
+                });
+            }
+            catch (error) {
+                const errorDetails = error instanceof Error
+                    ? {
+                        name: error.name,
+                        message: error.message,
+                    }
+                    : error;
+                (_a = api.logDebugError) === null || _a === void 0 ? void 0 : _a.call(api, `Unable to connect to MCP Server:<br>${JSON.stringify(errorDetails, null, 2)}`, child.config.name);
+            }
+            if (mcpTools) {
+                if (sendDebug) {
+                    if (mcpTools.length === 0) {
+                        (_b = api.logDebugMessage) === null || _b === void 0 ? void 0 : _b.call(api, `No tools fetched from MCP Tool "${child.config.name}".`, "MCP Tool");
+                    }
+                    if (mcpTools.length > 0) {
+                        const messageLines = [`Fetched tools from MCP Tool "${child.config.name}"`];
+                        mcpTools.forEach((tool) => {
+                            messageLines.push(`<br>- <b>${tool.name}</b>: ${tool.description}`);
+                            if (child.config.debugMessageParameters && tool.inputSchema) {
+                                messageLines.push(`   <b>Parameters</b>:`);
+                                Object.keys(tool.inputSchema.properties).forEach((key) => {
+                                    const parameter = tool.inputSchema.properties[key];
+                                    const requiredText = tool.inputSchema.required && !tool.inputSchema.required.includes(key) ? " (optional)" : "";
+                                    if (parameter.description) {
+                                        messageLines.push(`   - ${key} (${parameter.type}): ${parameter.description}${requiredText}`);
+                                    }
+                                    else {
+                                        messageLines.push(`   - ${key}: ${parameter.type}${requiredText}`);
+                                    }
+                                });
+                            }
+                        });
+                        (_c = api.logDebugMessage) === null || _c === void 0 ? void 0 : _c.call(api, messageLines.join("\n"), "MCP Tool");
+                    }
+                }
+                const filteredMcpTools = mcpTools.filter((tool) => {
+                    if (toolFilter && toolFilter !== "none") {
+                        if (toolFilter === "whitelist" && child.config.whitelist) {
+                            const whitelist = child.config.whitelist.map((item) => item.trim());
+                            return whitelist.includes(tool.name);
+                        }
+                        else if (toolFilter === "blacklist") {
+                            // If the blacklist is falsy, all tools are allowed
+                            if (!child.config.blacklist) {
+                                return true;
+                            }
+                            const blacklist = child.config.blacklist.map((item) => item.trim());
+                            return !blacklist.includes(tool.name);
+                        }
+                    }
+                    else {
+                        return true;
+                    }
+                });
+                const structuredMcpTools = [];
+                filteredMcpTools.forEach((tool) => {
+                    var _a;
+                    if (toolIds.includes(tool.name)) {
+                        (_a = api.logDebugError) === null || _a === void 0 ? void 0 : _a.call(api, `Tool "${tool.name}" from MCP Tool "${child.config.name}" is not unique and will not be added. Please ensure each tool has a unique id.`);
+                        return;
+                    }
+                    // add tool to the list of tool ids to prevent duplicates
+                    toolIds.push(tool.name);
+                    toolNames.push(`${tool.name} (${child.config.name})`);
+                    toolMap.set(tool.name, child.id);
+                    const structuredTool = {
+                        type: "function",
+                        function: {
+                            name: tool.name,
+                            description: tool.description,
+                        },
+                    };
+                    if (tool.inputSchema) {
+                        structuredTool.function.parameters = tool.inputSchema;
+                    }
+                    structuredMcpTools.push(structuredTool);
+                });
+                tools.push(...structuredMcpTools);
+            }
+        }
+    }
+    ;
+    return {
+        toolIds,
+        toolNames,
+        toolMap,
+        tools,
+    };
+};
+exports.createToolDefinitions = createToolDefinitions;
+//# sourceMappingURL=createToolDefinitions.js.map

package/build/shared/charts/descriptors/service/aiAgent/loadAiAgent.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOAD_AI_AGENT = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/**
+ * Node name: 'loadAiAigent'
+ *
+ * Purpose:
+ * Loads the AI Agent configuration and stores it to context/input.
+ */
+exports.LOAD_AI_AGENT = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "loadAiAigent",
+    defaultLabel: "Load AI Agent",
+    summary: "UI__NODE_EDITOR__LOAD_AI_AGENT__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "aiAgent",
+            type: "aiAgentSelect",
+            label: "UI__NODE_EDITOR__LOAD_AI_AGENT__AI_AGENT_SELECTOR__LABEL",
+            description: "UI__NODE_EDITOR__AI_AGENT__AI_AGENT_SELECTOR__DESCRIPTION",
+            params: {
+                required: true
+            },
+        },
+        {
+            key: "storeLocation",
+            type: "select",
+            label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__LABEL",
+            description: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__DESCRIPTION",
+            defaultValue: "context",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__OPTIONS__INPUT__LABEL",
+                        value: "input"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__OPTIONS__CONTEXT__LABEL",
+                        value: "context"
+                    }
+                ],
+                required: true
+            },
+        },
+        {
+            key: "inputKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__INPUT_KEY__LABEL",
+            description: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__INPUT_KEY__DESCRIPTION",
+            defaultValue: "aiAgentConfiguration",
+            condition: {
+                or: [
+                    {
+                        key: "storeLocation",
+                        value: "input",
+                    }
+                ]
+            }
+        },
+        {
+            key: "contextKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__CONTEXT_KEY__LABEL",
+            description: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__CONTEXT_KEY__DESCRIPTION",
+            defaultValue: "aiAgentConfiguration",
+            condition: {
+                key: "storeLocation",
+                value: "context",
+            }
+        },
+        {
+            key: "keyWarning",
+            type: "description",
+            label: " ",
+            params: {
+                text: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__KEY_WARNING__TEXT"
+            },
+            condition: {
+                or: [
+                    {
+                        and: [
+                            {
+                                key: "storeLocation",
+                                value: "input",
+                            },
+                            {
+                                key: "inputKey",
+                                value: "aiAgentConfiguration",
+                                negate: true
+                            }
+                        ]
+                    },
+                    {
+                        and: [
+                            {
+                                key: "storeLocation",
+                                value: "context",
+                            },
+                            {
+                                key: "contextKey",
+                                value: "aiAgentConfiguration",
+                                negate: true
+                            }
+                        ]
+                    }
+                ]
+            }
+        }
+    ],
+    preview: {
+        key: "storeLocation",
+        type: "text",
+    },
+    form: [
+        { type: "field", key: "aiAgent" },
+        { type: "field", key: "storeLocation" },
+        { type: "field", key: "inputKey" },
+        { type: "field", key: "contextKey" },
+        { type: "field", key: "keyWarning" }
+    ],
+    tags: ["ai", "aiagent", "llm"],
+    tokens: [
+        {
+            label: "AI Agent Reference ID",
+            type: "input",
+            script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.referenceId",
+        },
+        {
+            label: "AI Agent Name",
+            type: "input",
+            script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.name",
+        },
+        {
+            label: "AI Agent Description",
+            type: "input",
+            script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.description",
+        },
+        {
+            label: "AI Agent Instructions",
+            type: "input",
+            script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.instructions",
+        },
+        {
+            label: "AI Agent Image URL",
+            type: "input",
+            script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.image",
+        },
+        {
+            label: "AI Agent Knowledge Store ID",
+            type: "input",
+            script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.knowledgeReferenceId",
+        },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { aiAgent, storeLocation, contextKey, inputKey } = config;
+        if (storeLocation === "input" && !inputKey) {
+            throw new Error("Unable to add value to input. No input key was defined.");
+        }
+        if (storeLocation === "context" && !contextKey) {
+            throw new Error("Unable to add value to context. No context key was defined.");
+        }
+        if (!aiAgent) {
+            throw new Error("Unable to load AI Agent values. No AI agent was defined.");
+        }
+        const aiAgentData = {
+            referenceId: aiAgent.referenceId,
+            name: aiAgent.name,
+            description: aiAgent.description,
+            instructions: aiAgent.instructions,
+            image: aiAgent.image,
+            speakingStyle: aiAgent.speakingStyle,
+            safetySettings: aiAgent.safetySettings,
+            contactProfilesOption: aiAgent.contactProfilesOption,
+            contactProfilesSelected: aiAgent.contactProfilesSelected,
+            knowledgeReferenceId: aiAgent.knowledgeReferenceId,
+            enableVoiceConfigs: aiAgent.enableVoiceConfigs,
+            voiceConfigs: aiAgent.voiceConfigs,
+        };
+        switch (storeLocation) {
+            case "context":
+                // @ts-ignore	
+                api.addToContext(contextKey, aiAgentData, "simple");
+                break;
+            default:
+                api.addToInput(inputKey, aiAgentData);
+        }
+    }
+});
+//# sourceMappingURL=loadAiAgent.js.map

package/build/shared/charts/descriptors/service/handoverV2.js

@@ -86,7 +86,7 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
             label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__HANDOVER_PROVIDER__LABEL",
             type: "json",
             description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__HANDOVER_PROVIDER__DESCRIPTION",
-            defaultValue: {},
+            defaultValue: { liveAgentPriority: "none" },
             params: {
                 required: true,
             },

package/build/shared/charts/descriptors/service/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AIOPS_CENTER_WEBHOOKS_CONNECTION = exports.NICECXONEAAH_AUTHENTICATION_CONNECTION = exports.GENESYS_CLOUD_CONNECTION_OM = exports.GENESYS_CLOUD_CONNECTION = exports.EIGHT_BY_EIGHT_CONNECTION = exports.CHATWOOT_CONNECTION = exports.RINGCENTRAL_ENGAGE_CONNECTION = exports.LIVE_AGENT_CONNECTION = exports.AI_AGENT_JOB_CALL_MCP_TOOL = exports.AI_AGENT_HANDOVER = exports.AI_AGENT_TOOL_ANSWER = exports.AI_AGENT_JOB_MCP_TOOL = exports.AI_AGENT_JOB_TOOL = exports.AI_AGENT_JOB_DEFAULT = exports.AI_AGENT_JOB = exports.LLM_MODERATE = exports.LLM_ENTITY_EXTRACT = exports.GPT_CONVERSATION_SUMMARY = exports.GPT_CONVERSATION = exports.HANDOVER_INACTIVITY_TIMER = exports.CLOSE_HANDOVER = exports.GPT_PROMPT = exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.JWT_SECRET_CONNECTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.CHECK_AGENT_AVAILABILITY = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
+exports.AIOPS_CENTER_WEBHOOKS_CONNECTION = exports.NICECXONEAAH_AUTHENTICATION_CONNECTION = exports.GENESYS_CLOUD_CONNECTION_OM = exports.GENESYS_CLOUD_CONNECTION = exports.EIGHT_BY_EIGHT_CONNECTION = exports.CHATWOOT_CONNECTION = exports.RINGCENTRAL_ENGAGE_CONNECTION = exports.LIVE_AGENT_CONNECTION = exports.LOAD_AI_AGENT = exports.AI_AGENT_JOB_CALL_MCP_TOOL = exports.AI_AGENT_HANDOVER = exports.AI_AGENT_TOOL_ANSWER = exports.AI_AGENT_JOB_MCP_TOOL = exports.AI_AGENT_JOB_TOOL = exports.AI_AGENT_JOB_DEFAULT = exports.AI_AGENT_JOB = exports.LLM_MODERATE = exports.LLM_ENTITY_EXTRACT = exports.GPT_CONVERSATION_SUMMARY = exports.GPT_CONVERSATION = exports.HANDOVER_INACTIVITY_TIMER = exports.CLOSE_HANDOVER = exports.LLM_PROMPT_TOOL = exports.LLM_PROMPT_MCP_TOOL = exports.LLM_PROMPT_DEFAULT = exports.LLM_PROMPT_V2 = exports.GPT_PROMPT = exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.JWT_SECRET_CONNECTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.CHECK_AGENT_AVAILABILITY = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
 var handover_1 = require("./handover");
 Object.defineProperty(exports, "HANDOVER", { enumerable: true, get: function () { return handover_1.HANDOVER; } });
 var handoverV2_1 = require("./handoverV2");
@@ -25,6 +25,14 @@ var onSchedulingError_1 = require("./triggerFunction/onSchedulingError");
 Object.defineProperty(exports, "ON_SCHEDULING_ERROR", { enumerable: true, get: function () { return onSchedulingError_1.ON_SCHEDULING_ERROR; } });
 var GPTPrompt_1 = require("./GPTPrompt");
 Object.defineProperty(exports, "GPT_PROMPT", { enumerable: true, get: function () { return GPTPrompt_1.GPT_PROMPT; } });
+var LLMPromptV2_1 = require("./llmPrompt/LLMPromptV2");
+Object.defineProperty(exports, "LLM_PROMPT_V2", { enumerable: true, get: function () { return LLMPromptV2_1.LLM_PROMPT_V2; } });
+var llmPromptDefault_1 = require("./llmPrompt/llmPromptDefault");
+Object.defineProperty(exports, "LLM_PROMPT_DEFAULT", { enumerable: true, get: function () { return llmPromptDefault_1.LLM_PROMPT_DEFAULT; } });
+var llmPromptMCPTool_1 = require("./llmPrompt/llmPromptMCPTool");
+Object.defineProperty(exports, "LLM_PROMPT_MCP_TOOL", { enumerable: true, get: function () { return llmPromptMCPTool_1.LLM_PROMPT_MCP_TOOL; } });
+var llmPromptTool_1 = require("./llmPrompt/llmPromptTool");
+Object.defineProperty(exports, "LLM_PROMPT_TOOL", { enumerable: true, get: function () { return llmPromptTool_1.LLM_PROMPT_TOOL; } });
 var closeHandover_1 = require("./closeHandover");
 Object.defineProperty(exports, "CLOSE_HANDOVER", { enumerable: true, get: function () { return closeHandover_1.CLOSE_HANDOVER; } });
 var handoverInactivityTimer_1 = require("./handoverInactivityTimer");
@@ -51,6 +59,8 @@ var aiAgentHandover_1 = require("./aiAgent/aiAgentHandover");
 Object.defineProperty(exports, "AI_AGENT_HANDOVER", { enumerable: true, get: function () { return aiAgentHandover_1.AI_AGENT_HANDOVER; } });
 var aiAgentJobCallMCPTool_1 = require("./aiAgent/aiAgentJobCallMCPTool");
 Object.defineProperty(exports, "AI_AGENT_JOB_CALL_MCP_TOOL", { enumerable: true, get: function () { return aiAgentJobCallMCPTool_1.AI_AGENT_JOB_CALL_MCP_TOOL; } });
+var loadAiAgent_1 = require("./aiAgent/loadAiAgent");
+Object.defineProperty(exports, "LOAD_AI_AGENT", { enumerable: true, get: function () { return loadAiAgent_1.LOAD_AI_AGENT; } });
 var handoverConnections_1 = require("./handoverConnections");
 Object.defineProperty(exports, "LIVE_AGENT_CONNECTION", { enumerable: true, get: function () { return handoverConnections_1.LIVE_AGENT_CONNECTION; } });
 Object.defineProperty(exports, "RINGCENTRAL_ENGAGE_CONNECTION", { enumerable: true, get: function () { return handoverConnections_1.RINGCENTRAL_ENGAGE_CONNECTION; } });