@cognigy/rest-api-client 2025.12.0 → 2025.14.0

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

@@ -21,6 +21,7 @@ const logFullConfigToDebugMode_1 = require("../../../../helper/logFullConfigToDe
 const createSystemMessage_1 = require("./helpers/createSystemMessage");
 const generateSearchPrompt_1 = require("./helpers/generateSearchPrompt");
 const getUserMemory_1 = require("./helpers/getUserMemory");
+const createToolDefinitions_1 = require("./helpers/createToolDefinitions");
 const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
 exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "aiAgentJob",
@@ -78,7 +79,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "name",
             label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__JOB_NAME__LABEL",
-            type: "cognigyText",
+            type: "cognigyLLMText",
             defaultValue: "Customer Support Specialist",
             params: {
                 required: true,
@@ -511,6 +512,13 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
             description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__LOG_CONFIG__DESCRIPTION",
             defaultValue: true
         },
+        {
+            key: "debugLogLLMLatency",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__LOG_LLM_LATENCY__LABEL",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__LOG_LLM_LATENCY__DESCRIPTION",
+            defaultValue: false
+        },
         {
             key: "storeLocation",
             type: "select",
@@ -830,7 +838,8 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "debugResult",
                 "debugLogTokenCount",
                 "debugLogSystemPrompt",
-                "debugLogToolDefinitions"
+                "debugLogToolDefinitions",
+                "debugLogLLMLatency"
             ],
         }
     ],
@@ -851,9 +860,9 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
     ],
     tags: ["ai", "aiAgent"],
     function: async ({ cognigy, config, childConfigs, nodeId }) => {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21;
         const { api, context, input, profile, flowReferenceId } = cognigy;
-        const { aiAgent, llmProviderReferenceId, name: jobName, description: jobDescription, instructions: jobInstructions, outputImmediately, toolChoice, useStrict, memoryType, selectedProfileFields, memoryContextInjection, knowledgeSearchBehavior, knowledgeSearchTags, knowledgeSearchTagsFilterOp, knowledgeSearchAiAgentKnowledge, knowledgeSearchJobKnowledge, knowledgeSearchJobStore, knowledgeSearchGenerateSearchPrompt, knowledgeSearchTopK, timeoutInMs, maxTokens, temperature, logErrorToSystem, storeErrorInInput, errorHandling, errorHandlingGotoTarget, errorMessage, debugConfig, debugLogTokenCount, debugLogSystemPrompt, debugLogToolDefinitions, debugResult, storeLocation, contextKey, inputKey, streamStoreCopyInInput, streamStopTokens, processImages, transcriptImageHandling, sessionParams } = config;
+        const { aiAgent, llmProviderReferenceId, name: jobName, description: jobDescription, instructions: jobInstructions, outputImmediately, toolChoice, useStrict, memoryType, selectedProfileFields, memoryContextInjection, knowledgeSearchBehavior, knowledgeSearchTags, knowledgeSearchTagsFilterOp, knowledgeSearchAiAgentKnowledge, knowledgeSearchJobKnowledge, knowledgeSearchJobStore, knowledgeSearchGenerateSearchPrompt, knowledgeSearchTopK, timeoutInMs, maxTokens, temperature, logErrorToSystem, storeErrorInInput, errorHandling, errorHandlingGotoTarget, errorMessage, debugConfig, debugLogTokenCount, debugLogSystemPrompt, debugLogToolDefinitions, debugResult, debugLogLLMLatency, storeLocation, contextKey, inputKey, streamStoreCopyInInput, streamStopTokens, processImages, transcriptImageHandling, sessionParams } = config;
         try {
             if (!aiAgent) {
                 throw new Error("Could not resolve AI Agent reference in AI Agent Node");
@@ -901,7 +910,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     throw new Error(`[VG2] Error on AI Agent Job node. Error message: ${error.message}`);
                 }
             }
-            const _24 = profile, { profileId, accepted_gdpr, prevent_data_collection, privacy_policy } = _24, cleanedProfile = __rest(_24, ["profileId", "accepted_gdpr", "prevent_data_collection", "privacy_policy"]);
+            const _22 = profile, { profileId, accepted_gdpr, prevent_data_collection, privacy_policy } = _22, cleanedProfile = __rest(_22, ["profileId", "accepted_gdpr", "prevent_data_collection", "privacy_policy"]);
             const userMemory = (0, getUserMemory_1.getUserMemory)(memoryType, selectedProfileFields, aiAgent, cleanedProfile);
             /**
              *  ----- Knowledge Search Section -----
@@ -1026,149 +1035,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 const debugSystemMessage = (_r = (_q = systemMessage[0]) === null || _q === void 0 ? void 0 : _q.content) === null || _r === void 0 ? void 0 : _r.replace(`${(0, createSystemMessage_1.getCognigyBrandMessage)()}\n`, "");
                 (_s = api.logDebugMessage) === null || _s === void 0 ? void 0 : _s.call(api, debugSystemMessage, "UI__DEBUG_MODE__AI_AGENT_JOB__SYSTEM_PROMPT__HEADER");
             }
-            // 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 = [];
-            for (const child of childConfigs) {
-                if (child.type === "aiAgentJobDefault") {
-                    continue;
-                }
-                const toolId = child.config.toolId;
-                if (child.type === "aiAgentJobTool" &&
-                    (!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.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;
-                        (_t = api.logDebugError) === null || _t === void 0 ? void 0 : _t.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) {
-                                (_u = api.logDebugMessage) === null || _u === void 0 ? void 0 : _u.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}`);
-                                            }
-                                        });
-                                    }
-                                });
-                                (_v = api.logDebugMessage) === null || _v === void 0 ? void 0 : _v.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);
-                    }
-                }
-            }
-            ;
+            const { toolIds, toolNames, toolMap, tools } = await (0, createToolDefinitions_1.createToolDefinitions)(childConfigs, api, useStrict);
             // we only add this tool if at least one knowledge source is enabled
             if (isOnDemandKnowledgeStoreConfigured) {
                 const knowledgeTool = {
@@ -1200,7 +1067,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 tools.push(knowledgeTool);
             }
             if (debugLogToolDefinitions) {
-                (_w = api.logDebugMessage) === null || _w === void 0 ? void 0 : _w.call(api, tools, "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_DEFINITIONS");
+                (_t = api.logDebugMessage) === null || _t === void 0 ? void 0 : _t.call(api, tools, "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_DEFINITIONS");
             }
             // Optional Debug Message with the config
             if (debugConfig) {
@@ -1209,10 +1076,10 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__AI_AGENT_NAME__LABEL</b> ${aiAgent.name}`);
                 messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__JOB_NAME__LABEL</b> ${jobName}`);
                 // Safety settings
-                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_AVOID_HARMFUL_CONTENT</b> ${(_x = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _x === void 0 ? void 0 : _x.avoidHarmfulContent}`);
-                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_AVOID_UNGROUNDED_CONTENT</b> ${(_y = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _y === void 0 ? void 0 : _y.avoidUngroundedContent}`);
-                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_AVOID_COPYRIGHT_INFRINGEMENTS</b> ${(_z = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _z === void 0 ? void 0 : _z.avoidCopyrightInfringements}`);
-                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_PREVENT_JAILBREAK_AND_MANIPULATION</b> ${(_0 = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _0 === void 0 ? void 0 : _0.preventJailbreakAndManipulation}`);
+                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_AVOID_HARMFUL_CONTENT</b> ${(_u = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _u === void 0 ? void 0 : _u.avoidHarmfulContent}`);
+                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_AVOID_UNGROUNDED_CONTENT</b> ${(_v = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _v === void 0 ? void 0 : _v.avoidUngroundedContent}`);
+                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_AVOID_COPYRIGHT_INFRINGEMENTS</b> ${(_w = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _w === void 0 ? void 0 : _w.avoidCopyrightInfringements}`);
+                messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__SAFETY_SETTINGS_PREVENT_JAILBREAK_AND_MANIPULATION</b> ${(_x = aiAgent === null || aiAgent === void 0 ? void 0 : aiAgent.safetySettings) === null || _x === void 0 ? void 0 : _x.preventJailbreakAndManipulation}`);
                 // Tools
                 if (toolNames.length > 0) {
                     messageLines.push("<b>UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__TOOLS__LABEL</b>");
@@ -1268,7 +1135,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 messageLines.push(`UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__VOICE_SETTING__TTS_VOICE ${config.ttsVoice || 'UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__VOICE_SETTING__NOT_SET'}`);
                 messageLines.push(`UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__VOICE_SETTING__TTS_LABEL ${config.ttsLabel || 'UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__VOICE_SETTING__NOT_SET'}`);
                 messageLines.push(`UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__VOICE_SETTING__TTS_DISABLE_CACHE ${config.ttsDisableCache || 'UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__VOICE_SETTING__NOT_SET'}`);
-                (_1 = api.logDebugMessage) === null || _1 === void 0 ? void 0 : _1.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__HEADER");
+                (_y = api.logDebugMessage) === null || _y === void 0 ? void 0 : _y.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__CONFIGURATION__HEADER");
             }
             const transcript = await api.getTranscript({
                 limit: 50,
@@ -1282,17 +1149,21 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 transcript.length > 0 &&
                 transcript[transcript.length - 1].role === transcripts_1.TranscriptRole.USER) {
                 const userInput = transcript[transcript.length - 1];
-                const enhancedInput = `## Knowledge Source Context\nAdditional Context from the knowledge source: \n${JSON.stringify(knowledgeSearchResponseData)}\n\n\n${((_2 = userInput === null || userInput === void 0 ? void 0 : userInput.payload) === null || _2 === void 0 ? void 0 : _2.text) || input.text}`;
+                const enhancedInput = `## Knowledge Source Context\nAdditional Context from the knowledge source: \n${JSON.stringify(knowledgeSearchResponseData)}\n\n\n${((_z = userInput === null || userInput === void 0 ? void 0 : userInput.payload) === null || _z === void 0 ? void 0 : _z.text) || input.text}`;
                 transcript[transcript.length - 1].payload.text = enhancedInput;
             }
             const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
             const _messageId = (0, crypto_1.randomUUID)();
             const llmPromptOptions = Object.assign(Object.assign({ prompt: "", chat: systemMessage, 
                 // Temp fix to override the transcript if needed
-                transcript: ((_3 = context === null || context === void 0 ? void 0 : context._cognigy) === null || _3 === void 0 ? void 0 : _3.transcript) ? [...context._cognigy.transcript] : transcript, detailedResults: true, timeoutInMs: timeoutInMs !== null && timeoutInMs !== void 0 ? timeoutInMs : 8000, maxTokens: maxTokens !== null && maxTokens !== void 0 ? maxTokens : 4000, temperature: temperature !== null && temperature !== void 0 ? temperature : 0.7, topP: 1, frequencyPenalty: 0, presencePenalty: 0, responseFormat: "text", stream: storeLocation === "stream", streamOnDataHandler: (text) => {
+                transcript: ((_0 = context === null || context === void 0 ? void 0 : context._cognigy) === null || _0 === void 0 ? void 0 : _0.transcript) ? [...context._cognigy.transcript] : transcript, detailedResults: true, timeoutInMs: timeoutInMs !== null && timeoutInMs !== void 0 ? timeoutInMs : 8000, maxTokens: maxTokens !== null && maxTokens !== void 0 ? maxTokens : 4000, temperature: temperature !== null && temperature !== void 0 ? temperature : 0.7, topP: 1, frequencyPenalty: 0, presencePenalty: 0, responseFormat: "text", stream: storeLocation === "stream", streamOnDataHandler: (text) => {
                     var _a;
                     text = isStreamingChannel ? text : text.trim();
                     if (text) {
+                        // Record first output time for debugging if not already recorded
+                        if (debugLogLLMLatency && firstOutputTime === null) {
+                            firstOutputTime = Date.now();
+                        }
                         // if we got text, we output it, but prevent it from being added to the transcript
                         (_a = api.output) === null || _a === void 0 ? void 0 : _a.call(api, text, {
                             _cognigy: {
@@ -1313,15 +1184,40 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 };
             }
             // Set understood to true so that an AI Agent interaction doesn't look false in our analytics
-            (_4 = api.setAnalyticsData) === null || _4 === void 0 ? void 0 : _4.call(api, "understood", "true");
+            (_1 = api.setAnalyticsData) === null || _1 === void 0 ? void 0 : _1.call(api, "understood", "true");
             input.understood = true;
-            const fullLlmResult = await ((_5 = api.runGenerativeAIPrompt) === null || _5 === void 0 ? void 0 : _5.call(api, llmPromptOptions, "aiAgent"));
+            // Start measuring LLM latency and time to first output if debug flag is enabled
+            const llmStartTime = debugLogLLMLatency ? Date.now() : 0;
+            let firstOutputTime = null;
+            const fullLlmResult = await ((_2 = api.runGenerativeAIPrompt) === null || _2 === void 0 ? void 0 : _2.call(api, llmPromptOptions, "aiAgent"));
+            // End measuring times and log if debug flag is enabled
+            if (debugLogLLMLatency) {
+                const llmEndTime = Date.now();
+                const debugMessages = [];
+                const llmLatencyMs = llmEndTime - llmStartTime;
+                let timeToFirstOutputLabel;
+                if (fullLlmResult.finishReason === "tool_calls" && fullLlmResult.toolCalls.length > 0) {
+                    timeToFirstOutputLabel = " - (tool call)";
+                }
+                else if (firstOutputTime === null) {
+                    timeToFirstOutputLabel = " - (no output)";
+                }
+                else {
+                    firstOutputTime = firstOutputTime || llmEndTime;
+                    timeToFirstOutputLabel = `${firstOutputTime - llmStartTime}ms`;
+                }
+                if (storeLocation === "stream") {
+                    debugMessages.push(`UI__DEBUG_MODE__AI_AGENT_JOB__TIME_TO_FIRST_OUTPUT__LABEL: ${timeToFirstOutputLabel}`);
+                }
+                debugMessages.push(`UI__DEBUG_MODE__AI_AGENT_JOB__LLM_LATENCY__LABEL: ${llmLatencyMs}ms`);
+                (_3 = api.logDebugMessage) === null || _3 === void 0 ? void 0 : _3.call(api, debugMessages.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__TIMING__HEADER");
+            }
             const { messages } = fullLlmResult, llmResult = __rest(fullLlmResult, ["messages"]);
             const llmProvider = llmResult === null || llmResult === void 0 ? void 0 : llmResult.provider;
             const tokenUsage = fullLlmResult.tokenUsage;
             // Send optional debug message with token usage
             if (debugLogTokenCount && tokenUsage) {
-                (_6 = api.logDebugMessage) === null || _6 === void 0 ? void 0 : _6.call(api, tokenUsage, "UI__DEBUG_MODE__AI_AGENT_JOB__TOKEN_USAGE__HEADER");
+                (_4 = api.logDebugMessage) === null || _4 === void 0 ? void 0 : _4.call(api, tokenUsage, "UI__DEBUG_MODE__AI_AGENT_JOB__TOKEN_USAGE__HEADER");
             }
             // Identify if the result is a tool call
             // If response is a tool call, set next node for Tools
@@ -1336,7 +1232,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     isMcpToolCall = true;
                 }
                 if (mainToolCall.function.name !== "retrieve_knowledge" && toolChild === undefined) {
-                    (_7 = api.logDebugError) === null || _7 === void 0 ? void 0 : _7.call(api, `UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__ERROR__BODY <b>${mainToolCall.function.name}</b>`, "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__ERROR__HEADER");
+                    (_5 = api.logDebugError) === null || _5 === void 0 ? void 0 : _5.call(api, `UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__ERROR__BODY <b>${mainToolCall.function.name}</b>`, "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__ERROR__HEADER");
                 }
                 // Add last tool call to session state for loading it from Tool Answer Node
                 api.updateSessionStateValues({
@@ -1344,21 +1240,21 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                             flow: flowReferenceId,
                             node: nodeId,
                         } }, (isMcpToolCall && {
-                        mcpServerUrl: (_8 = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _8 === void 0 ? void 0 : _8.mcpServerUrl,
-                        timeout: (_9 = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _9 === void 0 ? void 0 : _9.timeout,
+                        mcpServerUrl: (_6 = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _6 === void 0 ? void 0 : _6.mcpServerUrl,
+                        timeout: (_7 = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _7 === void 0 ? void 0 : _7.timeout,
                         mcpToolNode: toolChild === null || toolChild === void 0 ? void 0 : toolChild.id,
                     })), { toolCall: mainToolCall }),
                 });
                 // if there are any parameters/arguments, add them to the input slots
                 if (mainToolCall.function.arguments) {
-                    input.aiAgent = Object.assign(Object.assign({}, input.aiAgent), { toolArgs: Object.assign(Object.assign({}, (_11 = (_10 = input.aiAgent) === null || _10 === void 0 ? void 0 : _10.toolArgs) !== null && _11 !== void 0 ? _11 : {}), mainToolCall.function.arguments) });
+                    input.aiAgent = Object.assign(Object.assign({}, input.aiAgent), { toolArgs: Object.assign(Object.assign({}, (_9 = (_8 = input.aiAgent) === null || _8 === void 0 ? void 0 : _8.toolArgs) !== null && _9 !== void 0 ? _9 : {}), mainToolCall.function.arguments) });
                 }
                 // Debug Message for Tool Calls, configured in the Tool Node
-                if ((_12 = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _12 === void 0 ? void 0 : _12.debugMessage) {
+                if ((_10 = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _10 === void 0 ? void 0 : _10.debugMessage) {
                     const toolId = isMcpToolCall ? mainToolCall.function.name : api.parseCognigyScriptText(toolChild.config.toolId);
                     const messageLines = [`<b>UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER:</b> ${toolId}`];
                     // Arguments / Parameters Slots
-                    const slots = ((_13 = mainToolCall === null || mainToolCall === void 0 ? void 0 : mainToolCall.function) === null || _13 === void 0 ? void 0 : _13.arguments) && Object.keys(mainToolCall.function.arguments);
+                    const slots = ((_11 = mainToolCall === null || mainToolCall === void 0 ? void 0 : mainToolCall.function) === null || _11 === void 0 ? void 0 : _11.arguments) && Object.keys(mainToolCall.function.arguments);
                     const hasSlots = slots && slots.length > 0;
                     messageLines.push(`<b>UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__SLOTS</b>${hasSlots ? "" : " -"}`);
                     if (hasSlots) {
@@ -1373,7 +1269,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                             messageLines.push(`- ${slot}: ${slotValueAsString}`);
                         });
                     }
-                    (_14 = api.logDebugMessage) === null || _14 === void 0 ? void 0 : _14.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER");
+                    (_12 = api.logDebugMessage) === null || _12 === void 0 ? void 0 : _12.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER");
                 }
                 if (toolChild) {
                     api.setNextNode(toolChild.id);
@@ -1398,11 +1294,11 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
             // Optionally output the result immediately
             if (llmResult.result && outputImmediately && !llmPromptOptions.stream) {
-                await ((_15 = api.output) === null || _15 === void 0 ? void 0 : _15.call(api, llmResult.result, {}));
+                await ((_13 = api.output) === null || _13 === void 0 ? void 0 : _13.call(api, llmResult.result, {}));
             }
             else if (llmResult.finishReason && llmPromptOptions.stream) {
                 // send the finishReason as last output for a stream
-                (_16 = api.output) === null || _16 === void 0 ? void 0 : _16.call(api, "", {
+                (_14 = api.output) === null || _14 === void 0 ? void 0 : _14.call(api, "", {
                     _cognigy: {
                         _preventTranscript: true,
                         _messageId,
@@ -1425,7 +1321,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
             // Add response to Cognigy Input/Context for further usage
             if (storeLocation === "context") {
-                (_17 = api.addToContext) === null || _17 === void 0 ? void 0 : _17.call(api, contextKey, llmResult, "simple");
+                (_15 = api.addToContext) === null || _15 === void 0 ? void 0 : _15.call(api, contextKey, llmResult, "simple");
             }
             else if (storeLocation === "input") {
                 api.addToInput(inputKey, llmResult);
@@ -1438,14 +1334,14 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
             const errorDetails = {
                 name: (error === null || error === void 0 ? void 0 : error.name) || "Error",
                 code: (error === null || error === void 0 ? void 0 : error.code) || (error === null || error === void 0 ? void 0 : error.httpStatusCode),
-                message: (error === null || error === void 0 ? void 0 : error.message) || ((_18 = error.originalErrorDetails) === null || _18 === void 0 ? void 0 : _18.message),
+                message: (error === null || error === void 0 ? void 0 : error.message) || ((_16 = error.originalErrorDetails) === null || _16 === void 0 ? void 0 : _16.message),
             };
-            (_19 = api.emitEvent) === null || _19 === void 0 ? void 0 : _19.call(api, "nodeError", { nodeId, flowId: flowReferenceId, errorMessage: error });
+            (_17 = api.emitEvent) === null || _17 === void 0 ? void 0 : _17.call(api, "nodeError", { nodeId, flowId: flowReferenceId, errorMessage: error });
             if (logErrorToSystem) {
-                (_20 = api.log) === null || _20 === void 0 ? void 0 : _20.call(api, "error", JSON.stringify(errorDetails));
+                (_18 = api.log) === null || _18 === void 0 ? void 0 : _18.call(api, "error", JSON.stringify(errorDetails));
             }
             if (errorHandling !== "stop") {
-                (_21 = api.logDebugError) === null || _21 === void 0 ? void 0 : _21.call(api, errorDetails.message + (errorDetails.code ? ` (error code: ${errorDetails.code})` : ""), errorDetails.name);
+                (_19 = api.logDebugError) === null || _19 === void 0 ? void 0 : _19.call(api, errorDetails.message + (errorDetails.code ? ` (error code: ${errorDetails.code})` : ""), errorDetails.name);
             }
             if (storeErrorInInput) {
                 input.aiAgent = input.aiAgent || {};
@@ -1454,7 +1350,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
             if (errorHandling === "continue") {
                 // output the timeout message
                 if (errorMessage) {
-                    await ((_22 = api.output) === null || _22 === void 0 ? void 0 : _22.call(api, errorMessage, null));
+                    await ((_20 = api.output) === null || _20 === void 0 ? void 0 : _20.call(api, errorMessage, null));
                 }
                 // Set default node as next node
                 const defaultChild = childConfigs.find(child => child.type === "aiAgentJobDefault");
@@ -1466,7 +1362,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 if (!errorHandlingGotoTarget) {
                     throw new Error("GoTo Target is required");
                 }
-                if (!((_23 = api.checkThink) === null || _23 === void 0 ? void 0 : _23.call(api, nodeId))) {
+                if (!((_21 = api.checkThink) === null || _21 === void 0 ? void 0 : _21.call(api, nodeId))) {
                     api.resetNextNodes();
                     await api.executeFlow({
                         flowNode: {

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

@@ -29,7 +29,7 @@ exports.AI_AGENT_JOB_TOOL = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "toolId",
             label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__LABEL",
             description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__DESCRIPTION",
-            type: "cognigyText",
+            type: "cognigyLLMText",
             defaultValue: "unlock_account",
             params: {
                 required: true,
@@ -42,7 +42,7 @@ exports.AI_AGENT_JOB_TOOL = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "description",
             label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__LABEL",
             description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__DESCRIPTION",
-            type: "cognigyText",
+            type: "cognigyLLMText",
             defaultValue: "This tool unlocks a locked user account.",
             params: {
                 required: true,

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