@cognigy/rest-api-client 0.18.0 → 0.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 (136) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/build/apigroups/AdministrationAPIGroup_2_0.js +3 -1
  3. package/build/apigroups/MetricsAPIGroup_2_0.js +5 -0
  4. package/build/apigroups/ResourcesAPIGroup_2_0.js +9 -6
  5. package/build/shared/charts/descriptors/agentAssist/helpers/determineMetadata.js +15 -0
  6. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/answerExtraction.helper.js +1 -1
  7. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/followUpDetection.helper.js +2 -2
  8. package/build/shared/charts/descriptors/agentAssist/identityAssist.js +1 -1
  9. package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +1 -1
  10. package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +4 -5
  11. package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +1 -1
  12. package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js +2 -0
  13. package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +2 -1
  14. package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js +5 -3
  15. package/build/shared/charts/descriptors/agentAssist/setIframeTile.js +5 -3
  16. package/build/shared/charts/descriptors/agentAssist/setSecureFormsTile.js +2 -2
  17. package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +2 -1
  18. package/build/shared/charts/descriptors/analytics/activateProfile.js +1 -0
  19. package/build/shared/charts/descriptors/analytics/blindMode.js +2 -0
  20. package/build/shared/charts/descriptors/analytics/completeGoal.js +1 -0
  21. package/build/shared/charts/descriptors/analytics/deactivateProfile.js +1 -0
  22. package/build/shared/charts/descriptors/analytics/deleteProfile.js +1 -0
  23. package/build/shared/charts/descriptors/analytics/index.js +3 -1
  24. package/build/shared/charts/descriptors/analytics/mergeProfile.js +1 -0
  25. package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +9 -0
  26. package/build/shared/charts/descriptors/analytics/setRating.js +4 -2
  27. package/build/shared/charts/descriptors/analytics/trackMilestone.js +95 -0
  28. package/build/shared/charts/descriptors/analytics/updateProfile.js +1 -0
  29. package/build/shared/charts/descriptors/apps/initAppSession.js +1 -0
  30. package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js +35 -10
  31. package/build/shared/charts/descriptors/apps/setHtmlAppState.js +25 -2
  32. package/build/shared/charts/descriptors/apps/utils/getXAppsOverlaySettings.js +54 -0
  33. package/build/shared/charts/descriptors/connectionNodes/documentParserProviders/azureAIDocumentIntelligenceConnection.js +12 -0
  34. package/build/shared/charts/descriptors/connectionNodes/documentParserProviders/index.js +13 -0
  35. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/awsBedrockProviderConnection.js +12 -0
  36. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnection.js +4 -3
  37. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnectionV2.js +3 -3
  38. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderOauth2Connection.js +14 -0
  39. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +16 -8
  40. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +3 -3
  41. package/build/shared/charts/descriptors/data/addToContext.js +7 -0
  42. package/build/shared/charts/descriptors/data/copyDataToContext.js +3 -0
  43. package/build/shared/charts/descriptors/data/copySlotsToContext.js +3 -0
  44. package/build/shared/charts/descriptors/data/debugMessage.js +73 -0
  45. package/build/shared/charts/descriptors/data/index.js +3 -1
  46. package/build/shared/charts/descriptors/data/removeFromContext.js +9 -1
  47. package/build/shared/charts/descriptors/data/resetContext.js +1 -0
  48. package/build/shared/charts/descriptors/index.js +7 -1
  49. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +35 -10
  50. package/build/shared/charts/descriptors/logic/resetState.js +1 -0
  51. package/build/shared/charts/descriptors/logic/setState.js +2 -1
  52. package/build/shared/charts/descriptors/logic/setTranslation.js +3 -1
  53. package/build/shared/charts/descriptors/logic/switchLocale.js +1 -0
  54. package/build/shared/charts/descriptors/logic/think.js +3 -1
  55. package/build/shared/charts/descriptors/logic/thinkV2.js +2 -0
  56. package/build/shared/charts/descriptors/message/question/question.js +50 -5
  57. package/build/shared/charts/descriptors/message/question/utils/validateQuestionAnswer.js +4 -2
  58. package/build/shared/charts/descriptors/nlu/cleanText.js +1 -0
  59. package/build/shared/charts/descriptors/nlu/fuzzySearch.js +23 -1
  60. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +19 -9
  61. package/build/shared/charts/descriptors/service/GPTPrompt.js +59 -24
  62. package/build/shared/charts/descriptors/service/LLMEntityExtract.js +11 -2
  63. package/build/shared/charts/descriptors/service/handoverV2.js +84 -1
  64. package/build/shared/charts/descriptors/service/httpRequest.js +35 -2
  65. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +96 -17
  66. package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +2 -0
  67. package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +2 -0
  68. package/build/shared/charts/descriptors/voice/nodes/dtmf.js +2 -0
  69. package/build/shared/charts/descriptors/voice/nodes/muteSpeechInput.js +1 -0
  70. package/build/shared/charts/descriptors/voice/nodes/noUserInput.js +2 -0
  71. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +2 -0
  72. package/build/shared/charts/descriptors/voice/nodes/transfer.js +2 -0
  73. package/build/shared/charts/descriptors/voicegateway2/nodes/dtmf.js +2 -0
  74. package/build/shared/charts/descriptors/voicegateway2/nodes/hangup.js +2 -0
  75. package/build/shared/charts/descriptors/voicegateway2/nodes/muteSpeechInput.js +3 -0
  76. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +1 -0
  77. package/build/shared/charts/descriptors/voicegateway2/nodes/record.js +1 -0
  78. package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js +1 -0
  79. package/build/shared/charts/descriptors/voicegateway2/nodes/sendMetadata.js +1 -0
  80. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +298 -8
  81. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +10 -6
  82. package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +2 -2
  83. package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +4 -2
  84. package/build/shared/constants.js +10 -1
  85. package/build/shared/handoverClients/interfaces/THandoverEventType.js +1 -0
  86. package/build/shared/helper/logFullConfigToDebugMode.js +30 -0
  87. package/build/shared/helper/nlu/textCleaner.js +3 -1
  88. package/build/shared/interfaces/IOrganisation.js +1 -0
  89. package/build/shared/interfaces/IProfile.js +1 -0
  90. package/build/shared/interfaces/IProfileSchema.js +3 -0
  91. package/build/shared/interfaces/analytics/IAnalyticsSourceData.js +20 -20
  92. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyStep_2_0.js → analytics/IMilestoneAnalytics.js} +1 -1
  93. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyProgress_2_0.js → appsession/ISetAppStateOptions.js} +1 -1
  94. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyIndexItem_2_0.js → appsession/ISetAppStateOverlaySettings.js} +1 -1
  95. package/build/shared/interfaces/appsession/ISetAppStateOverlaySettingsMetaData.js +3 -0
  96. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IIndexJourneysRest_2_0.js → debugEvents/TDebugEventMessagePayload.js} +1 -1
  97. package/build/shared/interfaces/debugEvents/TDebugEventType.js +2 -0
  98. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +33 -69
  99. package/build/shared/interfaces/handover.js +42 -1
  100. package/build/shared/interfaces/license.js +3 -2
  101. package/build/shared/interfaces/license.js.map +1 -1
  102. package/build/shared/interfaces/messageAPI/endpoints.js +2 -0
  103. package/build/shared/interfaces/messageAPI/handover.js +20 -1
  104. package/build/shared/interfaces/resources/IConnection.js +1 -0
  105. package/build/shared/interfaces/resources/IEndpoint.js +1 -2
  106. package/build/shared/interfaces/resources/ILargeLanguageModel.js +25 -4
  107. package/build/shared/interfaces/resources/IMilestone.js +1 -1
  108. package/build/shared/interfaces/resources/INodeDescriptorSet.js +12 -0
  109. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  110. package/build/shared/interfaces/resources/settings/IAgentSettings.js +12 -7
  111. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
  112. package/build/shared/interfaces/resources/settings/IKnowledgeAISettings.js +18 -0
  113. package/build/shared/interfaces/resources/settings/index.js +4 -1
  114. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadCollectionsToBeDeletedRest_2_0.js +0 -1
  115. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadOrganisationKnowledgeChunksCountRest_2_0.js +3 -0
  116. package/build/shared/interfaces/restAPI/operations/nlu/v2.0/IGenerateNluScoresRest_2_0.js +57 -0
  117. package/build/shared/interfaces/restAPI/{resources/journey/v2.0/IJourney_2_0.js → operations/nlu/v2.0/index.js} +1 -1
  118. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IAvailableModelsForLLMProvider_2_0 .js +18 -0
  119. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IGetAvailableModelsForLLMRest_2_0 .js +3 -0
  120. package/build/shared/interfaces/security/IRole.js +2 -0
  121. package/build/shared/interfaces/security/ISystemCapabilities.js +3 -0
  122. package/build/shared/interfaces/security/index.js +1 -1
  123. package/build/shared/interfaces/trainer/ITrainerRecord.js +2 -2
  124. package/build/shared/interfaces/user.js +1 -1
  125. package/package.json +2 -2
  126. package/types/index.d.ts +1254 -670
  127. package/build/shared/interfaces/journeys/IJourney.js +0 -83
  128. package/build/shared/interfaces/journeys/IJourneyProgress.js +0 -40
  129. package/build/shared/interfaces/journeys/IJourneyTrackEvent.js +0 -35
  130. package/build/shared/interfaces/journeys/index.js +0 -14
  131. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IJourneyTrackEvents_2_0.js +0 -3
  132. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyProgressRest_2_0.js +0 -3
  133. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyRest_2_0.js +0 -3
  134. package/build/shared/interfaces/restAPI/resources/journey/v2.0/ITrackJourneyEventRest_2_0.js +0 -3
  135. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IUpdateSelectedJourneyRest_2_0.js +0 -3
  136. /package/build/shared/interfaces/restAPI/{resources/journey/v2.0 → operations}/index.js +0 -0
package/types/index.d.ts CHANGED
@@ -952,6 +952,7 @@ declare const projectWideRoles: readonly [
952
952
  "function_admin",
953
953
  "function_editor",
954
954
  "intents",
955
+ "knowledgeAdmin",
955
956
  "large_language_model_admin",
956
957
  "lexicon_admin",
957
958
  "lexicon_editor",
@@ -2015,6 +2016,7 @@ export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyti
2015
2016
  handoverEscalations: number;
2016
2017
  snapshotName?: string;
2017
2018
  flowHistory?: IAnalyticsFlowHistoryData[];
2019
+ allowDataOnly: boolean;
2018
2020
  custom1?: string;
2019
2021
  custom2?: string;
2020
2022
  custom3?: string;
@@ -2062,6 +2064,12 @@ declare const whisperAssistConfigurations: readonly [
2062
2064
  "template"
2063
2065
  ];
2064
2066
  export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
2067
+ declare const copilotType: readonly [
2068
+ "none",
2069
+ "workspace",
2070
+ "whisper"
2071
+ ];
2072
+ export declare type TCopilotType = typeof copilotType[number];
2065
2073
  export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
2066
2074
  export interface IRCEHandoverSettings {
2067
2075
  /**
@@ -2195,6 +2203,7 @@ export interface ISalesForceHandoverSettings {
2195
2203
  forwardUnknownEventsToFlow: boolean;
2196
2204
  }
2197
2205
  export interface IAgentAssistSettings {
2206
+ copilotType: TCopilotType;
2198
2207
  agentAssistFlowId: string;
2199
2208
  agentAssistConfigId: string;
2200
2209
  enableTranscriptTile?: boolean;
@@ -2237,7 +2246,7 @@ export interface IGenesysCloudOMHandoverSettings {
2237
2246
  }
2238
2247
  export interface IHandoverStatusInputObject {
2239
2248
  status: THandoverStatus;
2240
- eventType?: "queueUpdate" | "handoverInactivity";
2249
+ eventType?: "queueUpdate" | "handoverInactivity" | "genericHandoverUpdate";
2241
2250
  inactivityCount?: number;
2242
2251
  error?: {
2243
2252
  reason: "unsupported" | "error";
@@ -2245,7 +2254,7 @@ export interface IHandoverStatusInputObject {
2245
2254
  };
2246
2255
  data?: any;
2247
2256
  }
2248
- export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject";
2257
+ export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject" | "genericHandoverUpdate";
2249
2258
  export interface IEndpointTranslationSettings {
2250
2259
  translationEnabled: boolean;
2251
2260
  flowLanguage: string;
@@ -2301,10 +2310,6 @@ export interface IEndpoint extends IEntityMeta {
2301
2310
  useAnalytics: boolean;
2302
2311
  /** Whether we should store data payloads into analytics for this endpoint */
2303
2312
  storeDataPayload: boolean;
2304
- /** Whether we should use Chatbase to collect analytics */
2305
- useChatbaseAnalytics: boolean;
2306
- /** The apikey for the Chatbase bot */
2307
- chatbaseApikey: string;
2308
2313
  /** Whether we should use Dashbot to collect analytics */
2309
2314
  useDashbotAnalytics: boolean;
2310
2315
  /** The apikey for the dashbot bot */
@@ -2316,6 +2321,10 @@ export interface IEndpoint extends IEntityMeta {
2316
2321
  * is true.
2317
2322
  */
2318
2323
  dashbotPlatform: TDashbotPlatform;
2324
+ /**
2325
+ * If set to `true`, disables input sanitization
2326
+ */
2327
+ disableInputSanitization: boolean;
2319
2328
  /**
2320
2329
  * Optional endpoint specific settings e.g. Facebook Page token
2321
2330
  */
@@ -3213,6 +3222,11 @@ export interface IWebchat3EndpointColorsSettings {
3213
3222
  textLinkColor: string;
3214
3223
  }
3215
3224
  export interface IWebchat3EndpointBehaviorSettings {
3225
+ /**
3226
+ * Whether to enable collecting
3227
+ * addtional meatadata from customers
3228
+ */
3229
+ enableCollectMetadata: boolean;
3216
3230
  /**
3217
3231
  * Whether to enable typing indicators
3218
3232
  * when the bot is replying
@@ -3737,27 +3751,208 @@ export interface IFileStorageSettings {
3737
3751
  azureConnection?: string;
3738
3752
  googleCloudConnection?: string;
3739
3753
  }
3754
+ /**
3755
+ * @openapi
3756
+ *
3757
+ * components:
3758
+ * schemas:
3759
+ * IMediaAttachment:
3760
+ * type: object
3761
+ * properties:
3762
+ * name:
3763
+ * type: string
3764
+ * caption:
3765
+ * type: string
3766
+ * url:
3767
+ * type: string
3768
+ * type:
3769
+ * type: string
3770
+ * required:
3771
+ * - name
3772
+ * - url
3773
+ * - type
3774
+ */
3740
3775
  export interface IMediaAttachment {
3741
3776
  name: string;
3742
3777
  caption?: string;
3743
3778
  url: string;
3744
3779
  type: string;
3745
3780
  }
3781
+ /**
3782
+ * @openapi
3783
+ *
3784
+ * components:
3785
+ * schemas:
3786
+ * IFileAttachment:
3787
+ * allOf:
3788
+ * - $ref: '#/components/schemas/IMediaAttachment'
3789
+ * - type: object
3790
+ * properties:
3791
+ * type:
3792
+ * type: string
3793
+ * enum: [file, document]
3794
+ * required:
3795
+ * - type
3796
+ */
3746
3797
  export interface IFileAttachment extends IMediaAttachment {
3747
3798
  type: "file" | "document";
3748
3799
  }
3800
+ /**
3801
+ * @openapi
3802
+ *
3803
+ * components:
3804
+ * schemas:
3805
+ * IImageAttachment:
3806
+ * allOf:
3807
+ * - $ref: '#/components/schemas/IMediaAttachment'
3808
+ * - type: object
3809
+ * properties:
3810
+ * type:
3811
+ * type: string
3812
+ * enum: [image]
3813
+ * required:
3814
+ * - type
3815
+ */
3749
3816
  export interface IImageAttachment extends IMediaAttachment {
3750
3817
  type: "image";
3751
3818
  }
3819
+ /**
3820
+ * @openapi
3821
+ *
3822
+ * components:
3823
+ * schemas:
3824
+ * IStickerAttachment:
3825
+ * allOf:
3826
+ * - $ref: '#/components/schemas/IMediaAttachment'
3827
+ * - type: object
3828
+ * properties:
3829
+ * type:
3830
+ * type: string
3831
+ * enum: [sticker]
3832
+ * required:
3833
+ * - type
3834
+ */
3752
3835
  export interface IStickerAttachment extends IMediaAttachment {
3753
3836
  type: "sticker";
3754
3837
  }
3838
+ /**
3839
+ * @openapi
3840
+ *
3841
+ * components:
3842
+ * schemas:
3843
+ * IVideoAttachment:
3844
+ * allOf:
3845
+ * - $ref: '#/components/schemas/IMediaAttachment'
3846
+ * - type: object
3847
+ * properties:
3848
+ * type:
3849
+ * type: string
3850
+ * enum: [video]
3851
+ * required:
3852
+ * - type
3853
+ */
3755
3854
  export interface IVideoAttachment extends IMediaAttachment {
3756
3855
  type: "video";
3757
3856
  }
3857
+ /**
3858
+ * @openapi
3859
+ *
3860
+ * components:
3861
+ * schemas:
3862
+ * IAudioAttachment:
3863
+ * allOf:
3864
+ * - $ref: '#/components/schemas/IMediaAttachment'
3865
+ * - type: object
3866
+ * properties:
3867
+ * type:
3868
+ * type: string
3869
+ * enum: [audio]
3870
+ * required:
3871
+ * - type
3872
+ */
3758
3873
  export interface IAudioAttachment extends IMediaAttachment {
3759
3874
  type: "audio";
3760
3875
  }
3876
+ /**
3877
+ * @openapi
3878
+ *
3879
+ * components:
3880
+ * schemas:
3881
+ * IContactAttachment:
3882
+ * type: object
3883
+ * properties:
3884
+ * type:
3885
+ * type: string
3886
+ * enum: [contact]
3887
+ * addresses:
3888
+ * type: array
3889
+ * items:
3890
+ * type: object
3891
+ * properties:
3892
+ * city:
3893
+ * type: string
3894
+ * country:
3895
+ * type: string
3896
+ * countryCode:
3897
+ * type: string
3898
+ * state:
3899
+ * type: string
3900
+ * street:
3901
+ * type: string
3902
+ * type:
3903
+ * type: string
3904
+ * enum: [HOME, WORK]
3905
+ * zip:
3906
+ * type: string
3907
+ * postOfficeBox:
3908
+ * type: string
3909
+ * extendedAddress:
3910
+ * type: string
3911
+ * latitude:
3912
+ * type: number
3913
+ * longitude:
3914
+ * type: number
3915
+ * birthday:
3916
+ * type: string
3917
+ * emails:
3918
+ * type: array
3919
+ * items:
3920
+ * type: object
3921
+ * properties:
3922
+ * email:
3923
+ * type: string
3924
+ * type:
3925
+ * type: string
3926
+ * enum: [HOME, WORK]
3927
+ * urls:
3928
+ * type: array
3929
+ * items:
3930
+ * type: object
3931
+ * properties:
3932
+ * url:
3933
+ * type: string
3934
+ * type:
3935
+ * type: string
3936
+ * enum: [HOME, WORK]
3937
+ * photos:
3938
+ * type: array
3939
+ * items:
3940
+ * type: string
3941
+ * gender:
3942
+ * type: string
3943
+ * languages:
3944
+ * type: array
3945
+ * items:
3946
+ * type: string
3947
+ * timeZone:
3948
+ * type: string
3949
+ * notes:
3950
+ * type: array
3951
+ * items:
3952
+ * type: string
3953
+ * required:
3954
+ * - type
3955
+ */
3761
3956
  export interface IContactAttachment {
3762
3957
  type: "contact";
3763
3958
  addresses?: {
@@ -3808,6 +4003,32 @@ export interface IContactAttachment {
3808
4003
  timeZone?: string;
3809
4004
  notes?: string[];
3810
4005
  }
4006
+ /**
4007
+ * @openapi
4008
+ *
4009
+ * components:
4010
+ * schemas:
4011
+ * ILocationAttachment:
4012
+ * type: object
4013
+ * properties:
4014
+ * type:
4015
+ * type: string
4016
+ * enum: [location]
4017
+ * latitude:
4018
+ * type: number
4019
+ * longitude:
4020
+ * type: number
4021
+ * name:
4022
+ * type: string
4023
+ * title:
4024
+ * type: string
4025
+ * address:
4026
+ * type: string
4027
+ * required:
4028
+ * - type
4029
+ * - latitude
4030
+ * - longitude
4031
+ */
3811
4032
  export interface ILocationAttachment {
3812
4033
  type: "location";
3813
4034
  latitude: number;
@@ -3816,8 +4037,23 @@ export interface ILocationAttachment {
3816
4037
  title?: string;
3817
4038
  address?: string;
3818
4039
  }
3819
- export declare type TGenricAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
3820
- export declare type TAttachments = TGenricAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
4040
+ export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
4041
+ /**
4042
+ * @openapi
4043
+ *
4044
+ * components:
4045
+ * schemas:
4046
+ * TAttachments:
4047
+ * oneOf:
4048
+ * - $ref: '#/components/schemas/IFileAttachment'
4049
+ * - $ref: '#/components/schemas/IImageAttachment'
4050
+ * - $ref: '#/components/schemas/IVideoAttachment'
4051
+ * - $ref: '#/components/schemas/IAudioAttachment'
4052
+ * - $ref: '#/components/schemas/IStickerAttachment'
4053
+ * - $ref: '#/components/schemas/IContactAttachment'
4054
+ * - $ref: '#/components/schemas/ILocationAttachment'
4055
+ */
4056
+ export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
3821
4057
  export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
3822
4058
  /** The base 8x8 server url */
3823
4059
  baseUrl: string;
@@ -3860,7 +4096,8 @@ declare const generativeAIModels: readonly [
3860
4096
  "gpt-3.5-turbo",
3861
4097
  "gpt-3.5-turbo-instruct",
3862
4098
  "gpt-4",
3863
- "text-davinci-003",
4099
+ "gpt-4o",
4100
+ "gpt-4o-mini",
3864
4101
  "luminous-extended-control",
3865
4102
  "claude-v1-100k",
3866
4103
  "claude-instant-v1",
@@ -3869,24 +4106,62 @@ declare const generativeAIModels: readonly [
3869
4106
  "claude-3-sonnet-20240229",
3870
4107
  "text-bison@001",
3871
4108
  "custom-model",
4109
+ "gemini-1.0-pro",
4110
+ "text-embedding-3-small",
3872
4111
  "text-embedding-3-large",
3873
4112
  "text-embedding-ada-002",
3874
4113
  "luminous-embedding-128"
3875
4114
  ];
3876
- export declare type TGenerativeAIModels = typeof generativeAIModels[number];
3877
- declare const modelGroups: readonly [
3878
- "chat",
3879
- "completion"
3880
- ];
3881
- export declare type TModelGroups = typeof modelGroups[number];
4115
+ /**
4116
+ * @openapi
4117
+ *
4118
+ * components:
4119
+ * schemas:
4120
+ * TGenerativeAIModels:
4121
+ * type: string
4122
+ * enum:
4123
+ * - gpt-3.5-turbo
4124
+ * - gpt-3.5-turbo-instruct
4125
+ * - gpt-4
4126
+ * - gpt-4o
4127
+ * - gpt-4o-mini
4128
+ * - text-embedding-ada-002
4129
+ * - luminous-extended-control
4130
+ * - luminous-embedding-128
4131
+ * - claude-v1-100k
4132
+ * - claude-instant-v1
4133
+ * - claude-3-opus-20240229
4134
+ * - text-bison@001
4135
+ * - custom-model
4136
+ * - gemini-1.0-pro
4137
+ */
4138
+ export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
3882
4139
  declare const generativeAIProviders: readonly [
3883
4140
  "azureOpenAI",
3884
4141
  "openAI",
3885
4142
  "alephAlpha",
3886
4143
  "anthropic",
3887
- "googleVertexAI"
4144
+ "googleVertexAI",
4145
+ "googleGemini",
4146
+ "awsBedrock"
3888
4147
  ];
3889
- export declare type TGenerativeAIProviders = typeof generativeAIProviders[number];
4148
+ /**
4149
+ * @openapi
4150
+ *
4151
+ * components:
4152
+ * schemas:
4153
+ * TGenerativeAIProviders:
4154
+ * type: string
4155
+ * enum:
4156
+ * - azureOpenAI
4157
+ * - openAI
4158
+ * - anthropic
4159
+ * - googleVertexAI
4160
+ * - googleGemini
4161
+ * - alephAlpha
4162
+ * - awsBedrock
4163
+ */
4164
+ export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
3890
4165
  declare const generativeAIUseCases: readonly [
3891
4166
  "nlu",
3892
4167
  "knowledgeSearch",
@@ -3897,9 +4172,16 @@ declare const generativeAIUseCases: readonly [
3897
4172
  "intentSentenceGeneration",
3898
4173
  "flowGeneration",
3899
4174
  "generateNodeOutput",
3900
- "lexiconGeneration"
4175
+ "lexiconGeneration",
4176
+ "answerExtraction"
3901
4177
  ];
3902
4178
  export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
4179
+ declare const modeType: readonly [
4180
+ "chat",
4181
+ "completion",
4182
+ "embedding"
4183
+ ];
4184
+ export declare type TModeType = typeof modeType[number];
3903
4185
  export interface IGenerativeAIUseCaseSettings {
3904
4186
  largeLanguageModelId: string | null;
3905
4187
  temperature: number;
@@ -4553,6 +4835,14 @@ export interface ISharedSettings_2_0 {
4553
4835
  * $ref: '#/components/schemas/IAudioPreviewSettings_2_0'
4554
4836
  * generativeAISettings:
4555
4837
  * $ref: '#/components/schemas/IGenerativeAIModelSettings_2_0'
4838
+ * currencySettings:
4839
+ * type: object
4840
+ * properties:
4841
+ * currency:
4842
+ * type: string
4843
+ * example: "USD"
4844
+ * knowledgeAISettings:
4845
+ * $ref: '#/components/schemas/IKnowledgeAISettings_2_0'
4556
4846
  *
4557
4847
  * IAgentSettings_2_0:
4558
4848
  * allOf:
@@ -4577,6 +4867,10 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
4577
4867
  translationSettings: IAgentTranslationSettings_2_0;
4578
4868
  audioPreviewSettings: IAudioPreviewSettings_2_0;
4579
4869
  generativeAISettings: IGenerativeAISettings_2_0;
4870
+ currencySettings: {
4871
+ currency: string;
4872
+ };
4873
+ knowledgeAISettings: IKnowledgeAISettings_2_0;
4580
4874
  }
4581
4875
  /**
4582
4876
  * @openapi
@@ -4723,7 +5017,9 @@ export interface IAudioPreviewSettings_2_0 {
4723
5017
  * - azureOpenAI
4724
5018
  * - anthropic
4725
5019
  * - googleVertexAI
5020
+ * - googleGemini
4726
5021
  * - alephAlpha
5022
+ * - awsBedrock
4727
5023
  */
4728
5024
  export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
4729
5025
  /**
@@ -4762,6 +5058,40 @@ export interface IGenerativeAISettings_2_0 {
4762
5058
  [key in TGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
4763
5059
  };
4764
5060
  }
5061
+ /**
5062
+ * @openapi
5063
+ *
5064
+ * components:
5065
+ * schemas:
5066
+ * TFileExtractorOptions_2_0:
5067
+ * type: string
5068
+ * description: Options for the Knowledge AI File Extractor
5069
+ * enum:
5070
+ * - default
5071
+ * - legacy
5072
+ * - azure
5073
+ */
5074
+ export declare type TFileExtractorOptions_2_0 = "default" | "legacy" | "azure";
5075
+ /**
5076
+ * @openapi
5077
+ *
5078
+ * components:
5079
+ * schemas:
5080
+ * IKnowledgeAISettings_2_0:
5081
+ * type: object
5082
+ * properties:
5083
+ * fileExtractor:
5084
+ * $ref: '#/components/schemas/TFileExtractorOptions_2_0'
5085
+ * azureDIConnectionId:
5086
+ * type: string
5087
+ * description: ReferenceId of the Azure AI Document Intelligence Connection
5088
+ * example: "f66e99eb-db8f-433c-977f-69160d9a6bdb"
5089
+ *
5090
+ */
5091
+ export interface IKnowledgeAISettings_2_0 {
5092
+ fileExtractor: TFileExtractorOptions_2_0;
5093
+ azureDIConnectionId?: string;
5094
+ }
4765
5095
  /**
4766
5096
  * @openapi
4767
5097
  *
@@ -6222,7 +6552,9 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6222
6552
  * description: The name of the endpoint
6223
6553
  * example: New Endpoint
6224
6554
  * entrypoint:
6225
- * $ref: '#/components/schemas/TMongoId'
6555
+ * type: string
6556
+ * description: The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.
6557
+ * example: 667ed4ae16d66f47dc2a9400
6226
6558
  * active:
6227
6559
  * type: boolean
6228
6560
  * description: Toggle whether the endpoint is active or not
@@ -6248,12 +6580,6 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6248
6580
  * useAnalytics:
6249
6581
  * type: boolean
6250
6582
  * description: Whether we should store analytics for this endpoint
6251
- * useChatbaseAnalytics:
6252
- * type: boolean
6253
- * description: Whether we should use Chatbase to collect analytics
6254
- * chatbaseApikey:
6255
- * type: string
6256
- * description: The apikey for the Chatbase bot
6257
6583
  * useDashbotAnalytics:
6258
6584
  * type: boolean
6259
6585
  * description: Whether we should use Dashbot to collect analytics
@@ -6262,6 +6588,9 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6262
6588
  * description: The apikey for the dashbot bot
6263
6589
  * dashbotPlatform:
6264
6590
  * type: string
6591
+ * disableInputSanitization:
6592
+ * type: string
6593
+ * description: If true, disables input text sanitization after Input Transformer
6265
6594
  * overrideSnapshotConnections:
6266
6595
  * type: boolean
6267
6596
  * settings:
@@ -6333,6 +6662,8 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6333
6662
  * type: boolean
6334
6663
  * dynamicImageAspectRatio:
6335
6664
  * type: boolean
6665
+ * enableCollectMetadata:
6666
+ * type: boolean
6336
6667
  * enableConnectionStatusIndicator:
6337
6668
  * type: boolean
6338
6669
  * enableDemoWebchat:
@@ -6540,6 +6871,13 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6540
6871
  * agentAssistSettings:
6541
6872
  * type: object
6542
6873
  * properties:
6874
+ * copilotType:
6875
+ * type: string
6876
+ * enum:
6877
+ * - none
6878
+ * - workspace
6879
+ * - whisper
6880
+ * description: Copilot Type
6543
6881
  * agentAssistFlowId:
6544
6882
  * type: string
6545
6883
  * description: Copilot flow ID
@@ -6599,10 +6937,6 @@ export interface IEndpoint_2_0 {
6599
6937
  useContactProfiles: boolean;
6600
6938
  /** Whether we should store analytics for this endpoint */
6601
6939
  useAnalytics: boolean;
6602
- /** Whether we should use Chatbase to collect analytics */
6603
- useChatbaseAnalytics: boolean;
6604
- /** The apikey for the Chatbase bot */
6605
- chatbaseApikey: string;
6606
6940
  /** Whether we should use Dashbot to collect analytics */
6607
6941
  useDashbotAnalytics: boolean;
6608
6942
  /** The apikey for the dashbot bot */
@@ -6614,6 +6948,10 @@ export interface IEndpoint_2_0 {
6614
6948
  * is true.
6615
6949
  */
6616
6950
  dashbotPlatform: TDashbotPlatform;
6951
+ /**
6952
+ * If set to `true`, disables input sanitization
6953
+ */
6954
+ disableInputSanitization: boolean;
6617
6955
  /**
6618
6956
  * Optional endpoint specific settings e.g. Facebook Page token
6619
6957
  */
@@ -7995,6 +8333,7 @@ export interface IConnection extends IEntityMeta {
7995
8333
  type: string;
7996
8334
  projectReference: TMongoId;
7997
8335
  organisationReference: TMongoId;
8336
+ isDeprecated: boolean;
7998
8337
  }
7999
8338
  export interface IGraphConnection {
8000
8339
  type: "connection";
@@ -8013,6 +8352,10 @@ export interface IAlephAlphaMeta {
8013
8352
  export interface IAnthropicMeta {
8014
8353
  customModel?: string;
8015
8354
  }
8355
+ export interface IAwsBedrockMeta {
8356
+ region: string;
8357
+ customModel?: string;
8358
+ }
8016
8359
  export interface IAzureOpenAIMeta {
8017
8360
  resourceName?: string;
8018
8361
  deploymentName?: string;
@@ -8026,13 +8369,17 @@ export interface IGoogleVertexAIMeta {
8026
8369
  publisher?: string;
8027
8370
  customModel?: string;
8028
8371
  }
8372
+ export interface IGoogleGeminiMeta {
8373
+ location: string;
8374
+ customModel?: string;
8375
+ }
8029
8376
  export interface ILargeLanguageModel extends IEntityMeta {
8030
8377
  _id: TMongoId;
8031
8378
  referenceId: string;
8032
8379
  name: string;
8033
8380
  description: string;
8034
8381
  modelType: TGenerativeAIModels;
8035
- modelGroup?: TModelGroups;
8382
+ modelGroup?: TModeType;
8036
8383
  isCustomModel?: boolean;
8037
8384
  provider: TGenerativeAIProviders;
8038
8385
  connectionId: string;
@@ -8041,9 +8388,11 @@ export interface ILargeLanguageModel extends IEntityMeta {
8041
8388
  organisationReference: TMongoId;
8042
8389
  azureOpenAI?: IAzureOpenAIMeta;
8043
8390
  googleVertexAI?: IGoogleVertexAIMeta;
8391
+ googleGemini?: IGoogleGeminiMeta;
8044
8392
  openAI?: IOpenAIMeta;
8045
8393
  alephAlpha?: IAlephAlphaMeta;
8046
8394
  anthropic?: IAnthropicMeta;
8395
+ awsBedrock?: IAwsBedrockMeta;
8047
8396
  }
8048
8397
  export interface IGraphLargeLanguageModelDependencyAttachment {
8049
8398
  _id: string;
@@ -8210,6 +8559,7 @@ export interface IHttpRequestNodeSharedConfig {
8210
8559
  allowSelfSigned: boolean;
8211
8560
  abortOnError: boolean;
8212
8561
  errorLogging: "none" | "basic" | "full";
8562
+ debugLogging: "none" | "request" | "response" | "full";
8213
8563
  logWarning: string;
8214
8564
  }
8215
8565
  export interface IHttpRequestNodeOAuthConfig extends IHttpRequestNodeSharedConfig {
@@ -8262,7 +8612,9 @@ declare const arrayTDebugEventTypes: readonly [
8262
8612
  "input",
8263
8613
  "output",
8264
8614
  "switchedFlow",
8265
- "nluWarning"
8615
+ "nluWarning",
8616
+ "debugMessage",
8617
+ "debugError"
8266
8618
  ];
8267
8619
  export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
8268
8620
  export interface IInputChangedEventPayload {
@@ -8345,7 +8697,21 @@ export interface INluWarningEventPayload {
8345
8697
  errorMessage: string;
8346
8698
  sessionId?: string;
8347
8699
  }
8348
- export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload;
8700
+ export interface IDebugEventMessagePayloadBase {
8701
+ sessionId?: string;
8702
+ header?: string;
8703
+ metadata?: IOutputEventMetadata;
8704
+ }
8705
+ export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
8706
+ type: "text";
8707
+ message: string;
8708
+ }
8709
+ export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
8710
+ type: "json";
8711
+ message: object;
8712
+ }
8713
+ export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
8714
+ export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload;
8349
8715
  declare const audioPreviewProviders: readonly [
8350
8716
  "microsoft",
8351
8717
  "google",
@@ -8383,6 +8749,20 @@ export interface INluEmbeddingCredentials {
8383
8749
  apiDeploymentName?: string;
8384
8750
  apiVersion?: string;
8385
8751
  }
8752
+ export interface ISetAppStateOverlaySettings {
8753
+ autoOpen: boolean;
8754
+ closeOnSubmit: boolean;
8755
+ feedbackMessage: string;
8756
+ screenTitle: string;
8757
+ sendEventOnCloseIconClick: boolean;
8758
+ showCloseIcon: boolean;
8759
+ }
8760
+ export interface ISetAppStateOverlaySettingsMetaData {
8761
+ overlaySettings: ISetAppStateOverlaySettings;
8762
+ endpointType: TEndpointType;
8763
+ url: string;
8764
+ URLToken: string;
8765
+ }
8386
8766
  export interface IVoiceGateway2VadParams {
8387
8767
  enable?: boolean;
8388
8768
  voiceMs?: number;
@@ -8559,6 +8939,7 @@ export declare type TVoiceGatewayNuanceFormatting = {
8559
8939
  };
8560
8940
  export declare type TVoiceGateway2InputType = "digits" | "speech";
8561
8941
  export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
8942
+ export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
8562
8943
  export interface IVoiceGateway2BargeInParams {
8563
8944
  enable?: boolean;
8564
8945
  sticky?: boolean;
@@ -8579,7 +8960,15 @@ export interface IVoiceGateway2ActivityParams {
8579
8960
  user?: IVoiceGateway2CognigyUserInputConfigParams;
8580
8961
  dtmf?: boolean;
8581
8962
  sessionParams?: IVoiceGateway2ActivityParams;
8963
+ fillerNoise?: IVoiceGateway2FillerNoiseParams;
8964
+ flow?: IVoiceGateway2CognigyFlowInputConfigParams;
8965
+ }
8966
+ export interface IVoiceGateway2FillerNoiseParams {
8967
+ enable: boolean;
8968
+ url?: string;
8969
+ startDelaySecs?: number;
8582
8970
  }
8971
+ export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
8583
8972
  export interface IVoiceGateway2CognigyUserInputConfigParams {
8584
8973
  noInputMode?: TVoiceGateway2UserNoInputMode;
8585
8974
  noInputTimeout?: number;
@@ -8588,6 +8977,14 @@ export interface IVoiceGateway2CognigyUserInputConfigParams {
8588
8977
  noInputUrl?: string;
8589
8978
  userNoInputAutoHangup?: boolean;
8590
8979
  }
8980
+ export interface IVoiceGateway2CognigyFlowInputConfigParams {
8981
+ flowNoInputEnable?: boolean;
8982
+ flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
8983
+ flowNoInputTimeout?: number;
8984
+ flowNoInputRetries?: number;
8985
+ flowNoInputSpeech?: string;
8986
+ flowNoInputUrl?: string;
8987
+ }
8591
8988
  export interface IGetNluPipelineParams {
8592
8989
  parseIntents?: boolean;
8593
8990
  parseSlots?: boolean;
@@ -8623,6 +9020,10 @@ export interface IHandoverRequestStatus {
8623
9020
  nodeType: "question" | "handoverToAgent";
8624
9021
  agentAssistInitMessage: string;
8625
9022
  processedInitMessage?: boolean;
9023
+ /**
9024
+ * Indicates whether an "Assist / Copilot Flow"
9025
+ * should be used during the Handover Request
9026
+ */
8626
9027
  agentAssistConfigured: boolean;
8627
9028
  providerResponse: TAnyProviderResponse;
8628
9029
  sendOnQueueEvent?: boolean;
@@ -8660,6 +9061,14 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
8660
9061
  agentAssistInitMessage: string;
8661
9062
  sendOnQueueEvent: boolean;
8662
9063
  sendOnActiveEvent: boolean;
9064
+ getQueuePosition: boolean;
9065
+ getEstimatedWaitTime: boolean;
9066
+ alternativeUpdate: boolean;
9067
+ updateIntervalQueuePosition: number;
9068
+ updateIntervalEstimatedWaitTime: number;
9069
+ maximumQueuePosition: number;
9070
+ maximumEstimatedWaitTime: number;
9071
+ alternativeText: string;
8663
9072
  };
8664
9073
  nodeType?: "question" | "handoverToAgent";
8665
9074
  }
@@ -8775,6 +9184,8 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
8775
9184
  repromptLLMProvider: string;
8776
9185
  repromptLLMPrompt: string;
8777
9186
  repromptLLMTurns: number;
9187
+ repromptLLMStream: boolean;
9188
+ repromptLLMStreamStopTokens: string[];
8778
9189
  repromptType: "text" | "say" | "llm" | "execute";
8779
9190
  repromptSay: ISayParams["config"]["say"];
8780
9191
  repromptFlowNode: {
@@ -8953,51 +9364,176 @@ export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
8953
9364
  type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber" | "llm_entity";
8954
9365
  }
8955
9366
  export declare type TRephraseWithAIQuestionType = IActiveQuestion["type"] | IOptionalQuestionNodeOtherConfig["type"];
8956
- export interface ILastConversationEntry {
8957
- source: "user" | "bot";
8958
- text: string;
8959
- }
8960
- export interface OpenAIChatMessage {
8961
- role: "system" | "user" | "assistant";
8962
- content: string;
8963
- }
8964
- export interface IGenerativeSlot {
8965
- tag: string;
8966
- description: string;
8967
- value: string;
8968
- optional?: boolean;
8969
- validation?: {
8970
- type: string;
8971
- value: string;
8972
- invalidReason: string;
9367
+ export interface INodeToExecute {
9368
+ nodeId: string;
9369
+ flowExecutionCallerId?: string;
9370
+ flowId: string;
9371
+ cognigyScriptInput?: IExecutionObjects["input"];
9372
+ inputObjectToRestore?: IExecutionObjects["input"];
9373
+ nextMainFlowNodeInputObject?: IExecutionObjects["input"];
9374
+ ignoreSlotScope?: boolean;
9375
+ trackAnalyticsStepOptions?: {
9376
+ entityReferenceId: string;
9377
+ flowName: string;
9378
+ flowReferenceId: string;
9379
+ type: "intent" | "node";
9380
+ stepLabel: string;
8973
9381
  };
8974
- invalid?: boolean;
9382
+ type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
8975
9383
  }
8976
- export declare type TCompletionPrompt = {
8977
- prompt: string;
8978
- };
8979
- export declare type TChatPrompt = {
8980
- messages: Array<{
8981
- role: "user" | "system" | "assistant";
8982
- content: string;
8983
- }>;
8984
- };
8985
- export interface IRunGenerativeAIPromptOptions {
9384
+ export interface ISessionState extends ISessionStateWithoutMeta {
8986
9385
  /**
8987
- * @deprecated should not inject the prompt anymore, use getPrompt() instead
9386
+ * The Mongo ObjectId. Typed as any due
9387
+ * to extending the mongoose document below.
8988
9388
  */
8989
- prompt?: string;
8990
- /** Text to calculate the embedding vector */
8991
- embeddingText?: string;
9389
+ _id: any;
8992
9390
  /**
8993
- * Instead of a prompt, we can also provide messages in OpenAI's chat format
9391
+ * The id of the user.
8994
9392
  */
8995
- chat?: OpenAIChatMessage[];
8996
- /** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
8997
- promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
8998
- /** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
8999
- temperature?: number;
9000
- /** model - (Optional) The OpenAI model to use. Defaults to 'text-davinci-003' */
9393
+ userId: string;
9394
+ /**
9395
+ * The unique identifier of the
9396
+ * current session (conversation) the
9397
+ * user is having.
9398
+ */
9399
+ sessionId: string;
9400
+ /**
9401
+ * The 'epoch' is a value which we will increase whenever
9402
+ * we dispatch a change for the session state. We use it
9403
+ * to avoid that we apply outdated updates to the session state
9404
+ */
9405
+ epoch: number;
9406
+ /**
9407
+ * Date when this object will expire in the database. We utilize a
9408
+ * time-based index in MongoDB.
9409
+ */
9410
+ expiresAt: Date;
9411
+ }
9412
+ export interface ISessionStateWithoutMeta {
9413
+ /**
9414
+ * The context object that the user
9415
+ * can manipulate in the Flow.
9416
+ * Moves from string at storage to object in memory
9417
+ */
9418
+ context: {
9419
+ [key: string]: any;
9420
+ } | string;
9421
+ /**
9422
+ * The system context stores information
9423
+ * like execution number and Flow paths.
9424
+ */
9425
+ systemContext: {
9426
+ [key: string]: any;
9427
+ };
9428
+ /**
9429
+ * The current Flow state.
9430
+ */
9431
+ state: string;
9432
+ flowId: string;
9433
+ thinkFlowReferenceIdMarker: string;
9434
+ localeReferenceId: string;
9435
+ /**
9436
+ * The snapshot / project
9437
+ * the user is using
9438
+ */
9439
+ entrypoint: string;
9440
+ entrypointType: "project" | "snapshot";
9441
+ projectId: string;
9442
+ timezoneOffset: number | string;
9443
+ /**
9444
+ * Forms/Processes need the any slots of the calling flow to map injected any slots
9445
+ */
9446
+ injectedAnySlots: {
9447
+ [key: string]: string;
9448
+ };
9449
+ reconfirmedSentences: {
9450
+ [key: string]: string[];
9451
+ };
9452
+ endpointClientInstanceId?: string;
9453
+ endpointId?: string;
9454
+ previousInputId: string | null;
9455
+ previousInputMessageAmount: number;
9456
+ sensitiveLoggingSettings: ISensitiveLoggingSettings;
9457
+ sentWelcomeMessage?: boolean;
9458
+ nodesToExecuteStack?: INodeToExecute[];
9459
+ trackedSteps?: IAnalyticsStepData["trackedSteps"];
9460
+ trackedGoals?: IAnalyticsSourceData["trackedGoals"];
9461
+ handoverEscalations?: IAnalyticsSourceData["handoverEscalations"];
9462
+ previousInputText?: IAnalyticsSourceData["previousInputText"];
9463
+ previousInputData?: IAnalyticsSourceData["previousInputData"];
9464
+ previousInputAttachments?: IAnalyticsSourceData["previousInputAttachments"] | any;
9465
+ previousSource?: IAnalyticsSourceData["previousSource"];
9466
+ handoverRequest?: IHandoverRequestStatus;
9467
+ frustration?: number;
9468
+ /**
9469
+ * The list of nodes that were visited in the last
9470
+ * Flow execution
9471
+ */
9472
+ lastFlowPath?: string;
9473
+ apps?: IAppsSessionState;
9474
+ /**
9475
+ * The last user input and bot output strings.
9476
+ * Only filled & used if Generative AI feature is enabled.
9477
+ */
9478
+ lastConversationEntries?: ILastConversationEntry[];
9479
+ analytics: ISessionStateAnalytcis;
9480
+ }
9481
+ export interface ISessionStateAnalytcis {
9482
+ milestoneCycleIds: {
9483
+ [milestoneId: string]: string;
9484
+ };
9485
+ }
9486
+ export interface ILastConversationEntry {
9487
+ source: "user" | "bot";
9488
+ text: string;
9489
+ }
9490
+ export interface IAppsSessionState {
9491
+ session: {
9492
+ token: string;
9493
+ };
9494
+ customization: {};
9495
+ }
9496
+ export interface OpenAIChatMessage {
9497
+ role: "system" | "user" | "assistant";
9498
+ content: string;
9499
+ }
9500
+ export interface IGenerativeSlot {
9501
+ tag: string;
9502
+ description: string;
9503
+ value: string;
9504
+ optional?: boolean;
9505
+ validation?: {
9506
+ type: string;
9507
+ value: string;
9508
+ invalidReason: string;
9509
+ };
9510
+ invalid?: boolean;
9511
+ }
9512
+ export declare type TCompletionPrompt = {
9513
+ prompt: string;
9514
+ };
9515
+ export declare type TChatPrompt = {
9516
+ messages: Array<{
9517
+ role: "user" | "system" | "assistant";
9518
+ content: string;
9519
+ }>;
9520
+ };
9521
+ export interface IRunGenerativeAIPromptOptions {
9522
+ /**
9523
+ * @deprecated should not inject the prompt anymore, use getPrompt() instead
9524
+ */
9525
+ prompt?: string;
9526
+ /** Text to calculate the embedding vector */
9527
+ embeddingText?: string;
9528
+ /**
9529
+ * Instead of a prompt, we can also provide messages in OpenAI's chat format
9530
+ */
9531
+ chat?: OpenAIChatMessage[];
9532
+ /** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
9533
+ promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
9534
+ /** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
9535
+ temperature?: number;
9536
+ /** model - (Optional) The OpenAI model to use. Defaults to 'gpt-4o' */
9001
9537
  model?: TGenerativeAIModels;
9002
9538
  /** timeoutInMs - (Optional) The timeout for the request in ms. Defaults to 10000 */
9003
9539
  timeoutInMs?: number;
@@ -9052,6 +9588,10 @@ export interface IRunGenerativeAIPromptOptions {
9052
9588
  * flushing of token buffer to the provided handler
9053
9589
  */
9054
9590
  streamStopTokens?: string[];
9591
+ /**
9592
+ * Array of regular expressions which prevent the stream buffer to be flushed
9593
+ */
9594
+ streamStopTokenOverrides?: string[];
9055
9595
  /**
9056
9596
  * A string denoting the reference ID of the chosen LLM provider
9057
9597
  */
@@ -9077,13 +9617,53 @@ export interface IRunGenerativeAIPromptOptions {
9077
9617
  */
9078
9618
  customRequestOptions?: any;
9079
9619
  }
9080
- export interface IOpenAiCredentials {
9081
- apiType?: TGenerativeAIProviders;
9620
+ export interface IAzureOpenAIProviderFieldsV2 {
9082
9621
  apiKey: string;
9083
- apiCustomBaseUrl?: string;
9084
- apiResourceName?: string;
9085
- apiDeploymentName?: string;
9086
- apiVersion?: string;
9622
+ }
9623
+ export interface IAzureOpenAIProviderOauth2Fields {
9624
+ clientId: string;
9625
+ clientSecret: string;
9626
+ oauthUrl: string;
9627
+ scope: string;
9628
+ }
9629
+ export interface IParams {
9630
+ [key: string]: any;
9631
+ }
9632
+ export interface IConnectionSchemaField {
9633
+ _id?: TMongoId;
9634
+ /** The field name, e.g. 'client_id' */
9635
+ fieldName: string;
9636
+ required?: boolean;
9637
+ label?: string;
9638
+ description?: string;
9639
+ params?: IParams;
9640
+ }
9641
+ export interface IConnectionSchema extends IEntityMeta {
9642
+ _id: TMongoId;
9643
+ extension: string;
9644
+ isCognigy: boolean;
9645
+ /** The type of the connection, e.g. 'oauth' */
9646
+ type: string;
9647
+ /** An additional label for the connection schema - by default we will pick the 'type' */
9648
+ label: string;
9649
+ /** The actual fields */
9650
+ fields: IConnectionSchemaField[];
9651
+ projectReference: TMongoId;
9652
+ organisationReference: TMongoId;
9653
+ }
9654
+ /** Logical operators that can be used when filtering tags for search */
9655
+ export declare type ISearchTagsFilterOps = "and" | "or";
9656
+ export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields {
9657
+ tokenCacheKey: string;
9658
+ }
9659
+ export interface ISearchLLMCredentials {
9660
+ provider: TGenerativeAIProviders;
9661
+ connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields;
9662
+ providerMetaData: IAzureOpenAIMeta;
9663
+ }
9664
+ export interface ISearchTagsData {
9665
+ tags: string[];
9666
+ op: ISearchTagsFilterOps;
9087
9667
  }
9088
9668
  export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
9089
9669
  query: string;
@@ -9092,9 +9672,9 @@ export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
9092
9672
  topK: number;
9093
9673
  language: string;
9094
9674
  knowledgeStoreIds?: string[];
9095
- openAiCredentials?: IOpenAiCredentials;
9675
+ llmCredentials?: ISearchLLMCredentials;
9096
9676
  sessionId?: string;
9097
- tags?: string[];
9677
+ tagsData?: ISearchTagsData;
9098
9678
  }
9099
9679
  export interface IKnowledgeSearchReturnValue {
9100
9680
  status: "success" | "error";
@@ -9120,6 +9700,95 @@ export interface IKnowledgeSearchReturnValue {
9120
9700
  ];
9121
9701
  };
9122
9702
  }
9703
+ export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
9704
+ config: {
9705
+ lexiconId: string;
9706
+ keyphrase: string;
9707
+ slots: string[];
9708
+ synonyms: string[];
9709
+ };
9710
+ }
9711
+ export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
9712
+ config: {
9713
+ text: string;
9714
+ data: any;
9715
+ mode: string;
9716
+ contextKey: string;
9717
+ inputKey: string;
9718
+ parseIntents: boolean;
9719
+ parseSlots: boolean;
9720
+ parseSystemSlots: boolean;
9721
+ findType: boolean;
9722
+ processDefaultReply: boolean;
9723
+ };
9724
+ }
9725
+ export interface IRegexSlotFillerConfig {
9726
+ regex: string;
9727
+ flags: string;
9728
+ slot: string;
9729
+ }
9730
+ export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
9731
+ config: IRegexSlotFillerConfig;
9732
+ }
9733
+ export interface IMatchPatternParams extends INodeFunctionBaseParams {
9734
+ config: {
9735
+ patterns: string[];
9736
+ patternGroupName: string;
9737
+ alternateInput: string;
9738
+ detailedCompoundSlots: boolean;
9739
+ createNewSlots: boolean;
9740
+ tagExistingSlots: boolean;
9741
+ useFullSystemslotText: boolean;
9742
+ };
9743
+ }
9744
+ export interface IFuzzySearchParams extends INodeFunctionBaseParams {
9745
+ config: {
9746
+ searchPattern: string;
9747
+ items: any;
9748
+ isCaseSensitive: boolean;
9749
+ includeScore: boolean;
9750
+ includeMatches: boolean;
9751
+ minMatchCharLength: number;
9752
+ shouldSort: boolean;
9753
+ findAllMatches: boolean;
9754
+ location: number;
9755
+ threshold: number;
9756
+ distance: number;
9757
+ ignoreLocation: boolean;
9758
+ storeLocation: string;
9759
+ inputKey: string;
9760
+ contextKey: string;
9761
+ };
9762
+ }
9763
+ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
9764
+ config: {
9765
+ slotsConfig: IGenerativeSlot[];
9766
+ amountOfLastUserInputs: number;
9767
+ maxQuestions: number;
9768
+ temperature: number;
9769
+ storeLocation: string;
9770
+ contextKey: string;
9771
+ inputKey: string;
9772
+ timeout: number;
9773
+ };
9774
+ }
9775
+ export interface IMilestoneAnalyticsPayload {
9776
+ analyticsdata: IMilestoneEscalations;
9777
+ data: IPayloadBaseMetaData;
9778
+ }
9779
+ export interface IMilestoneAnalyticsData {
9780
+ projectId: string;
9781
+ organisationId: string;
9782
+ sessionId: string;
9783
+ version: string;
9784
+ timestamp: Date;
9785
+ milestoneCycleId: string;
9786
+ stepId: string;
9787
+ milestoneId: string;
9788
+ contactId: string;
9789
+ }
9790
+ export interface IMilestoneEscalations extends IMilestoneAnalyticsData, IAnalytiscEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
9791
+ }
9123
9792
  export interface IGetConversationTranscriptParams {
9124
9793
  turnLimit: number;
9125
9794
  }
@@ -9161,6 +9830,7 @@ export interface IRephraseSentenceWithAIOptions {
9161
9830
  question?: string;
9162
9831
  answer?: string;
9163
9832
  }
9833
+ export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics">>;
9164
9834
  export interface IActions {
9165
9835
  addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
9166
9836
  addHandoverInactivityTimer?: (params: {
@@ -9168,12 +9838,13 @@ export interface IActions {
9168
9838
  }) => Promise<void>;
9169
9839
  activateProfile?: () => Promise<any>;
9170
9840
  addLexiconKeyphrase?: (lexicon: string, keyphrase: string, slots: Array<string>, synonyms: Array<string>, data?: Object) => void;
9171
- addToContext?: (key: string, value: any, mode: string) => void;
9841
+ addToContext?: (key: string, value: any, mode: "simple" | "array") => void;
9172
9842
  cancelHandoverRequest?: (cancelHandoverInProvider?: boolean) => Promise<void>;
9173
9843
  checkAgentAvailability?: (params: ICheckAgentAvailabilityNodeParams) => void;
9174
9844
  checkFrustration?: (nodeId: string, input: any) => void;
9175
9845
  checkThink?: (id: string) => boolean;
9176
9846
  completeGoal?: (goalData: IAnalyticsDataGoals) => void;
9847
+ countGPTTokens: (prompt: string) => number;
9177
9848
  deactivateProfile?: (deleteData: boolean) => Promise<any>;
9178
9849
  deleteContext?: (key: string) => void;
9179
9850
  deleteProfile?: () => Promise<any>;
@@ -9188,8 +9859,18 @@ export interface IActions {
9188
9859
  executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
9189
9860
  executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
9190
9861
  handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
9191
- getAnalyticsData?: () => IAnalyticsSourceData;
9192
- setAnalyticsData?: (key: string, value: any) => void;
9862
+ /**
9863
+ * returns the analytics data object - mutable
9864
+ * @deprecated
9865
+ */
9866
+ getAnalyticsData: () => IAnalyticsSourceData;
9867
+ /** returns a copy of the analytics data object - immutable */
9868
+ getAnalyticsDataCopy: (key: string, value: any) => void;
9869
+ setAnalyticsData?: (key: keyof IAnalyticsSourceData, value: any) => void;
9870
+ /** returns a copy of the analytics data object - immutable */
9871
+ getSessionStateCopy: () => ISessionState;
9872
+ /** sets a key value pair in the session state in the brain */
9873
+ setSessionState: (key: keyof TBrainSessionState, value: any) => void;
9193
9874
  getInjectedAnySlots?: () => {
9194
9875
  [key: string]: string;
9195
9876
  };
@@ -9207,6 +9888,10 @@ export interface IActions {
9207
9888
  targetRuntimeVersion: number;
9208
9889
  }) => boolean;
9209
9890
  log?: (level: string, text: string) => void;
9891
+ logDebugMessage?: (message: string | object, header?: string) => void;
9892
+ logDebugError?: (message: string | object, header?: string) => void;
9893
+ logDebugMessageWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
9894
+ logDebugErrorWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
9210
9895
  mergeProfile?: (contactId: string) => Promise<any>;
9211
9896
  parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
9212
9897
  parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
@@ -9239,6 +9924,7 @@ export interface IActions {
9239
9924
  }) => void;
9240
9925
  setLastTopic?: (text: string, type: any, age: number) => void;
9241
9926
  setLocaleReferenceId?: (localeReferenceID: string) => void;
9927
+ setRegexSlot: (regexSlotFillerParams: IRegexSlotFillerParams) => void;
9242
9928
  setSensitiveLoggingSettings?: (settings: ISensitiveLoggingSettings, traceId: string) => void;
9243
9929
  setState?: (state: string) => void;
9244
9930
  setSystemContext?: (key: string, value: any) => void;
@@ -9255,6 +9941,24 @@ export interface IActions {
9255
9941
  matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
9256
9942
  getAgentAssistConfigId: () => string;
9257
9943
  getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
9944
+ getMetadata: () => IGetMetaDataActionValue;
9945
+ sendTrackMilestone: (payload: IMilestoneAnalyticsPayload) => Promise<void>;
9946
+ }
9947
+ export interface IGetMetaDataActionValue {
9948
+ sessionId: string;
9949
+ projectId: string;
9950
+ organisationId: string;
9951
+ traceId: string;
9952
+ endpointUrlToken: string;
9953
+ endpointName: string;
9954
+ channel: string;
9955
+ localeReferenceId: string;
9956
+ localeName: string;
9957
+ endpointType: TEndpointType;
9958
+ snapshotId: string;
9959
+ snapshotName: string;
9960
+ isFollowSessionActive: boolean;
9961
+ contactId: string;
9258
9962
  }
9259
9963
  export interface ICognigyNLPProperties {
9260
9964
  /** The original text of the user */
@@ -9654,14 +10358,6 @@ export interface IMongoAggregateNodeParams extends INodeFunctionBaseParams {
9654
10358
  stopOnError: boolean;
9655
10359
  };
9656
10360
  }
9657
- export interface IRegexSlotFillerConfig {
9658
- regex: string;
9659
- flags: string;
9660
- slot: string;
9661
- }
9662
- export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
9663
- config: IRegexSlotFillerConfig;
9664
- }
9665
10361
  declare const ruleOperands: readonly [
9666
10362
  "lt",
9667
10363
  "lte",
@@ -9780,7 +10476,6 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
9780
10476
  };
9781
10477
  }
9782
10478
  export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal" | "getConversationTranscript"> {
9783
- getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
9784
10479
  setNextNode: (nodeId: string, newFlowId?: string) => void;
9785
10480
  resetNextNodes: () => void;
9786
10481
  stopExecution: () => void;
@@ -9850,7 +10545,6 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
9850
10545
  traceId: string;
9851
10546
  }) => Promise<any>;
9852
10547
  fuseSearch?: (list: any, options: any, pattern: string) => any;
9853
- setRegexSlot: (regexSlotFillerParams: IRegexSlotFillerParams) => void;
9854
10548
  addToInput: (key: string, value: any) => void;
9855
10549
  resetCognigyScriptInput?: () => void;
9856
10550
  setForwardDatesOnly?: () => void;
@@ -9862,14 +10556,18 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
9862
10556
  appInterimScreenOverride?: string;
9863
10557
  appConnectScreenOverride?: string;
9864
10558
  }) => Promise<string>;
9865
- setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown>) => void;
10559
+ setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown>, options?: {
10560
+ webchat3?: {
10561
+ overlaySettingsMetaData?: ISetAppStateOverlaySettingsMetaData;
10562
+ };
10563
+ }) => void;
9866
10564
  getAppSessionPin: () => Promise<string>;
9867
10565
  validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
9868
10566
  completeGoal: (goal: string) => void;
9869
10567
  knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
9870
10568
  matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
9871
10569
  getAgentAssistConfigId: () => string;
9872
- countGPTTokens?: (prompt: string) => number;
10570
+ countGPTTokens: (prompt: string) => number;
9873
10571
  getConversationTranscript?: (mode: string, options?: any) => any;
9874
10572
  }
9875
10573
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
@@ -10061,6 +10759,7 @@ declare const nodeFieldTypes: readonly [
10061
10759
  "knowledgeStoreSelect",
10062
10760
  "knowledgeSourceTags",
10063
10761
  "llmSelect",
10762
+ "milestoneAndStepsSelect",
10064
10763
  "lexicon",
10065
10764
  "localeField",
10066
10765
  "node",
@@ -10137,6 +10836,11 @@ export interface INodeField<K extends string | number | symbol = string> {
10137
10836
  [key: string]: any;
10138
10837
  };
10139
10838
  optionsResolver?: INodeOptionsResolver;
10839
+ resetOption?: IResetOption;
10840
+ }
10841
+ export interface IResetOption {
10842
+ lookupValue: string;
10843
+ fieldsToReset: string[];
10140
10844
  }
10141
10845
  export interface INodeSection {
10142
10846
  /** Unique identifier for this section within all sections of a descriptor, e.g. 'authentication' */
@@ -10196,33 +10900,8 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
10196
10900
  /** The form defines how fields and sections should be render in order */
10197
10901
  form?: INodeFieldAndSectionFormElement[];
10198
10902
  }
10199
- export interface IParams {
10200
- [key: string]: any;
10201
- }
10202
- export interface IConnectionSchemaField {
10203
- _id?: TMongoId;
10204
- /** The field name, e.g. 'client_id' */
10205
- fieldName: string;
10206
- required?: boolean;
10207
- label?: string;
10208
- description?: string;
10209
- params?: IParams;
10210
- }
10211
- export interface IConnectionSchema extends IEntityMeta {
10212
- _id: TMongoId;
10213
- extension: string;
10214
- isCognigy: boolean;
10215
- /** The type of the connection, e.g. 'oauth' */
10216
- type: string;
10217
- /** An additional label for the connection schema - by default we will pick the 'type' */
10218
- label: string;
10219
- /** The actual fields */
10220
- fields: IConnectionSchemaField[];
10221
- projectReference: TMongoId;
10222
- organisationReference: TMongoId;
10223
- }
10224
- export interface IAppTemplate extends IEntityMeta {
10225
- /** The object id of this app template */
10903
+ export interface IAppTemplate extends IEntityMeta {
10904
+ /** The object id of this app template */
10226
10905
  _id: TMongoId;
10227
10906
  /** The technical type of the app template, e.g. 'flightSeatPicker' */
10228
10907
  type: string;
@@ -10490,7 +11169,7 @@ export interface IGraphPlaybook {
10490
11169
  export interface IMilestone extends IEntityMeta {
10491
11170
  _id: TMongoId;
10492
11171
  name: string;
10493
- version: number;
11172
+ version: string;
10494
11173
  steps: IMilestoneStep[];
10495
11174
  description: string;
10496
11175
  referenceId: string;
@@ -13412,6 +14091,9 @@ export interface IComposeSnapshotDownloadLinkRestReturnValue_2_0 {
13412
14091
  * type: string
13413
14092
  * description: The name of the Connection
13414
14093
  * example: azure
14094
+ * isDeprecated:
14095
+ * type: boolean
14096
+ * description: Marked 'true' if the connection type is deprecated
13415
14097
  * connectionSchema:
13416
14098
  * type: object
13417
14099
  * properties:
@@ -13427,6 +14109,7 @@ export interface IConnectionIndexItem_2_0 {
13427
14109
  _id: TMongoId;
13428
14110
  referenceId: string;
13429
14111
  name: string;
14112
+ isDeprecated: boolean;
13430
14113
  extension: string;
13431
14114
  type: string;
13432
14115
  createdAt: number;
@@ -13460,6 +14143,9 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
13460
14143
  * name:
13461
14144
  * type: string
13462
14145
  * example: "some name"
14146
+ * isDeprecated:
14147
+ * type: boolean
14148
+ * description: Marked 'true' if the connection type is deprecated
13463
14149
  * type:
13464
14150
  * type: string
13465
14151
  * example: "http_basic"
@@ -13480,6 +14166,9 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
13480
14166
  * type: string
13481
14167
  * description: The name of the Connection
13482
14168
  * example: Azure API
14169
+ * isDeprecated:
14170
+ * type: boolean
14171
+ * description: Marked 'true' if the connection type is deprecated
13483
14172
  * connectionSchema:
13484
14173
  * type: object
13485
14174
  * description: Identifies the schema which should be used to validate the connection fields.
@@ -13503,6 +14192,7 @@ export interface IConnection_2_0 {
13503
14192
  referenceId: string;
13504
14193
  _id: TMongoId;
13505
14194
  name: string;
14195
+ isDeprecated: boolean;
13506
14196
  fields: IConnectionFields;
13507
14197
  extension: string;
13508
14198
  type: string;
@@ -13588,294 +14278,6 @@ export interface IDeleteConnectionFieldRestData_2_0 extends IDeleteConnectionFie
13588
14278
  }
13589
14279
  export interface IDeleteConnectionFieldRestReturnValue_2_0 {
13590
14280
  }
13591
- declare const journeyStepGoals: readonly [
13592
- "createAgent",
13593
- "createFlow",
13594
- "createEndpoint",
13595
- "createLexicon",
13596
- "createSnapshot",
13597
- "createKnowledgeStore",
13598
- "createKnowledgeSource",
13599
- "openWebchat",
13600
- "createCodeNode",
13601
- "createHttpRequestNode",
13602
- "createIfNode",
13603
- "createQuestionNode",
13604
- "createSayNode",
13605
- "createLookupNode",
13606
- "createKnowledgeSearchNode",
13607
- "createSearchExtractOutputNode",
13608
- "createGptConversationNode",
13609
- "createLlmPromptNode",
13610
- "updateCaseNode",
13611
- "updateHttpRequestNode",
13612
- "updateIfNode",
13613
- "updateQuestionNode",
13614
- "updateSayNode",
13615
- "createIntent",
13616
- "trainIntents",
13617
- "activateLexicon",
13618
- "useToken",
13619
- "addKeyphrase",
13620
- "expertModeOn",
13621
- "openContextTab",
13622
- "openInfoTab",
13623
- "openIP",
13624
- "sendMessage",
13625
- "prepareSnapshotDownload",
13626
- "restoreSnapshot"
13627
- ];
13628
- export declare type TJourneyStepGoals = typeof journeyStepGoals[number];
13629
- /**
13630
- * @openapi
13631
- *
13632
- * components:
13633
- * schemas:
13634
- * IJourneyStep_2_0:
13635
- * allOf:
13636
- * - type: object
13637
- * properties:
13638
- * referenceId:
13639
- * type: string
13640
- * name:
13641
- * type: string
13642
- * description: The name of this journey step, e.g. 'Create a Virtual Agent'
13643
- * link:
13644
- * type: string
13645
- * description: A hyperlink to our helpdesk for this journey step.
13646
- * summary:
13647
- * type: string
13648
- * description: A quick summary what this journey step is about.
13649
- * description:
13650
- * type: string
13651
- * description: The full-blown description for this journey step containing rich media.
13652
- * goals:
13653
- * type: array
13654
- * items:
13655
- * type: string
13656
- * description: Internal name of the goal.
13657
- */
13658
- export interface IJourneyStep_2_0 {
13659
- /** The reference id of the journey step */
13660
- referenceId: string;
13661
- /** The name of this journey step */
13662
- name: string;
13663
- /** Hyperlink to our helpdesk */
13664
- link: string;
13665
- /** Summary of this journey step */
13666
- summary: string;
13667
- /** Full description */
13668
- description: string;
13669
- /** The goals which need to be completed in order to complete this step */
13670
- goals: TJourneyStepGoals[];
13671
- }
13672
- /**
13673
- * @openapi
13674
- *
13675
- * components:
13676
- * schemas:
13677
- * IJourney_2_0:
13678
- * allOf:
13679
- * - type: object
13680
- * properties:
13681
- * name:
13682
- * type: string
13683
- * description: The name of the journey.
13684
- * link:
13685
- * type: string
13686
- * description: A hyperlink to the help-center for this journey.
13687
- * summary:
13688
- * type: string
13689
- * description: A quick summary for what the journey is about.
13690
- * steps:
13691
- * $ref: '#/components/schemas/IJourneyStep_2_0'
13692
- * - $ref: '#/components/schemas/IEntityMeta'
13693
- */
13694
- export interface IJourney_2_0 {
13695
- /** The object id of the journey */
13696
- _id: TMongoId;
13697
- /** The reference id of the journey */
13698
- referenceId: string;
13699
- /** The name of the journey */
13700
- name: string;
13701
- /** The hyperlink to the helpdesk for this journey */
13702
- link: string;
13703
- /** Summary of the journey */
13704
- summary: string;
13705
- /** The list of journey steps in this journey */
13706
- steps: IJourneyStep_2_0[];
13707
- createdAt: number;
13708
- lastChanged: number;
13709
- createdBy: TMongoId;
13710
- lastChangedBy: TMongoId;
13711
- }
13712
- /**
13713
- * @openapi
13714
- *
13715
- * components:
13716
- * schemas:
13717
- * IJourneyIndexItem_2_0:
13718
- * allOf:
13719
- * - type: object
13720
- * properties:
13721
- * referenceId:
13722
- * type: string
13723
- * name:
13724
- * type: string
13725
- * description: The name of the journey.
13726
- * link:
13727
- * type: string
13728
- * description: A hyperlink to the help-center for this journey.
13729
- * summary:
13730
- * type: string
13731
- * description: A quick summary for what the journey is about.
13732
- * - $ref: '#/components/schemas/IEntityMeta'
13733
- */
13734
- export interface IJourneyIndexItem_2_0 {
13735
- /** The object id of the journey */
13736
- _id: TMongoId;
13737
- /** The reference id of the journey */
13738
- referenceId: string;
13739
- /** The name of the journey */
13740
- name: string;
13741
- /** The hyperlink to the helpdesk for this journey */
13742
- link: string;
13743
- /** Summary of the journey */
13744
- summary: string;
13745
- /** Unix-timestamp when the entity was created initially */
13746
- createdAt: number;
13747
- /** Unix-timestamp when the entity was changed last time */
13748
- lastChanged: number;
13749
- /** Id of the user who created the entity initially */
13750
- createdBy: TMongoId;
13751
- /** Id of the user who did the last modification */
13752
- lastChangedBy: TMongoId;
13753
- }
13754
- /**
13755
- * @openapi
13756
- *
13757
- * components:
13758
- * schemas:
13759
- * IJourneyProgress_2_0:
13760
- * allOf:
13761
- * - type: object
13762
- * properties:
13763
- * userReference:
13764
- * $ref: '#/components/schemas/TMongoId'
13765
- * organisationReference:
13766
- * $ref: '#/components/schemas/TMongoId'
13767
- * isCurrent:
13768
- * type: boolean
13769
- * description: Information whether this progress object keeps track of the currently selected journey.
13770
- * isComplete:
13771
- * type: boolean
13772
- * description: Information whether the currently selected journey is complete.
13773
- * journeyReferenceId:
13774
- * type: string
13775
- * journeySteps:
13776
- * $ref: '#/components/schemas/IJourneyStepProgress_2_0'
13777
- */
13778
- export interface IJourneyProgress_2_0 {
13779
- /** The user who owns this journey progress object */
13780
- userReference: TMongoId;
13781
- /** The organisation id the user belongs to who owns the progress object */
13782
- organisationReference: TMongoId;
13783
- /** Whether this is the current journey */
13784
- isCurrent: boolean;
13785
- /** Whether this journey was completed already */
13786
- isComplete: boolean;
13787
- /** A reference to the journey this progress object is for */
13788
- journeyReferenceId: TMongoId;
13789
- /** Stores information about the steps and their progress */
13790
- journeySteps: IJourneyStepProgress_2_0[];
13791
- }
13792
- /**
13793
- * @openapi
13794
- *
13795
- * components:
13796
- * schemas:
13797
- * IJourneyStepProgress_2_0:
13798
- * allOf:
13799
- * - type: object
13800
- * properties:
13801
- * journeyStepReferenceId:
13802
- * type: string
13803
- * isComplete:
13804
- * type: boolean
13805
- * completedGoals:
13806
- * type: array
13807
- * items:
13808
- * type: string
13809
- */
13810
- export interface IJourneyStepProgress_2_0 {
13811
- /** The id of this journey progress step */
13812
- journeyStepReferenceId: TMongoId;
13813
- /** Whether this step is complete */
13814
- isComplete: boolean;
13815
- /** The already completed goals */
13816
- completedGoals: string[];
13817
- }
13818
- export interface IIndexJourneysRestData_2_0 extends IRestPagination<IJourneyIndexItem_2_0> {
13819
- }
13820
- export interface IIndexJourneysRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IJourneyIndexItem_2_0> {
13821
- }
13822
- export interface IReadJourneyRestDataParams_2_0 {
13823
- journeyReferenceId: string;
13824
- }
13825
- export interface IReadJourneyRestData_2_0 extends IReadJourneyRestDataParams_2_0 {
13826
- }
13827
- export interface IReadJourneyRestReturnValue_2_0 extends IJourney_2_0 {
13828
- }
13829
- export interface IReadJourneyProgressRestData_2_0 {
13830
- }
13831
- export interface IReadJourneyProgressRestReturnValue_2_0 extends IJourneyProgress_2_0 {
13832
- }
13833
- /**
13834
- * @openapi
13835
- *
13836
- * components:
13837
- * schemas:
13838
- * IJourneyTrackEventBase_2_0:
13839
- * allOf:
13840
- * - type: object
13841
- * properties:
13842
- * event:
13843
- * type: string
13844
- * description: The name of the event to track.
13845
- * example: createFlow
13846
- * payload:
13847
- * type: object
13848
- */
13849
- export interface IJourneyTrackEventBase_2_0 {
13850
- event: string;
13851
- payload: {
13852
- [key: string]: any;
13853
- };
13854
- }
13855
- export interface ITrackJourneyEventRestDataBody_2_0 extends IJourneyTrackEventBase_2_0 {
13856
- }
13857
- export interface ITrackJourneyEventRestData_2_0 extends ITrackJourneyEventRestDataBody_2_0 {
13858
- }
13859
- export interface ITrackJourneyEventRestReturnValue_2_0 extends IJourneyProgress_2_0 {
13860
- }
13861
- /**
13862
- * @openapi
13863
- *
13864
- * components:
13865
- * schemas:
13866
- * IUpdateSelectedJourneyRestDataBody_2_0:
13867
- * type: object
13868
- * properties:
13869
- * journeyReferenceId:
13870
- * type: string
13871
- */
13872
- export interface IUpdateSelectedJourneyRestDataBody_2_0 {
13873
- journeyReferenceId: string;
13874
- }
13875
- export interface IUpdateSelectedJourneyRestData_2_0 extends IUpdateSelectedJourneyRestDataBody_2_0 {
13876
- }
13877
- export interface IUpdateSelectedJourneyRestReturnValue_2_0 {
13878
- }
13879
14281
  declare const slotFillerTypesGeneric: readonly [
13880
14282
  "age",
13881
14283
  "date",
@@ -14654,6 +15056,13 @@ export interface ILogNodeParams extends INodeFunctionBaseParams {
14654
15056
  message: string;
14655
15057
  };
14656
15058
  }
15059
+ export interface IDebugMessageNodeParams extends INodeFunctionBaseParams {
15060
+ config: {
15061
+ level: "info" | "error";
15062
+ message: string;
15063
+ header: string;
15064
+ };
15065
+ }
14657
15066
  export interface IDatePickerConfig {
14658
15067
  datepicker_eventName: string;
14659
15068
  datepicker_locale: string;
@@ -14686,70 +15095,6 @@ export interface IDatePickerNodeParams extends INodeFunctionBaseParams {
14686
15095
  config: IDatePickerConfig;
14687
15096
  }
14688
15097
  export declare type ISayNodeParams = ISayParams;
14689
- export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
14690
- config: {
14691
- lexiconId: string;
14692
- keyphrase: string;
14693
- slots: string[];
14694
- synonyms: string[];
14695
- };
14696
- }
14697
- export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
14698
- config: {
14699
- text: string;
14700
- data: any;
14701
- mode: string;
14702
- contextKey: string;
14703
- inputKey: string;
14704
- parseIntents: boolean;
14705
- parseSlots: boolean;
14706
- parseSystemSlots: boolean;
14707
- findType: boolean;
14708
- processDefaultReply: boolean;
14709
- };
14710
- }
14711
- export interface IMatchPatternParams extends INodeFunctionBaseParams {
14712
- config: {
14713
- patterns: string[];
14714
- patternGroupName: string;
14715
- alternateInput: string;
14716
- detailedCompoundSlots: boolean;
14717
- createNewSlots: boolean;
14718
- tagExistingSlots: boolean;
14719
- useFullSystemslotText: boolean;
14720
- };
14721
- }
14722
- export interface IFuzzySearchParams extends INodeFunctionBaseParams {
14723
- config: {
14724
- searchPattern: string;
14725
- items: any;
14726
- isCaseSensitive: boolean;
14727
- includeScore: boolean;
14728
- includeMatches: boolean;
14729
- minMatchCharLength: number;
14730
- shouldSort: boolean;
14731
- findAllMatches: boolean;
14732
- location: number;
14733
- threshold: number;
14734
- distance: number;
14735
- ignoreLocation: boolean;
14736
- storeLocation: string;
14737
- inputKey: string;
14738
- contextKey: string;
14739
- };
14740
- }
14741
- export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
14742
- config: {
14743
- slotsConfig: IGenerativeSlot[];
14744
- amountOfLastUserInputs: number;
14745
- maxQuestions: number;
14746
- temperature: number;
14747
- storeLocation: string;
14748
- contextKey: string;
14749
- inputKey: string;
14750
- timeout: number;
14751
- };
14752
- }
14753
15098
  export interface IContinuousASRParams extends INodeFunctionBaseParams {
14754
15099
  config: {
14755
15100
  asrEnabled: boolean;
@@ -14810,15 +15155,16 @@ export interface IVoiceConfigParams {
14810
15155
  googleModel: TVoiceGateway2GoogleModel;
14811
15156
  userNoInputMode: TVoiceGateway2UserNoInputMode;
14812
15157
  userNoInputTimeout: number;
15158
+ userNoInputTimeoutEnable: boolean;
14813
15159
  userNoInputRetries: number;
14814
15160
  userNoInputSpeech: string;
14815
15161
  userNoInputUrl: string;
14816
- botFailOnError: boolean;
14817
- botNoOutputGiveupTimeout: number;
14818
- botNoOutputTimeout: number;
14819
- botNoOutputRetries: number;
14820
- botNoOutputSpeech: string;
14821
- botNoOutputUrl: string;
15162
+ flowNoInputTimeoutEnable: boolean;
15163
+ flowNoInputTimeout: number;
15164
+ flowNoInputMode: TVoiceGateway2FlowNoInputMode;
15165
+ flowNoInputRetries: number;
15166
+ flowNoInputSpeech: string;
15167
+ flowNoInputUrl: string;
14822
15168
  dtmfEnable: boolean;
14823
15169
  dtmfInterDigitTimeout: number;
14824
15170
  dtmfMaxDigits: number;
@@ -14842,6 +15188,13 @@ export interface IVoiceConfigParams {
14842
15188
  deepgramEndpointing: boolean;
14843
15189
  deepgramEndpointingValue: number;
14844
15190
  deepgramSmartFormatting: boolean;
15191
+ atmosphereAction: TVoiceGateway2DubActionType;
15192
+ atmosphereUrl: string;
15193
+ atmosphereLoop: boolean;
15194
+ atmosphereVolume: number;
15195
+ silenceOverlayAction: boolean | string;
15196
+ silenceOverlayURL: string;
15197
+ silenceOverlayDelay: number;
14845
15198
  }
14846
15199
  export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
14847
15200
  config: IVoiceConfigParams;
@@ -14991,6 +15344,19 @@ export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
14991
15344
  ratingChatStatusMessage: string;
14992
15345
  };
14993
15346
  }
15347
+ export interface ITrackMilestoneNodeParams extends INodeFunctionBaseParams {
15348
+ config: {
15349
+ milestone: {
15350
+ milestoneId: string;
15351
+ name: string;
15352
+ version: string;
15353
+ selectedSteps: {
15354
+ stepId: string;
15355
+ type: string;
15356
+ }[];
15357
+ };
15358
+ };
15359
+ }
14994
15360
  export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
14995
15361
  appInterimScreenOverride?: string;
14996
15362
  appConnectScreenOverride?: string;
@@ -15349,6 +15715,7 @@ export interface ISearchExtractOutputNodeParams extends INodeFunctionBaseParams
15349
15715
  searchStoreLocationContextKey: string;
15350
15716
  searchStoreLocationInputKey: string;
15351
15717
  searchSourceTags: string[];
15718
+ searchSourceTagsFilterOp: ISearchTagsFilterOps;
15352
15719
  knowledgeStoreId?: string;
15353
15720
  prompt: string;
15354
15721
  temperature: number;
@@ -15387,6 +15754,7 @@ export interface ICognigyBasicNodes {
15387
15754
  resetContext: ICreateChartNodeBasicNodesData<"resetContext", IResetContextNodeParams, TBASIC_EXTENSION>;
15388
15755
  code: ICreateChartNodeBasicNodesData<"code", ICodeNodeBasicParams, TBASIC_EXTENSION>;
15389
15756
  log: ICreateChartNodeBasicNodesData<"log", ILogNodeParams, TBASIC_EXTENSION>;
15757
+ debugMessage: ICreateChartNodeBasicNodesData<"debugMessage", IDebugMessageNodeParams, TBASIC_EXTENSION>;
15390
15758
  activateProfile: ICreateChartNodeBasicNodesData<"activateProfile", IActivateProfileNodeParams, TBASIC_EXTENSION>;
15391
15759
  blindMode: ICreateChartNodeBasicNodesData<"blindMode", IBlindModeNodeParams, TBASIC_EXTENSION>;
15392
15760
  completeGoal: ICreateChartNodeBasicNodesData<"completeGoal", ICompleteGoalNodeParams, TBASIC_EXTENSION>;
@@ -15397,6 +15765,7 @@ export interface ICognigyBasicNodes {
15397
15765
  overwriteAnalytics: ICreateChartNodeBasicNodesData<"overwriteAnalytics", IOverwriteAnalyticsParams, TBASIC_EXTENSION>;
15398
15766
  setRating: ICreateChartNodeBasicNodesData<"setRating", ISetRatingParams, TBASIC_EXTENSION>;
15399
15767
  requestRating: ICreateChartNodeBasicNodesData<"requestRating", IRequestRatingNodeParams, TBASIC_EXTENSION>;
15768
+ trackMilestone: ICreateChartNodeBasicNodesData<"trackMilestone", ITrackMilestoneNodeParams, TBASIC_EXTENSION>;
15400
15769
  executeFlow: ICreateChartNodeBasicNodesData<"executeFlow", IExecuteFlowNodeParams, TBASIC_EXTENSION>;
15401
15770
  goTo: ICreateChartNodeBasicNodesData<"goTo", IGoToNodeParams, TBASIC_EXTENSION>;
15402
15771
  if: ICreateChartNodeBasicNodesData<"if", IIfNodeParams, TBASIC_EXTENSION>;
@@ -15835,6 +16204,10 @@ export interface IOpenAIMeta_2_0 {
15835
16204
  export interface IAnthropicMeta_2_0 {
15836
16205
  customModel?: string;
15837
16206
  }
16207
+ export interface IAwsBedrockMeta_2_0 {
16208
+ region: string;
16209
+ customModel?: string;
16210
+ }
15838
16211
  export interface IAlephAlphaMeta_2_0 {
15839
16212
  customModel?: string;
15840
16213
  baseCustomUrl?: string;
@@ -15850,6 +16223,16 @@ export interface IGoogleVertexAIMeta_2_0 {
15850
16223
  apiEndPoint: string;
15851
16224
  publisher?: string;
15852
16225
  }
16226
+ /******************************************************************************/
16227
+ /**
16228
+ * IMPORTANT!
16229
+ * Openapi components from the llm-providers pacakge, if you need to updtate something here
16230
+ * make sure that the actual code in the llm-providers package is updated as well
16231
+ */
16232
+ /******************************************************************************/
16233
+ export interface IGoogleGeminiMeta_2_0 {
16234
+ location: string;
16235
+ }
15853
16236
  /**
15854
16237
  * @openapi
15855
16238
  *
@@ -15925,6 +16308,12 @@ export interface IGoogleVertexAIMeta_2_0 {
15925
16308
  * type: string
15926
16309
  * publisher:
15927
16310
  * type: string
16311
+ * googleGemini:
16312
+ * type: object
16313
+ * description: Google Gemini specific meta data
16314
+ * properties:
16315
+ * location:
16316
+ * type: string
15928
16317
  * alephAlpha:
15929
16318
  * type: object
15930
16319
  * description: Aleph Alpha specific meta data
@@ -15963,7 +16352,7 @@ export interface ILargeLanguageModel_2_0 {
15963
16352
  description: string;
15964
16353
  modelType: TGenerativeAIModels;
15965
16354
  /** model type e.g. chat */
15966
- modelGroup?: TModelGroups;
16355
+ modelGroup?: TModeType;
15967
16356
  isCustomModel?: boolean;
15968
16357
  provider: TGenerativeAIProviders;
15969
16358
  connectionId: string;
@@ -15980,8 +16369,12 @@ export interface ILargeLanguageModel_2_0 {
15980
16369
  alephAlpha?: IAlephAlphaMeta_2_0;
15981
16370
  /** Meta data for the GoogleVertexAI connection */
15982
16371
  googleVertexAI?: IGoogleVertexAIMeta_2_0;
16372
+ /** Meta data for the GoogleGemini connection */
16373
+ googleGemini?: IGoogleGeminiMeta_2_0;
15983
16374
  /** Meta data for the Anthropic connection */
15984
16375
  anthropic?: IAnthropicMeta_2_0;
16376
+ /** Meta data for the AwsBedrock connection */
16377
+ awsBedrock?: IAwsBedrockMeta_2_0;
15985
16378
  }
15986
16379
  export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
15987
16380
  }
@@ -16035,17 +16428,61 @@ export interface ITestLargeLanguageModelRestReturnValue_2_0 {
16035
16428
  }
16036
16429
  /**
16037
16430
  * @openapi
16038
- *
16039
16431
  * components:
16040
16432
  * schemas:
16041
- * IKnowledgeStoreDataCreate_2_0:
16042
- * allOf:
16043
- * - type: object
16044
- * properties:
16045
- * name:
16046
- * type: string
16047
- * example: "mystore"
16048
- * description: The name of the KnowledgeStore
16433
+ * IAvailableModelItem_2_0:
16434
+ * type: object
16435
+ * properties:
16436
+ * modelName:
16437
+ * type: string
16438
+ * modelId:
16439
+ * type: string
16440
+ * providerName:
16441
+ * type: array
16442
+ *
16443
+ */
16444
+ /**
16445
+ * @openapi
16446
+ * components:
16447
+ * schemas:
16448
+ * IAvailableModelsForLLMProvider_2_0:
16449
+ * allOf:
16450
+ * - type: object
16451
+ * properties:
16452
+ * availableModels:
16453
+ * type: array
16454
+ * items:
16455
+ * $ref: '#/components/schemas/IAvailableModelItem_2_0'
16456
+ *
16457
+ */
16458
+ export interface IAvailableModelsForLLMProvider_2_0 {
16459
+ availableModels: {
16460
+ modelName: string;
16461
+ modelId: string;
16462
+ providerName: string;
16463
+ }[];
16464
+ }
16465
+ export interface IGetAvailableModelsForLLMRestDataParams_2_0 {
16466
+ largeLanguageModelId: string;
16467
+ }
16468
+ export interface IGetAvailableModelsForLLMRestData_2_0 extends IGetAvailableModelsForLLMRestDataParams_2_0 {
16469
+ connectionRefId: string;
16470
+ }
16471
+ export interface IGetAvailableModelsForLLMRestReturnValue_2_0 extends IAvailableModelsForLLMProvider_2_0 {
16472
+ }
16473
+ /**
16474
+ * @openapi
16475
+ *
16476
+ * components:
16477
+ * schemas:
16478
+ * IKnowledgeStoreDataCreate_2_0:
16479
+ * allOf:
16480
+ * - type: object
16481
+ * properties:
16482
+ * name:
16483
+ * type: string
16484
+ * example: "mystore"
16485
+ * description: The name of the KnowledgeStore
16049
16486
  * description:
16050
16487
  * type: string
16051
16488
  * example: "mystore description"
@@ -16144,9 +16581,16 @@ declare const knowledgeSourceType: readonly [
16144
16581
  "pdf",
16145
16582
  "txt",
16146
16583
  "docx",
16584
+ "pptx",
16147
16585
  "ctxt",
16148
16586
  "url",
16149
- "manual"
16587
+ "manual",
16588
+ "jpeg",
16589
+ "jpg",
16590
+ "png",
16591
+ "bmp",
16592
+ "heif",
16593
+ "tiff"
16150
16594
  ];
16151
16595
  export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
16152
16596
  export interface IKnowledgeSourceMetaData {
@@ -16210,7 +16654,15 @@ export interface IKnowledgeSourceMetaData {
16210
16654
  * - ready
16211
16655
  * - ingesting
16212
16656
  * - disabled
16213
- *
16657
+ * metaData:
16658
+ * type: object
16659
+ * properties:
16660
+ * tags:
16661
+ * type: array
16662
+ * description: Array of tags to replace the existing tags
16663
+ * items:
16664
+ * type: string
16665
+ * example: "tag1"
16214
16666
  * IKnowledgeSourceDataTypeWebsite_2_0:
16215
16667
  * allOf:
16216
16668
  * - type: object
@@ -16303,6 +16755,7 @@ export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSour
16303
16755
  export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
16304
16756
  }
16305
16757
  export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
16758
+ metaData?: Partial<Pick<IKnowledgeSourceMetaData, "tags">>;
16306
16759
  }
16307
16760
  export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
16308
16761
  knowledgeStoreId: string;
@@ -16449,7 +16902,9 @@ export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
16449
16902
  */
16450
16903
  export interface IMilestoneIndexItem_2_0 {
16451
16904
  _id: TMongoId;
16905
+ referenceId: string;
16452
16906
  name: string;
16907
+ description?: string;
16453
16908
  createdAt: number;
16454
16909
  lastChanged: number;
16455
16910
  createdBy: TMongoId;
@@ -16519,6 +16974,7 @@ export interface IMilestoneStepMetric_2_0 {
16519
16974
  * $ref: '#/components/schemas/IMilestoneStepMetric_2_0'
16520
16975
  */
16521
16976
  export interface IMilestoneStep_2_0 {
16977
+ _id?: TMongoId;
16522
16978
  name?: string;
16523
16979
  description?: string;
16524
16980
  order?: number;
@@ -16537,10 +16993,6 @@ export interface IMilestoneStep_2_0 {
16537
16993
  * type: string
16538
16994
  * description: The name of the Milestone
16539
16995
  * example: New Milestone
16540
- * version:
16541
- * type: number
16542
- * description: Current version of the milestone.
16543
- * example: 1
16544
16996
  * description:
16545
16997
  * type: string
16546
16998
  * description: The description of the milestone
@@ -16558,8 +17010,9 @@ export interface IMilestoneStep_2_0 {
16558
17010
  */
16559
17011
  export interface IMilestone_2_0 {
16560
17012
  _id: TMongoId;
17013
+ referenceId: string;
16561
17014
  name: string;
16562
- version: number;
17015
+ version: string;
16563
17016
  createdAt: number;
16564
17017
  lastChanged: number;
16565
17018
  createdBy: TMongoId;
@@ -16635,6 +17088,72 @@ export interface IUploadResumableRestReturnValue_2_0 {
16635
17088
  url: string;
16636
17089
  uploadId: string;
16637
17090
  }
17091
+ /**
17092
+ * @openapi
17093
+ *
17094
+ * components:
17095
+ * schemas:
17096
+ * IGenerateNluScoreData_2_0:
17097
+ * type: object
17098
+ * required:
17099
+ * - flowReferenceId
17100
+ * - localeReferenceId
17101
+ * - sentence
17102
+ * properties:
17103
+ * flowReferenceId:
17104
+ * type: string
17105
+ * format: uuid
17106
+ * description: UUID of the flow reference.
17107
+ * localeReferenceId:
17108
+ * type: string
17109
+ * format: uuid
17110
+ * description: UUID of the locale reference.
17111
+ * sentence:
17112
+ * type: string
17113
+ * description: Sentence to analyze for NLU scoring.
17114
+ *
17115
+ * IGeneratedNluScore_2_0:
17116
+ * type: object
17117
+ * properties:
17118
+ * id:
17119
+ * type: string
17120
+ * description: Unique identifier of the score.
17121
+ * name:
17122
+ * type: string
17123
+ * description: Name of the score type.
17124
+ * score:
17125
+ * type: number
17126
+ * description: Numerical value of the score.
17127
+ * negated:
17128
+ * type: boolean
17129
+ * description: Indicates if the score is negated.
17130
+ * confirmationSentence:
17131
+ * type: string
17132
+ * description: Sentence used to confirm the score.
17133
+ * confirmationSentences:
17134
+ * type: array
17135
+ * items:
17136
+ * type: string
17137
+ * description: Multiple sentences for confirmation if applicable.
17138
+ * disambiguationSentence:
17139
+ * type: string
17140
+ * description: Sentence used for disambiguation.
17141
+ * flow:
17142
+ * type: string
17143
+ * description: UUID of the flow associated with the score.
17144
+ */
17145
+ export interface IGenerateNluScoresRestDataParams_2_0 {
17146
+ projectId: string;
17147
+ }
17148
+ export interface IGenerateNluScoresRestDataBody_2_0 {
17149
+ flowReferenceId: string;
17150
+ localeReferenceId: string;
17151
+ sentence: string;
17152
+ }
17153
+ export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
17154
+ }
17155
+ export interface IGenerateNluScoresRestReturnValue_2_0 {
17156
+ }
16638
17157
  export interface ResourcesAPIGroup_2_0 {
16639
17158
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
16640
17159
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
@@ -16802,11 +17321,6 @@ export interface ResourcesAPIGroup_2_0 {
16802
17321
  readLocale: TRestAPIOperation<IReadLocaleRestData_2_0, IReadLocaleRestReturnValue_2_0>;
16803
17322
  updateLocale: TRestAPIOperation<IUpdateLocaleRestData_2_0, IUpdateLocaleRestReturnValue_2_0>;
16804
17323
  deleteLocale: TRestAPIOperation<IDeleteLocaleRestData_2_0, IDeleteLocaleRestReturnValue_2_0>;
16805
- indexJourneys: TRestAPIOperation<IIndexJourneysRestData_2_0, IIndexJourneysRestReturnValue_2_0>;
16806
- readJourney: TRestAPIOperation<IReadJourneyRestData_2_0, IReadJourneyRestReturnValue_2_0>;
16807
- readJourneyProgress: TRestAPIOperation<IReadJourneyProgressRestData_2_0, IReadJourneyProgressRestReturnValue_2_0>;
16808
- updateSelectedJourney: TRestAPIOperation<IUpdateSelectedJourneyRestData_2_0, IUpdateSelectedJourneyRestReturnValue_2_0>;
16809
- trackJourneyEvent: TRestAPIOperation<ITrackJourneyEventRestData_2_0, ITrackJourneyEventRestReturnValue_2_0>;
16810
17324
  indexSlotFillers: TRestAPIOperation<IIndexSlotFillersRestData_2_0, IIndexSlotFillersRestReturnValue_2_0>;
16811
17325
  batchSlotFillers: TRestAPIOperation<IBatchSlotFillersRestData_2_0, IBatchSlotFillersRestReturnValue_2_0>;
16812
17326
  createSlotFiller: TRestAPIOperation<ICreateSlotFillerRestData_2_0, ICreateSlotFillerRestReturnValue_2_0>;
@@ -16857,6 +17371,7 @@ export interface ResourcesAPIGroup_2_0 {
16857
17371
  deleteLargeLanguageModel: TRestAPIOperation<IDeleteLargeLanguageModelRestData_2_0, IDeleteLargeLanguageModelRestReturnValue_2_0>;
16858
17372
  cloneLargeLanguageModel: TRestAPIOperation<ICloneLargeLanguageModelRestData_2_0, ICloneLargeLanguageModelRestReturnValue_2_0>;
16859
17373
  testLargeLanguageModel: TRestAPIOperation<ITestLargeLanguageModelRestData_2_0, ITestLargeLanguageModelRestReturnValue_2_0>;
17374
+ getAvailableModelsForLLM: TRestAPIOperation<IGetAvailableModelsForLLMRestData_2_0, IGetAvailableModelsForLLMRestReturnValue_2_0>;
16860
17375
  indexKnowledgeStores: TRestAPIOperation<IIndexKnowledgeStoresRestData_2_0, IIndexKnowledgeStoresRestReturnValue_2_0>;
16861
17376
  createKnowledgeStore: TRestAPIOperation<ICreateKnowledgeStoreRestData_2_0, ICreateKnowledgeStoreRestReturnValue_2_0>;
16862
17377
  readKnowledgeStore: TRestAPIOperation<IReadKnowledgeStoreRestData_2_0, IReadKnowledgeStoreRestReturnValue_2_0>;
@@ -16874,6 +17389,7 @@ export interface ResourcesAPIGroup_2_0 {
16874
17389
  deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
16875
17390
  updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
16876
17391
  uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
17392
+ generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
16877
17393
  }
16878
17394
  declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
16879
17395
  /**
@@ -17337,6 +17853,8 @@ export interface IStep_2_0 {
17337
17853
  * type: string
17338
17854
  * children:
17339
17855
  * type: array
17856
+ * items:
17857
+ * type: object
17340
17858
  * example:
17341
17859
  * step: Collect Email
17342
17860
  * type: node
@@ -17383,9 +17901,7 @@ export interface IStepReport_2_0 {
17383
17901
  * - done
17384
17902
  * - error
17385
17903
  * data:
17386
- * type: array
17387
- * items:
17388
- * $ref: '#/components/schemas/IStepReport_2_0'
17904
+ * $ref: '#/components/schemas/IStepReport_2_0'
17389
17905
  */
17390
17906
  export interface ILoadStepReportByQueryHashResponse_2_0 {
17391
17907
  status: "pending" | "done" | "error";
@@ -17444,6 +17960,14 @@ export interface InsightsAPIGroup_2_0 {
17444
17960
  }>;
17445
17961
  }
17446
17962
  declare function InsightsAPIGroup_2_0(instance: Base): InsightsAPIGroup_2_0;
17963
+ export interface IProfilePrivacyPolicy {
17964
+ accepted: boolean;
17965
+ meta?: {
17966
+ [key: string]: {
17967
+ timestamp: number;
17968
+ };
17969
+ };
17970
+ }
17447
17971
  /**
17448
17972
  * @openapi
17449
17973
  *
@@ -17490,6 +18014,8 @@ export interface IProfile_2_0 {
17490
18014
  * type: boolean
17491
18015
  * accepted_gdpr:
17492
18016
  * type: boolean
18017
+ * privacy_policy:
18018
+ * type: object
17493
18019
  * goals:
17494
18020
  * type: array
17495
18021
  * items:
@@ -17511,12 +18037,13 @@ export interface IProfile_2_0 {
17511
18037
  export interface IFlattenedProfile_2_0 {
17512
18038
  prevent_data_collection: boolean;
17513
18039
  accepted_gdpr: boolean;
18040
+ privacy_policy: IProfilePrivacyPolicy;
17514
18041
  goals?: string[];
17515
18042
  firstname?: string;
17516
18043
  lastname?: string;
17517
18044
  email?: string;
17518
18045
  profilepic?: string;
17519
- [key: string]: string | number | boolean | string[];
18046
+ [key: string]: string | number | boolean | string[] | IProfilePrivacyPolicy;
17520
18047
  }
17521
18048
  /**
17522
18049
  * @openapi
@@ -17615,6 +18142,7 @@ export interface IProfileSchema_2_0 {
17615
18142
  profilepic: "string";
17616
18143
  prevent_data_collection: "boolean";
17617
18144
  accepted_gdpr: "boolean";
18145
+ privacy_policy: "object";
17618
18146
  goals: "object";
17619
18147
  [key: string]: "string" | "boolean" | "number" | "object";
17620
18148
  };
@@ -18258,6 +18786,50 @@ export interface IDeleteConversationRestRestData_2_0 extends IDeleteConversation
18258
18786
  }
18259
18787
  export interface IDeleteConversationRestRestReturnValue_2_0 {
18260
18788
  }
18789
+ /**
18790
+ * @openapi
18791
+ *
18792
+ * components:
18793
+ * schemas:
18794
+ * IKnowledgeQueryCounterAggregatedValue_2_0:
18795
+ * type: object
18796
+ * properties:
18797
+ * queries:
18798
+ * type: number
18799
+ * day:
18800
+ * type: number
18801
+ * month:
18802
+ * type: number
18803
+ * year:
18804
+ * type: number
18805
+ */
18806
+ export interface IKnowledgeQueryCounterAggregatedValue_2_0 {
18807
+ /** The number of queries in the time-span */
18808
+ queries: number;
18809
+ /** The day, e.g. 1 for the first day in the month */
18810
+ day: number;
18811
+ /** The month of the year, e.g. 1 for January */
18812
+ month: number;
18813
+ /** The year, e.g. 2020 */
18814
+ year: number;
18815
+ }
18816
+ export interface IGetKnowledgeQueryCounterRestDataParams_2_0 {
18817
+ projectId: string;
18818
+ }
18819
+ export interface IGetKnowledgeQueryCounterRestData_2_0 extends IGetKnowledgeQueryCounterRestDataParams_2_0 {
18820
+ year: number;
18821
+ month: number;
18822
+ }
18823
+ export interface IGetKnowledgeQueryCounterRestReturnValue_2_0 {
18824
+ items: IKnowledgeQueryCounterAggregatedValue_2_0[];
18825
+ }
18826
+ export interface IGetKnowledgeQueryCounterOrganisationRestData_2_0 {
18827
+ year: number;
18828
+ month: number;
18829
+ }
18830
+ export interface IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0 {
18831
+ items: IKnowledgeQueryCounterAggregatedValue_2_0[];
18832
+ }
18261
18833
  export interface MetricsAPIGroup_2_0 {
18262
18834
  indexTasks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexTasksRestData_2_0>, IIndexTasksRestReturnValue_2_0>;
18263
18835
  readTask: TRestAPIOperation<IReadTaskRestData_2_0, IReadTaskRestReturnValue_2_0>;
@@ -18284,6 +18856,8 @@ export interface MetricsAPIGroup_2_0 {
18284
18856
  batchTrainerRecords: TRestAPIOperation<IBatchTrainerRecordsRestData_2_0, IBatchTrainerRecordsRestReturnValue_2_0>;
18285
18857
  getConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_2_0, IGetConversationCounterRestReturnValue_2_0>;
18286
18858
  getConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_2_0, IGetConversationCounterOrganisationRestReturnValue_2_0>;
18859
+ getKnowledgeQueryCounter: TRestAPIOperation<IGetKnowledgeQueryCounterRestData_2_0, IGetKnowledgeQueryCounterRestReturnValue_2_0>;
18860
+ getKnowledgeQueryCounterOrganisation: TRestAPIOperation<IGetKnowledgeQueryCounterOrganisationRestData_2_0, IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0>;
18287
18861
  indexConversations: TRestAPIOperation<IIndexConversationsRestRestData_2_0, IIndexConversationsRestRestReturnValue_2_0>;
18288
18862
  readConversation: TRestAPIOperation<IReadConversationRestRestData_2_0, IReadConversationRestRestReturnValue_2_0>;
18289
18863
  deleteConversation: TRestAPIOperation<IDeleteConversationRestRestData_2_0, IDeleteConversationRestRestReturnValue_2_0>;
@@ -18302,6 +18876,7 @@ export declare type IInjectRestReturnValue_2_0 = string;
18302
18876
  export interface INotifyRestDataBody_2_0 {
18303
18877
  text: string;
18304
18878
  data: object;
18879
+ attachments?: TAttachments[];
18305
18880
  URLToken: string;
18306
18881
  userId: string;
18307
18882
  sessionId: string;
@@ -19571,7 +20146,6 @@ export interface IRequestOrganisationDeletionRestReturnValue_2_0 extends Omit<IO
19571
20146
  declare const servicesNames: readonly [
19572
20147
  "service-api",
19573
20148
  "service-resources",
19574
- "service-journeys",
19575
20149
  "service-logs",
19576
20150
  "service-profiles",
19577
20151
  "service-security",
@@ -19588,6 +20162,9 @@ export declare type TServicesNames = typeof servicesNames[number];
19588
20162
  export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
19589
20163
  [key in keyof TServicesNames]: string[];
19590
20164
  };
20165
+ export interface IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0 {
20166
+ chunkCount: number;
20167
+ }
19591
20168
  export interface IReadVoiceGatewayAccountRestReturnValue_2_0 {
19592
20169
  voiceGatewayAccount: string;
19593
20170
  }
@@ -19596,169 +20173,6 @@ export interface ISetupVoiceGatewayRestDataBody_2_0 {
19596
20173
  }
19597
20174
  export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
19598
20175
  }
19599
- export interface AdministrationAPIGroup_2_0 {
19600
- requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
19601
- validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
19602
- resetPassword: TRestAPIOperation<IResetPasswordRestData_2_0, IResetPasswordRestReturnValue_2_0>;
19603
- changePassword: TRestAPIOperation<IChangePasswordRestData_2_0, IChangePasswordRestReturnValue_2_0>;
19604
- setSystemLicense: TRestAPIOperation<ISetSystemLicenseRestData_2_0, ISetSystemLicenseRestReturnValue_2_0>;
19605
- getSystemLicenseState: TRestAPIOperation<void, IGetSystemLicenseStateRestReturnValue_2_0>;
19606
- getSystemMessage: TRestAPIOperation<void, IGetSystemMessageRestReturnValue_2_0>;
19607
- indexAuditEvents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAuditEventsRestData_2_0>, IIndexAuditEventsRestReturnValue_2_0>;
19608
- readAuditEvent: TRestAPIOperation<IReadAuditEventRestData_2_0, IReadAuditEventRestReturnValue_2_0>;
19609
- logoutUser: TRestAPIOperation<ILogoutUserRestData_2_0, ILogoutUserRestReturnValue_2_0>;
19610
- resetFailedLoginAttempts: TRestAPIOperation<IResetFailedLoginAttemptsRestData_2_0, IResetFailedLoginAttemptsRestReturnValue_2_0>;
19611
- readLastLoginAttemptMe: TRestAPIOperation<void, IReadLastLoginAttemptRestReturnValue_2_0>;
19612
- indexLoginAttemptsMe: TRestAPIOperation<IIndexLoginAttemptsRestData_2_0, IIndexLoginAttemptsRestReturnValue_2_0>;
19613
- deprecatePassword: TRestAPIOperation<IDeprecatePasswordRestData_2_0, IDeprecatePasswordRestReturnValue_2_0>;
19614
- indexUsers: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestData_2_0>, IIndexUsersRestReturnValue_2_0>;
19615
- createUser: TRestAPIOperation<ICreateUserRestData_2_0, ICreateUserRestReturnValue_2_0>;
19616
- readUserMe: TRestAPIOperation<void, IReadUserMeRestReturnValue_2_0>;
19617
- readUser: TRestAPIOperation<IReadUserRestData_2_0, IReadUserRestReturnValue_2_0>;
19618
- updateUser: TRestAPIOperation<IUpdateUserRestData_2_0, IUpdateUserRestReturnValue_2_0>;
19619
- updateUserMe: TRestAPIOperation<IUpdateUserMeRestData_2_0, IUpdateUserMeRestReturnValue_2_0>;
19620
- deleteUser: TRestAPIOperation<IDeleteUserRestData_2_0, IDeleteUserRestReturnValue_2_0>;
19621
- deleteUserMe: TRestAPIOperation<void, void>;
19622
- createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_0, ICreateApiKeyMeRestReturnValue_2_0>;
19623
- deleteApiKeyMe: TRestAPIOperation<IDeleteApiKeyMeRestData_2_0, IDeleteApiKeyMeRestReturnValue_2_0>;
19624
- indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_0, IIndexApiKeysMeRestReturnValue_2_0>;
19625
- addRoleToUser: TRestAPIOperation<IAddRoleToUserRestData_2_0, IAddRoleToUserRestReturnValue_2_0>;
19626
- removeRoleFromUser: TRestAPIOperation<IRemoveRoleFromUserRestData_2_0, IRemoveRoleFromUserRestReturnValue_2_0>;
19627
- readUserAclMe: TRestAPIOperation<void, IReadUserAclMeRestReturnValue_2_0>;
19628
- acceptTermsOfService: TRestAPIOperation;
19629
- indexProjectMembers: TRestAPIOperation<IIndexProjectMembersRestData_2_0, IIndexProjectMembersRestReturnValue_2_0>;
19630
- readProjectMember: TRestAPIOperation<IReadProjectMemberRestData_2_0, IReadProjectMemberRestReturnValue_2_0>;
19631
- addProjectMember: TRestAPIOperation<IAddProjectMemberRestData_2_0, IAddProjectMemberRestReturnValue_2_0>;
19632
- updateProjectMember: TRestAPIOperation<IUpdateProjectMemberRestData_2_0, IUpdateProjectMemberRestReturnValue_2_0>;
19633
- removeProjectMember: TRestAPIOperation<IRemoveProjectMemberRestData_2_0, IRemoveProjectMemberRestReturnValue_2_0>;
19634
- addRoleToMember: TRestAPIOperation<IAddRoleToMemberRestData_2_0, IAddRoleToMemberRestReturnValue_2_0>;
19635
- removeRoleFromMember: TRestAPIOperation<IRemoveRoleFromMemberRestData_2_0, IRemoveRoleFromMemberRestReturnValue_2_0>;
19636
- addProjectToUser: TRestAPIOperation<IAddProjectToUserRestData_2_0, IAddProjectToUserRestReturnValue_2_0>;
19637
- removeProjectFromUser: TRestAPIOperation<IRemoveProjectFromUserRestData_2_0, IRemoveProjectFromUserRestReturnValue_2_0>;
19638
- configureIdentityProvider: TRestAPIOperation<IConfigureIdentityProviderRestData_2_0, IConfigureIdentityProviderRestReturnValue_2_0>;
19639
- resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
19640
- setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
19641
- setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
19642
- updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
19643
- readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
19644
- readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
19645
- requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
19646
- readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
19647
- setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
19648
- readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
19649
- }
19650
- declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
19651
- /**
19652
- * @openapi
19653
- *
19654
- * components:
19655
- * schemas:
19656
- * IApiKeyIndexItem_2_1:
19657
- * type: object
19658
- * properties:
19659
- * _id:
19660
- * $ref: '#/components/schemas/TMongoId'
19661
- * name:
19662
- * type: string
19663
- * createdAt:
19664
- * type: number
19665
- */
19666
- export interface IApiKeyIndexItem_2_1 {
19667
- /** The object id of the api-key */
19668
- _id: TMongoId;
19669
- /** The name of the api-key, e.g. 'my demo' */
19670
- name: string;
19671
- createdAt: number;
19672
- schemaVersion: number;
19673
- }
19674
- export interface IIndexApiKeysMeRestData_2_1 extends IRestPagination<IApiKeyIndexItem_2_1> {
19675
- }
19676
- export interface IIndexApiKeysMeRestReturnValue_2_1 extends ICursorBasedPaginationReturnValue<IApiKeyIndexItem_2_1> {
19677
- }
19678
- /**
19679
- * @openapi
19680
- *
19681
- * components:
19682
- * schemas:
19683
- * IApiKeyData_2_1:
19684
- * type: object
19685
- * properties:
19686
- * name:
19687
- * type: string
19688
- *
19689
- * IApiKey_2_1:
19690
- * allOf:
19691
- * - $ref: '#/components/schemas/IApiKeyData_2_1'
19692
- * - type: object
19693
- * properties:
19694
- * _id:
19695
- * $ref: '#/components/schemas/TMongoId'
19696
- * createdAt:
19697
- * type: integer
19698
- * minimum: 0
19699
- * maximum: 2147483647
19700
- * example: 1527621049
19701
- * apiKey:
19702
- * type: string
19703
- */
19704
- export interface IApiKey_2_1 {
19705
- /** The object id of the api-key */
19706
- _id: TMongoId;
19707
- /** The name of the api-key, e.g. 'my demo' */
19708
- name: string;
19709
- /** The actual api-key */
19710
- apiKey: string;
19711
- createdAt: number;
19712
- schemaVersion: number;
19713
- }
19714
- export interface ICreateApiKeyMeRestDataBody_2_1 extends Partial<Omit<IApiKey_2_1, keyof IEntityMeta | "apiKey">> {
19715
- }
19716
- export interface ICreateApiKeyMeRestData_2_1 extends ICreateApiKeyMeRestDataBody_2_1 {
19717
- }
19718
- export interface ICreateApiKeyMeRestReturnValue_2_1 extends IApiKey_2_1 {
19719
- }
19720
- export interface AdministrationAPIGroup_2_1 extends Omit<AdministrationAPIGroup_2_0, "createApiKeyMe" | "indexApiKeysMe"> {
19721
- createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_1, ICreateApiKeyMeRestReturnValue_2_1>;
19722
- indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_1, IIndexApiKeysMeRestReturnValue_2_1>;
19723
- }
19724
- declare function AdministrationAPIGroup_2_1(instance: Base): AdministrationAPIGroup_2_1;
19725
- /**
19726
- * @openapi
19727
- *
19728
- * components:
19729
- * schemas:
19730
- * IVendor_2_0:
19731
- * type: object
19732
- * properties:
19733
- * version:
19734
- * type: string
19735
- * description: The product version we are running
19736
- * frontendBaseUrl:
19737
- * type: string
19738
- * description: Base URL to the frontend UI
19739
- * hasLicenseAgreement:
19740
- * type: string
19741
- * description: Flag whether users need to agree the license agreement within this env
19742
- * maxContactProfileTTL:
19743
- * type: number
19744
- * maxConversationTTL:
19745
- * type: number
19746
- * maxSessionStateTTL:
19747
- * type: number
19748
- */
19749
- export interface IVendor_2_0 {
19750
- /** The COGNIGY.AI version we are running */
19751
- version: string;
19752
- /** Base URL to the frontend UI */
19753
- frontendBaseUrl: string;
19754
- /** Flag whether users need to agree the license agreement within this env */
19755
- hasLicenseAgreement: boolean;
19756
- maxContactProfileTTL: number;
19757
- maxConversationTTL: number;
19758
- maxSessionStateTTL: number;
19759
- }
19760
- export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
19761
- }
19762
20176
  /**
19763
20177
  * @openapi
19764
20178
  *
@@ -19778,6 +20192,8 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
19778
20192
  * type: number
19779
20193
  * quotaMaxMessagesPerDay:
19780
20194
  * type: number
20195
+ * quotaMaxKnowledgeChunks:
20196
+ * type: number
19781
20197
  * passwordPolicy:
19782
20198
  * $ref: '#/components/schemas/IOrganisationPasswordPolicy_2_0'
19783
20199
  * sessionStateTTLInMinutes:
@@ -19921,6 +20337,8 @@ export interface IOrganisationDataPrivacySettings_2_0 {
19921
20337
  * type: number
19922
20338
  * quotaMaxMessagesPerDay:
19923
20339
  * type: number
20340
+ * quotaMaxKnowledgeChunks:
20341
+ * type: number
19924
20342
  * passwordPolicy:
19925
20343
  * $ref: '#/components/schemas/IOrganisationPasswordPolicy_2_0'
19926
20344
  * sessionStateTTLInMinutes:
@@ -19948,6 +20366,7 @@ export interface IOrganisationIndexItem_2_0 {
19948
20366
  quotaMaxUsers: number;
19949
20367
  quotaMaxChannelsPerProject: number;
19950
20368
  quotaMaxMessagesPerDay: number;
20369
+ quotaMaxKnowledgeChunks: number;
19951
20370
  passwordPolicy: IOrganisationPasswordPolicy_2_0;
19952
20371
  billingTimezone: string;
19953
20372
  sessionStateTTLInMinutes: number;
@@ -20017,6 +20436,171 @@ export interface IDeleteOrganisationRestData_2_0 extends IDeleteOrganisationRest
20017
20436
  }
20018
20437
  export interface IDeleteOrganisationRestReturnValue_2_0 {
20019
20438
  }
20439
+ export interface AdministrationAPIGroup_2_0 {
20440
+ requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
20441
+ validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
20442
+ resetPassword: TRestAPIOperation<IResetPasswordRestData_2_0, IResetPasswordRestReturnValue_2_0>;
20443
+ changePassword: TRestAPIOperation<IChangePasswordRestData_2_0, IChangePasswordRestReturnValue_2_0>;
20444
+ setSystemLicense: TRestAPIOperation<ISetSystemLicenseRestData_2_0, ISetSystemLicenseRestReturnValue_2_0>;
20445
+ getSystemLicenseState: TRestAPIOperation<void, IGetSystemLicenseStateRestReturnValue_2_0>;
20446
+ getSystemMessage: TRestAPIOperation<void, IGetSystemMessageRestReturnValue_2_0>;
20447
+ indexAuditEvents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAuditEventsRestData_2_0>, IIndexAuditEventsRestReturnValue_2_0>;
20448
+ readAuditEvent: TRestAPIOperation<IReadAuditEventRestData_2_0, IReadAuditEventRestReturnValue_2_0>;
20449
+ logoutUser: TRestAPIOperation<ILogoutUserRestData_2_0, ILogoutUserRestReturnValue_2_0>;
20450
+ resetFailedLoginAttempts: TRestAPIOperation<IResetFailedLoginAttemptsRestData_2_0, IResetFailedLoginAttemptsRestReturnValue_2_0>;
20451
+ readLastLoginAttemptMe: TRestAPIOperation<void, IReadLastLoginAttemptRestReturnValue_2_0>;
20452
+ indexLoginAttemptsMe: TRestAPIOperation<IIndexLoginAttemptsRestData_2_0, IIndexLoginAttemptsRestReturnValue_2_0>;
20453
+ deprecatePassword: TRestAPIOperation<IDeprecatePasswordRestData_2_0, IDeprecatePasswordRestReturnValue_2_0>;
20454
+ indexUsers: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestData_2_0>, IIndexUsersRestReturnValue_2_0>;
20455
+ createUser: TRestAPIOperation<ICreateUserRestData_2_0, ICreateUserRestReturnValue_2_0>;
20456
+ readUserMe: TRestAPIOperation<void, IReadUserMeRestReturnValue_2_0>;
20457
+ readUser: TRestAPIOperation<IReadUserRestData_2_0, IReadUserRestReturnValue_2_0>;
20458
+ updateUser: TRestAPIOperation<IUpdateUserRestData_2_0, IUpdateUserRestReturnValue_2_0>;
20459
+ updateUserMe: TRestAPIOperation<IUpdateUserMeRestData_2_0, IUpdateUserMeRestReturnValue_2_0>;
20460
+ deleteUser: TRestAPIOperation<IDeleteUserRestData_2_0, IDeleteUserRestReturnValue_2_0>;
20461
+ deleteUserMe: TRestAPIOperation<void, void>;
20462
+ createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_0, ICreateApiKeyMeRestReturnValue_2_0>;
20463
+ deleteApiKeyMe: TRestAPIOperation<IDeleteApiKeyMeRestData_2_0, IDeleteApiKeyMeRestReturnValue_2_0>;
20464
+ indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_0, IIndexApiKeysMeRestReturnValue_2_0>;
20465
+ addRoleToUser: TRestAPIOperation<IAddRoleToUserRestData_2_0, IAddRoleToUserRestReturnValue_2_0>;
20466
+ removeRoleFromUser: TRestAPIOperation<IRemoveRoleFromUserRestData_2_0, IRemoveRoleFromUserRestReturnValue_2_0>;
20467
+ readUserAclMe: TRestAPIOperation<void, IReadUserAclMeRestReturnValue_2_0>;
20468
+ acceptTermsOfService: TRestAPIOperation;
20469
+ indexProjectMembers: TRestAPIOperation<IIndexProjectMembersRestData_2_0, IIndexProjectMembersRestReturnValue_2_0>;
20470
+ readProjectMember: TRestAPIOperation<IReadProjectMemberRestData_2_0, IReadProjectMemberRestReturnValue_2_0>;
20471
+ addProjectMember: TRestAPIOperation<IAddProjectMemberRestData_2_0, IAddProjectMemberRestReturnValue_2_0>;
20472
+ updateProjectMember: TRestAPIOperation<IUpdateProjectMemberRestData_2_0, IUpdateProjectMemberRestReturnValue_2_0>;
20473
+ removeProjectMember: TRestAPIOperation<IRemoveProjectMemberRestData_2_0, IRemoveProjectMemberRestReturnValue_2_0>;
20474
+ addRoleToMember: TRestAPIOperation<IAddRoleToMemberRestData_2_0, IAddRoleToMemberRestReturnValue_2_0>;
20475
+ removeRoleFromMember: TRestAPIOperation<IRemoveRoleFromMemberRestData_2_0, IRemoveRoleFromMemberRestReturnValue_2_0>;
20476
+ addProjectToUser: TRestAPIOperation<IAddProjectToUserRestData_2_0, IAddProjectToUserRestReturnValue_2_0>;
20477
+ removeProjectFromUser: TRestAPIOperation<IRemoveProjectFromUserRestData_2_0, IRemoveProjectFromUserRestReturnValue_2_0>;
20478
+ configureIdentityProvider: TRestAPIOperation<IConfigureIdentityProviderRestData_2_0, IConfigureIdentityProviderRestReturnValue_2_0>;
20479
+ resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
20480
+ setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
20481
+ setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
20482
+ updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
20483
+ readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
20484
+ readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
20485
+ requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
20486
+ readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
20487
+ setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
20488
+ readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
20489
+ readOrganisationPolicies: TRestAPIOperation<void, IReadOrganisationRestReturnValue_2_0>;
20490
+ readOrganisationKnowledgeChunksCount: TRestAPIOperation<void, IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0>;
20491
+ }
20492
+ declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
20493
+ /**
20494
+ * @openapi
20495
+ *
20496
+ * components:
20497
+ * schemas:
20498
+ * IApiKeyIndexItem_2_1:
20499
+ * type: object
20500
+ * properties:
20501
+ * _id:
20502
+ * $ref: '#/components/schemas/TMongoId'
20503
+ * name:
20504
+ * type: string
20505
+ * createdAt:
20506
+ * type: number
20507
+ */
20508
+ export interface IApiKeyIndexItem_2_1 {
20509
+ /** The object id of the api-key */
20510
+ _id: TMongoId;
20511
+ /** The name of the api-key, e.g. 'my demo' */
20512
+ name: string;
20513
+ createdAt: number;
20514
+ schemaVersion: number;
20515
+ }
20516
+ export interface IIndexApiKeysMeRestData_2_1 extends IRestPagination<IApiKeyIndexItem_2_1> {
20517
+ }
20518
+ export interface IIndexApiKeysMeRestReturnValue_2_1 extends ICursorBasedPaginationReturnValue<IApiKeyIndexItem_2_1> {
20519
+ }
20520
+ /**
20521
+ * @openapi
20522
+ *
20523
+ * components:
20524
+ * schemas:
20525
+ * IApiKeyData_2_1:
20526
+ * type: object
20527
+ * properties:
20528
+ * name:
20529
+ * type: string
20530
+ *
20531
+ * IApiKey_2_1:
20532
+ * allOf:
20533
+ * - $ref: '#/components/schemas/IApiKeyData_2_1'
20534
+ * - type: object
20535
+ * properties:
20536
+ * _id:
20537
+ * $ref: '#/components/schemas/TMongoId'
20538
+ * createdAt:
20539
+ * type: integer
20540
+ * minimum: 0
20541
+ * maximum: 2147483647
20542
+ * example: 1527621049
20543
+ * apiKey:
20544
+ * type: string
20545
+ */
20546
+ export interface IApiKey_2_1 {
20547
+ /** The object id of the api-key */
20548
+ _id: TMongoId;
20549
+ /** The name of the api-key, e.g. 'my demo' */
20550
+ name: string;
20551
+ /** The actual api-key */
20552
+ apiKey: string;
20553
+ createdAt: number;
20554
+ schemaVersion: number;
20555
+ }
20556
+ export interface ICreateApiKeyMeRestDataBody_2_1 extends Partial<Omit<IApiKey_2_1, keyof IEntityMeta | "apiKey">> {
20557
+ }
20558
+ export interface ICreateApiKeyMeRestData_2_1 extends ICreateApiKeyMeRestDataBody_2_1 {
20559
+ }
20560
+ export interface ICreateApiKeyMeRestReturnValue_2_1 extends IApiKey_2_1 {
20561
+ }
20562
+ export interface AdministrationAPIGroup_2_1 extends Omit<AdministrationAPIGroup_2_0, "createApiKeyMe" | "indexApiKeysMe"> {
20563
+ createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_1, ICreateApiKeyMeRestReturnValue_2_1>;
20564
+ indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_1, IIndexApiKeysMeRestReturnValue_2_1>;
20565
+ }
20566
+ declare function AdministrationAPIGroup_2_1(instance: Base): AdministrationAPIGroup_2_1;
20567
+ /**
20568
+ * @openapi
20569
+ *
20570
+ * components:
20571
+ * schemas:
20572
+ * IVendor_2_0:
20573
+ * type: object
20574
+ * properties:
20575
+ * version:
20576
+ * type: string
20577
+ * description: The product version we are running
20578
+ * frontendBaseUrl:
20579
+ * type: string
20580
+ * description: Base URL to the frontend UI
20581
+ * hasLicenseAgreement:
20582
+ * type: string
20583
+ * description: Flag whether users need to agree the license agreement within this env
20584
+ * maxContactProfileTTL:
20585
+ * type: number
20586
+ * maxConversationTTL:
20587
+ * type: number
20588
+ * maxSessionStateTTL:
20589
+ * type: number
20590
+ */
20591
+ export interface IVendor_2_0 {
20592
+ /** The COGNIGY.AI version we are running */
20593
+ version: string;
20594
+ /** Base URL to the frontend UI */
20595
+ frontendBaseUrl: string;
20596
+ /** Flag whether users need to agree the license agreement within this env */
20597
+ hasLicenseAgreement: boolean;
20598
+ maxContactProfileTTL: number;
20599
+ maxConversationTTL: number;
20600
+ maxSessionStateTTL: number;
20601
+ }
20602
+ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
20603
+ }
20020
20604
  export interface IGetBillingInformationRestData_2_0 extends IRestPagination<{
20021
20605
  name: string;
20022
20606
  isDisabled: boolean;