@cognigy/rest-api-client 0.18.0 → 0.20.0

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

@@ -28,9 +28,9 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             params: {
                 multiline: true,
                 rows: 5,
-                required: true
+                required: false
             },
-            defaultValue: ""
+            defaultValue: undefined
         },
         {
             key: "chatTranscriptSteps",
@@ -112,7 +112,7 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__MAX_TOKENS__LABEL",
             type: "slider",
             description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__MAX_TOKENS__DESCRIPTION",
-            defaultValue: 100,
+            defaultValue: 1000,
             params: {
                 min: 1,
                 max: 4000,
@@ -195,7 +195,7 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "immediateOutput",
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__IMMEDIATEOUTPUT__LABEL",
             type: "toggle",
-            defaultValue: false,
+            defaultValue: true,
             condition: {
                 or: [
                     {
@@ -250,7 +250,18 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             type: "textArray",
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_STOP_TOKENS__LABEL",
             description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_STOP_TOKENS__DESCRIPTION",
-            defaultValue: [".", "!", "?"],
+            defaultValue: [".", "!", "?", "\\n"],
+            condition: {
+                key: "storeLocation",
+                value: "stream",
+            }
+        },
+        {
+            key: "streamStopTokenOverrides",
+            type: "textArray",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_STOP_TOKEN_OVERRIDES__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_STOP_TOKEN_OVERRIDES__DESCRIPTION",
+            defaultValue: ["\d+\."],
             condition: {
                 key: "storeLocation",
                 value: "stream",
@@ -396,6 +407,13 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             type: "json",
             defaultValue: {}
         },
+        {
+            key: "logErrorToSystem",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__LOG_ERROR_TO_SYSTEM__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__LOG_ERROR_TO_SYSTEM__DESCRIPTION",
+            type: "toggle",
+            defaultValue: false,
+        },
         {
             key: "errorHandling",
             type: "select",
@@ -473,6 +491,7 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "contextKey",
                 "immediateOutput",
                 "streamStopTokens",
+                "streamStopTokenOverrides",
                 "streamStoreCopyInInput",
                 "detailedResults"
             ]
@@ -482,28 +501,29 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__ERROR_HANDLING__LABEL",
             defaultCollapsed: true,
             fields: [
+                "logErrorToSystem",
                 "errorHandling",
                 "errorMessage",
                 "errorHandlingGotoTarget",
             ]
         },
         {
-            key: "debugging",
-            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__DEBUGGING__LABEL",
+            key: "customOptions",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__CUSTOM_OPTIONS__LABEL",
             defaultCollapsed: true,
             fields: [
-                "debugDescription",
-                "debugLogTokenCount",
-                "debugLogRequestAndCompletion"
+                "customModelOptions",
+                "customRequestOptions"
             ]
         },
         {
-            key: "customOptions",
-            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__CUSTOM_OPTIONS__LABEL",
+            key: "debugging",
+            label: "UI__NODE_EDITOR__SECTIONS__DEBUG_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
-                "customModelOptions",
-                "customRequestOptions"
+                "debugDescription",
+                "debugLogTokenCount",
+                "debugLogRequestAndCompletion"
             ]
         }
     ],
@@ -515,16 +535,16 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "section", key: "advanced" },
         { type: "section", key: "storage" },
         { type: "section", key: "errorHandling" },
+        { type: "section", key: "customOptions" },
         { type: "section", key: "debugging" },
-        { type: "section", key: "customOptions" }
     ],
     appearance: {},
-    tags: ["service", "llm", "gpt", "generative ai", "openai", "azure", "prompt"],
+    tags: ["ai", "llm", "gpt", "generative ai", "openai", "azure", "prompt"],
     function: async ({ cognigy, config, nodeId }) => {
-        var _a;
+        var _a, _b, _c;
         const { api, input } = cognigy;
-        const { temperature, maxTokens, topP, presencePenalty, frequencyPenalty, useStop, stop, storeLocation, contextKey, inputKey, timeout, streamStopTokens, debugLogTokenCount, debugLogRequestAndCompletion, llmProviderReferenceId, useChatMode, chatTranscriptSteps, responseFormat, streamStoreCopyInInput, detailedResults, seed, immediateOutput, customModelOptions, customRequestOptions, errorHandling = "continue", // default behavior for LLM Prompt node was, continue its execution even though an error occurred (deviating it from the SEO node) & do not output an error message on UI explicitly. However, error is always stored in the input or context object. We can use an extra "say" node to output it.
-        errorHandlingGotoTarget, errorMessage, } = config;
+        const { temperature, maxTokens, topP, presencePenalty, frequencyPenalty, useStop, stop, storeLocation, contextKey, inputKey, timeout, streamStopTokens, streamStopTokenOverrides, debugLogTokenCount, debugLogRequestAndCompletion, llmProviderReferenceId, useChatMode, chatTranscriptSteps, responseFormat, streamStoreCopyInInput, detailedResults, seed, immediateOutput, customModelOptions, customRequestOptions, errorHandling = "continue", // default behavior for LLM Prompt node was, continue its execution even though an error occurred (deviating it from the SEO node) & do not output an error message on UI explicitly. However, error is always stored in the input or context object. We can use an extra "say" node to output it.
+        errorHandlingGotoTarget, errorMessage, logErrorToSystem, } = config;
         let prompt = config.prompt;
         const { traceId } = input;
         // check if custom variables are used and if they have a length modifier
@@ -549,13 +569,17 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
         }
         // handle errors from external services, depending on the settings
         const handleServiceError = async (error) => {
-            var _a;
+            var _a, _b, _c;
             const compactError = {
                 name: error === null || error === void 0 ? void 0 : error.name,
                 code: error === null || error === void 0 ? void 0 : error.code,
                 message: (error === null || error === void 0 ? void 0 : error.message) || error
             };
-            if ((_a = error === null || error === void 0 ? void 0 : error.originalErrorDetails) === null || _a === void 0 ? void 0 : _a.code) {
+            // return the requestId if it exist in the error obj.
+            if ((_a = error === null || error === void 0 ? void 0 : error.meta) === null || _a === void 0 ? void 0 : _a.requestId) {
+                compactError["requestId"] = (_b = error === null || error === void 0 ? void 0 : error.meta) === null || _b === void 0 ? void 0 : _b.requestId;
+            }
+            if ((_c = error === null || error === void 0 ? void 0 : error.originalErrorDetails) === null || _c === void 0 ? void 0 : _c.code) {
                 compactError.code = error.originalErrorDetails.code;
             }
             const errorResponse = {
@@ -619,7 +643,9 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     }
                 },
                 streamStopTokens,
-                detailedResults,
+                streamStopTokenOverrides,
+                // set to true in order to get token usage
+                detailedResults: true,
                 seed: Number(seed) ? Number(seed) : undefined,
                 customModelOptions,
                 customRequestOptions
@@ -641,25 +667,18 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 debugPrompt = JSON.stringify(data["chat"]);
             }
             const response = await api.runGenerativeAIPrompt(data, "gptPromptNode");
-            // if we're in adminconsole, process debugging options
-            input.channel === "adminconsole" && (0, prompt_1.writeLLMDebugLogs)("LLM Prompt", debugPrompt, response, debugLogTokenCount, debugLogRequestAndCompletion, cognigy);
+            const isFollowSessionActive = api.getMetadata().isFollowSessionActive;
+            // if we're in adminconsole or following a session, process debugging options
+            (input.endpointType === "adminconsole" || isFollowSessionActive) && (0, prompt_1.writeLLMDebugLogs)("LLM Prompt", debugPrompt, response, debugLogTokenCount, debugLogRequestAndCompletion, cognigy);
+            let responseToStore;
             if (detailedResults) {
-                // if the api didn't return native usage results, compute them
-                if (!response.usage) {
-                    const promptContent = (response.messages) ? JSON.stringify(response.messages) : prompt;
-                    delete response.messages;
-                    const prompt_tokens = await api.countGPTTokens(promptContent);
-                    const completion_tokens = await api.countGPTTokens(response.result);
-                    response.usage = {
-                        prompt_tokens,
-                        completion_tokens,
-                        total_tokens: prompt_tokens + completion_tokens,
-                        calculation_method: "estimate"
-                    };
-                }
+                responseToStore = response;
+            }
+            else {
+                responseToStore = response.result;
             }
             if (storeLocation === "context") {
-                api.addToContext(contextKey, response, "simple");
+                api.addToContext(contextKey, responseToStore, "simple");
                 // output result immediately if toggle is set
                 if (immediateOutput) {
                     const resultToOutput = typeof ((response === null || response === void 0 ? void 0 : response.result) || response) === "object" ? JSON.stringify((response === null || response === void 0 ? void 0 : response.result) || response, undefined, 2) : (response === null || response === void 0 ? void 0 : response.result) || response;
@@ -668,7 +687,7 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
             else if (storeLocation === "input" || (storeLocation === "stream" && streamStoreCopyInInput)) {
                 // @ts-ignore
-                api.addToInput(inputKey, response);
+                api.addToInput(inputKey, responseToStore);
                 // output result immediately if toggle is set and we're storing into input
                 // this means we don't output the result again if we streamed
                 if (storeLocation === "input" && immediateOutput) {
@@ -678,12 +697,22 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
         }
         catch (error) {
-            const errorDetails = {
+            const errorDetailsBase = {
                 name: error === null || error === void 0 ? void 0 : error.name,
                 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) || ((_a = error.originalErrorDetails) === null || _a === void 0 ? void 0 : _a.message),
-                originalErrorDetails: error === null || error === void 0 ? void 0 : error.originalErrorDetails
             };
+            const errorDetails = Object.assign(Object.assign({}, errorDetailsBase), { originalErrorDetails: error === null || error === void 0 ? void 0 : error.originalErrorDetails });
+            // return the requestId if it exist in the error obj.
+            if ((_b = error.meta) === null || _b === void 0 ? void 0 : _b.requestId) {
+                errorDetails["meta"] = {
+                    requestId: (_c = error.meta) === null || _c === void 0 ? void 0 : _c.requestId
+                };
+            }
+            if (logErrorToSystem) {
+                api.log("error", JSON.stringify(errorDetailsBase));
+            }
+            api.logDebugError(errorDetailsBase, "UI__DEBUG_MODE__LLM_PROMPT__ERROR");
             await handleServiceError(errorDetails);
             return;
         }

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

@@ -201,7 +201,7 @@ exports.LLM_ENTITY_EXTRACT = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "section", key: "debugging" }
     ],
     appearance: {},
-    tags: ["service", "llm", "gpt", "generative ai", "openai", "azure", "prompt", "entity", "extract"],
+    tags: ["ai", "llm", "gpt", "generative ai", "openai", "azure", "prompt", "entity", "extract"],
     function: async ({ cognigy, config }) => {
         var _a, _b;
         const { api, input } = cognigy;
@@ -228,8 +228,7 @@ exports.LLM_ENTITY_EXTRACT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
             options["chat"] = (0, prompt_1.createLastConversationChatObject)(cognigy.lastConversationEntries, (0, generativeAIPrompts_1.getLLMEntityExtractSystemMessage)(entityName, entityDescription, examples), 3, true);
             const response = await api.runGenerativeAIPrompt(options, "gptPromptNode");
-            // if we're in adminconsole, process debugging options
-            input.channel === "adminconsole" && (0, prompt_1.writeLLMDebugLogs)("LLM Entity Extract", prompt, response, debugLogTokenCount, debugLogRequestAndCompletion, cognigy);
+            (0, prompt_1.writeLLMDebugLogs)("LLM Entity Extract", prompt, response, debugLogTokenCount, debugLogRequestAndCompletion, cognigy);
             // find the entity in the response
             let result = (_a = response === null || response === void 0 ? void 0 : response.result) === null || _a === void 0 ? void 0 : _a[entityName];
             if (!result) {
@@ -248,10 +247,19 @@ exports.LLM_ENTITY_EXTRACT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
             if (storeLocation === "context") {
                 api.addToContext(contextKey, result, "simple");
+                if (result) {
+                    api.logDebugMessage(`context.${contextKey} = '${result}'`);
+                }
             }
             else if (storeLocation === "input") {
                 // @ts-ignore
                 api.addToInput(inputKey, result);
+                if (result) {
+                    api.logDebugMessage(`input.${inputKey} = '${result}'`);
+                }
+            }
+            if (!result) {
+                api.logDebugMessage(`UI__DEBUG_MODE__LLM_ENTITY_EXTRACT__MESSAGE`);
             }
         }
         catch (error) {
@@ -260,6 +268,7 @@ exports.LLM_ENTITY_EXTRACT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 code: error.code,
                 message: error.message || ((_b = error.originalErrorDetails) === null || _b === void 0 ? void 0 : _b.message),
             };
+            api.logDebugError(errorDetails);
             if (storeLocation === "context") {
                 api.addToContext(contextKey, { error: errorDetails }, "simple");
             }

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

@@ -0,0 +1,92 @@
+"use strict";
+/* Custom modules */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AI_AGENT_HANDOVER = void 0;
+/* Interfaces */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+exports.AI_AGENT_HANDOVER = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "aiAgentHandover",
+    defaultLabel: "AI Agent Handover",
+    summary: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__SUMMARY",
+    appearance: {
+        showIcon: false,
+        color: "#7F199B",
+    },
+    behavior: {
+        stopping: true
+    },
+    fields: [
+        {
+            key: "flowNode",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__FIELDS__FLOW_NODE__LABEL",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "parseIntents",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__FIELDS__PARSE_INTENTS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__FIELDS__PARSE_INTENTS__DESCRIPTION",
+            defaultValue: false,
+        },
+        {
+            key: "parseKeyphrases",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__FIELDS__PARSE_KEYPHRASES__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__FIELDS__PARSE_KEYPHRASES__DESCRIPTION",
+            defaultValue: false,
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_HANDOVER__SECTIONS__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "parseIntents",
+                "parseKeyphrases",
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "flowNode" },
+        { type: "section", key: "advanced" }
+    ],
+    preview: {
+        key: "flowNode",
+        type: "resource",
+    },
+    tags: ["ai", "aiAgent"],
+    function: async ({ cognigy, config, nodeId: thisNodeId }) => {
+        var _a, _b;
+        const { flowNode: { flow: flowId, node: nodeId }, parseIntents, parseKeyphrases } = config;
+        const { api } = cognigy;
+        if (!flowId) {
+            throw new Error("flowId is required");
+        }
+        if (!nodeId) {
+            throw new Error("nodeId is required");
+        }
+        if (!((_a = api.checkThink) === null || _a === void 0 ? void 0 : _a.call(api, thisNodeId))) {
+            api.resetNextNodes();
+            (_b = api.setThinkMarker) === null || _b === void 0 ? void 0 : _b.call(api, config.flowNode.flow);
+            // If Execution is to continue, execute Flow
+            await api.executeFlow({
+                flowNode: {
+                    flow: flowId,
+                    node: nodeId,
+                    isGoto: true,
+                },
+                absorbContext: true,
+                parseIntents,
+                parseKeyphrases
+            });
+        }
+        else {
+            throw new Error("Infinite Loop Detected");
+        }
+    },
+});
+//# sourceMappingURL=aiAgentHandover.js.map