@cognigy/rest-api-client 4.95.0 → 4.96.0

package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/transfer.js

@@ -16,7 +16,7 @@ export const transferNode = createNodeDescriptor({
     appearance: {
         color: nodeColor,
     },
-    tags: ["vg"],
+    tags: ["voice"],
     fields: [
         {
             key: "transferType",
@@ -155,6 +155,39 @@ export const transferNode = createNodeDescriptor({
                 max: 300
             }
         },
+        {
+            key: "enableTimeLimit",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__ENABLE_DURATION_LIMIT__LABEL",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__ENABLE_DURATION_LIMIT__DESCRIPTION",
+            condition: {
+                key: "transferType",
+                value: "dial"
+            },
+            defaultValue: false,
+        },
+        {
+            key: "timeLimit",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__DURATION_LIMIT__LABEL",
+            type: "number",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__DURATION_LIMIT__DESCRIPTION",
+            condition: {
+                and: [
+                    {
+                        key: "transferType",
+                        value: "dial"
+                    },
+                    {
+                        key: "enableTimeLimit",
+                        value: true
+                    },
+                ]
+            },
+            defaultValue: 600,
+            params: {
+                max: 12000
+            }
+        },
         {
             key: "agentAssistEnabled",
             label: "UI__NODE_EDITOR__TRANSFER__FIELDS__AGENT_ASSIST_ENABLED__LABEL",
@@ -459,6 +492,14 @@ export const transferNode = createNodeDescriptor({
             type: "field",
             key: "dialTimeout"
         },
+        {
+            type: "field",
+            key: "enableTimeLimit"
+        },
+        {
+            type: "field",
+            key: "timeLimit"
+        },
         {
             type: "field",
             key: "agentAssistEnabled"
@@ -483,7 +524,7 @@ export const transferNode = createNodeDescriptor({
     summary: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__SUMMARY",
     function: ({ cognigy, config, }) => __awaiter(void 0, void 0, void 0, function* () {
         const { api, input } = cognigy;
-        const { transferType, transferTarget, referredBy, anchorMedia, useTransferSipHeaders, transferSipHeaders = {}, transferReason, dialMusic, dialTranscriptionWebhook, dialCallerId, recognitionChannel, sttVendor, sttLanguage, sttDisablePunctuation, dialTimeout, amdEnabled, amdRedirectOnMachineDetected, amdRedirectText, sttLabel, googleModel, sttDeepgramModel, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, agentAssistEnabled, agentAssistHeadersKey = customHeaderDefaultValue } = config;
+        const { transferType, transferTarget, referredBy, anchorMedia, useTransferSipHeaders, transferSipHeaders = {}, transferReason, dialMusic, dialTranscriptionWebhook, dialCallerId, recognitionChannel, sttVendor, sttLanguage, sttDisablePunctuation, dialTimeout, enableTimeLimit, timeLimit, amdEnabled, amdRedirectOnMachineDetected, amdRedirectText, sttLabel, googleModel, sttDeepgramModel, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, agentAssistEnabled, agentAssistHeadersKey = customHeaderDefaultValue } = config;
         const transferParams = {
             transferType,
             transferReason,
@@ -498,6 +539,7 @@ export const transferNode = createNodeDescriptor({
             amdRedirectOnMachineDetected,
             amdRedirectText,
             dialTimeout,
+            timeLimit,
             sttLabel,
         };
         try {
@@ -509,6 +551,9 @@ export const transferNode = createNodeDescriptor({
                 yield api.say(textWarningAdminChannel, null);
                 return;
             }
+            if (!enableTimeLimit) {
+                delete transferParams.timeLimit;
+            }
             if (agentAssistEnabled && dialTranscriptionWebhook) {
                 try {
                     const agentAssistConfigId = api.getAgentAssistConfigId();

package/dist/esm/shared/constants.js

@@ -50,4 +50,13 @@ export const IP_NOT_AVAILABLE = "not available";
  * Number of seconds in one minute.
  */
 export const SECONDS_PER_MINUTE = 60;
+// Platform provided LLM
+export const PLATFORM_PROVIDED_LLM_USE_CASES = [
+    "intentSentenceGeneration",
+    "flowGeneration",
+    "lexiconGeneration",
+    "generateNodeOutput",
+];
+export const PLATFORM_PROVIDED_LLM_ID = "aaaaaaaa-aaaa-aaaa-aaaa-000000000000";
+export const PLATFORM_PROVIDED_LLM_CONNECTION_ID = "aaaaaaaa-aaaa-aaaa-aaaa-000000000001";
 //# sourceMappingURL=constants.js.map

package/dist/esm/shared/helper/nlu/textCleaner.js

@@ -173,9 +173,17 @@ export class TextCleaner {
         for (let phraseToDetect of Object.keys(this.dictSpecials)) {
             // make phrase regex-safe
             phraseToDetect = phraseToDetect.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
-            const matches = normalizedPhrase.match(new RegExp(`\\b(${phraseToDetect})\\b`, 'gi'));
+            // check if phraseToDetect is a single special character (e.g., *, ., +)
+            const isSpecialChar = /^[-\/\\^$*+?.()|[\]{}#]$/.test(phraseToDetect.replace(/\\/g, '')); // Remove escaping before testing
+            // for special characters like '*', don't use word boundaries since they can appear between numbers
+            // for normal words like "hello", use word boundaries (\b) to match whole words only
+            const regexPattern = isSpecialChar
+                ? `(${phraseToDetect})` // Match special char anywhere (e.g., in "8*4")
+                : `\\b(${phraseToDetect})\\b`; // Match whole words only (e.g., not "hello" in "hello123")
+            const matches = normalizedPhrase.match(new RegExp(regexPattern, 'gi'));
             if (matches) {
-                normalizedPhrase = normalizedPhrase.replace(new RegExp(`\\b${matches[0]}\\b`, "gi"), this.dictSpecials[phraseToDetect]);
+                normalizedPhrase = normalizedPhrase.replace(new RegExp(regexPattern, "gi"), this.dictSpecials[phraseToDetect.replace(/\\/g, '')] // Remove escaping to get original key
+                );
             }
         }
         return normalizedPhrase;

package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js

@@ -31,6 +31,7 @@ export const generativeAIModels = [
     "amazon.nova-pro-v1:0",
     "amazon.nova-micro-v1:0",
     "anthropic.claude-3-5-sonnet-20240620-v1:0",
+    "claude-3-7-sonnet-20250219",
     ...embeddingModels,
 ];
 export const generativeAIProviders = [

package/dist/esm/shared/interfaces/messageAPI/endpoints.js

@@ -135,6 +135,8 @@ const callFailoverSettingsSchema = {
         dialCallerId: { type: "string" },
         dialMusic: { type: "string" },
         dialTimeout: { type: "number" },
+        timeLimit: { type: "number" },
+        enableTimeLimit: { type: "boolean" },
         dialTranscribeEnabled: { type: "boolean" },
         dialTranscribeVendor: { type: "string" },
         dialTranscribeLanguage: { type: "string" },

package/dist/esm/shared/interfaces/messageAPI/handover.js

@@ -238,8 +238,8 @@ export const activateHandoverConversationSchema = {
         }
     }
 };
-export const pollAgentRepliesEventSchema = {
-    title: "pollAgentRepliesEventSchema",
+export const pollEventSchema = {
+    title: "pollEventSchema",
     type: "object",
     additionalProperties: false,
     required: ["handoverSettings", "traceId", "disableSensitiveLogging"],

package/dist/esm/shared/interfaces/resources/IAiAgent.js

@@ -19,6 +19,16 @@ export const aiAgentDataSchema = {
                 formality: { type: "string" }
             }
         },
+        voiceConfigs: {
+            type: "object",
+            properties: {
+                ttsVoice: { type: "string" },
+                ttsLanguage: { type: "string" },
+                ttsVendor: { type: "string" },
+                ttsModel: { type: "string" }
+            }
+        },
+        enableVoiceConfigs: { type: "boolean" },
         safetySettings: {
             type: "object",
             properties: {

package/dist/esm/shared/interfaces/resources/intent/IDefaultReply.js

@@ -15,7 +15,6 @@ export const defaultReplyInDBSchema = {
     additionalProperties: false,
     properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), defaultReplyDataSchema.properties), { localeReference: { type: "string", format: "mongo-id" }, intentReference: { type: "string", format: "mongo-id" }, flowReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
 };
-;
 export const defaultReplySchema = {
     title: "defaultReplySchema",
     type: "object",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "4.95.0",
+	"version": "4.96.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",
@@ -31,7 +31,7 @@
 	"license": "Cognigy Proprietary License",
 	"dependencies": {
 		"ajv": "6.12.6",
-		"axios": "1.7.4",
+		"axios": "1.7.9",
 		"form-data": "4.0.0",
 		"tus-js-client": "^3.1.1",
 		"uuidv4": "6.2.13"

package/types/index.d.ts

@@ -1982,7 +1982,7 @@ declare const analyticsSourceTypes: readonly [
 export interface IBaseAnalyticsSourceData extends IBaseAnalyticsData {
 	intentScore: number;
 	intentFlow: string;
-	understood: boolean;
+	understood: boolean | null;
 	type: TAnalyticsType;
 	source: TAnalyticsSource;
 	schemaVersion: number;
@@ -2536,6 +2536,8 @@ export interface ICallEventFailoverSettings {
 	dialCallerId?: string;
 	dialMusic?: string;
 	dialTimeout?: number;
+	enableTimeLimit?: boolean;
+	timeLimit?: number;
 	dialTranscribeEnabled?: boolean;
 	dialTranscribeVendor?: string;
 	dialTranscribeLanguage?: string;
@@ -2946,8 +2948,8 @@ export interface IWebchatEndpointSharedSettings extends ITypingIndicatorSettings
 	 */
 	enableFileUpload: boolean;
 	/**
-	 * Whether to display a persistent
-	 * menu in the Webchat.
+	* Whether to display a persistent
+	* menu in the Webchat.
 	 */
 	enablePersistentMenu: boolean;
 	/**
@@ -3207,6 +3209,15 @@ export interface IWebchat3EndpointLayoutSettings {
 	 * of input messages with a delay for the webchat
 	  */
 	enableInputCollation: boolean;
+	/**
+	* Whether to display a persistent
+	* menu in the Webchat.
+	 */
+	enablePersistentMenu: boolean;
+	/**
+	 * The persistent menu for the webchat
+	 */
+	persistentMenu: IWebchatPersistentMenu;
 	/**
 		 * This setting configures the delay for the automatic
 	 * input collation in miliseconds. Defaults to 1000
@@ -3252,6 +3263,18 @@ export interface IWebchat3EndpointLayoutSettings {
 	 * Advanced watermark URL settings for the webchat
 	 */
 	watermarkUrl: string;
+	/**
+	 * Setting to hide the chat bubble around AI Agent Messages
+	 */
+	disableBotOutputBorder: boolean;
+	/**
+	 * Set a number that will be used as a percentage value for the max-width of AI Agent Messages
+	 */
+	botOutputMaxWidthPercentage: number;
+	/**
+	 * Configure the width of the Webchat in px
+	 */
+	chatWindowWidth: number;
 }
 export interface IWebchat3EndpointColorsSettings {
 	/**
@@ -3335,6 +3358,23 @@ export interface IWebchat3EndpointBehaviorSettings {
 	 * a connectivity indicator should be displayed
 	 */
 	enableConnectionStatusIndicator: boolean;
+	/**
+	 * This setting enables collation of streamed
+	 * messages into one message bubble.
+	 */
+	collateStreamedOutputs: boolean;
+	/**
+	 * This setting enables output messages to appear progressively.
+	 */
+	progressiveMessageRendering: boolean;
+	/**
+	 * Whether the webchat renders Text messages as markdown
+	 */
+	renderMarkdown: boolean;
+	/**
+	 * This setting determines how scrolling behaves if chat is scrolled to bottom and a new message comes in.
+	 */
+	scrollingBehavior: string;
 }
 export interface IWebchat3EndpointStartBehaviorSettings {
 	/**
@@ -4186,6 +4226,7 @@ declare const generativeAIModels: readonly [
 	"amazon.nova-pro-v1:0",
 	"amazon.nova-micro-v1:0",
 	"anthropic.claude-3-5-sonnet-20240620-v1:0",
+	"claude-3-7-sonnet-20250219",
 	"text-embedding-3-small",
 	"text-embedding-3-large",
 	"text-embedding-ada-002",
@@ -9306,6 +9347,12 @@ export interface ISpeakingStyle {
 	formality: string;
 	[key: string]: string;
 }
+export interface IVoiceConfigParams {
+	ttsVoice: string;
+	ttsLanguage: string;
+	ttsVendor: TVoiceGateway2TTSVendor | "none";
+	ttsModel: string;
+}
 declare const contactProfileOptions: readonly [
 	"none",
 	"selectedProfileFields",
@@ -9327,6 +9374,8 @@ export interface IAiAgent extends IEntityMeta {
 	knowledgeReferenceId: string;
 	description: string;
 	speakingStyle: ISpeakingStyle;
+	voiceConfigs: IVoiceConfigParams;
+	enableVoiceConfigs: boolean;
 	safetySettings: ISafetySettings;
 	instructions: string;
 	contactProfilesOption: TContactProfileOptions;
@@ -10057,6 +10106,10 @@ export interface IRunGenerativeAIPromptOptions {
 			maxImageFileSizeInBytes?: number;
 		};
 	};
+	/**
+	   * Option to prevent the replacing of \n with " " in streamed outputs
+	   */
+	preventNewLineRemoval?: boolean;
 }
 export interface IAzureOpenAIProviderFieldsV2 {
 	apiKey: string;
@@ -14583,7 +14636,7 @@ export interface IConnectionIndexItem_2_0 extends Pick<IGlobalResource, "resourc
 	createdBy: TMongoId;
 	lastChangedBy: TMongoId;
 }
-export interface IIndexConnectionsRestData_2_0 extends IRestPagination<IConnectionIndexItem_2_0>, Partial<IProjectScope> {
+export interface IIndexConnectionsRestData_2_0 extends IRestPagination<IConnectionIndexItem_2_0>, Pick<IGlobalResource, "resourceLevel">, Partial<IProjectScope> {
 }
 export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IConnectionIndexItem_2_0> {
 }
@@ -16134,6 +16187,8 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
 		dialCallerId?: string;
 		dialMusic?: string;
 		dialTimeout?: number;
+		enableTimeLimit?: boolean;
+		timeLimit?: number;
 		dialTranscriptionWebhook?: string;
 		recognitionChannel: number;
 		sttLanguage: string;
@@ -16922,11 +16977,11 @@ export interface ILargeLanguageModelIndexItem_2_0 extends IGlobalResource {
 	createdBy: TMongoId;
 	lastChangedBy: TMongoId;
 }
-export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
+export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Pick<IGlobalResource, "resourceLevel">, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
 }
 export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
 }
-export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
+export interface ICreateLargeLanguageModelRestDataBody_2_0 extends Partial<IProjectScope>, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
 }
 export interface ICreateLargeLanguageModelRestData_2_0 extends ICreateLargeLanguageModelRestDataBody_2_0 {
 }
@@ -17741,6 +17796,23 @@ export interface IGenerateNluScoresRestReturnValue_2_0 {
  *             formality:
  *               type: string
  *           example: { "completeness": "concise", "formality": "formal" }
+ *         voiceConfigs:
+ *           type: object
+ *           properties:
+ *             ttsVoice:
+ *               type: string
+ *             ttsLanguage:
+ *               type: string
+ *             ttsVendor:
+ *               enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
+ *               type: string
+ *             ttsModel:
+ *               type: string
+ *           example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2" }
+ *         enableVoiceConfigs:
+ *           type: boolean
+ *           description: Enables the use of voice configuration.
+ *           example: false
  *         safetySettings:
  *           type: object
  *           properties:
@@ -17787,6 +17859,8 @@ export interface IAiAgent_2_0 {
 	knowledgeReferenceId: string;
 	description: string;
 	speakingStyle: ISpeakingStyle;
+	voiceConfigs: IVoiceConfigParams;
+	enableVoiceConfigs: boolean;
 	safetySettings: ISafetySettings;
 	contactProfilesOption: TContactProfileOptions;
 	contactProfilesSelected: string[];