@cognigy/rest-api-client 2025.15.1 → 2025.17.0

package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js

@@ -388,6 +388,13 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 ]
             }
         },
+        {
+            key: "useTextAlternativeForLLM",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__INCLUDE_ALL_OUTPUT_TYPES__LABEL",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__INCLUDE_ALL_OUTPUT_TYPES__DESCRIPTION",
+            defaultValue: true,
+        },
         {
             key: "customModelOptions",
             label: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__FIELDS__CUSTOM_MODEL_OPTIONS__LABEL",
@@ -539,7 +546,8 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 "frequencyPenalty",
                 "useStop",
                 "stop",
-                "seed"
+                "seed",
+                "useTextAlternativeForLLM",
             ]
         },
         {
@@ -625,10 +633,10 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
     },
     tags: ["ai", "llm", "gpt", "generative ai", "openai", "azure", "prompt"],
     function: ({ cognigy, config, childConfigs, nodeId }) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
         const { api, input, flowReferenceId } = cognigy;
         const { temperature, maxTokens, topP, presencePenalty, frequencyPenalty, useStop, stop, storeLocation, contextKey, inputKey, timeout, streamStopTokens, streamStopTokenOverrides, debugLogTokenCount, debugLogRequestAndCompletion, debugLogLLMLatency, debugLogToolDefinitions, llmProviderReferenceId, usePromptMode, chatTranscriptSteps, responseFormat, streamStoreCopyInInput, 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, processImages, transcriptImageHandling, toolChoice, useStrict } = config;
+        errorHandlingGotoTarget, errorMessage, useTextAlternativeForLLM, logErrorToSystem, processImages, transcriptImageHandling, toolChoice, useStrict } = config;
         let prompt = config.prompt || "";
         const { traceId } = input;
         // check if custom variables are used and if they have a length modifier
@@ -653,17 +661,17 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
         }
         // handle errors from external services, depending on the settings
         const handleServiceError = (error) => __awaiter(void 0, void 0, void 0, function* () {
-            var _w, _x, _y, _z, _0, _1;
+            var _y, _z, _0, _1, _2, _3;
             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 ((_w = error === null || error === void 0 ? void 0 : error.meta) === null || _w === void 0 ? void 0 : _w.requestId) {
-                compactError["requestId"] = (_x = error === null || error === void 0 ? void 0 : error.meta) === null || _x === void 0 ? void 0 : _x.requestId;
+            if ((_y = error === null || error === void 0 ? void 0 : error.meta) === null || _y === void 0 ? void 0 : _y.requestId) {
+                compactError["requestId"] = (_z = error === null || error === void 0 ? void 0 : error.meta) === null || _z === void 0 ? void 0 : _z.requestId;
             }
-            if ((_y = error === null || error === void 0 ? void 0 : error.originalErrorDetails) === null || _y === void 0 ? void 0 : _y.code) {
+            if ((_0 = error === null || error === void 0 ? void 0 : error.originalErrorDetails) === null || _0 === void 0 ? void 0 : _0.code) {
                 compactError.code = error.originalErrorDetails.code;
             }
             const errorResponse = {
@@ -672,7 +680,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
             // add error to context or input
             switch (storeLocation) {
                 case "context":
-                    (_z = api.addToContext) === null || _z === void 0 ? void 0 : _z.call(api, contextKey, errorResponse, "simple");
+                    (_1 = api.addToContext) === null || _1 === void 0 ? void 0 : _1.call(api, contextKey, errorResponse, "simple");
                     break;
                 default:
                     api.addToInput(inputKey, errorResponse);
@@ -680,7 +688,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
             if (errorHandling === "continue") {
                 // output the timeout message
                 if (errorMessage) {
-                    yield ((_0 = api.output) === null || _0 === void 0 ? void 0 : _0.call(api, errorMessage, null));
+                    yield ((_2 = api.output) === null || _2 === void 0 ? void 0 : _2.call(api, errorMessage, null));
                 }
                 // Continue with default node as next node
                 const defaultChild = childConfigs === null || childConfigs === void 0 ? void 0 : childConfigs.find(child => child.type === "llmPromptDefault");
@@ -707,7 +715,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                         absorbContext: false
                     }
                 };
-                yield ((_1 = GO_TO.function) === null || _1 === void 0 ? void 0 : _1.call(GO_TO, gotoParams));
+                yield ((_3 = GO_TO.function) === null || _3 === void 0 ? void 0 : _3.call(GO_TO, gotoParams));
             }
             else {
                 throw new InternalServerError(error === null || error === void 0 ? void 0 : error.message, { traceId });
@@ -773,7 +781,8 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 const transcript = yield api.getTranscript({
                     limit: chatTranscriptSteps || 50,
                     rolesWhiteList: [TranscriptRole.USER, TranscriptRole.ASSISTANT, TranscriptRole.TOOL],
-                    excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT]
+                    excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT],
+                    useTextAlternativeForLLM,
                 });
                 llmPromptOptions["transcript"] = transcript;
                 llmPromptOptions["chat"] = [{
@@ -817,14 +826,20 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 const mainToolCall = llmResult.toolCalls[0];
                 let isMcpToolCall = false;
                 // Find the child node with the toolId of the tool call
-                let toolChild = childConfigs.find(child => { var _a, _b; return child.type === "llmPromptTool" && ((_a = child.config) === null || _a === void 0 ? void 0 : _a.toolId) && api.parseCognigyScriptText((_b = child.config) === null || _b === void 0 ? void 0 : _b.toolId) === mainToolCall.function.name; });
+                let toolChild = undefined;
+                for (const child of childConfigs) {
+                    if (child.type === "llmPromptTool" && ((_e = child.config) === null || _e === void 0 ? void 0 : _e.toolId) && (yield api.parseCognigyScriptText((_f = child.config) === null || _f === void 0 ? void 0 : _f.toolId)) === mainToolCall.function.name) {
+                        toolChild = child;
+                        break;
+                    }
+                }
                 if (!toolChild && toolMap.has(mainToolCall.function.name)) {
                     // If the tool call is from an MCP tool, set the next node to the corresponding child node
                     toolChild = childConfigs.find(child => child.id === toolMap.get(mainToolCall.function.name));
                     isMcpToolCall = true;
                 }
                 if (mainToolCall.function.name !== "retrieve_knowledge" && toolChild === undefined) {
-                    (_e = api.logDebugError) === null || _e === void 0 ? void 0 : _e.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");
+                    (_g = api.logDebugError) === null || _g === void 0 ? void 0 : _g.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({
@@ -832,20 +847,20 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                             flow: flowReferenceId,
                             node: nodeId,
                         } }, (isMcpToolCall && {
-                        mcpServerUrl: (_f = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _f === void 0 ? void 0 : _f.mcpServerUrl,
-                        timeout: (_g = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _g === void 0 ? void 0 : _g.timeout,
+                        mcpServerUrl: (_h = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _h === void 0 ? void 0 : _h.mcpServerUrl,
+                        timeout: (_j = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _j === void 0 ? void 0 : _j.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.llmPrompt = Object.assign(Object.assign({}, input.llmPrompt), { toolArgs: Object.assign(Object.assign({}, (_j = (_h = input.llmPrompt) === null || _h === void 0 ? void 0 : _h.toolArgs) !== null && _j !== void 0 ? _j : {}), mainToolCall.function.arguments) });
+                    input.llmPrompt = Object.assign(Object.assign({}, input.llmPrompt), { toolArgs: Object.assign(Object.assign({}, (_l = (_k = input.llmPrompt) === null || _k === void 0 ? void 0 : _k.toolArgs) !== null && _l !== void 0 ? _l : {}), mainToolCall.function.arguments) });
                 }
                 // Debug Message for Tool Calls, configured in the Tool Node
-                if ((_k = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _k === void 0 ? void 0 : _k.debugMessage) {
-                    const messageLines = [`<b>UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER:</b> ${api.parseCognigyScriptText(toolChild.config.toolId)}`];
+                if ((_m = toolChild === null || toolChild === void 0 ? void 0 : toolChild.config) === null || _m === void 0 ? void 0 : _m.debugMessage) {
+                    const messageLines = [`<b>UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER:</b> ${yield api.parseCognigyScriptText(toolChild.config.toolId)}`];
                     // Arguments / Parameters Slots
-                    const slots = ((_l = mainToolCall === null || mainToolCall === void 0 ? void 0 : mainToolCall.function) === null || _l === void 0 ? void 0 : _l.arguments) && Object.keys(mainToolCall.function.arguments);
+                    const slots = ((_o = mainToolCall === null || mainToolCall === void 0 ? void 0 : mainToolCall.function) === null || _o === void 0 ? void 0 : _o.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) {
@@ -860,7 +875,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                             messageLines.push(`- ${slot}: ${slotValueAsString}`);
                         });
                     }
-                    (_m = api.logDebugMessage) === null || _m === void 0 ? void 0 : _m.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER");
+                    (_p = api.logDebugMessage) === null || _p === void 0 ? void 0 : _p.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__TOOL_CALL__DEBUG_MESSAGE__HEADER");
                 }
                 if (toolChild) {
                     api.setNextNode(toolChild.id);
@@ -885,11 +900,11 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 // we stringify objects (e.g. results coming from JSON Mode)
                 // so that the transcript only contains text
                 const resultToOutput = typeof ((llmResult === null || llmResult === void 0 ? void 0 : llmResult.result) || llmResult) === "object" ? JSON.stringify((llmResult === null || llmResult === void 0 ? void 0 : llmResult.result) || llmResult, undefined, 2) : (llmResult === null || llmResult === void 0 ? void 0 : llmResult.result) || llmResult;
-                yield ((_o = api.output) === null || _o === void 0 ? void 0 : _o.call(api, resultToOutput, {}));
+                yield ((_q = api.output) === null || _q === void 0 ? void 0 : _q.call(api, resultToOutput, {}));
             }
             else if (llmResult.finishReason && llmPromptOptions.stream) {
                 // send the finishReason as last output for a stream
-                (_p = api.output) === null || _p === void 0 ? void 0 : _p.call(api, "", {
+                (_r = api.output) === null || _r === void 0 ? void 0 : _r.call(api, "", {
                     _cognigy: {
                         _preventTranscript: true,
                         _messageId,
@@ -912,7 +927,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
             }
             // Add response to Cognigy Input/Context for further usage
             if (storeLocation === "context") {
-                (_q = api.addToContext) === null || _q === void 0 ? void 0 : _q.call(api, contextKey, llmResult, "simple");
+                (_s = api.addToContext) === null || _s === void 0 ? void 0 : _s.call(api, contextKey, llmResult, "simple");
             }
             else if (storeLocation === "input") {
                 api.addToInput(inputKey, llmResult);
@@ -925,19 +940,19 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
             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) || ((_r = error.originalErrorDetails) === null || _r === void 0 ? void 0 : _r.message),
+                message: (error === null || error === void 0 ? void 0 : error.message) || ((_t = error.originalErrorDetails) === null || _t === void 0 ? void 0 : _t.message),
             };
             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 ((_s = error.meta) === null || _s === void 0 ? void 0 : _s.requestId) {
+            if ((_u = error.meta) === null || _u === void 0 ? void 0 : _u.requestId) {
                 errorDetails["meta"] = {
-                    requestId: (_t = error.meta) === null || _t === void 0 ? void 0 : _t.requestId
+                    requestId: (_v = error.meta) === null || _v === void 0 ? void 0 : _v.requestId
                 };
             }
             if (logErrorToSystem) {
-                (_u = api.log) === null || _u === void 0 ? void 0 : _u.call(api, "error", JSON.stringify(errorDetailsBase));
+                (_w = api.log) === null || _w === void 0 ? void 0 : _w.call(api, "error", JSON.stringify(errorDetailsBase));
             }
-            (_v = api.logDebugError) === null || _v === void 0 ? void 0 : _v.call(api, errorDetailsBase, "UI__DEBUG_MODE__LLM_PROMPT__ERROR");
+            (_x = api.logDebugError) === null || _x === void 0 ? void 0 : _x.call(api, errorDetailsBase, "UI__DEBUG_MODE__LLM_PROMPT__ERROR");
             yield handleServiceError(errorDetails);
             return;
         }

package/dist/esm/shared/charts/descriptors/transcripts/addTranscriptStep.js

@@ -326,7 +326,7 @@ export const ADD_TRANSCRIPT_STEP = createNodeDescriptor({
     },
     tags: ["service", "transcripts"],
     function: ({ cognigy, config }) => __awaiter(void 0, void 0, void 0, function* () {
-        const { role, agentType, text, data, name, id, input, toolCallId, content, header, message, metadata } = config;
+        const { role, text, data, name, id, input, toolCallId, assistantType, content, header, message, metadata } = config;
         const { api } = cognigy;
         let log = null;
         switch (role) {
@@ -342,7 +342,7 @@ export const ADD_TRANSCRIPT_STEP = createNodeDescriptor({
                 };
                 break;
             case TranscriptRole.ASSISTANT:
-                if (agentType === TranscriptEntryType.OUTPUT) {
+                if (assistantType === TranscriptEntryType.OUTPUT) {
                     log = {
                         role: TranscriptRole.ASSISTANT,
                         type: TranscriptEntryType.OUTPUT,
@@ -353,7 +353,7 @@ export const ADD_TRANSCRIPT_STEP = createNodeDescriptor({
                         }
                     };
                 }
-                else if (agentType === TranscriptEntryType.TOOL_CALL) {
+                else if (assistantType === TranscriptEntryType.TOOL_CALL) {
                     log = {
                         role: TranscriptRole.ASSISTANT,
                         type: TranscriptEntryType.TOOL_CALL,

package/dist/esm/shared/charts/descriptors/transcripts/getTranscript.js

@@ -68,6 +68,13 @@ export const GET_TRANSCRIPT = createNodeDescriptor({
                 value: "context",
             }
         },
+        {
+            key: "includeTextAlternativeInTranscript",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__INCLUDE_TEXT_ALTERNATIVE_IN_TRANSCRIPT__LABEL",
+            description: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__INCLUDE_TEXT_ALTERNATIVE_IN_TRANSCRIPT__DESCRIPTION",
+            defaultValue: true,
+        },
     ],
     sections: [
         {
@@ -79,18 +86,31 @@ export const GET_TRANSCRIPT = createNodeDescriptor({
                 "inputKey",
                 "contextKey",
             ]
-        }
+        },
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "includeTextAlternativeInTranscript",
+            ],
+        },
     ],
     form: [
         { type: "field", key: "limit" },
         { type: "section", key: "storage" },
+        { type: "section", key: "advanced" },
     ],
     tags: ["service", "transcripts"],
     function: ({ cognigy, config }) => __awaiter(void 0, void 0, void 0, function* () {
         var _a;
-        const { limit, storeLocation, inputKey, contextKey } = config;
+        const { limit, storeLocation, inputKey, contextKey, includeTextAlternativeInTranscript } = config;
         const { api } = cognigy;
-        const transcript = yield api.getTranscript({ limit, excludeDataOnlyMessagesFilter: [TranscriptRole.AGENT, TranscriptRole.ASSISTANT] });
+        const transcript = yield api.getTranscript({
+            limit,
+            excludeDataOnlyMessagesFilter: [TranscriptRole.AGENT],
+            includeTextAlternativeInTranscript,
+        });
         if (storeLocation === "context") {
             (_a = api.addToContext) === null || _a === void 0 ? void 0 : _a.call(api, contextKey, transcript, "simple");
         }

package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js

@@ -143,6 +143,9 @@ class SessionConfigMapper extends BaseMapper {
             const timeout = Number(spAsrTimeout || asrTimeout);
             recognizer.asrTimeout = timeout / 1000 || undefined;
         }
+        else if (asrEnabled === false || spAsrEnabled === false) {
+            recognizer.asrTimeout = 0;
+        }
         return recognizer;
     }
     isDtmfEnabled(sessionParams, dtmf) {

package/dist/esm/shared/generativeAI/getPrompt.js

@@ -0,0 +1,68 @@
+/** Custom Modules */
+import { generativeAIPrompts } from "./utils/generativeAIPrompts";
+import { InternalServerError } from "../errors/internalServerError";
+export const isCompletionPrompt = (data) => {
+    return typeof data === "object" && data !== null && "prompt" in data;
+};
+export const isChatPrompt = (data) => {
+    return typeof data === "object" && data !== null && "messages" in data;
+};
+export const isOpenAIChatPrompt = (data) => {
+    return Array.isArray(data) &&
+        data.every((item) => typeof item === "object" &&
+            item !== null &&
+            ("role" in item) &&
+            ("content" in item) &&
+            (item.role === "system" || item.role === "user" || item.role === "assistant") &&
+            (typeof item.content === "string"));
+};
+/**
+ * Gets the current prompts for the passed model/useCase
+ * @param model - The model to get the prompt for
+ * @param useCase - The use case to get the prompt for
+ * @param subUseCase - Optional sub-use case to get a specific prompt
+ * @param promptParser - Optional function to modify the prompt before returning it
+ * @returns  {TALLPrompts}
+ */
+export const getPrompt = (model, useCase, subUseCase, promptParser) => {
+    var _a;
+    const loggerMeta = {
+        module: "getPrompt.ts",
+        label: "generativeAI",
+        function: "getPrompt",
+        model,
+        useCase,
+        subUseCase
+    };
+    let modelPrompts = (_a = generativeAIPrompts[`${model}`]) !== null && _a !== void 0 ? _a : generativeAIPrompts["default"];
+    if (!modelPrompts) {
+        throw new InternalServerError(`Neither the model "${model}" nor the default fallback have predefined prompts`, undefined, loggerMeta);
+    }
+    let prompt = modelPrompts[`${useCase}`];
+    // generativeAIPrompts[model] has no prompt for use case, so try to fallback to default prompt
+    if (!prompt) {
+        modelPrompts = generativeAIPrompts["default"];
+        if (!modelPrompts) {
+            throw new InternalServerError(`The default fallback has no predefined prompts`, undefined, loggerMeta);
+        }
+        prompt = modelPrompts[`${useCase}`];
+    }
+    if (!prompt) {
+        throw new InternalServerError(`Neither the model "${model}" nor the default fallback define a prompt for useCase "${useCase}"`, undefined, loggerMeta);
+    }
+    if (subUseCase && prompt && typeof prompt === "object" && `${subUseCase}` in prompt) {
+        prompt = prompt[`${subUseCase}`];
+    }
+    if (!prompt) {
+        throw new InternalServerError(`The prompt defined for the model "${model}" or the default fallback, useCase "${useCase}", and subUseCase "${subUseCase}" is invalid`, undefined, loggerMeta);
+    }
+    try {
+        return promptParser
+            ? promptParser(JSON.parse(JSON.stringify(prompt)))
+            : JSON.parse(JSON.stringify(prompt));
+    }
+    catch (error) {
+        throw new InternalServerError(`Error while parsing prompt for model: ${model} and useCase: ${useCase} and subUseCase: ${subUseCase}`, undefined, Object.assign({ originalError: error }, loggerMeta));
+    }
+};
+//# sourceMappingURL=getPrompt.js.map