@cognigy/rest-api-client 0.17.0 → 0.19.0

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

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GPT_PROMPT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const logic_1 = require("../logic");
 const prompt_1 = require("../nlu/generativeSlotFiller/prompt");
+const errors_1 = require("../../../errors");
 exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "completeText",
     defaultLabel: "LLM Prompt",
@@ -26,9 +28,9 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             params: {
                 multiline: true,
                 rows: 5,
-                required: true
+                required: false
             },
-            defaultValue: ""
+            defaultValue: undefined
         },
         {
             key: "chatTranscriptSteps",
@@ -189,14 +191,48 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 required: true
             },
         },
+        {
+            key: "immediateOutput",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__IMMEDIATEOUTPUT__LABEL",
+            type: "toggle",
+            defaultValue: false,
+            condition: {
+                or: [
+                    {
+                        key: "storeLocation",
+                        value: "input",
+                    },
+                    {
+                        key: "storeLocation",
+                        value: "context",
+                    }
+                ]
+            }
+        },
         {
             key: "inputKey",
             type: "cognigyText",
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__INPUT_KEY__LABEL",
             defaultValue: "promptResult",
             condition: {
-                key: "storeLocation",
-                value: "input",
+                or: [
+                    {
+                        key: "storeLocation",
+                        value: "input",
+                    },
+                    {
+                        and: [
+                            {
+                                key: "storeLocation",
+                                value: "stream",
+                            },
+                            {
+                                key: "streamStoreCopyInInput",
+                                value: true,
+                            }
+                        ]
+                    }
+                ]
             }
         },
         {
@@ -214,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",
@@ -225,13 +272,24 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             type: "description",
             label: " ",
             params: {
-                text: "Please note streaming may not be supported by all LLM providers. If streaming is not supported, the result is written to the Input object."
+                text: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_DESCRIPTION__TEXT"
             },
             condition: {
                 key: "storeLocation",
                 value: "stream",
             }
         },
+        {
+            key: "streamStoreCopyInInput",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_STORE_COPY__LABEL",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__STREAM_STORE_COPY__DESCRIPTION",
+            defaultValue: false,
+            condition: {
+                key: "storeLocation",
+                value: "stream",
+            }
+        },
         {
             key: "debugLogTokenCount",
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__DEBUGLOGTOKENCOUNT__LABEL",
@@ -251,7 +309,145 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             type: "description",
             label: " ",
             params: {
-                text: "For performance reasons, debug logging will only be active when testing from Interaction Panel."
+                text: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__DEBUG_DESCRIPTION__TEXT"
+            }
+        },
+        {
+            key: "responseFormat",
+            type: "select",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__RESPONSE_FORMAT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__RESPONSE_FORMAT__DESCRIPTION",
+            defaultValue: "default",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__RESPONSE_FORMAT__OPTIONS__DEFAULT__LABEL",
+                        value: "default"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__RESPONSE_FORMAT__OPTIONS__TEXT__LABEL",
+                        value: "text"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__RESPONSE_FORMAT__OPTIONS__JSON__LABEL",
+                        value: "json_object"
+                    }
+                ]
+            },
+        },
+        {
+            key: "detailedResults",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__DETAILED_RESULTS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__DETAILED_RESULTS__DESCRIPTION",
+            type: "toggle",
+            defaultValue: false,
+            condition: {
+                or: [
+                    {
+                        key: "storeLocation",
+                        value: "input",
+                    },
+                    {
+                        key: "storeLocation",
+                        value: "context",
+                    },
+                    {
+                        and: [
+                            {
+                                key: "storeLocation",
+                                value: "stream",
+                            },
+                            {
+                                key: "streamStoreCopyInInput",
+                                value: true,
+                            }
+                        ]
+                    }
+                ]
+            }
+        },
+        {
+            key: "seed",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__SEED__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__SEED__DESCRIPTION",
+            type: "cognigyText",
+            defaultValue: ""
+        },
+        {
+            key: "jsonStreamWarning",
+            type: "description",
+            label: " ",
+            params: {
+                text: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__JSONSTREAMWARNING__PARAM"
+            },
+            condition: {
+                and: [
+                    {
+                        key: "responseFormat",
+                        value: "json_object"
+                    },
+                    {
+                        key: "storeLocation",
+                        value: "stream",
+                    }
+                ]
+            }
+        },
+        {
+            key: "customModelOptions",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__CUSTOM_MODEL_OPTIONS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__CUSTOM_MODEL_OPTIONS__DESCRIPTION",
+            type: "json",
+            defaultValue: {}
+        },
+        {
+            key: "customRequestOptions",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__CUSTOM_REQUEST_OPTIONS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__CUSTOM_REQUEST_OPTIONS__DESCRIPTION",
+            type: "json",
+            defaultValue: {}
+        },
+        {
+            key: "errorHandling",
+            type: "select",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__HANDLE_SERVICE_ERROR__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__HANDLE_SERVICE_ERROR__DESCRIPTION",
+            defaultValue: "continue",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__HANDLE_SERVICE_ERROR__OPTIONS__STOP__LABEL",
+                        value: "stop"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__HANDLE_SERVICE_ERROR__OPTIONS__CONTINUE__LABEL",
+                        value: "continue"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__HANDLE_SERVICE_ERROR__OPTIONS__GOTO__LABEL",
+                        value: "goto"
+                    },
+                ]
+            }
+        },
+        {
+            key: "errorMessage",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__ERROR_MESSAGE__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__ERROR_MESSAGE__DESCRIPTION",
+            defaultValue: "",
+            condition: {
+                key: "errorHandling",
+                value: "continue"
+            }
+        },
+        {
+            key: "errorHandlingGotoTarget",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__ERROR__GOTO_NODE__LABEL",
+            condition: {
+                key: "errorHandling",
+                value: "goto"
             }
         },
     ],
@@ -271,6 +467,9 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "useStop",
                 "stop",
                 "timeout",
+                "responseFormat",
+                "jsonStreamWarning",
+                "seed"
             ]
         },
         {
@@ -279,15 +478,39 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             defaultCollapsed: true,
             fields: [
                 "storeLocation",
+                "jsonStreamWarning",
                 "streamDescription",
                 "inputKey",
                 "contextKey",
-                "streamStopTokens"
+                "immediateOutput",
+                "streamStopTokens",
+                "streamStopTokenOverrides",
+                "streamStoreCopyInInput",
+                "detailedResults"
+            ]
+        },
+        {
+            key: "errorHandling",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__ERROR_HANDLING__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "errorHandling",
+                "errorMessage",
+                "errorHandlingGotoTarget",
+            ]
+        },
+        {
+            key: "customOptions",
+            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__CUSTOM_OPTIONS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "customModelOptions",
+                "customRequestOptions"
             ]
         },
         {
             key: "debugging",
-            label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__SECTIONS__DEBUGGING__LABEL",
+            label: "UI__NODE_EDITOR__SECTIONS__DEBUG_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "debugDescription",
@@ -303,15 +526,19 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "field", key: "chatTranscriptSteps" },
         { type: "section", key: "advanced" },
         { type: "section", key: "storage" },
-        { type: "section", key: "debugging" }
+        { type: "section", key: "errorHandling" },
+        { type: "section", key: "customOptions" },
+        { type: "section", key: "debugging" },
     ],
     appearance: {},
     tags: ["service", "llm", "gpt", "generative ai", "openai", "azure", "prompt"],
-    function: async ({ cognigy, config }) => {
-        var _a;
+    function: async ({ cognigy, config, nodeId }) => {
+        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 } = 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, } = config;
         let prompt = config.prompt;
+        const { traceId } = input;
         // check if custom variables are used and if they have a length modifier
         // works only for a single variable per prompt
         if (prompt.includes("@cognigyRecentConversation")) {
@@ -332,6 +559,64 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
             const recentUserInputs = (0, prompt_1.createLastUserInputString)(cognigy.lastConversationEntries, turnLimit) + "\n";
             prompt = prompt.replace(/@cognigyRecentUserInputs(:\d+)?/, recentUserInputs);
         }
+        // handle errors from external services, depending on the settings
+        const handleServiceError = async (error) => {
+            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
+            };
+            // 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 = {
+                error: compactError,
+            };
+            // add error to context or input
+            switch (storeLocation) {
+                case "context":
+                    // @ts-ignore	
+                    api.addToContext(contextKey, errorResponse, "simple");
+                    break;
+                default:
+                    api.addToInput(inputKey, errorResponse);
+            }
+            if (errorHandling === "continue") {
+                // output the timeout message
+                if (errorMessage) {
+                    api.output(errorMessage, null);
+                }
+            }
+            else if (errorHandling === "goto") {
+                if (!errorHandlingGotoTarget) {
+                    throw new Error("GoTo Target is required");
+                }
+                const gotoParams = {
+                    cognigy,
+                    childConfigs: [],
+                    nodeId,
+                    config: {
+                        flowNode: {
+                            flow: errorHandlingGotoTarget.flow,
+                            node: errorHandlingGotoTarget.node,
+                        },
+                        injectedText: undefined,
+                        injectedData: undefined,
+                        executionMode: "continue",
+                        absorbContext: false
+                    }
+                };
+                await logic_1.GO_TO.function(gotoParams);
+            }
+            else {
+                throw new errors_1.InternalServerError(error === null || error === void 0 ? void 0 : error.message, { traceId });
+            }
+        };
         try {
             const data = {
                 prompt,
@@ -344,19 +629,28 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 useCase: "promptNode",
                 stream: storeLocation === "stream",
                 streamOnDataHandler: (text) => {
-                    text = text.trim();
+                    text = text && text.trim();
                     if (text) {
                         api.output(text, null);
                     }
                 },
-                streamStopTokens
+                streamStopTokens,
+                streamStopTokenOverrides,
+                detailedResults,
+                seed: Number(seed) ? Number(seed) : undefined,
+                customModelOptions,
+                customRequestOptions
             };
             if (useStop) {
                 data["stop"] = stop;
             }
+            // llmProviderReferenceId `default` value is not a responseFormat, rather it is LLM Model default selection.
             if (llmProviderReferenceId && llmProviderReferenceId !== "default") {
                 data["llmProviderReferenceId"] = llmProviderReferenceId;
             }
+            if (responseFormat && responseFormat !== "default") {
+                data["responseFormat"] = responseFormat;
+            }
             let debugPrompt = prompt;
             if (useChatMode && (prompt || chatTranscriptSteps)) {
                 data["chat"] = (0, prompt_1.createLastConversationChatObject)(cognigy.lastConversationEntries, prompt, chatTranscriptSteps);
@@ -364,30 +658,69 @@ 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 (detailedResults) {
+                if ((response === null || response === void 0 ? void 0 : response.usage) && response.usage.promptTokens && response.usage.completionTokens) {
+                    // the api has usage results, but in Azure format - reformat to OpenAI format
+                    const u = response.usage;
+                    response.usage = {
+                        prompt_tokens: u.promptTokens,
+                        completion_tokens: u.completionTokens,
+                        total_tokens: u.promptTokens + u.completionTokens,
+                        calculation_method: "api"
+                    };
+                }
+                else if (!response.usage) {
+                    // if the api didn't return native usage results, compute them
+                    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((typeof response.result === "object") ? JSON.stringify(response.result) : response.result);
+                    response.usage = {
+                        prompt_tokens,
+                        completion_tokens,
+                        total_tokens: prompt_tokens + completion_tokens,
+                        calculation_method: "estimate"
+                    };
+                }
+            }
+            // 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);
             if (storeLocation === "context") {
                 api.addToContext(contextKey, response, "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;
+                    api.output(resultToOutput, null);
+                }
             }
-            else if (storeLocation === "input") {
+            else if (storeLocation === "input" || (storeLocation === "stream" && streamStoreCopyInInput)) {
                 // @ts-ignore
                 api.addToInput(inputKey, response);
+                // 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) {
+                    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;
+                    api.output(resultToOutput, null);
+                }
             }
         }
         catch (error) {
-            const errorDetails = {
-                name: error.name,
-                code: error.code,
-                message: error.message || ((_a = error.originalErrorDetails) === null || _a === void 0 ? void 0 : _a.message),
+            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),
             };
-            if (storeLocation === "context") {
-                api.addToContext(contextKey, { error: errorDetails }, "simple");
-            }
-            else {
-                // @ts-ignore
-                api.addToInput(inputKey, { error: errorDetails });
+            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
+                };
             }
-            throw error;
+            api.logDebugError(errorDetailsBase, "UI__DEBUG_MODE__LLM_PROMPT__ERROR");
+            await handleServiceError(errorDetails);
+            return;
         }
     }
 });