@cognigy/rest-api-client 2025.18.0 → 2025.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/build/authentication/AuthenticationAPI.js +1 -1
  3. package/build/authentication/OAuth2/OAuth2Authentication.js +12 -9
  4. package/build/connector/AxiosAdapter.js +6 -2
  5. package/build/shared/charts/descriptors/service/GPTPrompt.js +2 -2
  6. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +2 -2
  7. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +2 -2
  8. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +20 -6
  9. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +39 -3
  10. package/build/shared/generativeAI/utils/generativeAIPrompts.js +17 -446
  11. package/build/shared/generativeAI/utils/prompts/flowGeneration.js +168 -0
  12. package/build/shared/generativeAI/utils/prompts/generateNodeOutput.js +39 -0
  13. package/build/shared/generativeAI/utils/prompts/intentSentenceGeneration.js +15 -0
  14. package/build/shared/generativeAI/utils/prompts/lexiconGeneration.js +22 -0
  15. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +4 -0
  16. package/build/shared/interfaces/handover.js +3 -1
  17. package/build/shared/interfaces/messageAPI/endpoints.js +5 -2
  18. package/build/shared/interfaces/resources/INodeDescriptorSet.js +87 -77
  19. package/dist/esm/authentication/AuthenticationAPI.js +1 -1
  20. package/dist/esm/authentication/OAuth2/OAuth2Authentication.js +12 -9
  21. package/dist/esm/connector/AxiosAdapter.js +6 -2
  22. package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +1 -1
  23. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +1 -1
  24. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +1 -1
  25. package/dist/esm/shared/charts/descriptors/voice/mappers/transfer.mapper.js +20 -6
  26. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/transfer.js +39 -3
  27. package/dist/esm/shared/generativeAI/utils/generativeAIPrompts.js +16 -445
  28. package/dist/esm/shared/generativeAI/utils/prompts/flowGeneration.js +165 -0
  29. package/dist/esm/shared/generativeAI/utils/prompts/generateNodeOutput.js +36 -0
  30. package/dist/esm/shared/generativeAI/utils/prompts/intentSentenceGeneration.js +12 -0
  31. package/dist/esm/shared/generativeAI/utils/prompts/lexiconGeneration.js +19 -0
  32. package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +4 -0
  33. package/dist/esm/shared/interfaces/handover.js +3 -1
  34. package/dist/esm/shared/interfaces/messageAPI/endpoints.js +5 -2
  35. package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js +88 -78
  36. package/package.json +1 -1
  37. package/types/index.d.ts +1045 -1016
package/types/index.d.ts CHANGED
@@ -146,6 +146,11 @@ export interface IHttpRequestOptions {
146
146
  * @default true
147
147
  */
148
148
  withAuthentication?: boolean;
149
+ /**
150
+ * Should send credentials to the request.
151
+ * @default false
152
+ */
153
+ withCredentials?: boolean;
149
154
  /**
150
155
  * Specifies the number of milliseconds before the request times out.
151
156
  */
@@ -374,6 +379,13 @@ export interface ILoginByAuthorizationCodeParameters {
374
379
  * The code verifier for authentication using authorization code with PKCE
375
380
  */
376
381
  codeVerifier?: string;
382
+ /**
383
+ * If rememberMe is set to true, you get a long lived refreshToken, default
384
+ * 7 days. If rememberMe is set to false, you get a short lived refreshToken valid only for 24 hours.
385
+ *
386
+ * @default false
387
+ */
388
+ rememberMe: boolean;
377
389
  }
378
390
  export interface IGetAuthorizationCodeParameters {
379
391
  /**
@@ -2342,6 +2354,10 @@ export interface IAgentAssistSettings {
2342
2354
  redactTranscriptTileMessages?: boolean;
2343
2355
  enableAgentCopilotAuthentication?: boolean;
2344
2356
  agentCopilotAuthentication?: string;
2357
+ /**
2358
+ * Optional OAuth2 connection id for providers that require it (e.g., Genesys)
2359
+ */
2360
+ oAuth2Connection?: string;
2345
2361
  }
2346
2362
  export interface IGenesysCloudHandoverSettings {
2347
2363
  host: string;
@@ -2526,218 +2542,921 @@ export interface IGraphEndpointDependency {
2526
2542
  _id: string;
2527
2543
  type: "endpointFlow" | "endpointNluConnector";
2528
2544
  }
2529
- /**
2530
- * The supported endpoint channels
2531
- *
2532
- * @openapi
2533
- *
2534
- * components:
2535
- * schemas:
2536
- * TChannelType:
2537
- * type: string
2538
- * example: webchat3
2539
- * enum:
2540
- * - facebook
2541
- * - alexa
2542
- * - slack
2543
- * - generic
2544
- * - inject
2545
- * - rest
2546
- * - realtime
2547
- * - socket
2548
- * - adminconsole
2549
- * - webchat2
2550
- * - dialogflow
2551
- * - twilio
2552
- * - twilio-sms
2553
- * - line
2554
- * - intercom
2555
- * - microsoftBotFramework
2556
- * - microsoftTeams
2557
- * - sunshineConversations
2558
- * - admin-webchat
2559
- * - avaya
2560
- * - nonConversational
2561
- * - voiceGateway2
2562
- * - amazonLex
2563
- * - workplace
2564
- * - webhook
2565
- * - abstractRest
2566
- * - userlike
2567
- * - ringCentralEngage
2568
- * - audioCodes
2569
- * - bandwidth
2570
- * - whatsapp
2571
- * - eightByEight
2572
- * - genesysBotConnector
2573
- * - niceCXOne
2574
- * - agentAssistVoice
2575
- * - webchat3
2576
- * - niceCXOneAAH
2577
- * - zoomContactCenter
2578
- */
2579
- export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
2580
- declare const endpointTypes: readonly [
2581
- "facebook",
2582
- "workplace",
2583
- "alexa",
2584
- "slack",
2585
- "webhook",
2586
- "rest",
2587
- "abstractRest",
2588
- "socket",
2589
- "adminconsole",
2590
- "webchat2",
2591
- "dialogflow",
2592
- "twilio",
2593
- "twilioSms",
2594
- "line",
2595
- "intercom",
2596
- "microsoftBotFramework",
2597
- "microsoftTeams",
2598
- "sunshineConversations",
2599
- "userlike",
2600
- "ringCentralEngage",
2601
- "audioCodes",
2602
- "avaya",
2603
- "nonConversational",
2604
- "voiceGateway2",
2605
- "whatsapp",
2606
- "amazonLex",
2607
- "eightByEight",
2608
- "bandwidth",
2609
- "genesysBotConnector",
2610
- "niceCXOne",
2611
- "niceCXOneAAH",
2612
- "agentAssistVoice",
2613
- "webchat3",
2614
- "zoomContactCenter"
2615
- ];
2616
- export declare type TEndpointType = typeof endpointTypes[number];
2617
- declare const transferTypes: readonly [
2618
- "dial",
2619
- "sip:refer"
2620
- ];
2621
- export declare type TTransferType = typeof transferTypes[number];
2622
- export interface IWebchatPersistentMenu {
2623
- /**
2624
- * The title of the persistent menu
2625
- */
2626
- title: string;
2627
- /**
2628
- * The menu items for the persistent menu.
2629
- * The webchat currently only supports
2630
- * one "layer" of menu items.
2631
- */
2632
- menuItems: {
2633
- /**
2634
- * The title of the menu item
2635
- */
2636
- title: string;
2637
- /**
2638
- * The payload to send to AI
2639
- * when clicking the menu item
2640
- */
2641
- payload: string;
2642
- }[];
2545
+ export interface ISystemSlots {
2546
+ DATE: IDateSlot[] | null;
2547
+ NUMBER: INumberSlot[] | null;
2548
+ DURATION: IDurationSlot[] | null;
2549
+ TEMPERATURE: ITemperatureSlot[] | null;
2550
+ AGE: IAgeSlot[] | null;
2551
+ PERCENTAGE: IPercentageSlot[] | null;
2552
+ EMAIL: IEmailSlot[] | null;
2553
+ URL: IUrlSlot[] | null;
2554
+ MONEY: IMoneySlot[] | null;
2555
+ DISTANCE: IDistanceSlot[] | null;
2643
2556
  }
2644
- export interface ICallEventSettings {
2645
- enabled: boolean;
2646
- action: "inject" | "executeFlow" | "transfer" | "none";
2647
- flowId: string;
2648
- entrypoint?: string;
2649
- injectText?: string;
2650
- injectData?: string;
2651
- failover?: ICallEventFailoverSettings;
2557
+ export interface IBaseSlot {
2558
+ text: string;
2559
+ data: any;
2560
+ offset: {
2561
+ start: number;
2562
+ end: number;
2563
+ };
2652
2564
  }
2653
- export interface ICallEventFailoverSettings {
2654
- enabled?: boolean;
2655
- enabledForSpeech?: boolean;
2656
- type?: TTransferType;
2657
- headers?: string;
2658
- to?: string;
2659
- reason?: string;
2660
- dialCallerId?: string;
2661
- dialMusic?: string;
2662
- dialTimeout?: number;
2663
- enableTimeLimit?: boolean;
2664
- timeLimit?: number;
2665
- dialTranscribeEnabled?: boolean;
2666
- dialTranscribeVendor?: string;
2667
- dialTranscribeLanguage?: string;
2668
- dialTranscribeWebhook?: string;
2669
- dialTranscribeRecognitionChannel?: number;
2670
- dialTranscribeRecognitionGoogleModel?: string;
2671
- dialTranscribeLabel?: string;
2672
- dialTranscribeDeepgramModel?: string;
2673
- referredBy?: string;
2674
- deepgramSmartFormatting?: boolean;
2675
- deepgramEndpointing?: boolean;
2676
- deepgramEndpointingValue?: number;
2677
- dialTranscribeDeepgramTier?: string;
2678
- anchorMedia?: boolean;
2565
+ export interface IPercentageSlot extends IBaseSlot {
2566
+ data: {
2567
+ value: number;
2568
+ };
2679
2569
  }
2680
- export interface ICallEvents {
2681
- amd?: ICallEventSettings;
2682
- callCreated?: ICallEventSettings;
2683
- callCompleted?: ICallEventSettings;
2684
- callFailed?: ICallEventSettings;
2685
- callInProgress?: ICallEventSettings;
2686
- callReconnected?: ICallEventSettings;
2687
- userInputTimeout?: ICallEventSettings;
2688
- recognizedSpeech?: ICallEventSettings;
2689
- recognizedDtmf?: ICallEventSettings;
2690
- transferReferSuccess?: ICallEventSettings;
2691
- transferReferError?: ICallEventSettings;
2692
- transferDialSuccess?: ICallEventSettings;
2693
- transferDialError?: ICallEventSettings;
2694
- userBusy?: ICallEventSettings;
2695
- noAnswer?: ICallEventSettings;
2570
+ export interface IAgeSlot extends IBaseSlot {
2571
+ data: {
2572
+ value: number;
2573
+ unit: TTimeGrain;
2574
+ };
2696
2575
  }
2697
- export interface IVGProsodySettings {
2698
- outputSpeed?: number;
2699
- outputPitch?: number;
2700
- outputVolume?: number;
2576
+ export interface INumberSlot extends IBaseSlot {
2577
+ data: {
2578
+ value: number;
2579
+ };
2701
2580
  }
2702
- export interface IVGGenericSettings {
2703
- prosodySettings?: IVGProsodySettings;
2704
- showBestTranscriptOnly?: boolean;
2705
- enableCallInProgress?: boolean;
2581
+ export interface IEmailSlot extends IBaseSlot {
2582
+ data: {
2583
+ value: string;
2584
+ };
2706
2585
  }
2707
- export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
2708
- callEvents: ICallEvents;
2709
- failover?: ICallEventFailoverSettings;
2710
- genericSettings?: IVGGenericSettings;
2711
- isFeatureAccmEnabled?: boolean;
2712
- /**
2713
- * Control the privacy notice of the Webrtc Widget
2714
- */
2715
- privacyNotice: Omit<IWebchat3EndpointPrivacyNoticeSettings, "title"> & {
2716
- cancelButtonText: string;
2586
+ export declare type ITemperatureUnit = "celsius" | "fahrenheit" | "degree" | "kelvin";
2587
+ export interface ITemperatureSlot extends IBaseSlot {
2588
+ data: {
2589
+ value: number;
2590
+ unit: ITemperatureUnit;
2717
2591
  };
2718
2592
  }
2719
- export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | IZoomContactCenterEndpointSettings | {};
2720
- export declare type TAvayaVoice = "man" | "woman" | string;
2721
- declare const avayaSttTtsLanguages: readonly [
2722
- "cy-GB",
2723
- "da-DK",
2724
- "de-DE",
2725
- "en-AU",
2726
- "en-GB",
2727
- "en-GB-WLS",
2728
- "en-IN",
2729
- "en-US",
2730
- "es-ES",
2731
- "es-US",
2732
- "fr-CA",
2733
- "fr-FR",
2734
- "is-IS",
2735
- "it-IT",
2736
- "ja-JP",
2737
- "nb-NO",
2738
- "nl-NL",
2739
- "pl-PL",
2740
- "pt-BR",
2593
+ export declare type TTimeGrain = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
2594
+ export interface IDateObject {
2595
+ day: number;
2596
+ hour: number;
2597
+ minute: number;
2598
+ month: number;
2599
+ second: number;
2600
+ milliseconds: number;
2601
+ weekday: number;
2602
+ dayOfWeek: string;
2603
+ year: number;
2604
+ ISODate: string;
2605
+ grain: TTimeGrain | null;
2606
+ plain: string;
2607
+ timezoneOffset?: string;
2608
+ }
2609
+ export interface IDateSlot extends IBaseSlot {
2610
+ data: {
2611
+ start?: IDateObject;
2612
+ end?: IDateObject;
2613
+ };
2614
+ }
2615
+ export interface IDurationSlot extends IBaseSlot {
2616
+ data: {
2617
+ unit?: TTimeGrain;
2618
+ value?: number;
2619
+ inSeconds?: number;
2620
+ years?: number;
2621
+ quarters?: number;
2622
+ months?: number;
2623
+ weeks?: number;
2624
+ days?: number;
2625
+ hours?: number;
2626
+ minutes?: number;
2627
+ seconds?: number;
2628
+ };
2629
+ }
2630
+ export interface IMoneySlot extends IBaseSlot {
2631
+ data: {
2632
+ value: number;
2633
+ unit: string;
2634
+ };
2635
+ }
2636
+ export interface IUrlSlot extends IBaseSlot {
2637
+ data: {
2638
+ domain: string;
2639
+ value: string;
2640
+ };
2641
+ }
2642
+ export interface IDistanceSlot extends IBaseSlot {
2643
+ data: {
2644
+ unit: string;
2645
+ value: number;
2646
+ };
2647
+ }
2648
+ declare const arrayTDebugEventTypes: readonly [
2649
+ "inputChanged",
2650
+ "contextChanged",
2651
+ "profileChanged",
2652
+ "activeEntrypointsChanged",
2653
+ "nodeExecuted",
2654
+ "nodeError",
2655
+ "finalPing",
2656
+ "input",
2657
+ "output",
2658
+ "switchedFlow",
2659
+ "nluWarning",
2660
+ "debugMessage",
2661
+ "debugError",
2662
+ "goalCompleted"
2663
+ ];
2664
+ export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
2665
+ export interface IErrorEventPayload extends ILoggerStack {
2666
+ message: string;
2667
+ flowId: string;
2668
+ nodeId?: string;
2669
+ }
2670
+ export interface IFinalPingEventPayload {
2671
+ type: "regular" | "preventFinalPingToEndpoint" | "cognigyStopFlow" | "error";
2672
+ analyticsData?: IAnalyticsSourceData;
2673
+ error?: IErrorEventPayload;
2674
+ sessionId?: string;
2675
+ }
2676
+ export interface IGenericIntentFeedbackFinding {
2677
+ type: IGenericIntentFeedbackFindingType;
2678
+ }
2679
+ export interface IOverlapIntentFeedbackFinding {
2680
+ type: IOverlapIntentFeedbackFindingType;
2681
+ overlappingIntentReferenceId: string;
2682
+ overlappingIntentName: string;
2683
+ overlappingIntentId: TMongoId;
2684
+ overlappingFlowName: string;
2685
+ overlappingFlowId: TMongoId;
2686
+ }
2687
+ export interface ILowDataIntentFeedbackFinding {
2688
+ type: "lowDataIntents";
2689
+ intents: {
2690
+ intentReferenceId: string;
2691
+ intentName: string;
2692
+ intentId: string;
2693
+ flowId: string;
2694
+ flowName: string;
2695
+ }[];
2696
+ }
2697
+ declare const overlapIntentFeedbackFindingArrayType: readonly [
2698
+ "strongOverlap",
2699
+ "someOverlap"
2700
+ ];
2701
+ export declare type IOverlapIntentFeedbackFindingType = typeof overlapIntentFeedbackFindingArrayType[number];
2702
+ declare const genericIntentFeedbackFindingArrayType: readonly [
2703
+ "poorFScore",
2704
+ "fairFScore",
2705
+ "goodFScore",
2706
+ "fewSentences",
2707
+ "unclearIntent",
2708
+ "noSiblings"
2709
+ ];
2710
+ export declare type IGenericIntentFeedbackFindingType = typeof genericIntentFeedbackFindingArrayType[number];
2711
+ export declare type IntentFeedbackFinding = IGenericIntentFeedbackFinding | IOverlapIntentFeedbackFinding | ILowDataIntentFeedbackFinding;
2712
+ export interface IIntentFeedbackInDBReport {
2713
+ findings: IntentFeedbackFinding[];
2714
+ info: {
2715
+ fScore: number;
2716
+ };
2717
+ }
2718
+ declare const biasTowardsParentOrChildIntentsTypes: readonly [
2719
+ "parents",
2720
+ "children"
2721
+ ];
2722
+ export declare type TBiasTowardsParentOrChildIntentsTypes = typeof biasTowardsParentOrChildIntentsTypes[number];
2723
+ declare const intentTypes: readonly [
2724
+ "yesNoIntent",
2725
+ "default"
2726
+ ];
2727
+ export declare type TIntentTypes = typeof intentTypes[number];
2728
+ export interface ILocalizedIntentData {
2729
+ rules: string[];
2730
+ condition: string;
2731
+ confirmationSentences: string[];
2732
+ disambiguationSentence: string;
2733
+ localeReference: TMongoId;
2734
+ }
2735
+ export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
2736
+ localizedData: ILocalizedIntentData[];
2737
+ /**
2738
+ * A list of all of the locales
2739
+ * that are not disabled. Used to return
2740
+ * the correct isDisabled value for the
2741
+ * given locale
2742
+ */
2743
+ enabledLocaleReferences: TMongoId[];
2744
+ }
2745
+ export interface IIntent extends IEntityMeta, ILocalizedIntentData {
2746
+ name: string;
2747
+ description?: string;
2748
+ referenceId: string;
2749
+ isRejectIntent: boolean;
2750
+ isDisabled: boolean;
2751
+ tags: string[];
2752
+ data: any;
2753
+ nodeReferenceId: string;
2754
+ childFeatures?: boolean | string[];
2755
+ biasTowardsParentOrChildIntents: TBiasTowardsParentOrChildIntentsTypes;
2756
+ parentIntentId?: string;
2757
+ feedbackReport: IIntentFeedbackInDBReport;
2758
+ intentRelationReferences: TMongoId[];
2759
+ flowReference?: TMongoId;
2760
+ projectReference: TMongoId;
2761
+ organisationReference: TMongoId;
2762
+ flowReferenceId?: string;
2763
+ /**
2764
+ * A label we use in analytics
2765
+ * to track when an intent was triggered
2766
+ */
2767
+ analyticsLabel?: string;
2768
+ /**
2769
+ * Enable the usage of default replies as example sentences
2770
+ */
2771
+ overrideIntentDefaultRepliesAsExamples?: string;
2772
+ intentType: TIntentTypes;
2773
+ }
2774
+ export interface IYesNoData {
2775
+ _id: string;
2776
+ rules: string[];
2777
+ name: string;
2778
+ isDisabled: boolean;
2779
+ }
2780
+ export interface IYesNoItem {
2781
+ yesIntent: IYesNoData | IIntentInDB;
2782
+ noIntent: IYesNoData | IIntentInDB;
2783
+ rejectIntent: IYesNoData | IIntentInDB;
2784
+ }
2785
+ declare const generativeAIModels: readonly [
2786
+ "gpt-3.5-turbo",
2787
+ "gpt-3.5-turbo-instruct",
2788
+ "gpt-4",
2789
+ "gpt-4o",
2790
+ "gpt-4o-mini",
2791
+ "gpt-4.1",
2792
+ "gpt-4.1-mini",
2793
+ "gpt-4.1-nano",
2794
+ "gpt-5",
2795
+ "gpt-5-nano",
2796
+ "gpt-5-mini",
2797
+ "gpt-5-chat-latest",
2798
+ "luminous-extended-control",
2799
+ "claude-v1-100k",
2800
+ "claude-instant-v1",
2801
+ "claude-3-opus-20240229",
2802
+ "claude-3-haiku-20240307",
2803
+ "claude-3-sonnet-20240229",
2804
+ "claude-3-5-sonnet-20241022",
2805
+ "claude-3-7-sonnet-20250219",
2806
+ "claude-3-5-sonnet-latest",
2807
+ "claude-3-7-sonnet-latest",
2808
+ "claude-opus-4-0",
2809
+ "claude-sonnet-4-0",
2810
+ "text-bison@001",
2811
+ "custom-model",
2812
+ "custom-embedding-model",
2813
+ "gemini-1.0-pro",
2814
+ "gemini-1.5-pro",
2815
+ "gemini-1.5-flash",
2816
+ "gemini-2.0-flash",
2817
+ "gemini-2.0-flash-lite",
2818
+ "amazon.nova-lite-v1:0",
2819
+ "amazon.nova-pro-v1:0",
2820
+ "amazon.nova-micro-v1:0",
2821
+ "anthropic.claude-3-5-sonnet-20240620-v1:0",
2822
+ "mistral-large-2411",
2823
+ "mistral-small-2503",
2824
+ "pixtral-large-2411",
2825
+ "pixtral-12b-2409",
2826
+ "mistral-large-latest",
2827
+ "pixtral-large-latest",
2828
+ "mistral-medium-latest",
2829
+ "mistral-small-latest",
2830
+ "text-davinci-003",
2831
+ "text-embedding-3-small",
2832
+ "text-embedding-3-large",
2833
+ "text-embedding-ada-002",
2834
+ "luminous-embedding-128",
2835
+ "amazon.titan-embed-text-v2:0",
2836
+ "Pharia-1-Embedding-4608"
2837
+ ];
2838
+ /**
2839
+ * @openapi
2840
+ *
2841
+ * components:
2842
+ * schemas:
2843
+ * TGenerativeAIModels:
2844
+ * type: string
2845
+ * enum:
2846
+ * - gpt-3.5-turbo
2847
+ * - gpt-3.5-turbo-instruct
2848
+ * - gpt-4
2849
+ * - gpt-4o
2850
+ * - gpt-4o-mini
2851
+ * - text-embedding-ada-002
2852
+ * - luminous-extended-control
2853
+ * - luminous-embedding-128
2854
+ * - Pharia-1-Embedding-4608
2855
+ * - claude-v1-100k
2856
+ * - claude-instant-v1
2857
+ * - claude-3-opus-20240229
2858
+ * - custom-model
2859
+ * - custom-embedding-model
2860
+ * - gemini-2.0-flash
2861
+ * - gemini-2.0-flash-lite
2862
+ * - mistral-large-2411
2863
+ * - mistral-small-2503
2864
+ * - pixtral-large-2411
2865
+ * - pixtral-12b-2409
2866
+ */
2867
+ export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
2868
+ declare const generativeAIProviders: readonly [
2869
+ "azureOpenAI",
2870
+ "openAI",
2871
+ "openAICompatible",
2872
+ "alephAlpha",
2873
+ "anthropic",
2874
+ "googleVertexAI",
2875
+ "googleGemini",
2876
+ "awsBedrock",
2877
+ "mistral"
2878
+ ];
2879
+ /**
2880
+ * @openapi
2881
+ *
2882
+ * components:
2883
+ * schemas:
2884
+ * TGenerativeAIProviders:
2885
+ * type: string
2886
+ * enum:
2887
+ * - azureOpenAI
2888
+ * - openAI
2889
+ * - anthropic
2890
+ * - googleVertexAI
2891
+ * - googleGemini
2892
+ * - alephAlpha
2893
+ * - awsBedrock
2894
+ * - mistral
2895
+ */
2896
+ export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
2897
+ declare const generativeAIUseCases: readonly [
2898
+ "nlu",
2899
+ "knowledgeSearch",
2900
+ "aiAgent",
2901
+ "gptPromptNode",
2902
+ "aiEnhancedOutputs",
2903
+ "sentimentAnalysis",
2904
+ "designTimeGeneration",
2905
+ "intentSentenceGeneration",
2906
+ "flowGeneration",
2907
+ "generateNodeOutput",
2908
+ "lexiconGeneration",
2909
+ "answerExtraction",
2910
+ "gptConversation"
2911
+ ];
2912
+ export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
2913
+ declare const modeType: readonly [
2914
+ "chat",
2915
+ "completion",
2916
+ "embedding"
2917
+ ];
2918
+ export declare type TModeType = typeof modeType[number];
2919
+ export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
2920
+ export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
2921
+ export declare type TSQL_EXTENSION = "@cognigy/mssql";
2922
+ export declare type TSMTP_EXTENSION = "@cognigy/smtp";
2923
+ export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
2924
+ export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
2925
+ export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
2926
+ export interface IGenerativeAIUseCaseSettings {
2927
+ largeLanguageModelId: string | null;
2928
+ temperature: number;
2929
+ }
2930
+ declare const audioPreviewProviders: readonly [
2931
+ "microsoft",
2932
+ "google",
2933
+ "aws",
2934
+ "deepgram"
2935
+ ];
2936
+ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
2937
+ /**
2938
+ * @openapi
2939
+ * components:
2940
+ * schemas:
2941
+ * IGenerativeAIUseCase:
2942
+ * type: object
2943
+ * properties:
2944
+ * useCase:
2945
+ * enum:
2946
+ * - designTimeGeneration
2947
+ * - intentSentenceGeneration
2948
+ * - aiEnhancedOutputs
2949
+ * - lexiconGeneration
2950
+ * - flowGeneration
2951
+ * - gptConversation
2952
+ * - gptPromptNode
2953
+ * - generateNodeOutput
2954
+ * - knowledgeSearch
2955
+ * - sentimentAnalysis
2956
+ */
2957
+ export interface IGenerativeAIUseCase {
2958
+ useCase: TGenerativeAIUseCases;
2959
+ }
2960
+ export declare const nluLanguages: readonly [
2961
+ "ar-AE",
2962
+ "bn-IN",
2963
+ "da-DK",
2964
+ "en-AU",
2965
+ "en-CA",
2966
+ "en-GB",
2967
+ "en-IN",
2968
+ "en-US",
2969
+ "es-ES",
2970
+ "fi-FI",
2971
+ "fr-FR",
2972
+ "de-DE",
2973
+ "hi-IN",
2974
+ "it-IT",
2975
+ "ja-JP",
2976
+ "ko-KR",
2977
+ "nn-NO",
2978
+ "nl-NL",
2979
+ "pl-PL",
2980
+ "pt-BR",
2981
+ "pt-PT",
2982
+ "ru-RU",
2983
+ "sv-SE",
2984
+ "ta-IN",
2985
+ "th-TH",
2986
+ "tr-TR",
2987
+ "vi-VN",
2988
+ "zh-CN",
2989
+ "ge-GE"
2990
+ ];
2991
+ export declare type TNluLanguage = typeof nluLanguages[number];
2992
+ export interface INluEmbeddingCredentials {
2993
+ apiType: TGenerativeAIProviders;
2994
+ apiKey: string;
2995
+ apiModel: TGenerativeAIModels;
2996
+ apiCustomBaseUrl?: string;
2997
+ apiResourceName?: string;
2998
+ apiDeploymentName?: string;
2999
+ apiVersion?: string;
3000
+ }
3001
+ export interface ISetAppStateOverlaySettings {
3002
+ autoOpen: boolean;
3003
+ closeOnSubmit: boolean;
3004
+ feedbackMessage: string;
3005
+ screenTitle: string;
3006
+ sendEventOnCloseIconClick: boolean;
3007
+ showCloseIcon: boolean;
3008
+ }
3009
+ export interface ISetAppStateOverlaySettingsMetaData {
3010
+ overlaySettings: ISetAppStateOverlaySettings;
3011
+ endpointType: TEndpointType;
3012
+ url: string;
3013
+ URLToken: string;
3014
+ }
3015
+ export interface IVoiceGateway2VadParams {
3016
+ enable?: boolean;
3017
+ voiceMs?: number;
3018
+ mode?: number;
3019
+ }
3020
+ export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
3021
+ export interface IVoiceGateway2SynthesizerParams {
3022
+ vendor?: TVoiceGateway2TTSVendor | "default" | "none";
3023
+ language?: string;
3024
+ voice?: string;
3025
+ label?: string;
3026
+ fallbackVendor?: string;
3027
+ fallbackLabel?: string;
3028
+ fallbackLanguage?: string;
3029
+ fallbackVoice?: string;
3030
+ engine?: "standard" | "neural";
3031
+ gender?: "MALE" | "FEMALE" | "NEUTRAL";
3032
+ azureServiceEndpoint?: string;
3033
+ options?: object;
3034
+ disableCache?: boolean;
3035
+ model?: string;
3036
+ }
3037
+ export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
3038
+ export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
3039
+ export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
3040
+ export interface IVoiceGateway2RecognizerParams {
3041
+ vendor?: TVoiceGateway2STTVendor | "default" | "none";
3042
+ language?: string;
3043
+ label?: string;
3044
+ fallbackVendor?: string;
3045
+ fallbackLabel?: string;
3046
+ fallbackLanguage?: string;
3047
+ vad?: IVoiceGateway2VadParams;
3048
+ hints?: string[];
3049
+ hintsBoost?: number;
3050
+ altLanguages?: string[];
3051
+ profanityFilter?: boolean;
3052
+ interim?: boolean;
3053
+ singleUtterance?: boolean;
3054
+ dualChannel?: boolean;
3055
+ separateRecognitionPerChannel?: boolean;
3056
+ punctuation?: boolean;
3057
+ enhancedModel?: boolean;
3058
+ words?: boolean;
3059
+ diarization?: boolean;
3060
+ diarizationMinSpeakers?: number;
3061
+ diarizationMaxSpeakers?: number;
3062
+ interactionType?: "unspecified" | "discussion" | "presentation" | "phone_call" | "voicemail" | "voice_search" | "voice_command" | "dictation";
3063
+ naicsCod?: number;
3064
+ identifyChannels?: boolean;
3065
+ vocabularyName?: string;
3066
+ vocabularyFilterName?: string;
3067
+ filterMethod?: "remove" | "mask" | "tag";
3068
+ outputFormat?: "simple" | "detailed";
3069
+ profanityOption?: "masked" | "removed" | "raw";
3070
+ requestSnr?: boolean;
3071
+ initialSpeechTimeoutMs?: number;
3072
+ azureSttEndpointId?: string;
3073
+ audioLogging?: boolean;
3074
+ asrDtmfTerminationDigit?: string;
3075
+ asrTimeout?: number;
3076
+ nuanceOptions?: TVoiceGateway2NuanceOptions;
3077
+ deepgramOptions?: TVoiceGateway2DeepgramOptions;
3078
+ ibmOptions?: TVoiceGateway2IbmOptions;
3079
+ nvidiaOptions?: TVoiceGateway2NvidiaOptions;
3080
+ sonioxOptions?: TVoiceGateway2SonioxOptions;
3081
+ model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
3082
+ }
3083
+ export declare type TVoiceGateway2NuanceOptions = {
3084
+ clientId?: string;
3085
+ secret?: string;
3086
+ kryptonEndpoint?: string;
3087
+ topic?: string;
3088
+ utteranceDetectionMode?: string;
3089
+ punctuation?: boolean;
3090
+ profanityFilter?: boolean;
3091
+ includeTokenization?: boolean;
3092
+ discardSpeakerAdaptation?: boolean;
3093
+ suppressCallRecording?: boolean;
3094
+ maskLoadFailures?: boolean;
3095
+ suppressInitialCapitalization?: boolean;
3096
+ allowZeroBaseLmWeight?: boolean;
3097
+ filterWakeupWord?: boolean;
3098
+ resultType?: string;
3099
+ noInputTimeoutMs?: number;
3100
+ recognitionTimeoutMs?: number;
3101
+ utteranceEndSilenceMs?: number;
3102
+ maxHypotheses?: number;
3103
+ speechDomain?: string;
3104
+ formatting?: TVoiceGatewayNuanceFormatting;
3105
+ clientData?: object;
3106
+ userId?: string;
3107
+ speechDetectionSensitivity?: number;
3108
+ resources?: [
3109
+ TVoiceGatewayNuanceResources
3110
+ ];
3111
+ };
3112
+ export declare type TVoiceGateway2DeepgramOptions = {
3113
+ deepgramSttUri?: string;
3114
+ deepgramSttUseTls?: boolean;
3115
+ apiKey?: string;
3116
+ tier?: string;
3117
+ model?: string;
3118
+ customModel?: string;
3119
+ version?: string;
3120
+ punctuate?: boolean;
3121
+ smartFormatting?: boolean;
3122
+ profanityFilter?: boolean;
3123
+ redact?: string;
3124
+ diarize?: boolean;
3125
+ diarizeVersion?: string;
3126
+ ner?: boolean;
3127
+ multichannel?: boolean;
3128
+ alternatives?: number;
3129
+ numerals?: boolean;
3130
+ search?: string[];
3131
+ replace?: string[];
3132
+ keywords?: string[];
3133
+ endpointing?: number | boolean;
3134
+ utteranceEndMs?: number;
3135
+ shortUtterance?: boolean;
3136
+ vadTurnoff?: number;
3137
+ tag?: string;
3138
+ };
3139
+ export declare type TVoiceGateway2NvidiaOptions = {
3140
+ rivaUri?: string;
3141
+ maxAlternatives?: number;
3142
+ profanityFilter?: boolean;
3143
+ punctuation?: boolean;
3144
+ wordTimeOffsets?: boolean;
3145
+ verbatimTranscripts?: boolean;
3146
+ customConfiguration?: object;
3147
+ };
3148
+ export declare type TVoiceGateway2SonioxOptions = {
3149
+ id?: string;
3150
+ title?: string;
3151
+ disableStoreAudio?: boolean;
3152
+ disableStoreTranscript?: boolean;
3153
+ disableSearch?: boolean;
3154
+ metadata?: object;
3155
+ storage?: object;
3156
+ };
3157
+ export declare type TVoiceGateway2IbmOptions = {
3158
+ sttApiKey?: string;
3159
+ sttRegion?: string;
3160
+ ttsApiKey?: string;
3161
+ ttsRegion?: string;
3162
+ instanceId?: string;
3163
+ model?: string;
3164
+ languageCustomizationId?: string;
3165
+ acousticCustomizationId?: string;
3166
+ baseModelVersion?: string;
3167
+ watsonMetadata?: string;
3168
+ watsonLearningOptOut?: boolean;
3169
+ };
3170
+ export declare type TVoiceGatewayNuanceResourceReference = {
3171
+ type?: string;
3172
+ uri?: string;
3173
+ maxLoadFailures?: boolean;
3174
+ requestTimeoutMs?: number;
3175
+ headers?: object;
3176
+ };
3177
+ export declare type TVoiceGatewayNuanceResources = {
3178
+ externalReference?: TVoiceGatewayNuanceResourceReference;
3179
+ inlineWordset?: string;
3180
+ builtin?: string;
3181
+ inlineGrammar?: string;
3182
+ wakeupWord?: Array<string>;
3183
+ weightName?: string;
3184
+ weightValue?: number;
3185
+ reuse?: string;
3186
+ };
3187
+ export declare type TVoiceGatewayNuanceFormatting = {
3188
+ scheme?: string;
3189
+ options?: object;
3190
+ };
3191
+ export declare type TVoiceGateway2InputType = "digits" | "speech";
3192
+ export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
3193
+ export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
3194
+ export interface IVoiceGateway2BargeInParams {
3195
+ enable?: boolean;
3196
+ sticky?: boolean;
3197
+ dtmfBargein?: boolean;
3198
+ actionHook?: object | string;
3199
+ input?: TVoiceGateway2InputType[];
3200
+ finishOnKey?: string;
3201
+ numDigits?: number;
3202
+ minDigits?: number;
3203
+ maxDigits?: number;
3204
+ interDigitTimeout?: number;
3205
+ minBargeinWordCount?: number;
3206
+ }
3207
+ export interface IVoiceGateway2ActivityParams {
3208
+ synthesizer?: IVoiceGateway2SynthesizerParams;
3209
+ recognizer?: IVoiceGateway2RecognizerParams;
3210
+ bargeIn?: IVoiceGateway2BargeInParams;
3211
+ user?: IVoiceGateway2CognigyUserInputConfigParams;
3212
+ dtmf?: boolean;
3213
+ sessionParams?: IVoiceGateway2ActivityParams;
3214
+ fillerNoise?: IVoiceGateway2FillerNoiseParams;
3215
+ flow?: IVoiceGateway2CognigyFlowInputConfigParams;
3216
+ }
3217
+ export interface IVoiceGateway2FillerNoiseParams {
3218
+ enable: boolean;
3219
+ url?: string;
3220
+ startDelaySecs?: number;
3221
+ }
3222
+ export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
3223
+ export declare type TVoiceGateway2MediaPath = "fullMedia" | "partialMedia" | "noMedia";
3224
+ export interface IVoiceGateway2CognigyUserInputConfigParams {
3225
+ noInputMode?: TVoiceGateway2UserNoInputMode;
3226
+ noInputTimeout?: number;
3227
+ noInputRetries?: number;
3228
+ noInputSpeech?: string;
3229
+ noInputUrl?: string;
3230
+ userNoInputAutoHangup?: boolean;
3231
+ }
3232
+ export interface IVoiceGateway2CognigyFlowInputConfigParams {
3233
+ flowNoInputEnable?: boolean;
3234
+ flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
3235
+ flowNoInputTimeout?: number;
3236
+ flowNoInputRetries?: number;
3237
+ flowNoInputSpeech?: string;
3238
+ flowNoInputUrl?: string;
3239
+ flowNoInputFail?: boolean;
3240
+ }
3241
+ export interface IGetNluPipelineParams {
3242
+ parseIntents?: boolean;
3243
+ parseSlots?: boolean;
3244
+ parseSystemSlots?: boolean;
3245
+ findType?: boolean;
3246
+ }
3247
+ /**
3248
+ * The supported endpoint channels
3249
+ *
3250
+ * @openapi
3251
+ *
3252
+ * components:
3253
+ * schemas:
3254
+ * TChannelType:
3255
+ * type: string
3256
+ * example: webchat3
3257
+ * enum:
3258
+ * - facebook
3259
+ * - alexa
3260
+ * - slack
3261
+ * - generic
3262
+ * - inject
3263
+ * - rest
3264
+ * - realtime
3265
+ * - socket
3266
+ * - adminconsole
3267
+ * - webchat2
3268
+ * - dialogflow
3269
+ * - twilio
3270
+ * - twilio-sms
3271
+ * - line
3272
+ * - intercom
3273
+ * - microsoftBotFramework
3274
+ * - microsoftTeams
3275
+ * - sunshineConversations
3276
+ * - admin-webchat
3277
+ * - avaya
3278
+ * - nonConversational
3279
+ * - voiceGateway2
3280
+ * - amazonLex
3281
+ * - workplace
3282
+ * - webhook
3283
+ * - abstractRest
3284
+ * - userlike
3285
+ * - ringCentralEngage
3286
+ * - audioCodes
3287
+ * - bandwidth
3288
+ * - whatsapp
3289
+ * - eightByEight
3290
+ * - genesysBotConnector
3291
+ * - niceCXOne
3292
+ * - agentAssistVoice
3293
+ * - webchat3
3294
+ * - niceCXOneAAH
3295
+ * - zoomContactCenter
3296
+ */
3297
+ export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
3298
+ declare const endpointTypes: readonly [
3299
+ "facebook",
3300
+ "workplace",
3301
+ "alexa",
3302
+ "slack",
3303
+ "webhook",
3304
+ "rest",
3305
+ "abstractRest",
3306
+ "socket",
3307
+ "adminconsole",
3308
+ "webchat2",
3309
+ "dialogflow",
3310
+ "twilio",
3311
+ "twilioSms",
3312
+ "line",
3313
+ "intercom",
3314
+ "microsoftBotFramework",
3315
+ "microsoftTeams",
3316
+ "sunshineConversations",
3317
+ "userlike",
3318
+ "ringCentralEngage",
3319
+ "audioCodes",
3320
+ "avaya",
3321
+ "nonConversational",
3322
+ "voiceGateway2",
3323
+ "whatsapp",
3324
+ "amazonLex",
3325
+ "eightByEight",
3326
+ "bandwidth",
3327
+ "genesysBotConnector",
3328
+ "niceCXOne",
3329
+ "niceCXOneAAH",
3330
+ "agentAssistVoice",
3331
+ "webchat3",
3332
+ "zoomContactCenter"
3333
+ ];
3334
+ export declare type TEndpointType = typeof endpointTypes[number];
3335
+ declare const transferTypes: readonly [
3336
+ "dial",
3337
+ "sip:refer"
3338
+ ];
3339
+ export declare type TTransferType = typeof transferTypes[number];
3340
+ export interface IWebchatPersistentMenu {
3341
+ /**
3342
+ * The title of the persistent menu
3343
+ */
3344
+ title: string;
3345
+ /**
3346
+ * The menu items for the persistent menu.
3347
+ * The webchat currently only supports
3348
+ * one "layer" of menu items.
3349
+ */
3350
+ menuItems: {
3351
+ /**
3352
+ * The title of the menu item
3353
+ */
3354
+ title: string;
3355
+ /**
3356
+ * The payload to send to AI
3357
+ * when clicking the menu item
3358
+ */
3359
+ payload: string;
3360
+ }[];
3361
+ }
3362
+ export interface ICallEventSettings {
3363
+ enabled: boolean;
3364
+ action: "inject" | "executeFlow" | "transfer" | "none";
3365
+ flowId: string;
3366
+ entrypoint?: string;
3367
+ injectText?: string;
3368
+ injectData?: string;
3369
+ failover?: ICallEventFailoverSettings;
3370
+ }
3371
+ export interface ICallEventFailoverSettings {
3372
+ enabled?: boolean;
3373
+ enabledForSpeech?: boolean;
3374
+ type?: TTransferType;
3375
+ headers?: string;
3376
+ to?: string;
3377
+ reason?: string;
3378
+ dialCallerId?: string;
3379
+ dialMusic?: string;
3380
+ dialTimeout?: number;
3381
+ enableTimeLimit?: boolean;
3382
+ timeLimit?: number;
3383
+ dialTranscribeEnabled?: boolean;
3384
+ dialTranscribeVendor?: string;
3385
+ dialTranscribeLanguage?: string;
3386
+ dialTranscribeWebhook?: string;
3387
+ dialTranscribeRecognitionChannel?: number;
3388
+ dialTranscribeRecognitionGoogleModel?: string;
3389
+ dialTranscribeLabel?: string;
3390
+ dialTranscribeDeepgramModel?: string;
3391
+ referredBy?: string;
3392
+ deepgramSmartFormatting?: boolean;
3393
+ deepgramEndpointing?: boolean;
3394
+ deepgramEndpointingValue?: number;
3395
+ dialTranscribeDeepgramTier?: string;
3396
+ mediaPath?: TVoiceGateway2MediaPath;
3397
+ anchorMedia?: boolean;
3398
+ }
3399
+ export interface ICallEvents {
3400
+ amd?: ICallEventSettings;
3401
+ callCreated?: ICallEventSettings;
3402
+ callCompleted?: ICallEventSettings;
3403
+ callFailed?: ICallEventSettings;
3404
+ callInProgress?: ICallEventSettings;
3405
+ callReconnected?: ICallEventSettings;
3406
+ userInputTimeout?: ICallEventSettings;
3407
+ recognizedSpeech?: ICallEventSettings;
3408
+ recognizedDtmf?: ICallEventSettings;
3409
+ transferReferSuccess?: ICallEventSettings;
3410
+ transferReferError?: ICallEventSettings;
3411
+ transferDialSuccess?: ICallEventSettings;
3412
+ transferDialError?: ICallEventSettings;
3413
+ userBusy?: ICallEventSettings;
3414
+ noAnswer?: ICallEventSettings;
3415
+ }
3416
+ export interface IVGProsodySettings {
3417
+ outputSpeed?: number;
3418
+ outputPitch?: number;
3419
+ outputVolume?: number;
3420
+ }
3421
+ export interface IVGGenericSettings {
3422
+ prosodySettings?: IVGProsodySettings;
3423
+ showBestTranscriptOnly?: boolean;
3424
+ enableCallInProgress?: boolean;
3425
+ }
3426
+ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
3427
+ callEvents: ICallEvents;
3428
+ failover?: ICallEventFailoverSettings;
3429
+ genericSettings?: IVGGenericSettings;
3430
+ isFeatureAccmEnabled?: boolean;
3431
+ /**
3432
+ * Control the privacy notice of the Webrtc Widget
3433
+ */
3434
+ privacyNotice: Omit<IWebchat3EndpointPrivacyNoticeSettings, "title"> & {
3435
+ cancelButtonText: string;
3436
+ };
3437
+ }
3438
+ export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | IZoomContactCenterEndpointSettings | {};
3439
+ export declare type TAvayaVoice = "man" | "woman" | string;
3440
+ declare const avayaSttTtsLanguages: readonly [
3441
+ "cy-GB",
3442
+ "da-DK",
3443
+ "de-DE",
3444
+ "en-AU",
3445
+ "en-GB",
3446
+ "en-GB-WLS",
3447
+ "en-IN",
3448
+ "en-US",
3449
+ "es-ES",
3450
+ "es-US",
3451
+ "fr-CA",
3452
+ "fr-FR",
3453
+ "is-IS",
3454
+ "it-IT",
3455
+ "ja-JP",
3456
+ "nb-NO",
3457
+ "nl-NL",
3458
+ "pl-PL",
3459
+ "pt-BR",
2741
3460
  "pt-PT",
2742
3461
  "ro-RO",
2743
3462
  "ru-RU",
@@ -4293,321 +5012,71 @@ export interface ILocationAttachment {
4293
5012
  type: "location";
4294
5013
  latitude: number;
4295
5014
  longitude: number;
4296
- name?: string;
4297
- title?: string;
4298
- address?: string;
4299
- }
4300
- export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
4301
- /**
4302
- * @openapi
4303
- *
4304
- * components:
4305
- * schemas:
4306
- * TAttachments:
4307
- * oneOf:
4308
- * - $ref: '#/components/schemas/IFileAttachment'
4309
- * - $ref: '#/components/schemas/IImageAttachment'
4310
- * - $ref: '#/components/schemas/IVideoAttachment'
4311
- * - $ref: '#/components/schemas/IAudioAttachment'
4312
- * - $ref: '#/components/schemas/IStickerAttachment'
4313
- * - $ref: '#/components/schemas/IContactAttachment'
4314
- * - $ref: '#/components/schemas/ILocationAttachment'
4315
- */
4316
- export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
4317
- export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
4318
- /** The base 8x8 server url */
4319
- baseUrl: string;
4320
- /** The API Key which we use to access/authorize the 8x8 API calls */
4321
- apiKey: string;
4322
- /**
4323
- * The API Tenant Id which we use as a 8x8 tenant header for the 8x8 API calls.
4324
- * Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.
4325
- */
4326
- apiTenant: string;
4327
- /**
4328
- * If activated, CONVERSATION UPDATE EVENTS of state ACTIVE will be accepted & sent to the Flow. Users will be able to access the event payload via the Input data object.
4329
- * If deactivated, CONVERSATION UPDATE EVENTS of state ACTIVE will not be accepted & will not be sent to the Flow.
4330
- */
4331
- acceptConversationActiveEvent?: boolean;
4332
- /** Settings to store attachments at a cloud provider */
4333
- fileStorageSettings?: IFileStorageSettings;
4334
- }
4335
- export interface IGenesysBotConnectorEndpointSettings {
4336
- verifyToken: string;
4337
- }
4338
- export interface INiceCXOneEndpointSettings {
4339
- verifyToken: string;
4340
- }
4341
- export interface INiceCXOneAAHEndpointSettings {
4342
- niceCXOneAAHConnection: string;
4343
- }
4344
- export interface IZoomContactCenterEndpointSettings {
4345
- verifyToken: string;
4346
- }
4347
- declare const arrayNLUConnectorType_2_0: readonly [
4348
- "alexa",
4349
- "dialogflow",
4350
- "dialogflowBuiltIn",
4351
- "amazonLexBuiltIn",
4352
- "luis",
4353
- "watson",
4354
- "noNlu",
4355
- "cognigy",
4356
- "code",
4357
- "lex",
4358
- "generativeAI"
4359
- ];
4360
- export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
4361
- declare const generativeAIModels: readonly [
4362
- "gpt-3.5-turbo",
4363
- "gpt-3.5-turbo-instruct",
4364
- "gpt-4",
4365
- "gpt-4o",
4366
- "gpt-4o-mini",
4367
- "gpt-4.1",
4368
- "gpt-4.1-mini",
4369
- "gpt-4.1-nano",
4370
- "luminous-extended-control",
4371
- "claude-v1-100k",
4372
- "claude-instant-v1",
4373
- "claude-3-opus-20240229",
4374
- "claude-3-haiku-20240307",
4375
- "claude-3-sonnet-20240229",
4376
- "claude-3-5-sonnet-20241022",
4377
- "claude-3-7-sonnet-20250219",
4378
- "claude-3-5-sonnet-latest",
4379
- "claude-3-7-sonnet-latest",
4380
- "claude-opus-4-0",
4381
- "claude-sonnet-4-0",
4382
- "text-bison@001",
4383
- "custom-model",
4384
- "custom-embedding-model",
4385
- "gemini-1.0-pro",
4386
- "gemini-1.5-pro",
4387
- "gemini-1.5-flash",
4388
- "gemini-2.0-flash",
4389
- "gemini-2.0-flash-lite",
4390
- "amazon.nova-lite-v1:0",
4391
- "amazon.nova-pro-v1:0",
4392
- "amazon.nova-micro-v1:0",
4393
- "anthropic.claude-3-5-sonnet-20240620-v1:0",
4394
- "mistral-large-2411",
4395
- "mistral-small-2503",
4396
- "pixtral-large-2411",
4397
- "pixtral-12b-2409",
4398
- "mistral-large-latest",
4399
- "pixtral-large-latest",
4400
- "mistral-medium-latest",
4401
- "mistral-small-latest",
4402
- "text-davinci-003",
4403
- "text-embedding-3-small",
4404
- "text-embedding-3-large",
4405
- "text-embedding-ada-002",
4406
- "luminous-embedding-128",
4407
- "amazon.titan-embed-text-v2:0",
4408
- "Pharia-1-Embedding-4608"
4409
- ];
4410
- /**
4411
- * @openapi
4412
- *
4413
- * components:
4414
- * schemas:
4415
- * TGenerativeAIModels:
4416
- * type: string
4417
- * enum:
4418
- * - gpt-3.5-turbo
4419
- * - gpt-3.5-turbo-instruct
4420
- * - gpt-4
4421
- * - gpt-4o
4422
- * - gpt-4o-mini
4423
- * - text-embedding-ada-002
4424
- * - luminous-extended-control
4425
- * - luminous-embedding-128
4426
- * - Pharia-1-Embedding-4608
4427
- * - claude-v1-100k
4428
- * - claude-instant-v1
4429
- * - claude-3-opus-20240229
4430
- * - custom-model
4431
- * - custom-embedding-model
4432
- * - gemini-2.0-flash
4433
- * - gemini-2.0-flash-lite
4434
- * - mistral-large-2411
4435
- * - mistral-small-2503
4436
- * - pixtral-large-2411
4437
- * - pixtral-12b-2409
4438
- */
4439
- export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
4440
- declare const generativeAIProviders: readonly [
4441
- "azureOpenAI",
4442
- "openAI",
4443
- "openAICompatible",
4444
- "alephAlpha",
4445
- "anthropic",
4446
- "googleVertexAI",
4447
- "googleGemini",
4448
- "awsBedrock",
4449
- "mistral"
4450
- ];
5015
+ name?: string;
5016
+ title?: string;
5017
+ address?: string;
5018
+ }
5019
+ export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
4451
5020
  /**
4452
5021
  * @openapi
4453
5022
  *
4454
5023
  * components:
4455
- * schemas:
4456
- * TGenerativeAIProviders:
4457
- * type: string
4458
- * enum:
4459
- * - azureOpenAI
4460
- * - openAI
4461
- * - anthropic
4462
- * - googleVertexAI
4463
- * - googleGemini
4464
- * - alephAlpha
4465
- * - awsBedrock
4466
- * - mistral
5024
+ * schemas:
5025
+ * TAttachments:
5026
+ * oneOf:
5027
+ * - $ref: '#/components/schemas/IFileAttachment'
5028
+ * - $ref: '#/components/schemas/IImageAttachment'
5029
+ * - $ref: '#/components/schemas/IVideoAttachment'
5030
+ * - $ref: '#/components/schemas/IAudioAttachment'
5031
+ * - $ref: '#/components/schemas/IStickerAttachment'
5032
+ * - $ref: '#/components/schemas/IContactAttachment'
5033
+ * - $ref: '#/components/schemas/ILocationAttachment'
4467
5034
  */
4468
- export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
4469
- declare const generativeAIUseCases: readonly [
4470
- "nlu",
4471
- "knowledgeSearch",
4472
- "aiAgent",
4473
- "gptPromptNode",
4474
- "aiEnhancedOutputs",
4475
- "sentimentAnalysis",
4476
- "designTimeGeneration",
4477
- "intentSentenceGeneration",
4478
- "flowGeneration",
4479
- "generateNodeOutput",
4480
- "lexiconGeneration",
4481
- "answerExtraction",
4482
- "gptConversation"
4483
- ];
4484
- export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
4485
- declare const modeType: readonly [
4486
- "chat",
4487
- "completion",
4488
- "embedding"
4489
- ];
4490
- export declare type TModeType = typeof modeType[number];
4491
- export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
4492
- export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
4493
- export declare type TSQL_EXTENSION = "@cognigy/mssql";
4494
- export declare type TSMTP_EXTENSION = "@cognigy/smtp";
4495
- export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
4496
- export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
4497
- export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
4498
- export interface IGenerativeAIUseCaseSettings {
4499
- largeLanguageModelId: string | null;
4500
- temperature: number;
4501
- }
4502
- export interface IGenericIntentFeedbackFinding {
4503
- type: IGenericIntentFeedbackFindingType;
4504
- }
4505
- export interface IOverlapIntentFeedbackFinding {
4506
- type: IOverlapIntentFeedbackFindingType;
4507
- overlappingIntentReferenceId: string;
4508
- overlappingIntentName: string;
4509
- overlappingIntentId: TMongoId;
4510
- overlappingFlowName: string;
4511
- overlappingFlowId: TMongoId;
4512
- }
4513
- export interface ILowDataIntentFeedbackFinding {
4514
- type: "lowDataIntents";
4515
- intents: {
4516
- intentReferenceId: string;
4517
- intentName: string;
4518
- intentId: string;
4519
- flowId: string;
4520
- flowName: string;
4521
- }[];
4522
- }
4523
- declare const overlapIntentFeedbackFindingArrayType: readonly [
4524
- "strongOverlap",
4525
- "someOverlap"
4526
- ];
4527
- export declare type IOverlapIntentFeedbackFindingType = typeof overlapIntentFeedbackFindingArrayType[number];
4528
- declare const genericIntentFeedbackFindingArrayType: readonly [
4529
- "poorFScore",
4530
- "fairFScore",
4531
- "goodFScore",
4532
- "fewSentences",
4533
- "unclearIntent",
4534
- "noSiblings"
4535
- ];
4536
- export declare type IGenericIntentFeedbackFindingType = typeof genericIntentFeedbackFindingArrayType[number];
4537
- export declare type IntentFeedbackFinding = IGenericIntentFeedbackFinding | IOverlapIntentFeedbackFinding | ILowDataIntentFeedbackFinding;
4538
- export interface IIntentFeedbackInDBReport {
4539
- findings: IntentFeedbackFinding[];
4540
- info: {
4541
- fScore: number;
4542
- };
4543
- }
4544
- declare const biasTowardsParentOrChildIntentsTypes: readonly [
4545
- "parents",
4546
- "children"
4547
- ];
4548
- export declare type TBiasTowardsParentOrChildIntentsTypes = typeof biasTowardsParentOrChildIntentsTypes[number];
4549
- declare const intentTypes: readonly [
4550
- "yesNoIntent",
4551
- "default"
4552
- ];
4553
- export declare type TIntentTypes = typeof intentTypes[number];
4554
- export interface ILocalizedIntentData {
4555
- rules: string[];
4556
- condition: string;
4557
- confirmationSentences: string[];
4558
- disambiguationSentence: string;
4559
- localeReference: TMongoId;
4560
- }
4561
- export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
4562
- localizedData: ILocalizedIntentData[];
4563
- /**
4564
- * A list of all of the locales
4565
- * that are not disabled. Used to return
4566
- * the correct isDisabled value for the
4567
- * given locale
4568
- */
4569
- enabledLocaleReferences: TMongoId[];
4570
- }
4571
- export interface IIntent extends IEntityMeta, ILocalizedIntentData {
4572
- name: string;
4573
- description?: string;
4574
- referenceId: string;
4575
- isRejectIntent: boolean;
4576
- isDisabled: boolean;
4577
- tags: string[];
4578
- data: any;
4579
- nodeReferenceId: string;
4580
- childFeatures?: boolean | string[];
4581
- biasTowardsParentOrChildIntents: TBiasTowardsParentOrChildIntentsTypes;
4582
- parentIntentId?: string;
4583
- feedbackReport: IIntentFeedbackInDBReport;
4584
- intentRelationReferences: TMongoId[];
4585
- flowReference?: TMongoId;
4586
- projectReference: TMongoId;
4587
- organisationReference: TMongoId;
4588
- flowReferenceId?: string;
5035
+ export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
5036
+ export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
5037
+ /** The base 8x8 server url */
5038
+ baseUrl: string;
5039
+ /** The API Key which we use to access/authorize the 8x8 API calls */
5040
+ apiKey: string;
4589
5041
  /**
4590
- * A label we use in analytics
4591
- * to track when an intent was triggered
5042
+ * The API Tenant Id which we use as a 8x8 tenant header for the 8x8 API calls.
5043
+ * Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.
4592
5044
  */
4593
- analyticsLabel?: string;
5045
+ apiTenant: string;
4594
5046
  /**
4595
- * Enable the usage of default replies as example sentences
5047
+ * If activated, CONVERSATION UPDATE EVENTS of state ACTIVE will be accepted & sent to the Flow. Users will be able to access the event payload via the Input data object.
5048
+ * If deactivated, CONVERSATION UPDATE EVENTS of state ACTIVE will not be accepted & will not be sent to the Flow.
4596
5049
  */
4597
- overrideIntentDefaultRepliesAsExamples?: string;
4598
- intentType: TIntentTypes;
5050
+ acceptConversationActiveEvent?: boolean;
5051
+ /** Settings to store attachments at a cloud provider */
5052
+ fileStorageSettings?: IFileStorageSettings;
4599
5053
  }
4600
- export interface IYesNoData {
4601
- _id: string;
4602
- rules: string[];
4603
- name: string;
4604
- isDisabled: boolean;
5054
+ export interface IGenesysBotConnectorEndpointSettings {
5055
+ verifyToken: string;
4605
5056
  }
4606
- export interface IYesNoItem {
4607
- yesIntent: IYesNoData | IIntentInDB;
4608
- noIntent: IYesNoData | IIntentInDB;
4609
- rejectIntent: IYesNoData | IIntentInDB;
5057
+ export interface INiceCXOneEndpointSettings {
5058
+ verifyToken: string;
5059
+ }
5060
+ export interface INiceCXOneAAHEndpointSettings {
5061
+ niceCXOneAAHConnection: string;
4610
5062
  }
5063
+ export interface IZoomContactCenterEndpointSettings {
5064
+ verifyToken: string;
5065
+ }
5066
+ declare const arrayNLUConnectorType_2_0: readonly [
5067
+ "alexa",
5068
+ "dialogflow",
5069
+ "dialogflowBuiltIn",
5070
+ "amazonLexBuiltIn",
5071
+ "luis",
5072
+ "watson",
5073
+ "noNlu",
5074
+ "cognigy",
5075
+ "code",
5076
+ "lex",
5077
+ "generativeAI"
5078
+ ];
5079
+ export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
4611
5080
  /**
4612
5081
  * @openapi
4613
5082
  *
@@ -7223,6 +7692,9 @@ export interface IWebrtcWidgetConfig {
7223
7692
  * agentCopilotAuthentication:
7224
7693
  * type: string
7225
7694
  * description: Authentication connection reference Id for agent copilot
7695
+ * oAuth2Connection:
7696
+ * type: string
7697
+ * description: OAuth2 Connection for Genesys Cloud
7226
7698
  * orgDataPrivacySettings:
7227
7699
  * $ref: '#/components/schemas/IEndpoitOrgDataPrivacySettings_2_0'
7228
7700
  * IEndpoint_2_0:
@@ -8496,60 +8968,28 @@ export interface ICreateProjectRestReturnValue_2_0 extends IProject_2_0 {
8496
8968
  * - type: object
8497
8969
  * properties:
8498
8970
  * liveAgentDefaultInbox:
8499
- * type: number
8500
- * description: Live agent default inbox Id for the project
8501
- * - $ref: '#/components/schemas/IEntityMeta'
8502
- */
8503
- export interface IProjectIndexItem_2_0 {
8504
- /** The Mongo id of the entity */
8505
- _id: string;
8506
- color: TCSSColorName | TCognigyColorName;
8507
- name: string;
8508
- primaryLocaleReference: TMongoId;
8509
- createdAt: number;
8510
- lastChanged: number;
8511
- createdBy: TMongoId;
8512
- lastChangedBy: TMongoId;
8513
- liveAgentDefaultInbox: number;
8514
- handoverConfiguration?: IHandoverConfiguration_2_0;
8515
- }
8516
- export interface IIndexProjectsRestData_2_0 extends IRestPagination<IProjectIndexItem_2_0> {
8517
- ignoreOwnership?: boolean;
8518
- }
8519
- export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
8520
- }
8521
- export declare const nluLanguages: readonly [
8522
- "ar-AE",
8523
- "bn-IN",
8524
- "da-DK",
8525
- "en-AU",
8526
- "en-CA",
8527
- "en-GB",
8528
- "en-IN",
8529
- "en-US",
8530
- "es-ES",
8531
- "fi-FI",
8532
- "fr-FR",
8533
- "de-DE",
8534
- "hi-IN",
8535
- "it-IT",
8536
- "ja-JP",
8537
- "ko-KR",
8538
- "nn-NO",
8539
- "nl-NL",
8540
- "pl-PL",
8541
- "pt-BR",
8542
- "pt-PT",
8543
- "ru-RU",
8544
- "sv-SE",
8545
- "ta-IN",
8546
- "th-TH",
8547
- "tr-TR",
8548
- "vi-VN",
8549
- "zh-CN",
8550
- "ge-GE"
8551
- ];
8552
- export declare type TNluLanguage = typeof nluLanguages[number];
8971
+ * type: number
8972
+ * description: Live agent default inbox Id for the project
8973
+ * - $ref: '#/components/schemas/IEntityMeta'
8974
+ */
8975
+ export interface IProjectIndexItem_2_0 {
8976
+ /** The Mongo id of the entity */
8977
+ _id: string;
8978
+ color: TCSSColorName | TCognigyColorName;
8979
+ name: string;
8980
+ primaryLocaleReference: TMongoId;
8981
+ createdAt: number;
8982
+ lastChanged: number;
8983
+ createdBy: TMongoId;
8984
+ lastChangedBy: TMongoId;
8985
+ liveAgentDefaultInbox: number;
8986
+ handoverConfiguration?: IHandoverConfiguration_2_0;
8987
+ }
8988
+ export interface IIndexProjectsRestData_2_0 extends IRestPagination<IProjectIndexItem_2_0> {
8989
+ ignoreOwnership?: boolean;
8990
+ }
8991
+ export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
8992
+ }
8553
8993
  /**
8554
8994
  * @openapi
8555
8995
  *
@@ -8847,109 +9287,6 @@ export interface IGraphLargeLanguageModel {
8847
9287
  properties: Pick<ILargeLanguageModel, "modelType" | "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
8848
9288
  dependencies?: IGraphLargeLanguageModelDependencyAttachment[];
8849
9289
  }
8850
- export interface ISystemSlots {
8851
- DATE: IDateSlot[] | null;
8852
- NUMBER: INumberSlot[] | null;
8853
- DURATION: IDurationSlot[] | null;
8854
- TEMPERATURE: ITemperatureSlot[] | null;
8855
- AGE: IAgeSlot[] | null;
8856
- PERCENTAGE: IPercentageSlot[] | null;
8857
- EMAIL: IEmailSlot[] | null;
8858
- URL: IUrlSlot[] | null;
8859
- MONEY: IMoneySlot[] | null;
8860
- DISTANCE: IDistanceSlot[] | null;
8861
- }
8862
- export interface IBaseSlot {
8863
- text: string;
8864
- data: any;
8865
- offset: {
8866
- start: number;
8867
- end: number;
8868
- };
8869
- }
8870
- export interface IPercentageSlot extends IBaseSlot {
8871
- data: {
8872
- value: number;
8873
- };
8874
- }
8875
- export interface IAgeSlot extends IBaseSlot {
8876
- data: {
8877
- value: number;
8878
- unit: TTimeGrain;
8879
- };
8880
- }
8881
- export interface INumberSlot extends IBaseSlot {
8882
- data: {
8883
- value: number;
8884
- };
8885
- }
8886
- export interface IEmailSlot extends IBaseSlot {
8887
- data: {
8888
- value: string;
8889
- };
8890
- }
8891
- export declare type ITemperatureUnit = "celsius" | "fahrenheit" | "degree" | "kelvin";
8892
- export interface ITemperatureSlot extends IBaseSlot {
8893
- data: {
8894
- value: number;
8895
- unit: ITemperatureUnit;
8896
- };
8897
- }
8898
- export declare type TTimeGrain = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
8899
- export interface IDateObject {
8900
- day: number;
8901
- hour: number;
8902
- minute: number;
8903
- month: number;
8904
- second: number;
8905
- milliseconds: number;
8906
- weekday: number;
8907
- dayOfWeek: string;
8908
- year: number;
8909
- ISODate: string;
8910
- grain: TTimeGrain | null;
8911
- plain: string;
8912
- timezoneOffset?: string;
8913
- }
8914
- export interface IDateSlot extends IBaseSlot {
8915
- data: {
8916
- start?: IDateObject;
8917
- end?: IDateObject;
8918
- };
8919
- }
8920
- export interface IDurationSlot extends IBaseSlot {
8921
- data: {
8922
- unit?: TTimeGrain;
8923
- value?: number;
8924
- inSeconds?: number;
8925
- years?: number;
8926
- quarters?: number;
8927
- months?: number;
8928
- weeks?: number;
8929
- days?: number;
8930
- hours?: number;
8931
- minutes?: number;
8932
- seconds?: number;
8933
- };
8934
- }
8935
- export interface IMoneySlot extends IBaseSlot {
8936
- data: {
8937
- value: number;
8938
- unit: string;
8939
- };
8940
- }
8941
- export interface IUrlSlot extends IBaseSlot {
8942
- data: {
8943
- domain: string;
8944
- value: string;
8945
- };
8946
- }
8947
- export interface IDistanceSlot extends IBaseSlot {
8948
- data: {
8949
- unit: string;
8950
- value: number;
8951
- };
8952
- }
8953
9290
  export interface IHandoverNodeParams extends INodeFunctionBaseParams {
8954
9291
  config: {
8955
9292
  text: string;
@@ -9044,23 +9381,6 @@ export interface ICodeNodeBasicParams extends INodeFunctionBaseParams {
9044
9381
  code: string;
9045
9382
  };
9046
9383
  }
9047
- declare const arrayTDebugEventTypes: readonly [
9048
- "inputChanged",
9049
- "contextChanged",
9050
- "profileChanged",
9051
- "activeEntrypointsChanged",
9052
- "nodeExecuted",
9053
- "nodeError",
9054
- "finalPing",
9055
- "input",
9056
- "output",
9057
- "switchedFlow",
9058
- "nluWarning",
9059
- "debugMessage",
9060
- "debugError",
9061
- "goalCompleted"
9062
- ];
9063
- export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
9064
9384
  export interface IInputChangedEventPayload {
9065
9385
  input: {
9066
9386
  [key: string]: any;
@@ -9090,17 +9410,6 @@ export interface INodeErrorEventPayload {
9090
9410
  errorMessage: string;
9091
9411
  sessionId?: string;
9092
9412
  }
9093
- export interface IErrorEventPayload extends ILoggerStack {
9094
- message: string;
9095
- flowId: string;
9096
- nodeId?: string;
9097
- }
9098
- export interface IFinalPingEventPayload {
9099
- type: "regular" | "preventFinalPingToEndpoint" | "cognigyStopFlow" | "error";
9100
- analyticsData?: IAnalyticsSourceData;
9101
- error?: IErrorEventPayload;
9102
- sessionId?: string;
9103
- }
9104
9413
  export interface IOutputEventPayload {
9105
9414
  text?: string;
9106
9415
  data?: {
@@ -9132,335 +9441,51 @@ export interface IActiveEntrypointsChangedEventPayload {
9132
9441
  entrypoints: IActiveEntrypoint[];
9133
9442
  sessionId?: string;
9134
9443
  }
9135
- export interface IActiveEntrypoint {
9136
- flowId: string;
9137
- nodeReferenceId: string;
9138
- primary?: boolean;
9139
- }
9140
- export interface INluWarningEventPayload {
9141
- errorMessage: string;
9142
- sessionId?: string;
9143
- }
9144
- export interface IDebugEventMessagePayloadBase {
9145
- sessionId?: string;
9146
- header?: string;
9147
- metadata?: IOutputEventMetadata;
9148
- }
9149
- export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
9150
- type: "text";
9151
- message: string;
9152
- }
9153
- export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
9154
- type: "json";
9155
- message: object;
9156
- }
9157
- export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
9158
- export interface IGoalAnalyticsPayload {
9159
- analyticsdata: IGoalEscalations;
9160
- data: IPayloadBaseMetaData;
9161
- }
9162
- export interface IGoalAnalyticsData {
9163
- projectId: string;
9164
- organisationId: string;
9165
- sessionId: string;
9166
- referenceId: string;
9167
- version: string;
9168
- timestamp: Date;
9169
- goalCycleId: string;
9170
- stepId: string;
9171
- goalId: string;
9172
- contactId: string;
9173
- stepType?: string;
9174
- }
9175
- export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
9176
- }
9177
- export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
9178
- }
9179
- export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
9180
- declare const audioPreviewProviders: readonly [
9181
- "microsoft",
9182
- "google",
9183
- "aws",
9184
- "deepgram"
9185
- ];
9186
- export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
9187
- /**
9188
- * @openapi
9189
- * components:
9190
- * schemas:
9191
- * IGenerativeAIUseCase:
9192
- * type: object
9193
- * properties:
9194
- * useCase:
9195
- * enum:
9196
- * - designTimeGeneration
9197
- * - intentSentenceGeneration
9198
- * - aiEnhancedOutputs
9199
- * - lexiconGeneration
9200
- * - flowGeneration
9201
- * - gptConversation
9202
- * - gptPromptNode
9203
- * - generateNodeOutput
9204
- * - knowledgeSearch
9205
- * - sentimentAnalysis
9206
- */
9207
- export interface IGenerativeAIUseCase {
9208
- useCase: TGenerativeAIUseCases;
9209
- }
9210
- export interface INluEmbeddingCredentials {
9211
- apiType: TGenerativeAIProviders;
9212
- apiKey: string;
9213
- apiModel: TGenerativeAIModels;
9214
- apiCustomBaseUrl?: string;
9215
- apiResourceName?: string;
9216
- apiDeploymentName?: string;
9217
- apiVersion?: string;
9218
- }
9219
- export interface ISetAppStateOverlaySettings {
9220
- autoOpen: boolean;
9221
- closeOnSubmit: boolean;
9222
- feedbackMessage: string;
9223
- screenTitle: string;
9224
- sendEventOnCloseIconClick: boolean;
9225
- showCloseIcon: boolean;
9226
- }
9227
- export interface ISetAppStateOverlaySettingsMetaData {
9228
- overlaySettings: ISetAppStateOverlaySettings;
9229
- endpointType: TEndpointType;
9230
- url: string;
9231
- URLToken: string;
9232
- }
9233
- export interface IVoiceGateway2VadParams {
9234
- enable?: boolean;
9235
- voiceMs?: number;
9236
- mode?: number;
9237
- }
9238
- export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
9239
- export interface IVoiceGateway2SynthesizerParams {
9240
- vendor?: TVoiceGateway2TTSVendor | "default" | "none";
9241
- language?: string;
9242
- voice?: string;
9243
- label?: string;
9244
- fallbackVendor?: string;
9245
- fallbackLabel?: string;
9246
- fallbackLanguage?: string;
9247
- fallbackVoice?: string;
9248
- engine?: "standard" | "neural";
9249
- gender?: "MALE" | "FEMALE" | "NEUTRAL";
9250
- azureServiceEndpoint?: string;
9251
- options?: object;
9252
- disableCache?: boolean;
9253
- model?: string;
9444
+ export interface IActiveEntrypoint {
9445
+ flowId: string;
9446
+ nodeReferenceId: string;
9447
+ primary?: boolean;
9254
9448
  }
9255
- export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
9256
- export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
9257
- export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
9258
- export interface IVoiceGateway2RecognizerParams {
9259
- vendor?: TVoiceGateway2STTVendor | "default" | "none";
9260
- language?: string;
9261
- label?: string;
9262
- fallbackVendor?: string;
9263
- fallbackLabel?: string;
9264
- fallbackLanguage?: string;
9265
- vad?: IVoiceGateway2VadParams;
9266
- hints?: string[];
9267
- hintsBoost?: number;
9268
- altLanguages?: string[];
9269
- profanityFilter?: boolean;
9270
- interim?: boolean;
9271
- singleUtterance?: boolean;
9272
- dualChannel?: boolean;
9273
- separateRecognitionPerChannel?: boolean;
9274
- punctuation?: boolean;
9275
- enhancedModel?: boolean;
9276
- words?: boolean;
9277
- diarization?: boolean;
9278
- diarizationMinSpeakers?: number;
9279
- diarizationMaxSpeakers?: number;
9280
- interactionType?: "unspecified" | "discussion" | "presentation" | "phone_call" | "voicemail" | "voice_search" | "voice_command" | "dictation";
9281
- naicsCod?: number;
9282
- identifyChannels?: boolean;
9283
- vocabularyName?: string;
9284
- vocabularyFilterName?: string;
9285
- filterMethod?: "remove" | "mask" | "tag";
9286
- outputFormat?: "simple" | "detailed";
9287
- profanityOption?: "masked" | "removed" | "raw";
9288
- requestSnr?: boolean;
9289
- initialSpeechTimeoutMs?: number;
9290
- azureSttEndpointId?: string;
9291
- audioLogging?: boolean;
9292
- asrDtmfTerminationDigit?: string;
9293
- asrTimeout?: number;
9294
- nuanceOptions?: TVoiceGateway2NuanceOptions;
9295
- deepgramOptions?: TVoiceGateway2DeepgramOptions;
9296
- ibmOptions?: TVoiceGateway2IbmOptions;
9297
- nvidiaOptions?: TVoiceGateway2NvidiaOptions;
9298
- sonioxOptions?: TVoiceGateway2SonioxOptions;
9299
- model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
9449
+ export interface INluWarningEventPayload {
9450
+ errorMessage: string;
9451
+ sessionId?: string;
9300
9452
  }
9301
- export declare type TVoiceGateway2NuanceOptions = {
9302
- clientId?: string;
9303
- secret?: string;
9304
- kryptonEndpoint?: string;
9305
- topic?: string;
9306
- utteranceDetectionMode?: string;
9307
- punctuation?: boolean;
9308
- profanityFilter?: boolean;
9309
- includeTokenization?: boolean;
9310
- discardSpeakerAdaptation?: boolean;
9311
- suppressCallRecording?: boolean;
9312
- maskLoadFailures?: boolean;
9313
- suppressInitialCapitalization?: boolean;
9314
- allowZeroBaseLmWeight?: boolean;
9315
- filterWakeupWord?: boolean;
9316
- resultType?: string;
9317
- noInputTimeoutMs?: number;
9318
- recognitionTimeoutMs?: number;
9319
- utteranceEndSilenceMs?: number;
9320
- maxHypotheses?: number;
9321
- speechDomain?: string;
9322
- formatting?: TVoiceGatewayNuanceFormatting;
9323
- clientData?: object;
9324
- userId?: string;
9325
- speechDetectionSensitivity?: number;
9326
- resources?: [
9327
- TVoiceGatewayNuanceResources
9328
- ];
9329
- };
9330
- export declare type TVoiceGateway2DeepgramOptions = {
9331
- deepgramSttUri?: string;
9332
- deepgramSttUseTls?: boolean;
9333
- apiKey?: string;
9334
- tier?: string;
9335
- model?: string;
9336
- customModel?: string;
9337
- version?: string;
9338
- punctuate?: boolean;
9339
- smartFormatting?: boolean;
9340
- profanityFilter?: boolean;
9341
- redact?: string;
9342
- diarize?: boolean;
9343
- diarizeVersion?: string;
9344
- ner?: boolean;
9345
- multichannel?: boolean;
9346
- alternatives?: number;
9347
- numerals?: boolean;
9348
- search?: string[];
9349
- replace?: string[];
9350
- keywords?: string[];
9351
- endpointing?: number | boolean;
9352
- utteranceEndMs?: number;
9353
- shortUtterance?: boolean;
9354
- vadTurnoff?: number;
9355
- tag?: string;
9356
- };
9357
- export declare type TVoiceGateway2NvidiaOptions = {
9358
- rivaUri?: string;
9359
- maxAlternatives?: number;
9360
- profanityFilter?: boolean;
9361
- punctuation?: boolean;
9362
- wordTimeOffsets?: boolean;
9363
- verbatimTranscripts?: boolean;
9364
- customConfiguration?: object;
9365
- };
9366
- export declare type TVoiceGateway2SonioxOptions = {
9367
- id?: string;
9368
- title?: string;
9369
- disableStoreAudio?: boolean;
9370
- disableStoreTranscript?: boolean;
9371
- disableSearch?: boolean;
9372
- metadata?: object;
9373
- storage?: object;
9374
- };
9375
- export declare type TVoiceGateway2IbmOptions = {
9376
- sttApiKey?: string;
9377
- sttRegion?: string;
9378
- ttsApiKey?: string;
9379
- ttsRegion?: string;
9380
- instanceId?: string;
9381
- model?: string;
9382
- languageCustomizationId?: string;
9383
- acousticCustomizationId?: string;
9384
- baseModelVersion?: string;
9385
- watsonMetadata?: string;
9386
- watsonLearningOptOut?: boolean;
9387
- };
9388
- export declare type TVoiceGatewayNuanceResourceReference = {
9389
- type?: string;
9390
- uri?: string;
9391
- maxLoadFailures?: boolean;
9392
- requestTimeoutMs?: number;
9393
- headers?: object;
9394
- };
9395
- export declare type TVoiceGatewayNuanceResources = {
9396
- externalReference?: TVoiceGatewayNuanceResourceReference;
9397
- inlineWordset?: string;
9398
- builtin?: string;
9399
- inlineGrammar?: string;
9400
- wakeupWord?: Array<string>;
9401
- weightName?: string;
9402
- weightValue?: number;
9403
- reuse?: string;
9404
- };
9405
- export declare type TVoiceGatewayNuanceFormatting = {
9406
- scheme?: string;
9407
- options?: object;
9408
- };
9409
- export declare type TVoiceGateway2InputType = "digits" | "speech";
9410
- export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
9411
- export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
9412
- export interface IVoiceGateway2BargeInParams {
9413
- enable?: boolean;
9414
- sticky?: boolean;
9415
- dtmfBargein?: boolean;
9416
- actionHook?: object | string;
9417
- input?: TVoiceGateway2InputType[];
9418
- finishOnKey?: string;
9419
- numDigits?: number;
9420
- minDigits?: number;
9421
- maxDigits?: number;
9422
- interDigitTimeout?: number;
9423
- minBargeinWordCount?: number;
9453
+ export interface IDebugEventMessagePayloadBase {
9454
+ sessionId?: string;
9455
+ header?: string;
9456
+ metadata?: IOutputEventMetadata;
9424
9457
  }
9425
- export interface IVoiceGateway2ActivityParams {
9426
- synthesizer?: IVoiceGateway2SynthesizerParams;
9427
- recognizer?: IVoiceGateway2RecognizerParams;
9428
- bargeIn?: IVoiceGateway2BargeInParams;
9429
- user?: IVoiceGateway2CognigyUserInputConfigParams;
9430
- dtmf?: boolean;
9431
- sessionParams?: IVoiceGateway2ActivityParams;
9432
- fillerNoise?: IVoiceGateway2FillerNoiseParams;
9433
- flow?: IVoiceGateway2CognigyFlowInputConfigParams;
9458
+ export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
9459
+ type: "text";
9460
+ message: string;
9434
9461
  }
9435
- export interface IVoiceGateway2FillerNoiseParams {
9436
- enable: boolean;
9437
- url?: string;
9438
- startDelaySecs?: number;
9462
+ export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
9463
+ type: "json";
9464
+ message: object;
9439
9465
  }
9440
- export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
9441
- export interface IVoiceGateway2CognigyUserInputConfigParams {
9442
- noInputMode?: TVoiceGateway2UserNoInputMode;
9443
- noInputTimeout?: number;
9444
- noInputRetries?: number;
9445
- noInputSpeech?: string;
9446
- noInputUrl?: string;
9447
- userNoInputAutoHangup?: boolean;
9466
+ export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
9467
+ export interface IGoalAnalyticsPayload {
9468
+ analyticsdata: IGoalEscalations;
9469
+ data: IPayloadBaseMetaData;
9448
9470
  }
9449
- export interface IVoiceGateway2CognigyFlowInputConfigParams {
9450
- flowNoInputEnable?: boolean;
9451
- flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
9452
- flowNoInputTimeout?: number;
9453
- flowNoInputRetries?: number;
9454
- flowNoInputSpeech?: string;
9455
- flowNoInputUrl?: string;
9456
- flowNoInputFail?: boolean;
9471
+ export interface IGoalAnalyticsData {
9472
+ projectId: string;
9473
+ organisationId: string;
9474
+ sessionId: string;
9475
+ referenceId: string;
9476
+ version: string;
9477
+ timestamp: Date;
9478
+ goalCycleId: string;
9479
+ stepId: string;
9480
+ goalId: string;
9481
+ contactId: string;
9482
+ stepType?: string;
9457
9483
  }
9458
- export interface IGetNluPipelineParams {
9459
- parseIntents?: boolean;
9460
- parseSlots?: boolean;
9461
- parseSystemSlots?: boolean;
9462
- findType?: boolean;
9484
+ export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
9463
9485
  }
9486
+ export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
9487
+ }
9488
+ export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
9464
9489
  export interface ITrackAnalyticsStepsArguments {
9465
9490
  nodeId?: string;
9466
9491
  flowReferenceId: string;
@@ -10134,6 +10159,7 @@ declare enum TranscriptEntryType {
10134
10159
  }
10135
10160
  export declare type TTranscriptEntryContent = TTranscriptUserInput | TTranscriptAssistantOutput | TTranscriptAgentOutput | TTranscriptAssistantToolCall | TTranscriptToolAnswer | TTranscriptDebugLog;
10136
10161
  export declare type TTranscriptEntry = TTranscriptEntryContent & {
10162
+ id: string;
10137
10163
  timestamp: number;
10138
10164
  traceId: string;
10139
10165
  };
@@ -11511,7 +11537,7 @@ declare const nodePreviewTypes: readonly [
11511
11537
  "image",
11512
11538
  "aiAgent"
11513
11539
  ];
11514
- export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
11540
+ export declare type TNodePreviewType = typeof nodePreviewTypes[number];
11515
11541
  export interface INodePreview {
11516
11542
  type: TNodePreviewType;
11517
11543
  key: string;
@@ -11608,7 +11634,7 @@ declare const nodeFieldTypes: readonly [
11608
11634
  "typescript",
11609
11635
  "xml"
11610
11636
  ];
11611
- export declare type TNodeFieldType = (typeof nodeFieldTypes)[number];
11637
+ export declare type TNodeFieldType = typeof nodeFieldTypes[number];
11612
11638
  export declare type TComparableValue = string | number | boolean;
11613
11639
  export declare type TNodeFieldCondition = INodeFieldSingleCondition | INodeFieldANDCondition | INodeFieldORCondition;
11614
11640
  export interface INodeFieldSingleCondition {
@@ -11655,6 +11681,7 @@ export interface INodeField<K extends string | number | symbol = string> {
11655
11681
  label: string | INodeFieldTranslations;
11656
11682
  condition?: TNodeFieldCondition;
11657
11683
  defaultValue?: any;
11684
+ fallbackValue?: any;
11658
11685
  description?: string | INodeFieldTranslations;
11659
11686
  params?: {
11660
11687
  [key: string]: any;
@@ -17204,7 +17231,8 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
17204
17231
  transferReason: string;
17205
17232
  transferTarget: string;
17206
17233
  referredBy: string;
17207
- anchorMedia: boolean;
17234
+ mediaPath: TVoiceGateway2MediaPath;
17235
+ anchorMedia?: boolean;
17208
17236
  useTransferSipHeaders: boolean;
17209
17237
  transferSipHeaders: {
17210
17238
  [key: string]: string | object;
@@ -23208,6 +23236,7 @@ export interface IOpsCenterObservationConfig {
23208
23236
  observationActive: boolean;
23209
23237
  notificationConfig: NotificationConfig;
23210
23238
  alertingConfig: AlertingConfig;
23239
+ recordVersion: number;
23211
23240
  }
23212
23241
  export interface IGetOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
23213
23242
  }