@cognigy/rest-api-client 2025.25.0 → 2026.1.0

package/dist/esm/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js

@@ -0,0 +1,237 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../../createNodeDescriptor";
+import { TranscriptEntryType, TranscriptRole } from "../../../../interfaces/transcripts/transcripts";
+export const EXECUTE_WORKFLOW_TOOL = createNodeDescriptor({
+    type: "executeWorkflowTool",
+    defaultLabel: "Execute Workflow Tool",
+    parentType: ["aiAgentJob", "llmPromptV2"],
+    constraints: {
+        editable: true,
+        deletable: true,
+        collapsable: true,
+        creatable: true,
+        movable: true,
+        placement: {
+            predecessor: {
+                whitelist: []
+            }
+        },
+        childFlowCreatable: false
+    },
+    behavior: {
+        stopping: true
+    },
+    preview: {
+        type: "text",
+        key: "toolId"
+    },
+    fields: [
+        {
+            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: "cognigyLLMText",
+            defaultValue: "execute_workflow",
+            params: {
+                required: true,
+                rows: 1,
+                multiline: false,
+                maxLength: 64,
+            }
+        },
+        {
+            key: "description",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__EXECUTE_WORKFLOW_TOOL__FIELDS__DESCRIPTION__DESCRIPTION",
+            type: "cognigyLLMText",
+            params: {
+                required: true,
+                rows: 5,
+                multiline: true,
+                placeholder: `Describe the action or functionality that the target Flow handles.\nFor example: "Update a booking", "Check order status", or "Start onboarding workflow". Be specific so the AI Agent knows exactly when to execute this Flow.`
+            }
+        },
+        {
+            key: "parameters",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__DESCRIPTION",
+            type: "toolParameters",
+            defaultValue: `{
+	"type": "object",
+	"properties": {
+		"execution_reason": {
+			"type": "string",
+			"description": "The reason for executing this workflow, including context from the conversation."
+		}
+	},
+	"required": ["execution_reason"],
+	"additionalProperties": false
+}`,
+            params: {
+                required: false,
+            },
+        },
+        {
+            key: "flowNode",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__SERVICE__EXECUTE_WORKFLOW_TOOL__FIELDS__FLOW_NODE__LABEL",
+            params: {
+                required: true,
+            }
+        },
+        {
+            key: "parseIntents",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_INTENTS__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_INTENTS__DESCRIPTION",
+            defaultValue: false
+        },
+        {
+            key: "parseKeyphrases",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_KEYPHRASES__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_KEYPHRASES__DESCRIPTION",
+            defaultValue: false
+        },
+        {
+            key: "absorbContext",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__ABSORB_CONTEXT__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__ABSORB_CONTEXT__DESCRIPTION",
+            defaultValue: false
+        },
+        {
+            key: "debugMessage",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__DESCRIPTION",
+            defaultValue: true,
+        },
+        {
+            key: "condition",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__DESCRIPTION",
+            type: "cognigyText",
+            defaultValue: "",
+        },
+    ],
+    sections: [
+        {
+            key: "debugging",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__DEBUG_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "debugMessage",
+            ],
+        },
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "condition",
+                "parseIntents",
+                "parseKeyphrases",
+                "absorbContext",
+            ],
+        },
+    ],
+    form: [
+        { type: "field", key: "toolId" },
+        { type: "field", key: "description" },
+        { type: "field", key: "flowNode" },
+        { type: "section", key: "debugging" },
+        { type: "section", key: "advanced" },
+    ],
+    appearance: {
+        color: "white",
+        textColor: "#252525",
+        variant: "mini",
+    },
+    function: ({ cognigy, config, nodeId: thisNodeId }) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const { api } = cognigy;
+        const { debugMessage, flowNode: targetFlowNode, parseIntents, parseKeyphrases, absorbContext, } = config;
+        const sessionState = yield api.loadSessionState();
+        const toolCall = (_a = sessionState.lastToolCall) === null || _a === void 0 ? void 0 : _a.toolCall;
+        const aiAgentJobNode = (_b = sessionState.lastToolCall) === null || _b === void 0 ? void 0 : _b.aiAgentJobNode;
+        if (!(toolCall === null || toolCall === void 0 ? void 0 : toolCall.id)) {
+            (_c = api.logDebugError) === null || _c === void 0 ? void 0 : _c.call(api, "UI__DEBUG_MODE__AI_AGENT_ANSWER__ERROR__MESSAGE");
+        }
+        if (!(targetFlowNode === null || targetFlowNode === void 0 ? void 0 : targetFlowNode.flow)) {
+            throw new Error("Flow is required for Execute Workflow Tool");
+        }
+        if (toolCall && aiAgentJobNode) {
+            if (!((_d = api.checkThink) === null || _d === void 0 ? void 0 : _d.call(api, thisNodeId))) {
+                const executionReason = ((_f = (_e = toolCall === null || toolCall === void 0 ? void 0 : toolCall.function) === null || _e === void 0 ? void 0 : _e.arguments) === null || _f === void 0 ? void 0 : _f.execution_reason) || "No reason provided";
+                // Optional Debug Message
+                if (debugMessage) {
+                    (_g = api.logDebugMessage) === null || _g === void 0 ? void 0 : _g.call(api, JSON.stringify({
+                        execution_reason: executionReason,
+                        target_flow: targetFlowNode.flow,
+                        target_node: targetFlowNode.node,
+                    }, null, 2));
+                }
+                api.resetNextNodes();
+                // We add the return to the AI Agent Job node before the executeFlow of the target flow,
+                // because we want to return to the AI Agent Job node after the target flow has been executed
+                const { flow: thisFlow, node: thisNode } = aiAgentJobNode;
+                if (thisFlow && thisNode) {
+                    yield api.executeFlow({
+                        flowNode: {
+                            flow: thisFlow,
+                            node: thisNode,
+                        },
+                        absorbContext: true,
+                    });
+                }
+                else {
+                    throw new Error("AI Agent Job Node is required for Execute Workflow Tool");
+                }
+                // Execute the target flow (mirrors executeFlow functionality)
+                yield api.executeFlow({
+                    flowNode: {
+                        flow: targetFlowNode.flow,
+                        node: targetFlowNode.node
+                    },
+                    absorbContext,
+                    parseIntents,
+                    parseKeyphrases
+                });
+                // Add Tool Call Message to Transcript
+                const toolCallTranscriptStep = {
+                    role: TranscriptRole.ASSISTANT,
+                    type: TranscriptEntryType.TOOL_CALL,
+                    source: "system",
+                    payload: {
+                        name: toolCall.function.name,
+                        id: toolCall.id,
+                        input: toolCall.function.arguments,
+                    }
+                };
+                yield api.addTranscriptStep(toolCallTranscriptStep);
+                // Add Tool Answer Message to Transcript
+                const toolAnswer = {
+                    role: TranscriptRole.TOOL,
+                    type: TranscriptEntryType.TOOL_ANSWER,
+                    source: "system",
+                    payload: {
+                        toolCallId: toolCall.id,
+                        name: toolCall.function.name,
+                        content: "Workflow executed",
+                    }
+                };
+                yield api.addTranscriptStep(toolAnswer);
+                // Clear the last tool call from session state
+                api.updateSessionStateValues({
+                    lastToolCall: undefined
+                });
+            }
+            else {
+                throw new Error("Infinite Loop Detected");
+            }
+        }
+    })
+});
+//# sourceMappingURL=executeWorkflowTool.js.map