@cognigy/rest-api-client 2025.18.1 → 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.
package/types/index.d.ts CHANGED
@@ -2354,6 +2354,10 @@ export interface IAgentAssistSettings {
2354
2354
  redactTranscriptTileMessages?: boolean;
2355
2355
  enableAgentCopilotAuthentication?: boolean;
2356
2356
  agentCopilotAuthentication?: string;
2357
+ /**
2358
+ * Optional OAuth2 connection id for providers that require it (e.g., Genesys)
2359
+ */
2360
+ oAuth2Connection?: string;
2357
2361
  }
2358
2362
  export interface IGenesysCloudHandoverSettings {
2359
2363
  host: string;
@@ -2538,227 +2542,930 @@ export interface IGraphEndpointDependency {
2538
2542
  _id: string;
2539
2543
  type: "endpointFlow" | "endpointNluConnector";
2540
2544
  }
2541
- /**
2542
- * The supported endpoint channels
2543
- *
2544
- * @openapi
2545
- *
2546
- * components:
2547
- * schemas:
2548
- * TChannelType:
2549
- * type: string
2550
- * example: webchat3
2551
- * enum:
2552
- * - facebook
2553
- * - alexa
2554
- * - slack
2555
- * - generic
2556
- * - inject
2557
- * - rest
2558
- * - realtime
2559
- * - socket
2560
- * - adminconsole
2561
- * - webchat2
2562
- * - dialogflow
2563
- * - twilio
2564
- * - twilio-sms
2565
- * - line
2566
- * - intercom
2567
- * - microsoftBotFramework
2568
- * - microsoftTeams
2569
- * - sunshineConversations
2570
- * - admin-webchat
2571
- * - avaya
2572
- * - nonConversational
2573
- * - voiceGateway2
2574
- * - amazonLex
2575
- * - workplace
2576
- * - webhook
2577
- * - abstractRest
2578
- * - userlike
2579
- * - ringCentralEngage
2580
- * - audioCodes
2581
- * - bandwidth
2582
- * - whatsapp
2583
- * - eightByEight
2584
- * - genesysBotConnector
2585
- * - niceCXOne
2586
- * - agentAssistVoice
2587
- * - webchat3
2588
- * - niceCXOneAAH
2589
- * - zoomContactCenter
2590
- */
2591
- export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
2592
- declare const endpointTypes: readonly [
2593
- "facebook",
2594
- "workplace",
2595
- "alexa",
2596
- "slack",
2597
- "webhook",
2598
- "rest",
2599
- "abstractRest",
2600
- "socket",
2601
- "adminconsole",
2602
- "webchat2",
2603
- "dialogflow",
2604
- "twilio",
2605
- "twilioSms",
2606
- "line",
2607
- "intercom",
2608
- "microsoftBotFramework",
2609
- "microsoftTeams",
2610
- "sunshineConversations",
2611
- "userlike",
2612
- "ringCentralEngage",
2613
- "audioCodes",
2614
- "avaya",
2615
- "nonConversational",
2616
- "voiceGateway2",
2617
- "whatsapp",
2618
- "amazonLex",
2619
- "eightByEight",
2620
- "bandwidth",
2621
- "genesysBotConnector",
2622
- "niceCXOne",
2623
- "niceCXOneAAH",
2624
- "agentAssistVoice",
2625
- "webchat3",
2626
- "zoomContactCenter"
2627
- ];
2628
- export declare type TEndpointType = typeof endpointTypes[number];
2629
- declare const transferTypes: readonly [
2630
- "dial",
2631
- "sip:refer"
2632
- ];
2633
- export declare type TTransferType = typeof transferTypes[number];
2634
- export interface IWebchatPersistentMenu {
2635
- /**
2636
- * The title of the persistent menu
2637
- */
2638
- title: string;
2639
- /**
2640
- * The menu items for the persistent menu.
2641
- * The webchat currently only supports
2642
- * one "layer" of menu items.
2643
- */
2644
- menuItems: {
2645
- /**
2646
- * The title of the menu item
2647
- */
2648
- title: string;
2649
- /**
2650
- * The payload to send to AI
2651
- * when clicking the menu item
2652
- */
2653
- payload: string;
2654
- }[];
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;
2655
2556
  }
2656
- export interface ICallEventSettings {
2657
- enabled: boolean;
2658
- action: "inject" | "executeFlow" | "transfer" | "none";
2659
- flowId: string;
2660
- entrypoint?: string;
2661
- injectText?: string;
2662
- injectData?: string;
2663
- failover?: ICallEventFailoverSettings;
2557
+ export interface IBaseSlot {
2558
+ text: string;
2559
+ data: any;
2560
+ offset: {
2561
+ start: number;
2562
+ end: number;
2563
+ };
2664
2564
  }
2665
- export interface ICallEventFailoverSettings {
2666
- enabled?: boolean;
2667
- enabledForSpeech?: boolean;
2668
- type?: TTransferType;
2669
- headers?: string;
2670
- to?: string;
2671
- reason?: string;
2672
- dialCallerId?: string;
2673
- dialMusic?: string;
2674
- dialTimeout?: number;
2675
- enableTimeLimit?: boolean;
2676
- timeLimit?: number;
2677
- dialTranscribeEnabled?: boolean;
2678
- dialTranscribeVendor?: string;
2679
- dialTranscribeLanguage?: string;
2680
- dialTranscribeWebhook?: string;
2681
- dialTranscribeRecognitionChannel?: number;
2682
- dialTranscribeRecognitionGoogleModel?: string;
2683
- dialTranscribeLabel?: string;
2684
- dialTranscribeDeepgramModel?: string;
2685
- referredBy?: string;
2686
- deepgramSmartFormatting?: boolean;
2687
- deepgramEndpointing?: boolean;
2688
- deepgramEndpointingValue?: number;
2689
- dialTranscribeDeepgramTier?: string;
2690
- anchorMedia?: boolean;
2565
+ export interface IPercentageSlot extends IBaseSlot {
2566
+ data: {
2567
+ value: number;
2568
+ };
2691
2569
  }
2692
- export interface ICallEvents {
2693
- amd?: ICallEventSettings;
2694
- callCreated?: ICallEventSettings;
2695
- callCompleted?: ICallEventSettings;
2696
- callFailed?: ICallEventSettings;
2697
- callInProgress?: ICallEventSettings;
2698
- callReconnected?: ICallEventSettings;
2699
- userInputTimeout?: ICallEventSettings;
2700
- recognizedSpeech?: ICallEventSettings;
2701
- recognizedDtmf?: ICallEventSettings;
2702
- transferReferSuccess?: ICallEventSettings;
2703
- transferReferError?: ICallEventSettings;
2704
- transferDialSuccess?: ICallEventSettings;
2705
- transferDialError?: ICallEventSettings;
2706
- userBusy?: ICallEventSettings;
2707
- noAnswer?: ICallEventSettings;
2570
+ export interface IAgeSlot extends IBaseSlot {
2571
+ data: {
2572
+ value: number;
2573
+ unit: TTimeGrain;
2574
+ };
2708
2575
  }
2709
- export interface IVGProsodySettings {
2710
- outputSpeed?: number;
2711
- outputPitch?: number;
2712
- outputVolume?: number;
2576
+ export interface INumberSlot extends IBaseSlot {
2577
+ data: {
2578
+ value: number;
2579
+ };
2713
2580
  }
2714
- export interface IVGGenericSettings {
2715
- prosodySettings?: IVGProsodySettings;
2716
- showBestTranscriptOnly?: boolean;
2717
- enableCallInProgress?: boolean;
2581
+ export interface IEmailSlot extends IBaseSlot {
2582
+ data: {
2583
+ value: string;
2584
+ };
2718
2585
  }
2719
- export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
2720
- callEvents: ICallEvents;
2721
- failover?: ICallEventFailoverSettings;
2722
- genericSettings?: IVGGenericSettings;
2723
- isFeatureAccmEnabled?: boolean;
2724
- /**
2725
- * Control the privacy notice of the Webrtc Widget
2726
- */
2727
- privacyNotice: Omit<IWebchat3EndpointPrivacyNoticeSettings, "title"> & {
2728
- 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;
2729
2591
  };
2730
2592
  }
2731
- 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 | {};
2732
- export declare type TAvayaVoice = "man" | "woman" | string;
2733
- declare const avayaSttTtsLanguages: readonly [
2734
- "cy-GB",
2735
- "da-DK",
2736
- "de-DE",
2737
- "en-AU",
2738
- "en-GB",
2739
- "en-GB-WLS",
2740
- "en-IN",
2741
- "en-US",
2742
- "es-ES",
2743
- "es-US",
2744
- "fr-CA",
2745
- "fr-FR",
2746
- "is-IS",
2747
- "it-IT",
2748
- "ja-JP",
2749
- "nb-NO",
2750
- "nl-NL",
2751
- "pl-PL",
2752
- "pt-BR",
2753
- "pt-PT",
2754
- "ro-RO",
2755
- "ru-RU",
2756
- "sv-SE",
2757
- "tr-TR"
2758
- ];
2759
- export declare type TAvayaSttTtsLanguages = typeof avayaSttTtsLanguages[number];
2760
- declare const avayaGatherLanguages: readonly [
2761
- "af-ZA",
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",
3460
+ "pt-PT",
3461
+ "ro-RO",
3462
+ "ru-RU",
3463
+ "sv-SE",
3464
+ "tr-TR"
3465
+ ];
3466
+ export declare type TAvayaSttTtsLanguages = typeof avayaSttTtsLanguages[number];
3467
+ declare const avayaGatherLanguages: readonly [
3468
+ "af-ZA",
2762
3469
  "am-ET",
2763
3470
  "hy-AM",
2764
3471
  "az-AZ",
@@ -4304,326 +5011,72 @@ export interface IContactAttachment {
4304
5011
  export interface ILocationAttachment {
4305
5012
  type: "location";
4306
5013
  latitude: number;
4307
- longitude: number;
4308
- name?: string;
4309
- title?: string;
4310
- address?: string;
4311
- }
4312
- export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
4313
- /**
4314
- * @openapi
4315
- *
4316
- * components:
4317
- * schemas:
4318
- * TAttachments:
4319
- * oneOf:
4320
- * - $ref: '#/components/schemas/IFileAttachment'
4321
- * - $ref: '#/components/schemas/IImageAttachment'
4322
- * - $ref: '#/components/schemas/IVideoAttachment'
4323
- * - $ref: '#/components/schemas/IAudioAttachment'
4324
- * - $ref: '#/components/schemas/IStickerAttachment'
4325
- * - $ref: '#/components/schemas/IContactAttachment'
4326
- * - $ref: '#/components/schemas/ILocationAttachment'
4327
- */
4328
- export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
4329
- export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
4330
- /** The base 8x8 server url */
4331
- baseUrl: string;
4332
- /** The API Key which we use to access/authorize the 8x8 API calls */
4333
- apiKey: string;
4334
- /**
4335
- * The API Tenant Id which we use as a 8x8 tenant header for the 8x8 API calls.
4336
- * Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.
4337
- */
4338
- apiTenant: string;
4339
- /**
4340
- * 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.
4341
- * If deactivated, CONVERSATION UPDATE EVENTS of state ACTIVE will not be accepted & will not be sent to the Flow.
4342
- */
4343
- acceptConversationActiveEvent?: boolean;
4344
- /** Settings to store attachments at a cloud provider */
4345
- fileStorageSettings?: IFileStorageSettings;
4346
- }
4347
- export interface IGenesysBotConnectorEndpointSettings {
4348
- verifyToken: string;
4349
- }
4350
- export interface INiceCXOneEndpointSettings {
4351
- verifyToken: string;
4352
- }
4353
- export interface INiceCXOneAAHEndpointSettings {
4354
- niceCXOneAAHConnection: string;
4355
- }
4356
- export interface IZoomContactCenterEndpointSettings {
4357
- verifyToken: string;
4358
- }
4359
- declare const arrayNLUConnectorType_2_0: readonly [
4360
- "alexa",
4361
- "dialogflow",
4362
- "dialogflowBuiltIn",
4363
- "amazonLexBuiltIn",
4364
- "luis",
4365
- "watson",
4366
- "noNlu",
4367
- "cognigy",
4368
- "code",
4369
- "lex",
4370
- "generativeAI"
4371
- ];
4372
- export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
4373
- declare const generativeAIModels: readonly [
4374
- "gpt-3.5-turbo",
4375
- "gpt-3.5-turbo-instruct",
4376
- "gpt-4",
4377
- "gpt-4o",
4378
- "gpt-4o-mini",
4379
- "gpt-4.1",
4380
- "gpt-4.1-mini",
4381
- "gpt-4.1-nano",
4382
- "gpt-5",
4383
- "gpt-5-nano",
4384
- "gpt-5-mini",
4385
- "gpt-5-chat-latest",
4386
- "luminous-extended-control",
4387
- "claude-v1-100k",
4388
- "claude-instant-v1",
4389
- "claude-3-opus-20240229",
4390
- "claude-3-haiku-20240307",
4391
- "claude-3-sonnet-20240229",
4392
- "claude-3-5-sonnet-20241022",
4393
- "claude-3-7-sonnet-20250219",
4394
- "claude-3-5-sonnet-latest",
4395
- "claude-3-7-sonnet-latest",
4396
- "claude-opus-4-0",
4397
- "claude-sonnet-4-0",
4398
- "text-bison@001",
4399
- "custom-model",
4400
- "custom-embedding-model",
4401
- "gemini-1.0-pro",
4402
- "gemini-1.5-pro",
4403
- "gemini-1.5-flash",
4404
- "gemini-2.0-flash",
4405
- "gemini-2.0-flash-lite",
4406
- "amazon.nova-lite-v1:0",
4407
- "amazon.nova-pro-v1:0",
4408
- "amazon.nova-micro-v1:0",
4409
- "anthropic.claude-3-5-sonnet-20240620-v1:0",
4410
- "mistral-large-2411",
4411
- "mistral-small-2503",
4412
- "pixtral-large-2411",
4413
- "pixtral-12b-2409",
4414
- "mistral-large-latest",
4415
- "pixtral-large-latest",
4416
- "mistral-medium-latest",
4417
- "mistral-small-latest",
4418
- "text-davinci-003",
4419
- "text-embedding-3-small",
4420
- "text-embedding-3-large",
4421
- "text-embedding-ada-002",
4422
- "luminous-embedding-128",
4423
- "amazon.titan-embed-text-v2:0",
4424
- "Pharia-1-Embedding-4608"
4425
- ];
4426
- /**
4427
- * @openapi
4428
- *
4429
- * components:
4430
- * schemas:
4431
- * TGenerativeAIModels:
4432
- * type: string
4433
- * enum:
4434
- * - gpt-3.5-turbo
4435
- * - gpt-3.5-turbo-instruct
4436
- * - gpt-4
4437
- * - gpt-4o
4438
- * - gpt-4o-mini
4439
- * - text-embedding-ada-002
4440
- * - luminous-extended-control
4441
- * - luminous-embedding-128
4442
- * - Pharia-1-Embedding-4608
4443
- * - claude-v1-100k
4444
- * - claude-instant-v1
4445
- * - claude-3-opus-20240229
4446
- * - custom-model
4447
- * - custom-embedding-model
4448
- * - gemini-2.0-flash
4449
- * - gemini-2.0-flash-lite
4450
- * - mistral-large-2411
4451
- * - mistral-small-2503
4452
- * - pixtral-large-2411
4453
- * - pixtral-12b-2409
4454
- */
4455
- export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
4456
- declare const generativeAIProviders: readonly [
4457
- "azureOpenAI",
4458
- "openAI",
4459
- "openAICompatible",
4460
- "alephAlpha",
4461
- "anthropic",
4462
- "googleVertexAI",
4463
- "googleGemini",
4464
- "awsBedrock",
4465
- "mistral"
4466
- ];
5014
+ longitude: number;
5015
+ name?: string;
5016
+ title?: string;
5017
+ address?: string;
5018
+ }
5019
+ export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
4467
5020
  /**
4468
5021
  * @openapi
4469
5022
  *
4470
5023
  * components:
4471
- * schemas:
4472
- * TGenerativeAIProviders:
4473
- * type: string
4474
- * enum:
4475
- * - azureOpenAI
4476
- * - openAI
4477
- * - anthropic
4478
- * - googleVertexAI
4479
- * - googleGemini
4480
- * - alephAlpha
4481
- * - awsBedrock
4482
- * - 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'
4483
5034
  */
4484
- export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
4485
- declare const generativeAIUseCases: readonly [
4486
- "nlu",
4487
- "knowledgeSearch",
4488
- "aiAgent",
4489
- "gptPromptNode",
4490
- "aiEnhancedOutputs",
4491
- "sentimentAnalysis",
4492
- "designTimeGeneration",
4493
- "intentSentenceGeneration",
4494
- "flowGeneration",
4495
- "generateNodeOutput",
4496
- "lexiconGeneration",
4497
- "answerExtraction",
4498
- "gptConversation"
4499
- ];
4500
- export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
4501
- declare const modeType: readonly [
4502
- "chat",
4503
- "completion",
4504
- "embedding"
4505
- ];
4506
- export declare type TModeType = typeof modeType[number];
4507
- export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
4508
- export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
4509
- export declare type TSQL_EXTENSION = "@cognigy/mssql";
4510
- export declare type TSMTP_EXTENSION = "@cognigy/smtp";
4511
- export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
4512
- export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
4513
- export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
4514
- export interface IGenerativeAIUseCaseSettings {
4515
- largeLanguageModelId: string | null;
4516
- temperature: number;
4517
- }
4518
- export interface IGenericIntentFeedbackFinding {
4519
- type: IGenericIntentFeedbackFindingType;
4520
- }
4521
- export interface IOverlapIntentFeedbackFinding {
4522
- type: IOverlapIntentFeedbackFindingType;
4523
- overlappingIntentReferenceId: string;
4524
- overlappingIntentName: string;
4525
- overlappingIntentId: TMongoId;
4526
- overlappingFlowName: string;
4527
- overlappingFlowId: TMongoId;
4528
- }
4529
- export interface ILowDataIntentFeedbackFinding {
4530
- type: "lowDataIntents";
4531
- intents: {
4532
- intentReferenceId: string;
4533
- intentName: string;
4534
- intentId: string;
4535
- flowId: string;
4536
- flowName: string;
4537
- }[];
4538
- }
4539
- declare const overlapIntentFeedbackFindingArrayType: readonly [
4540
- "strongOverlap",
4541
- "someOverlap"
4542
- ];
4543
- export declare type IOverlapIntentFeedbackFindingType = typeof overlapIntentFeedbackFindingArrayType[number];
4544
- declare const genericIntentFeedbackFindingArrayType: readonly [
4545
- "poorFScore",
4546
- "fairFScore",
4547
- "goodFScore",
4548
- "fewSentences",
4549
- "unclearIntent",
4550
- "noSiblings"
4551
- ];
4552
- export declare type IGenericIntentFeedbackFindingType = typeof genericIntentFeedbackFindingArrayType[number];
4553
- export declare type IntentFeedbackFinding = IGenericIntentFeedbackFinding | IOverlapIntentFeedbackFinding | ILowDataIntentFeedbackFinding;
4554
- export interface IIntentFeedbackInDBReport {
4555
- findings: IntentFeedbackFinding[];
4556
- info: {
4557
- fScore: number;
4558
- };
4559
- }
4560
- declare const biasTowardsParentOrChildIntentsTypes: readonly [
4561
- "parents",
4562
- "children"
4563
- ];
4564
- export declare type TBiasTowardsParentOrChildIntentsTypes = typeof biasTowardsParentOrChildIntentsTypes[number];
4565
- declare const intentTypes: readonly [
4566
- "yesNoIntent",
4567
- "default"
4568
- ];
4569
- export declare type TIntentTypes = typeof intentTypes[number];
4570
- export interface ILocalizedIntentData {
4571
- rules: string[];
4572
- condition: string;
4573
- confirmationSentences: string[];
4574
- disambiguationSentence: string;
4575
- localeReference: TMongoId;
4576
- }
4577
- export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
4578
- localizedData: ILocalizedIntentData[];
4579
- /**
4580
- * A list of all of the locales
4581
- * that are not disabled. Used to return
4582
- * the correct isDisabled value for the
4583
- * given locale
4584
- */
4585
- enabledLocaleReferences: TMongoId[];
4586
- }
4587
- export interface IIntent extends IEntityMeta, ILocalizedIntentData {
4588
- name: string;
4589
- description?: string;
4590
- referenceId: string;
4591
- isRejectIntent: boolean;
4592
- isDisabled: boolean;
4593
- tags: string[];
4594
- data: any;
4595
- nodeReferenceId: string;
4596
- childFeatures?: boolean | string[];
4597
- biasTowardsParentOrChildIntents: TBiasTowardsParentOrChildIntentsTypes;
4598
- parentIntentId?: string;
4599
- feedbackReport: IIntentFeedbackInDBReport;
4600
- intentRelationReferences: TMongoId[];
4601
- flowReference?: TMongoId;
4602
- projectReference: TMongoId;
4603
- organisationReference: TMongoId;
4604
- 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;
4605
5041
  /**
4606
- * A label we use in analytics
4607
- * 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.
4608
5044
  */
4609
- analyticsLabel?: string;
5045
+ apiTenant: string;
4610
5046
  /**
4611
- * 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.
4612
5049
  */
4613
- overrideIntentDefaultRepliesAsExamples?: string;
4614
- intentType: TIntentTypes;
5050
+ acceptConversationActiveEvent?: boolean;
5051
+ /** Settings to store attachments at a cloud provider */
5052
+ fileStorageSettings?: IFileStorageSettings;
4615
5053
  }
4616
- export interface IYesNoData {
4617
- _id: string;
4618
- rules: string[];
4619
- name: string;
4620
- isDisabled: boolean;
5054
+ export interface IGenesysBotConnectorEndpointSettings {
5055
+ verifyToken: string;
4621
5056
  }
4622
- export interface IYesNoItem {
4623
- yesIntent: IYesNoData | IIntentInDB;
4624
- noIntent: IYesNoData | IIntentInDB;
4625
- rejectIntent: IYesNoData | IIntentInDB;
5057
+ export interface INiceCXOneEndpointSettings {
5058
+ verifyToken: string;
5059
+ }
5060
+ export interface INiceCXOneAAHEndpointSettings {
5061
+ niceCXOneAAHConnection: string;
5062
+ }
5063
+ export interface IZoomContactCenterEndpointSettings {
5064
+ verifyToken: string;
4626
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];
4627
5080
  /**
4628
5081
  * @openapi
4629
5082
  *
@@ -7239,6 +7692,9 @@ export interface IWebrtcWidgetConfig {
7239
7692
  * agentCopilotAuthentication:
7240
7693
  * type: string
7241
7694
  * description: Authentication connection reference Id for agent copilot
7695
+ * oAuth2Connection:
7696
+ * type: string
7697
+ * description: OAuth2 Connection for Genesys Cloud
7242
7698
  * orgDataPrivacySettings:
7243
7699
  * $ref: '#/components/schemas/IEndpoitOrgDataPrivacySettings_2_0'
7244
7700
  * IEndpoint_2_0:
@@ -8513,59 +8969,27 @@ export interface ICreateProjectRestReturnValue_2_0 extends IProject_2_0 {
8513
8969
  * properties:
8514
8970
  * liveAgentDefaultInbox:
8515
8971
  * type: number
8516
- * description: Live agent default inbox Id for the project
8517
- * - $ref: '#/components/schemas/IEntityMeta'
8518
- */
8519
- export interface IProjectIndexItem_2_0 {
8520
- /** The Mongo id of the entity */
8521
- _id: string;
8522
- color: TCSSColorName | TCognigyColorName;
8523
- name: string;
8524
- primaryLocaleReference: TMongoId;
8525
- createdAt: number;
8526
- lastChanged: number;
8527
- createdBy: TMongoId;
8528
- lastChangedBy: TMongoId;
8529
- liveAgentDefaultInbox: number;
8530
- handoverConfiguration?: IHandoverConfiguration_2_0;
8531
- }
8532
- export interface IIndexProjectsRestData_2_0 extends IRestPagination<IProjectIndexItem_2_0> {
8533
- ignoreOwnership?: boolean;
8534
- }
8535
- export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
8536
- }
8537
- export declare const nluLanguages: readonly [
8538
- "ar-AE",
8539
- "bn-IN",
8540
- "da-DK",
8541
- "en-AU",
8542
- "en-CA",
8543
- "en-GB",
8544
- "en-IN",
8545
- "en-US",
8546
- "es-ES",
8547
- "fi-FI",
8548
- "fr-FR",
8549
- "de-DE",
8550
- "hi-IN",
8551
- "it-IT",
8552
- "ja-JP",
8553
- "ko-KR",
8554
- "nn-NO",
8555
- "nl-NL",
8556
- "pl-PL",
8557
- "pt-BR",
8558
- "pt-PT",
8559
- "ru-RU",
8560
- "sv-SE",
8561
- "ta-IN",
8562
- "th-TH",
8563
- "tr-TR",
8564
- "vi-VN",
8565
- "zh-CN",
8566
- "ge-GE"
8567
- ];
8568
- export declare type TNluLanguage = typeof nluLanguages[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
+ }
8569
8993
  /**
8570
8994
  * @openapi
8571
8995
  *
@@ -8863,109 +9287,6 @@ export interface IGraphLargeLanguageModel {
8863
9287
  properties: Pick<ILargeLanguageModel, "modelType" | "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
8864
9288
  dependencies?: IGraphLargeLanguageModelDependencyAttachment[];
8865
9289
  }
8866
- export interface ISystemSlots {
8867
- DATE: IDateSlot[] | null;
8868
- NUMBER: INumberSlot[] | null;
8869
- DURATION: IDurationSlot[] | null;
8870
- TEMPERATURE: ITemperatureSlot[] | null;
8871
- AGE: IAgeSlot[] | null;
8872
- PERCENTAGE: IPercentageSlot[] | null;
8873
- EMAIL: IEmailSlot[] | null;
8874
- URL: IUrlSlot[] | null;
8875
- MONEY: IMoneySlot[] | null;
8876
- DISTANCE: IDistanceSlot[] | null;
8877
- }
8878
- export interface IBaseSlot {
8879
- text: string;
8880
- data: any;
8881
- offset: {
8882
- start: number;
8883
- end: number;
8884
- };
8885
- }
8886
- export interface IPercentageSlot extends IBaseSlot {
8887
- data: {
8888
- value: number;
8889
- };
8890
- }
8891
- export interface IAgeSlot extends IBaseSlot {
8892
- data: {
8893
- value: number;
8894
- unit: TTimeGrain;
8895
- };
8896
- }
8897
- export interface INumberSlot extends IBaseSlot {
8898
- data: {
8899
- value: number;
8900
- };
8901
- }
8902
- export interface IEmailSlot extends IBaseSlot {
8903
- data: {
8904
- value: string;
8905
- };
8906
- }
8907
- export declare type ITemperatureUnit = "celsius" | "fahrenheit" | "degree" | "kelvin";
8908
- export interface ITemperatureSlot extends IBaseSlot {
8909
- data: {
8910
- value: number;
8911
- unit: ITemperatureUnit;
8912
- };
8913
- }
8914
- export declare type TTimeGrain = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
8915
- export interface IDateObject {
8916
- day: number;
8917
- hour: number;
8918
- minute: number;
8919
- month: number;
8920
- second: number;
8921
- milliseconds: number;
8922
- weekday: number;
8923
- dayOfWeek: string;
8924
- year: number;
8925
- ISODate: string;
8926
- grain: TTimeGrain | null;
8927
- plain: string;
8928
- timezoneOffset?: string;
8929
- }
8930
- export interface IDateSlot extends IBaseSlot {
8931
- data: {
8932
- start?: IDateObject;
8933
- end?: IDateObject;
8934
- };
8935
- }
8936
- export interface IDurationSlot extends IBaseSlot {
8937
- data: {
8938
- unit?: TTimeGrain;
8939
- value?: number;
8940
- inSeconds?: number;
8941
- years?: number;
8942
- quarters?: number;
8943
- months?: number;
8944
- weeks?: number;
8945
- days?: number;
8946
- hours?: number;
8947
- minutes?: number;
8948
- seconds?: number;
8949
- };
8950
- }
8951
- export interface IMoneySlot extends IBaseSlot {
8952
- data: {
8953
- value: number;
8954
- unit: string;
8955
- };
8956
- }
8957
- export interface IUrlSlot extends IBaseSlot {
8958
- data: {
8959
- domain: string;
8960
- value: string;
8961
- };
8962
- }
8963
- export interface IDistanceSlot extends IBaseSlot {
8964
- data: {
8965
- unit: string;
8966
- value: number;
8967
- };
8968
- }
8969
9290
  export interface IHandoverNodeParams extends INodeFunctionBaseParams {
8970
9291
  config: {
8971
9292
  text: string;
@@ -9060,23 +9381,6 @@ export interface ICodeNodeBasicParams extends INodeFunctionBaseParams {
9060
9381
  code: string;
9061
9382
  };
9062
9383
  }
9063
- declare const arrayTDebugEventTypes: readonly [
9064
- "inputChanged",
9065
- "contextChanged",
9066
- "profileChanged",
9067
- "activeEntrypointsChanged",
9068
- "nodeExecuted",
9069
- "nodeError",
9070
- "finalPing",
9071
- "input",
9072
- "output",
9073
- "switchedFlow",
9074
- "nluWarning",
9075
- "debugMessage",
9076
- "debugError",
9077
- "goalCompleted"
9078
- ];
9079
- export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
9080
9384
  export interface IInputChangedEventPayload {
9081
9385
  input: {
9082
9386
  [key: string]: any;
@@ -9106,17 +9410,6 @@ export interface INodeErrorEventPayload {
9106
9410
  errorMessage: string;
9107
9411
  sessionId?: string;
9108
9412
  }
9109
- export interface IErrorEventPayload extends ILoggerStack {
9110
- message: string;
9111
- flowId: string;
9112
- nodeId?: string;
9113
- }
9114
- export interface IFinalPingEventPayload {
9115
- type: "regular" | "preventFinalPingToEndpoint" | "cognigyStopFlow" | "error";
9116
- analyticsData?: IAnalyticsSourceData;
9117
- error?: IErrorEventPayload;
9118
- sessionId?: string;
9119
- }
9120
9413
  export interface IOutputEventPayload {
9121
9414
  text?: string;
9122
9415
  data?: {
@@ -9146,337 +9439,53 @@ export interface ISwitchedFlowEventPayload {
9146
9439
  }
9147
9440
  export interface IActiveEntrypointsChangedEventPayload {
9148
9441
  entrypoints: IActiveEntrypoint[];
9149
- sessionId?: string;
9150
- }
9151
- export interface IActiveEntrypoint {
9152
- flowId: string;
9153
- nodeReferenceId: string;
9154
- primary?: boolean;
9155
- }
9156
- export interface INluWarningEventPayload {
9157
- errorMessage: string;
9158
- sessionId?: string;
9159
- }
9160
- export interface IDebugEventMessagePayloadBase {
9161
- sessionId?: string;
9162
- header?: string;
9163
- metadata?: IOutputEventMetadata;
9164
- }
9165
- export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
9166
- type: "text";
9167
- message: string;
9168
- }
9169
- export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
9170
- type: "json";
9171
- message: object;
9172
- }
9173
- export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
9174
- export interface IGoalAnalyticsPayload {
9175
- analyticsdata: IGoalEscalations;
9176
- data: IPayloadBaseMetaData;
9177
- }
9178
- export interface IGoalAnalyticsData {
9179
- projectId: string;
9180
- organisationId: string;
9181
- sessionId: string;
9182
- referenceId: string;
9183
- version: string;
9184
- timestamp: Date;
9185
- goalCycleId: string;
9186
- stepId: string;
9187
- goalId: string;
9188
- contactId: string;
9189
- stepType?: string;
9190
- }
9191
- export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
9192
- }
9193
- export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
9194
- }
9195
- export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
9196
- declare const audioPreviewProviders: readonly [
9197
- "microsoft",
9198
- "google",
9199
- "aws",
9200
- "deepgram"
9201
- ];
9202
- export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
9203
- /**
9204
- * @openapi
9205
- * components:
9206
- * schemas:
9207
- * IGenerativeAIUseCase:
9208
- * type: object
9209
- * properties:
9210
- * useCase:
9211
- * enum:
9212
- * - designTimeGeneration
9213
- * - intentSentenceGeneration
9214
- * - aiEnhancedOutputs
9215
- * - lexiconGeneration
9216
- * - flowGeneration
9217
- * - gptConversation
9218
- * - gptPromptNode
9219
- * - generateNodeOutput
9220
- * - knowledgeSearch
9221
- * - sentimentAnalysis
9222
- */
9223
- export interface IGenerativeAIUseCase {
9224
- useCase: TGenerativeAIUseCases;
9225
- }
9226
- export interface INluEmbeddingCredentials {
9227
- apiType: TGenerativeAIProviders;
9228
- apiKey: string;
9229
- apiModel: TGenerativeAIModels;
9230
- apiCustomBaseUrl?: string;
9231
- apiResourceName?: string;
9232
- apiDeploymentName?: string;
9233
- apiVersion?: string;
9234
- }
9235
- export interface ISetAppStateOverlaySettings {
9236
- autoOpen: boolean;
9237
- closeOnSubmit: boolean;
9238
- feedbackMessage: string;
9239
- screenTitle: string;
9240
- sendEventOnCloseIconClick: boolean;
9241
- showCloseIcon: boolean;
9242
- }
9243
- export interface ISetAppStateOverlaySettingsMetaData {
9244
- overlaySettings: ISetAppStateOverlaySettings;
9245
- endpointType: TEndpointType;
9246
- url: string;
9247
- URLToken: string;
9248
- }
9249
- export interface IVoiceGateway2VadParams {
9250
- enable?: boolean;
9251
- voiceMs?: number;
9252
- mode?: number;
9442
+ sessionId?: string;
9253
9443
  }
9254
- export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
9255
- export interface IVoiceGateway2SynthesizerParams {
9256
- vendor?: TVoiceGateway2TTSVendor | "default" | "none";
9257
- language?: string;
9258
- voice?: string;
9259
- label?: string;
9260
- fallbackVendor?: string;
9261
- fallbackLabel?: string;
9262
- fallbackLanguage?: string;
9263
- fallbackVoice?: string;
9264
- engine?: "standard" | "neural";
9265
- gender?: "MALE" | "FEMALE" | "NEUTRAL";
9266
- azureServiceEndpoint?: string;
9267
- options?: object;
9268
- disableCache?: boolean;
9269
- model?: string;
9444
+ export interface IActiveEntrypoint {
9445
+ flowId: string;
9446
+ nodeReferenceId: string;
9447
+ primary?: boolean;
9270
9448
  }
9271
- export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
9272
- export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
9273
- 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";
9274
- export interface IVoiceGateway2RecognizerParams {
9275
- vendor?: TVoiceGateway2STTVendor | "default" | "none";
9276
- language?: string;
9277
- label?: string;
9278
- fallbackVendor?: string;
9279
- fallbackLabel?: string;
9280
- fallbackLanguage?: string;
9281
- vad?: IVoiceGateway2VadParams;
9282
- hints?: string[];
9283
- hintsBoost?: number;
9284
- altLanguages?: string[];
9285
- profanityFilter?: boolean;
9286
- interim?: boolean;
9287
- singleUtterance?: boolean;
9288
- dualChannel?: boolean;
9289
- separateRecognitionPerChannel?: boolean;
9290
- punctuation?: boolean;
9291
- enhancedModel?: boolean;
9292
- words?: boolean;
9293
- diarization?: boolean;
9294
- diarizationMinSpeakers?: number;
9295
- diarizationMaxSpeakers?: number;
9296
- interactionType?: "unspecified" | "discussion" | "presentation" | "phone_call" | "voicemail" | "voice_search" | "voice_command" | "dictation";
9297
- naicsCod?: number;
9298
- identifyChannels?: boolean;
9299
- vocabularyName?: string;
9300
- vocabularyFilterName?: string;
9301
- filterMethod?: "remove" | "mask" | "tag";
9302
- outputFormat?: "simple" | "detailed";
9303
- profanityOption?: "masked" | "removed" | "raw";
9304
- requestSnr?: boolean;
9305
- initialSpeechTimeoutMs?: number;
9306
- azureSttEndpointId?: string;
9307
- audioLogging?: boolean;
9308
- asrDtmfTerminationDigit?: string;
9309
- asrTimeout?: number;
9310
- nuanceOptions?: TVoiceGateway2NuanceOptions;
9311
- deepgramOptions?: TVoiceGateway2DeepgramOptions;
9312
- ibmOptions?: TVoiceGateway2IbmOptions;
9313
- nvidiaOptions?: TVoiceGateway2NvidiaOptions;
9314
- sonioxOptions?: TVoiceGateway2SonioxOptions;
9315
- model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
9449
+ export interface INluWarningEventPayload {
9450
+ errorMessage: string;
9451
+ sessionId?: string;
9316
9452
  }
9317
- export declare type TVoiceGateway2NuanceOptions = {
9318
- clientId?: string;
9319
- secret?: string;
9320
- kryptonEndpoint?: string;
9321
- topic?: string;
9322
- utteranceDetectionMode?: string;
9323
- punctuation?: boolean;
9324
- profanityFilter?: boolean;
9325
- includeTokenization?: boolean;
9326
- discardSpeakerAdaptation?: boolean;
9327
- suppressCallRecording?: boolean;
9328
- maskLoadFailures?: boolean;
9329
- suppressInitialCapitalization?: boolean;
9330
- allowZeroBaseLmWeight?: boolean;
9331
- filterWakeupWord?: boolean;
9332
- resultType?: string;
9333
- noInputTimeoutMs?: number;
9334
- recognitionTimeoutMs?: number;
9335
- utteranceEndSilenceMs?: number;
9336
- maxHypotheses?: number;
9337
- speechDomain?: string;
9338
- formatting?: TVoiceGatewayNuanceFormatting;
9339
- clientData?: object;
9340
- userId?: string;
9341
- speechDetectionSensitivity?: number;
9342
- resources?: [
9343
- TVoiceGatewayNuanceResources
9344
- ];
9345
- };
9346
- export declare type TVoiceGateway2DeepgramOptions = {
9347
- deepgramSttUri?: string;
9348
- deepgramSttUseTls?: boolean;
9349
- apiKey?: string;
9350
- tier?: string;
9351
- model?: string;
9352
- customModel?: string;
9353
- version?: string;
9354
- punctuate?: boolean;
9355
- smartFormatting?: boolean;
9356
- profanityFilter?: boolean;
9357
- redact?: string;
9358
- diarize?: boolean;
9359
- diarizeVersion?: string;
9360
- ner?: boolean;
9361
- multichannel?: boolean;
9362
- alternatives?: number;
9363
- numerals?: boolean;
9364
- search?: string[];
9365
- replace?: string[];
9366
- keywords?: string[];
9367
- endpointing?: number | boolean;
9368
- utteranceEndMs?: number;
9369
- shortUtterance?: boolean;
9370
- vadTurnoff?: number;
9371
- tag?: string;
9372
- };
9373
- export declare type TVoiceGateway2NvidiaOptions = {
9374
- rivaUri?: string;
9375
- maxAlternatives?: number;
9376
- profanityFilter?: boolean;
9377
- punctuation?: boolean;
9378
- wordTimeOffsets?: boolean;
9379
- verbatimTranscripts?: boolean;
9380
- customConfiguration?: object;
9381
- };
9382
- export declare type TVoiceGateway2SonioxOptions = {
9383
- id?: string;
9384
- title?: string;
9385
- disableStoreAudio?: boolean;
9386
- disableStoreTranscript?: boolean;
9387
- disableSearch?: boolean;
9388
- metadata?: object;
9389
- storage?: object;
9390
- };
9391
- export declare type TVoiceGateway2IbmOptions = {
9392
- sttApiKey?: string;
9393
- sttRegion?: string;
9394
- ttsApiKey?: string;
9395
- ttsRegion?: string;
9396
- instanceId?: string;
9397
- model?: string;
9398
- languageCustomizationId?: string;
9399
- acousticCustomizationId?: string;
9400
- baseModelVersion?: string;
9401
- watsonMetadata?: string;
9402
- watsonLearningOptOut?: boolean;
9403
- };
9404
- export declare type TVoiceGatewayNuanceResourceReference = {
9405
- type?: string;
9406
- uri?: string;
9407
- maxLoadFailures?: boolean;
9408
- requestTimeoutMs?: number;
9409
- headers?: object;
9410
- };
9411
- export declare type TVoiceGatewayNuanceResources = {
9412
- externalReference?: TVoiceGatewayNuanceResourceReference;
9413
- inlineWordset?: string;
9414
- builtin?: string;
9415
- inlineGrammar?: string;
9416
- wakeupWord?: Array<string>;
9417
- weightName?: string;
9418
- weightValue?: number;
9419
- reuse?: string;
9420
- };
9421
- export declare type TVoiceGatewayNuanceFormatting = {
9422
- scheme?: string;
9423
- options?: object;
9424
- };
9425
- export declare type TVoiceGateway2InputType = "digits" | "speech";
9426
- export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
9427
- export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
9428
- export interface IVoiceGateway2BargeInParams {
9429
- enable?: boolean;
9430
- sticky?: boolean;
9431
- dtmfBargein?: boolean;
9432
- actionHook?: object | string;
9433
- input?: TVoiceGateway2InputType[];
9434
- finishOnKey?: string;
9435
- numDigits?: number;
9436
- minDigits?: number;
9437
- maxDigits?: number;
9438
- interDigitTimeout?: number;
9439
- minBargeinWordCount?: number;
9453
+ export interface IDebugEventMessagePayloadBase {
9454
+ sessionId?: string;
9455
+ header?: string;
9456
+ metadata?: IOutputEventMetadata;
9440
9457
  }
9441
- export interface IVoiceGateway2ActivityParams {
9442
- synthesizer?: IVoiceGateway2SynthesizerParams;
9443
- recognizer?: IVoiceGateway2RecognizerParams;
9444
- bargeIn?: IVoiceGateway2BargeInParams;
9445
- user?: IVoiceGateway2CognigyUserInputConfigParams;
9446
- dtmf?: boolean;
9447
- sessionParams?: IVoiceGateway2ActivityParams;
9448
- fillerNoise?: IVoiceGateway2FillerNoiseParams;
9449
- flow?: IVoiceGateway2CognigyFlowInputConfigParams;
9458
+ export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
9459
+ type: "text";
9460
+ message: string;
9450
9461
  }
9451
- export interface IVoiceGateway2FillerNoiseParams {
9452
- enable: boolean;
9453
- url?: string;
9454
- startDelaySecs?: number;
9462
+ export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
9463
+ type: "json";
9464
+ message: object;
9455
9465
  }
9456
- export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
9457
- export interface IVoiceGateway2CognigyUserInputConfigParams {
9458
- noInputMode?: TVoiceGateway2UserNoInputMode;
9459
- noInputTimeout?: number;
9460
- noInputRetries?: number;
9461
- noInputSpeech?: string;
9462
- noInputUrl?: string;
9463
- userNoInputAutoHangup?: boolean;
9466
+ export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
9467
+ export interface IGoalAnalyticsPayload {
9468
+ analyticsdata: IGoalEscalations;
9469
+ data: IPayloadBaseMetaData;
9464
9470
  }
9465
- export interface IVoiceGateway2CognigyFlowInputConfigParams {
9466
- flowNoInputEnable?: boolean;
9467
- flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
9468
- flowNoInputTimeout?: number;
9469
- flowNoInputRetries?: number;
9470
- flowNoInputSpeech?: string;
9471
- flowNoInputUrl?: string;
9472
- 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;
9473
9483
  }
9474
- export interface IGetNluPipelineParams {
9475
- parseIntents?: boolean;
9476
- parseSlots?: boolean;
9477
- parseSystemSlots?: boolean;
9478
- findType?: boolean;
9484
+ export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
9485
+ }
9486
+ export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
9479
9487
  }
9488
+ export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
9480
9489
  export interface ITrackAnalyticsStepsArguments {
9481
9490
  nodeId?: string;
9482
9491
  flowReferenceId: string;
@@ -17222,7 +17231,8 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
17222
17231
  transferReason: string;
17223
17232
  transferTarget: string;
17224
17233
  referredBy: string;
17225
- anchorMedia: boolean;
17234
+ mediaPath: TVoiceGateway2MediaPath;
17235
+ anchorMedia?: boolean;
17226
17236
  useTransferSipHeaders: boolean;
17227
17237
  transferSipHeaders: {
17228
17238
  [key: string]: string | object;
@@ -23226,6 +23236,7 @@ export interface IOpsCenterObservationConfig {
23226
23236
  observationActive: boolean;
23227
23237
  notificationConfig: NotificationConfig;
23228
23238
  alertingConfig: AlertingConfig;
23239
+ recordVersion: number;
23229
23240
  }
23230
23241
  export interface IGetOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
23231
23242
  }