@cognigy/rest-api-client 2025.16.0 → 2025.18.0

package/build/shared/interfaces/resources/IKnowledgeDescriptor.js

@@ -20,13 +20,13 @@ exports.knowledgeFieldTypes = [
     "daterange",
     "connection",
     "condition",
-    "description"
+    "description",
 ];
 exports.knowledgeFieldSchema = {
     title: "knowledgeFieldSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign({}, INodeDescriptorSet_1.nodeFieldSchema.properties), { type: { type: "string", enum: [...exports.knowledgeFieldTypes] }, key: { type: "string", minLength: 1, maxLength: 200 } })
+    properties: Object.assign(Object.assign({}, INodeDescriptorSet_1.nodeFieldSchema.properties), { type: { type: "string", enum: [...exports.knowledgeFieldTypes] }, key: { type: "string", minLength: 1, maxLength: 200 } }),
 };
 const { type, summary, defaultLabel, sections, form } = INodeDescriptorSet_1.nodeDescriptorSchema.properties;
 exports.knowledgeDescriptorSchema = {
@@ -39,15 +39,15 @@ exports.knowledgeDescriptorSchema = {
         summary,
         sections,
         form,
-        fields: { type: "array", items: exports.knowledgeFieldSchema }
-    }
+        fields: { type: "array", items: exports.knowledgeFieldSchema },
+    },
 };
 const filterNonConfigFields = ({ type }) => !["description"].includes(type);
 const buildConfigValidationSchema = (fields) => ({
     type: "object",
     additionalProperties: false,
     required: (fields || []).filter(filterNonConfigFields).map(({ key }) => key),
-    properties: Object.assign({}, (fields || []).filter(filterNonConfigFields).reduce((result, field) => (Object.assign(Object.assign({}, result), { [field.key]: mapFieldToSchema(field) })), {}))
+    properties: Object.assign({}, (fields || []).filter(filterNonConfigFields).reduce((result, field) => (Object.assign(Object.assign({}, result), { [field.key]: mapFieldToSchema(field) })), {})),
 });
 exports.buildConfigValidationSchema = buildConfigValidationSchema;
 const mapFieldToSchema = ({ type, params }) => {
@@ -59,19 +59,20 @@ const mapFieldToSchema = ({ type, params }) => {
         case "slider":
             return { type: "number" };
         case "textArray":
+        case "chipInput":
             return {
                 type: "array",
-                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0
+                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0,
             };
         case "json":
             return {
                 type: ["object", "array"],
-                additionalProperties: true
+                additionalProperties: true,
             };
         default:
             return {
                 type: "string",
-                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0
+                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0,
             };
     }
 };

package/build/shared/interfaces/resources/ILargeLanguageModel.js

@@ -57,6 +57,7 @@ exports.openAICompatibleMetaSchema = {
         customModel: { type: "string" },
         baseCustomUrl: { type: "string" },
         customAuthHeader: { type: "string" },
+        embeddingVectorSize: { type: "number" },
     }
 };
 exports.azureOpenAIMetaSchema = {

package/build/shared/interfaces/resources/TResourceType.js

@@ -159,6 +159,7 @@ exports.searchableResourceTypes = [
     "playbook",
     "project",
     "snapshot",
+    "simulation",
 ];
 exports.packageableResourceTypes = [
     "aiAgent",

package/dist/esm/shared/charts/descriptors/data/code.js

@@ -27,7 +27,7 @@ export const CODE = createNodeDescriptor({
     function: (codeParams) => __awaiter(void 0, void 0, void 0, function* () {
         const { cognigy } = codeParams;
         const { api } = cognigy;
-        api.executeCodeInSecureContext(codeParams);
+        yield api.executeCodeInSecureContext(codeParams);
     })
 });
 //# sourceMappingURL=code.js.map

package/dist/esm/shared/charts/descriptors/data/debugMessage.js

@@ -58,12 +58,22 @@ export const DEBUG_MESSAGE = createNodeDescriptor({
     function: ({ cognigy, config }) => __awaiter(void 0, void 0, void 0, function* () {
         const { api } = cognigy;
         const { level, message, header } = config;
-        if (level && message) {
+        let messageToOutput = message;
+        //Atp message can be of type any since cognigyScript can return any type
+        // whereas logDebugMessage expects a string or object
+        // so we need to change the type of message to string if not string or object
+        if (message === undefined || message === null) {
+            return;
+        }
+        else if (typeof message !== "string" && typeof message !== "object") {
+            messageToOutput = JSON.stringify(message);
+        }
+        if (level) {
             if (level === "info") {
-                api.logDebugMessage(message, header);
+                api.logDebugMessage(messageToOutput, header);
             }
             if (level === "error") {
-                api.logDebugError(message, header);
+                api.logDebugError(messageToOutput, header);
             }
         }
     })

package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js

@@ -4,6 +4,7 @@ import { createNodeDescriptor } from "../../createNodeDescriptor";
 import { GO_TO } from "../logic";
 import { writeLLMDebugLogs } from "../nlu/generativeSlotFiller/prompt";
 import { randomUUID } from 'crypto';
+import { isOpenAIChatPrompt } from "../../../generativeAI/getPrompt";
 import { InternalServerError } from "../../../errors";
 /**
  * Returns the simplified english name for a language given a language code
@@ -547,7 +548,7 @@ export const SEARCH_EXTRACT_OUTPUT = createNodeDescriptor({
     },
     tags: ["ai", "knowledgeSearch", "knowledge", "search"],
     function: (knowledgeSearchParams) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         const { cognigy, config, nodeId } = knowledgeSearchParams;
         const { input, api } = cognigy;
         const { topK, searchString, searchStoreLocation, searchStoreLocationContextKey, searchStoreLocationInputKey, searchSourceTags, searchSourceTagsFilterOp, temperature, maxTokens, topP, presencePenalty, frequencyPenalty, useStop, stop, storeLocation, contextKey, inputKey, timeout, timeoutMessage, outputFallback, outputMode, mode, errorHandling, errorHandlingGotoTarget, streamStopTokens, followUpDetection, debugLogTokenCount, debugLogRequestAndCompletion } = config;
@@ -574,53 +575,24 @@ export const SEARCH_EXTRACT_OUTPUT = createNodeDescriptor({
         // check if follow up detection is active and if yes, handle accordingly
         // this is "context aware search"
         if (followUpDetection === "transcript") {
-            let prompt;
-            let lastRoundTrip;
-            // this is a fallback in case the node was created before this function was added and followUpDetectionSteps is undefined
-            followUpDetectionSteps = followUpDetectionSteps || 2;
             // check whether we're in an flow execution that's not the first
             // as it doesn't make sense to check for follow ups in the first execution
             if (input.execution > 1) {
+                // this is a fallback in case the node was created before this function was added and followUpDetectionSteps is undefined
+                followUpDetectionSteps = followUpDetectionSteps || 2;
                 // always remember the last thing the user said (needed later)
-                lastRoundTrip = (_b = cognigy
-                    .lastConversationEntries) === null || _b === void 0 ? void 0 : _b.slice(1, followUpDetectionSteps + 1).reverse().map(entry => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
-                // if follow up detection is set to 2 or more, we use the conversation transcript
-                // as reference. Start at the second entry, because the first one is the current
-                const recentConversation = (_c = cognigy
-                    .lastConversationEntries) === null || _c === void 0 ? void 0 : _c.slice(1, followUpDetectionSteps + 1).reverse().map(entry => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
-                prompt = `Below is the transcript of a conversation:
-${recentConversation}
-USER: ${searchString}
-Does the last USER input refer to the conversation before?
-Answer with "true" or "false". Answer:`;
-                let promptResponse;
-                // set the detailed results to true to get the token usage
-                const returnDetailedResults = true;
+                const chatHistory = (_b = cognigy
+                    .lastConversationEntries) === null || _b === void 0 ? void 0 : _b.slice(0, followUpDetectionSteps + 1).reverse();
                 try {
-                    const firstFollowUpResponse = yield api.runGenerativeAIPrompt({ prompt, detailedResults: returnDetailedResults }, "answerExtraction");
-                    promptResponse = firstFollowUpResponse.result;
+                    const promptData = {
+                        // set the detailed results to true to get the token usage
+                        detailedResults: true
+                    };
+                    const rephrasedUserQueryResponse = yield api.runGenerativeAIPromptForUseCase(promptData, "answerExtraction", "contextAwareUserQueryRephrasing", getContextAwareUserQueryRephrasingPromptParser(chatHistory));
+                    const promptResponse = rephrasedUserQueryResponse.result;
                     // if we're in adminconsole, process debugging options
-                    writeLLMDebugLogs("Search Extract Output Follow Up Detection", prompt, firstFollowUpResponse, debugLogTokenCount, false, cognigy);
-                    // check if LLM thinks the input was a follow up
-                    if (promptResponse === null || promptResponse === void 0 ? void 0 : promptResponse.toLowerCase().includes("true")) {
-                        prompt = `You are tasked to rewrite a question based on a context, so that the question is clearer.
-
-Example:
-Context: 
-USER: Where is Germany?
-BOT: Germany is in Europe.
-Question: Is that a continent?
-New: Is Europe a continent?
-
-Task: 
-Context:
-${lastRoundTrip}
-Question: ${searchString}
-New: `;
-                        const secondFollowUpResponse = yield api.runGenerativeAIPrompt({ prompt, detailedResults: returnDetailedResults }, "answerExtraction");
-                        promptResponse = secondFollowUpResponse.result;
-                        // if we're in adminconsole, process debugging options
-                        writeLLMDebugLogs("Search Extract Output Follow Up Detection 2", prompt, secondFollowUpResponse, debugLogTokenCount, false, cognigy);
+                    writeLLMDebugLogs("Search Extract Output Follow Up Detection", prompt, rephrasedUserQueryResponse, debugLogTokenCount, false, cognigy);
+                    if ((promptResponse === null || promptResponse === void 0 ? void 0 : promptResponse.toLowerCase()) !== "false") {
                         // the actual search string to now use is the rewritten question
                         actualSearchString = promptResponse;
                         api.logDebugMessage(`UI__DEBUG_MODE__SEO__MESSAGE '${actualSearchString}'`);
@@ -634,7 +606,7 @@ New: `;
         let knowledgeSearchResponseData;
         // handle errors from external services, depending on the settings
         const handleServiceError = (error) => __awaiter(void 0, void 0, void 0, function* () {
-            var _m;
+            var _l;
             const compactError = {
                 message: (error === null || error === void 0 ? void 0 : error.message) || error,
             };
@@ -670,7 +642,7 @@ New: `;
                     isSnapshotError: !!(metadata === null || metadata === void 0 ? void 0 : metadata.snapshotId),
                 });
             }
-            if ((_m = error === null || error === void 0 ? void 0 : error.originalErrorDetails) === null || _m === void 0 ? void 0 : _m.code) {
+            if ((_l = error === null || error === void 0 ? void 0 : error.originalErrorDetails) === null || _l === void 0 ? void 0 : _l.code) {
                 compactError["code"] = error.originalErrorDetails.code;
             }
             let searchStoreDataWithError = {
@@ -743,7 +715,7 @@ New: `;
         // Perform knowledge search
         try {
             // Set understood to true so that the interaction doesn't look false in our analytics
-            (_d = api.setAnalyticsData) === null || _d === void 0 ? void 0 : _d.call(api, "understood", "true");
+            (_c = api.setAnalyticsData) === null || _c === void 0 ? void 0 : _c.call(api, "understood", "true");
             input.understood = true;
             const knowledgeSearchResponse = yield api.knowledgeSearch(data);
             writeLLMDebugLogs("Search Extract Output Embeddings Call", data.query, undefined, debugLogTokenCount, false, cognigy);
@@ -776,7 +748,7 @@ New: `;
         }
         // #endregion 1 Perform Search
         // #region 2 Perform Answer Extraction
-        let documents = (_e = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _e === void 0 ? void 0 : _e.map(result => result === null || result === void 0 ? void 0 : result.text).join(' ');
+        let documents = (_d = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _d === void 0 ? void 0 : _d.map(result => result === null || result === void 0 ? void 0 : result.text).join(' ');
         const replacedUserInput = input.text + (actualSearchString !== input.text ? ` possibly meaning "${actualSearchString}"` : "");
         prompt = prompt.replace(/@userInput/g, replacedUserInput);
         prompt = prompt.replace(/@foundDocuments/g, documents);
@@ -981,7 +953,7 @@ New: `;
                                                 {
                                                     "separator": true,
                                                     "type": "TextBlock",
-                                                    "text": (_f = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _f === void 0 ? void 0 : _f[0].text,
+                                                    "text": (_e = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _e === void 0 ? void 0 : _e[0].text,
                                                     "wrap": true,
                                                     "spacing": "Padding"
                                                 }
@@ -1002,7 +974,7 @@ New: `;
                     "version": "1.6"
                 };
                 // @ts-ignore
-                if ((_j = (_h = (_g = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _g === void 0 ? void 0 : _g[0]) === null || _h === void 0 ? void 0 : _h.chunkMetaData) === null || _j === void 0 ? void 0 : _j.url) {
+                if ((_h = (_g = (_f = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _f === void 0 ? void 0 : _f[0]) === null || _g === void 0 ? void 0 : _g.chunkMetaData) === null || _h === void 0 ? void 0 : _h.url) {
                     ADAPTIVE_CARD_RESULT.body[2].items[0].columns[1].items.push({
                         "type": "ActionSet",
                         "actions": [
@@ -1010,7 +982,7 @@ New: `;
                                 "type": "Action.OpenUrl",
                                 "title": "Open Source",
                                 // @ts-ignore
-                                "url": (_k = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _k === void 0 ? void 0 : _k[0].chunkMetaData.url
+                                "url": (_j = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _j === void 0 ? void 0 : _j[0].chunkMetaData.url
                             }
                         ],
                         "separator": true
@@ -1040,7 +1012,7 @@ New: `;
                                 yield api.output(promptResponse, null);
                             }
                             else if (mainPromptResponse.finishReason) {
-                                (_l = api.output) === null || _l === void 0 ? void 0 : _l.call(api, "", {
+                                (_k = api.output) === null || _k === void 0 ? void 0 : _k.call(api, "", {
                                     _cognigy: {
                                         _preventTranscript: true,
                                         _messageId,
@@ -1065,4 +1037,30 @@ New: `;
         }
     })
 });
+/**
+ * Parses the prompt for the context-aware user query rephrasing.
+ * It replaces the "@@chatHistory" variable with the chat history messages.
+ * It replaces the "@@userQuery" variable with the last user message.
+ *
+ * @param chatHistory - The chat history to be used for context.
+ * @return A function that takes a raw prompt and returns the modified prompt.
+ */
+export function getContextAwareUserQueryRephrasingPromptParser(chatHistory) {
+    return (rawPrompt) => {
+        if (isOpenAIChatPrompt(rawPrompt)) {
+            const modifiedPrompt = [...rawPrompt];
+            for (const message of chatHistory) {
+                const role = message.source === "user" ? "user" : "assistant";
+                modifiedPrompt.push({
+                    role,
+                    content: message.text
+                });
+            }
+            return modifiedPrompt;
+        }
+        else {
+            throw new InternalServerError(`Invalid prompt type for context-aware user query rephrasing. Expected a chat prompt.`);
+        }
+    };
+}
 //# sourceMappingURL=searchExtractOutput.js.map

package/dist/esm/shared/charts/descriptors/logic/goTo.js

@@ -132,12 +132,12 @@ export const GO_TO = createNodeDescriptor({
         }
         if (!api.checkThink(thisNodeId)) {
             api.resetNextNodes();
-            api.setThinkMarker(config.flowNode.flow);
+            api.setThinkMarker(flowId);
             // Check if execution is to wait at Node for Input
             if (executionMode === "wait") {
                 // only set the next node if the execution mode is "wait",
                 // otherwise input after the goto node would again go to this node, and not to the start node
-                yield api.goToNode(config.flowNode);
+                yield api.goToNode({ flowNode: config.flowNode, absorbContext });
                 return;
             }
             if (injectedText) {

package/dist/esm/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js

@@ -151,6 +151,10 @@ export const writeLLMDebugLogs = (label, prompt, response, debugLogTokenCount, d
                     completionTokenMessage = ` (${completionTokens} Tokens)`;
                 }
             }
+            let promptString = prompt;
+            if (typeof prompt != "string") {
+                promptString = promptToString(prompt);
+            }
             let inputLabelKey = "UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__REQUEST";
             let headerKey = "UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__HEADER";
             if (nodeType === "llmPromptV2") {
@@ -158,7 +162,7 @@ export const writeLLMDebugLogs = (label, prompt, response, debugLogTokenCount, d
                 headerKey = "UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__HEADER_WITH_SYSTEM_PROMPT";
             }
             ;
-            api.logDebugMessage(`${inputLabelKey}${requestTokenMessage}:<br>${prompt}<br><br>UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__COMPLETION${completionTokenMessage}:<br>${responseOutputFormatted}`, headerKey);
+            api.logDebugMessage(`${inputLabelKey}${requestTokenMessage}:<br>${promptString}<br><br>UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__COMPLETION${completionTokenMessage}:<br>${responseOutputFormatted}`, headerKey);
         }
         catch (err) { }
     }
@@ -198,4 +202,28 @@ export const convertChatToPrompt = (chat) => {
     prompt += "assistant: ";
     return prompt;
 };
+/**
+ * Converts a TALLPrompts object into a string representation.
+ * @param prompt The prompt to convert to a string
+ * @returns The string representation of the prompt
+ */
+export function promptToString(prompt) {
+    if ("prompt" in prompt) {
+        // TCompletionPrompt
+        return prompt.prompt;
+    }
+    else if ("messages" in prompt) {
+        // TChatPrompt
+        return prompt.messages
+            .map((msg) => `[${msg.role}] ${msg.content}`)
+            .join("\n");
+    }
+    else if (Array.isArray(prompt)) {
+        // OpenAIChatMessage[]
+        return prompt
+            .map((msg) => `[${msg.role}] ${msg.content}`)
+            .join("\n");
+    }
+    return "";
+}
 //# sourceMappingURL=prompt.js.map

package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js

@@ -408,6 +408,13 @@ export const AI_AGENT_JOB = createNodeDescriptor({
                 step: 0.1
             }
         },
+        {
+            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: "logErrorToSystem",
             label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__FIELDS__LOG_TO_SYSTEM__LABEL",
@@ -803,6 +810,7 @@ export const AI_AGENT_JOB = createNodeDescriptor({
                 "timeoutInMs",
                 "maxTokens",
                 "temperature",
+                "useTextAlternativeForLLM",
             ],
         },
         {
@@ -850,7 +858,7 @@ export const AI_AGENT_JOB = createNodeDescriptor({
     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, _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;
         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, debugLogLLMLatency, 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, useTextAlternativeForLLM, 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");
@@ -1128,7 +1136,8 @@ export const AI_AGENT_JOB = createNodeDescriptor({
             const transcript = yield api.getTranscript({
                 limit: 50,
                 rolesWhiteList: [TranscriptRole.USER, TranscriptRole.ASSISTANT, TranscriptRole.TOOL],
-                excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT]
+                excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT],
+                useTextAlternativeForLLM,
             });
             // For knowledgeSearch "always", we enhance the user input with the knowledge search response data
             if (knowledgeSearchBehavior === "always" &&

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",
             ]
         },
         {
@@ -628,7 +636,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
         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
@@ -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"] = [{

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/errors/codes.js

@@ -1,4 +1,5 @@
 import { ErrorCode } from "./ErrorCode";
+export const BAD_REQUEST_ERROR = ErrorCode.BAD_REQUEST;
 export const MISSING_ARGUMENT_ERROR = ErrorCode.MISSING_ARGUMENT_ERROR;
 export const DATABASE_WRITE_ERROR = ErrorCode.DATABASE_WRITE_ERROR;
 export const RESOURCE_NOT_FOUND_ERROR = ErrorCode.RESOURCE_NOT_FOUND_ERROR;

package/dist/esm/shared/errors/invalidArgument.js

@@ -7,5 +7,9 @@ export class InvalidArgumentError extends BadRequestError {
         this.name = "Invalid Argument Error";
         this.code = ErrorCode.INVALID_ARGUMENT_ERROR;
     }
+    toRFC7807Response(data) {
+        const baseResponse = super.toRFC7807Response(data);
+        return Object.assign(Object.assign({}, baseResponse), { type: "Bad Request" });
+    }
 }
 //# sourceMappingURL=invalidArgument.js.map

package/dist/esm/shared/errors/missingArgument.js

@@ -7,5 +7,9 @@ export class MissingArgumentError extends BadRequestError {
         this.name = "Missing Argument Error";
         this.code = ErrorCode.MISSING_ARGUMENT_ERROR;
     }
+    toRFC7807Response(data) {
+        const baseResponse = super.toRFC7807Response(data);
+        return Object.assign(Object.assign({}, baseResponse), { type: "Bad Request" });
+    }
 }
 //# sourceMappingURL=missingArgument.js.map

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