@cognigy/rest-api-client 0.15.0 → 0.16.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 (137) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/build/GenericTusFn.js +64 -0
  3. package/build/RestAPIClient.js +3 -0
  4. package/build/apigroups/AdministrationAPIGroup_2_0.js +7 -2
  5. package/build/apigroups/ResourcesAPIGroup_2_0.js +28 -23
  6. package/build/{shared/interfaces/agentAssist/ISendTileUpdateReferenceParams.js → apigroups/TTusAPIOperation.js} +1 -1
  7. package/build/apigroups/index.js +2 -0
  8. package/build/connector/AxiosAdapter.js +5 -4
  9. package/build/shared/charts/descriptors/agentAssist/constants/constants.js +7 -0
  10. package/build/shared/charts/descriptors/agentAssist/helpers/sentiment.helper.js +41 -0
  11. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/identityAssistTemplate.js +54 -0
  12. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +187 -0
  13. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/nextActionWidgetTemplate.js +93 -0
  14. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage0.js +81 -0
  15. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage1.js +84 -0
  16. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage2.js +97 -0
  17. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stageError.js +85 -0
  18. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/sentimentAnalysisTemplate.js +41 -0
  19. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/stylesPartial.js +15 -0
  20. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/transcriptAssistTemplate.js +53 -0
  21. package/build/shared/charts/descriptors/agentAssist/identityAssist.js +135 -0
  22. package/build/shared/charts/descriptors/agentAssist/index.js +15 -1
  23. package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +625 -0
  24. package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +77 -0
  25. package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +86 -0
  26. package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js +2 -2
  27. package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +105 -0
  28. package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js +2 -2
  29. package/build/shared/charts/descriptors/agentAssist/setIframeTile.js +2 -2
  30. package/build/shared/charts/descriptors/agentAssist/setSecureFormsTile.js +171 -0
  31. package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +72 -0
  32. package/build/shared/charts/descriptors/allFields.js +6 -0
  33. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/TGenerativeAIConnectionFields.js +3 -0
  34. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/alephAlphaProviderConnection.js +11 -0
  35. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/anthropicProviderConnection.js +1 -1
  36. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnectionV2.js +1 -1
  37. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +6 -2
  38. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +1 -1
  39. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +4 -4
  40. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/azureBlobStorageProviderConnection.js +3 -3
  41. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/googleCloudStorageProviderConnection.js +3 -3
  42. package/build/shared/charts/descriptors/connectionNodes/mongoDB/mongoDBConnection.js +1 -1
  43. package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2Connection.js +8 -8
  44. package/build/shared/charts/descriptors/connectionNodes/smtp/serviceConnection.js +2 -2
  45. package/build/shared/charts/descriptors/connectionNodes/smtp/smtpConnection.js +5 -5
  46. package/build/shared/charts/descriptors/connectionNodes/speechProviders/awsSpeechProviderConnection.js +4 -4
  47. package/build/shared/charts/descriptors/connectionNodes/speechProviders/microsoftSpeechProviderConnection.js +2 -2
  48. package/build/shared/charts/descriptors/connectionNodes/sql/sqlConnection.js +5 -5
  49. package/build/shared/charts/descriptors/connectionNodes/translationProviders/deeplTranslationProviderConnection.js +15 -0
  50. package/build/shared/charts/descriptors/connectionNodes/translationProviders/googleTranslationProviderConnection.js +15 -0
  51. package/build/shared/charts/descriptors/connectionNodes/translationProviders/index.js +23 -0
  52. package/build/shared/charts/descriptors/connectionNodes/translationProviders/microsoftTranslationProviderConnection.js +21 -0
  53. package/build/shared/charts/descriptors/index.js +13 -2
  54. package/build/shared/charts/descriptors/knowledgeSearch/constants/constants.js +6 -0
  55. package/build/shared/charts/descriptors/knowledgeSearch/index.js +5 -1
  56. package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearch.js +7 -2
  57. package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearchV2.js +151 -0
  58. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +985 -0
  59. package/build/shared/charts/descriptors/logic/goTo.js +3 -1
  60. package/build/shared/charts/descriptors/message/question/optionalQuestion.js +2 -2
  61. package/build/shared/charts/descriptors/message/question/question.js +215 -8
  62. package/build/shared/charts/descriptors/nlu/cleanText.js +1 -0
  63. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +103 -5
  64. package/build/shared/charts/descriptors/service/GPTConversation.js +125 -23
  65. package/build/shared/charts/descriptors/service/GPTPrompt.js +148 -12
  66. package/build/shared/charts/descriptors/service/checkAgentAvailability.js +15 -1
  67. package/build/shared/charts/descriptors/service/handoverV2.js +45 -0
  68. package/build/shared/{interfaces/twilioInterface.js → charts/descriptors/voice/interface/IBandwidth.js} +1 -1
  69. package/build/shared/charts/descriptors/voice/mappers/base.mapper.js +14 -0
  70. package/build/shared/charts/descriptors/voice/mappers/hangup.mapper.js +26 -0
  71. package/build/shared/charts/descriptors/voice/mappers/muteSpeechInput.mapper.js +17 -2
  72. package/build/shared/charts/descriptors/voice/mappers/play.mapper.js +54 -0
  73. package/build/shared/charts/descriptors/voice/mappers/record.mapper.js +7 -0
  74. package/build/shared/charts/descriptors/voice/mappers/sendMetadata.mapper.js +15 -0
  75. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +38 -8
  76. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +31 -9
  77. package/build/shared/charts/descriptors/voice/nodes/muteSpeechInput.js +1 -1
  78. package/build/shared/charts/descriptors/voice/nodes/play.js +1 -1
  79. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +118 -4
  80. package/build/shared/charts/descriptors/voice/nodes/transfer.js +11 -3
  81. package/build/shared/charts/descriptors/voice/utils/vgConstants.js +14 -0
  82. package/build/shared/charts/descriptors/voicegateway/index.js +14 -11
  83. package/build/shared/charts/descriptors/voicegateway/utils/paramUtils.js +1 -5
  84. package/build/shared/charts/descriptors/voicegateway2/nodes/muteSpeechInput.js +12 -1
  85. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +6 -0
  86. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +158 -10
  87. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +296 -43
  88. package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +30 -4
  89. package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +1 -1
  90. package/build/shared/constants.js +5 -1
  91. package/build/shared/handoverClients/interfaces/THandoverEventType.js +3 -1
  92. package/build/shared/helper/BaseContext.js +2 -15
  93. package/build/shared/helper/nlu/textCleaner.js +25 -3
  94. package/build/shared/interfaces/IEndpointTranslationSettings.js +9 -0
  95. package/build/shared/interfaces/IOrganisation.js +2 -1
  96. package/build/shared/interfaces/agentAssist/ISendConfigUpdateParams.js +3 -0
  97. package/build/shared/interfaces/agentAssist/ISendUpdateReferenceParams.js +3 -0
  98. package/build/shared/interfaces/amqpInterface.js +18 -22
  99. package/build/shared/interfaces/channels/genesysBotConnector.js +21 -0
  100. package/build/shared/interfaces/channels/niceCXOne.js +8 -0
  101. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +15 -7
  102. package/build/shared/interfaces/handover.js +57 -3
  103. package/build/shared/interfaces/journeys/IJourney.js +6 -0
  104. package/build/shared/interfaces/journeys/IJourneyTrackEvent.js +2 -0
  105. package/build/shared/interfaces/messageAPI/endpoints.js +91 -8
  106. package/build/shared/interfaces/resources/IAuditEvent.js +1 -0
  107. package/build/shared/interfaces/resources/IConnectionSchema.js +3 -0
  108. package/build/shared/interfaces/resources/IEndpoint.js +1 -0
  109. package/build/shared/interfaces/resources/IExtension.js +3 -0
  110. package/build/shared/interfaces/resources/ILargeLanguageModel.js +24 -5
  111. package/build/shared/interfaces/resources/INodeDescriptorSet.js +23 -1
  112. package/build/shared/interfaces/resources/TNLUConnectorType.js +0 -1
  113. package/build/shared/interfaces/resources/TRestChannelType.js +16 -11
  114. package/build/shared/interfaces/resources/TWebhookChannelType.js +6 -1
  115. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +21 -3
  116. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +13 -2
  117. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeStore.js +1 -1
  118. package/build/shared/interfaces/resources/settings/IAgentSettings.js +3 -23
  119. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
  120. package/build/shared/interfaces/resources/settings/ITranslationSettings.js +63 -0
  121. package/build/shared/interfaces/resources/settings/index.js +4 -1
  122. package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/IReadVoiceGatewayAccountRest_2_0.js +3 -0
  123. package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/ISetupVoiceGatewayAccountRest_2_0.js +3 -0
  124. package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/index.js +3 -0
  125. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IGetKnowledgeQueryCounterOrganisationRest_2_0.js +3 -0
  126. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IGetKnowledgeQueryCounterRest_2_0.js +3 -0
  127. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IKnowlegeQueryCounterAggregatedValue_2_0.js +3 -0
  128. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/index.js +3 -0
  129. package/build/shared/interfaces/restAPI/resources/nluconnector/v2.0/TNLUConnectorType_2_0.js +0 -2
  130. package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/IUploadResumableRest_2_0.js +17 -0
  131. package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/index.js +3 -0
  132. package/build/shared/interfaces/security/IKnowledgeQueryCounterAggregatedValue.js +3 -0
  133. package/build/shared/interfaces/security/IPermission.js +2 -0
  134. package/build/shared/interfaces/security/IRole.js +3 -1
  135. package/build/test.js +27 -0
  136. package/package.json +19 -17
  137. package/types/index.d.ts +581 -129
package/types/index.d.ts CHANGED
@@ -417,7 +417,8 @@ declare const organisationWidePermissions: readonly [
417
417
  "liveAgentAccount",
418
418
  "projects",
419
419
  "userDetails",
420
- "users"
420
+ "users",
421
+ "voiceGatewayAccount"
421
422
  ];
422
423
  export declare type TOrganisationWidePermissions = typeof organisationWidePermissions[number];
423
424
  declare const projectWidePermissions: readonly [
@@ -480,12 +481,6 @@ export declare type TTimestamp = number;
480
481
  * has. These are dates when a resource was created and modified as well as information
481
482
  * about the user who initially created a resource and who modified it the last time.
482
483
  * type: object
483
- * required:
484
- * - _id
485
- * - createdAt
486
- * - lastChanged
487
- * - createdBy
488
- * - lastChangedBy
489
484
  * properties:
490
485
  * _id:
491
486
  * $ref: '#/components/schemas/TMongoId'
@@ -912,7 +907,7 @@ declare const referenceKeys: readonly [
912
907
  "storeReference",
913
908
  "sourceReference"
914
909
  ];
915
- export declare type TReferenceKeys = typeof referenceKeys[number];
910
+ export declare type TReferenceKeys = (typeof referenceKeys)[number];
916
911
  export declare type TReferenceAndEntityMetaKeys = TReferenceKeys | TEntityMetaKeys | "referenceId";
917
912
  export declare type TNonQueriableKeys<T> = TReferenceKeys;
918
913
  declare const organisationWideRoles: readonly [
@@ -926,7 +921,8 @@ declare const organisationWideRoles: readonly [
926
921
  "odata",
927
922
  "projectManager",
928
923
  "userManager",
929
- "userDetailsViewer"
924
+ "userDetailsViewer",
925
+ "voiceGatewayUser"
930
926
  ];
931
927
  export declare type TOrganisationWideRole = typeof organisationWideRoles[number];
932
928
  declare const projectWideRoles: readonly [
@@ -1066,6 +1062,8 @@ export interface ICrudPermissions {
1066
1062
  * $ref: '#/components/schemas/ICrudPermissions'
1067
1063
  * tokens:
1068
1064
  * $ref: '#/components/schemas/ICrudPermissions'
1065
+ * voiceGatewayAccount:
1066
+ * $ref: '#/components/schemas/ICrudPermissions'
1069
1067
  * roles:
1070
1068
  * type: array
1071
1069
  * items:
@@ -1540,6 +1538,7 @@ export interface IHttpAdapter {
1540
1538
  request(request: IHttpRequest, client: any): PromiseLike<IHttpResponse>;
1541
1539
  setConfig(config: IRestAPIClientConfig): void;
1542
1540
  }
1541
+ export declare type TTusAPIOperation<Data = void, ReturnValue = void> = (args: Data) => ReturnValue;
1543
1542
  declare const arrayTResourceType: readonly [
1544
1543
  "agentassistconfig",
1545
1544
  "agentSettings",
@@ -1601,7 +1600,6 @@ declare const arrayNLUConnectorType: readonly [
1601
1600
  "dialogflow",
1602
1601
  "dialogflowBuiltIn",
1603
1602
  "amazonLexBuiltIn",
1604
- "twilioAutopilotBuiltIn",
1605
1603
  "luis",
1606
1604
  "watson",
1607
1605
  "noNlu",
@@ -1818,24 +1816,26 @@ declare const webhookChannelTypes: readonly [
1818
1816
  "ringCentralEngage",
1819
1817
  "intercom",
1820
1818
  "whatsapp",
1821
- "eightByEight"
1819
+ "eightByEight",
1820
+ "agentAssistVoice"
1822
1821
  ];
1823
1822
  export declare type TWebhookChannelType = typeof webhookChannelTypes[number];
1824
1823
  declare const restChannelTypes: readonly [
1825
1824
  "alexa",
1826
1825
  "audioCodes",
1827
1826
  "avaya",
1827
+ "bandwidth",
1828
1828
  "dialogflow",
1829
- "google",
1830
1829
  "line",
1831
1830
  "microsoftTeams",
1832
1831
  "rest",
1833
- "twilio-autopilot",
1834
1832
  "twilio-sms",
1835
1833
  "twilio",
1836
1834
  "userlike",
1837
1835
  "nonConversational",
1838
- "amazonLex"
1836
+ "amazonLex",
1837
+ "genesysBotConnector",
1838
+ "niceCXOne"
1839
1839
  ];
1840
1840
  export declare type TRestChannelType = typeof restChannelTypes[number];
1841
1841
  declare const socketChannelTypes: readonly [
@@ -2035,6 +2035,7 @@ declare const handoverProviders: readonly [
2035
2035
  "salesforce",
2036
2036
  "liveAgent",
2037
2037
  "genesysCloud",
2038
+ "genesysCloudOM",
2038
2039
  "eightByEight"
2039
2040
  ];
2040
2041
  export declare type THandoverProvider = typeof handoverProviders[number];
@@ -2049,7 +2050,7 @@ declare const whisperAssistConfigurations: readonly [
2049
2050
  "template"
2050
2051
  ];
2051
2052
  export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
2052
- export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings;
2053
+ export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
2053
2054
  export interface IRCEHandoverSettings {
2054
2055
  /**
2055
2056
  * Whether to forward all conversations
@@ -2059,6 +2060,11 @@ export interface IRCEHandoverSettings {
2059
2060
  * was triggered.
2060
2061
  */
2061
2062
  forwardOnlyHandoverConversations?: boolean;
2063
+ /**
2064
+ * Indicates if queue updates should be enabled
2065
+ * to receive events about the estimated wait time
2066
+ */
2067
+ getQueueUpdates?: boolean;
2062
2068
  /**
2063
2069
  * The API access token
2064
2070
  * you can create within RCE
@@ -2182,6 +2188,7 @@ export interface IAgentAssistSettings {
2182
2188
  enableTranscriptTile?: boolean;
2183
2189
  enableTranscriptTileChatInput?: boolean;
2184
2190
  redactTranscriptTileMessages?: boolean;
2191
+ oAuth2Connection?: string;
2185
2192
  }
2186
2193
  export interface IGenesysCloudHandoverSettings {
2187
2194
  host: string;
@@ -2200,13 +2207,31 @@ export interface IGenesysCloudHandoverSettings {
2200
2207
  */
2201
2208
  forwardOnlyHandoverConversations: true;
2202
2209
  }
2210
+ export interface IGenesysCloudOMHandoverSettings {
2211
+ host: string;
2212
+ deploymentName: string;
2213
+ queue: string;
2214
+ webhookSecret: string;
2215
+ sendProfile: boolean;
2216
+ clientId: string;
2217
+ clientSecret: string;
2218
+ /**
2219
+ * This setting cannot be changed,
2220
+ * since the cognigy client only supports
2221
+ * forwarding handover conversations. The value
2222
+ * is therefore set to 'true'
2223
+ */
2224
+ forwardOnlyHandoverConversations: true;
2225
+ }
2203
2226
  export interface IHandoverStatusInputObject {
2204
2227
  status: THandoverStatus;
2228
+ eventType?: "queueUpdate" | "handoverInactivity";
2205
2229
  inactivityCount?: number;
2206
2230
  error?: {
2207
2231
  reason: "unsupported" | "error";
2208
2232
  message: string;
2209
2233
  };
2234
+ data?: any;
2210
2235
  }
2211
2236
  export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject";
2212
2237
  export interface IEndpointTranslationSettings {
@@ -2214,6 +2239,9 @@ export interface IEndpointTranslationSettings {
2214
2239
  flowLanguage: string;
2215
2240
  inputLanguage: "auto" | string;
2216
2241
  noTranslateMarker: string;
2242
+ glossaryId?: string;
2243
+ glossaryIdInput?: string;
2244
+ formality?: "default" | "more" | "less" | "prefer_more" | "prefer_less";
2217
2245
  padPayloads: boolean;
2218
2246
  alwaysRemoveNoTranslateMarker: boolean;
2219
2247
  setInputLanguageOnExecutionCount: number;
@@ -2259,6 +2287,8 @@ export interface IEndpoint extends IEntityMeta {
2259
2287
  useContactProfiles: boolean;
2260
2288
  /** Whether we should store analytics for this endpoint */
2261
2289
  useAnalytics: boolean;
2290
+ /** Whether we should store data payloads into analytics for this endpoint */
2291
+ storeDataPayload: boolean;
2262
2292
  /** Whether we should use Chatbase to collect analytics */
2263
2293
  useChatbaseAnalytics: boolean;
2264
2294
  /** The apikey for the Chatbase bot */
@@ -2320,7 +2350,6 @@ export interface IGraphEndpointDependency {
2320
2350
  * - facebook
2321
2351
  * - alexa
2322
2352
  * - slack
2323
- * - google
2324
2353
  * - generic
2325
2354
  * - inject
2326
2355
  * - rest
@@ -2331,7 +2360,6 @@ export interface IGraphEndpointDependency {
2331
2360
  * - dialogflow
2332
2361
  * - twilio
2333
2362
  * - twilio-sms
2334
- * - twilio-autopilot
2335
2363
  * - line
2336
2364
  * - intercom
2337
2365
  * - microsoftBotFramework
@@ -2342,6 +2370,18 @@ export interface IGraphEndpointDependency {
2342
2370
  * - nonConversational
2343
2371
  * - voiceGateway2
2344
2372
  * - amazonLex
2373
+ * - workplace
2374
+ * - webhook
2375
+ * - abstractRest
2376
+ * - userlike
2377
+ * - ringCentralEngage
2378
+ * - audioCodes
2379
+ * - bandwidth
2380
+ * - whatsapp
2381
+ * - eightByEight
2382
+ * - genesysBotConnector
2383
+ * - niceCXOne
2384
+ * - agentAssistVoice
2345
2385
  */
2346
2386
  export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
2347
2387
  declare const endpointTypes: readonly [
@@ -2349,7 +2389,6 @@ declare const endpointTypes: readonly [
2349
2389
  "workplace",
2350
2390
  "alexa",
2351
2391
  "slack",
2352
- "google",
2353
2392
  "webhook",
2354
2393
  "rest",
2355
2394
  "abstractRest",
@@ -2359,7 +2398,6 @@ declare const endpointTypes: readonly [
2359
2398
  "dialogflow",
2360
2399
  "twilio",
2361
2400
  "twilioSms",
2362
- "twilioAutopilot",
2363
2401
  "line",
2364
2402
  "intercom",
2365
2403
  "microsoftBotFramework",
@@ -2373,9 +2411,18 @@ declare const endpointTypes: readonly [
2373
2411
  "voiceGateway2",
2374
2412
  "whatsapp",
2375
2413
  "amazonLex",
2376
- "eightByEight"
2414
+ "eightByEight",
2415
+ "bandwidth",
2416
+ "genesysBotConnector",
2417
+ "niceCXOne",
2418
+ "agentAssistVoice"
2377
2419
  ];
2378
2420
  export declare type TEndpointType = typeof endpointTypes[number];
2421
+ declare const transferTypes: readonly [
2422
+ "dial",
2423
+ "sip:refer"
2424
+ ];
2425
+ export declare type TTransferType = typeof transferTypes[number];
2379
2426
  export interface IWebchatPersistentMenu {
2380
2427
  /**
2381
2428
  * The title of the persistent menu
@@ -2398,28 +2445,58 @@ export interface IWebchatPersistentMenu {
2398
2445
  payload: string;
2399
2446
  }[];
2400
2447
  }
2401
- declare const callEvents: readonly [
2402
- any,
2403
- "RECOGNIZED_SPEECH",
2404
- "RECOGNIZED_DTMF",
2405
- "CALL_CREATED",
2406
- "CALL_RECONNECTED",
2407
- "CALL_COMPLETED",
2408
- "CALL_FAILED",
2409
- "USER_INPUT_TIMEOUT",
2410
- "ANSWERING_MACHINE_DETECTION"
2411
- ];
2412
- export declare type TCallEvent = typeof callEvents[number];
2413
2448
  export interface ICallEventSettings {
2414
2449
  enabled: boolean;
2415
- event: TCallEvent;
2416
- action: "inject" | "executeFlow";
2450
+ action: "inject" | "executeFlow" | "transfer" | "none";
2417
2451
  flowId: string;
2418
2452
  entrypoint?: string;
2419
2453
  injectText?: string;
2420
2454
  injectData?: string;
2455
+ failover?: ICallEventFailoverSettings;
2456
+ }
2457
+ export interface ICallEventFailoverSettings {
2458
+ enabled?: boolean;
2459
+ type?: TTransferType;
2460
+ headers?: string;
2461
+ to?: string;
2462
+ reason?: string;
2463
+ dialCallerId?: string;
2464
+ dialMusic?: string;
2465
+ dialTimeout?: number;
2466
+ dialTranscribeEnabled?: boolean;
2467
+ dialTranscribeVendor?: string;
2468
+ dialTranscribeLanguage?: string;
2469
+ dialTranscribeWebhook?: string;
2470
+ dialTranscribeRecognitionChannel?: number;
2471
+ dialTranscribeRecognitionGoogleModel?: string;
2472
+ dialTranscribeLabel?: string;
2473
+ dialTranscribeDeepgramTier?: string;
2474
+ dialTranscribeDeepgramModel?: string;
2475
+ deepgramSmartFormatting?: boolean;
2476
+ deepgramEndpointing?: boolean;
2477
+ deepgramEndpointingValue?: number;
2478
+ }
2479
+ export interface ICallEvents {
2480
+ amd?: ICallEventSettings;
2481
+ callCreated?: ICallEventSettings;
2482
+ callCompleted?: ICallEventSettings;
2483
+ callFailed?: ICallEventSettings;
2484
+ callReconnected?: ICallEventSettings;
2485
+ userInputTimeout?: ICallEventSettings;
2486
+ recognizedSpeech?: ICallEventSettings;
2487
+ recognizedDtmf?: ICallEventSettings;
2488
+ transferReferSuccess?: ICallEventSettings;
2489
+ transferReferError?: ICallEventSettings;
2490
+ transferDialSuccess?: ICallEventSettings;
2491
+ transferDialError?: ICallEventSettings;
2492
+ userBusy?: ICallEventSettings;
2493
+ noAnswer?: ICallEventSettings;
2494
+ }
2495
+ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
2496
+ callEvents: ICallEvents;
2497
+ failover?: ICallEventFailoverSettings;
2421
2498
  }
2422
- export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | {};
2499
+ export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
2423
2500
  export declare type TAvayaVoice = "man" | "woman" | string;
2424
2501
  declare const avayaSttTtsLanguages: readonly [
2425
2502
  "cy-GB",
@@ -2642,6 +2719,8 @@ export interface IGenericEndpointSettings {
2642
2719
  basicAuthPassword: string;
2643
2720
  webhookUrl: string;
2644
2721
  }
2722
+ export interface IAgentAssistVoiceEndpointSettings {
2723
+ }
2645
2724
  export interface ISunshineConversationsEndpointSettings extends IEndpointSessionSettings {
2646
2725
  sunshineConversationsChannelKeyId: string;
2647
2726
  sunshineConversationsChannelSecret: string;
@@ -2703,9 +2782,6 @@ export interface IMicrosoftBotFrameworkEndpointSettings extends IEndpointSession
2703
2782
  connectionName: string;
2704
2783
  tenantId: string;
2705
2784
  }
2706
- export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
2707
- callEvents: ICallEventSettings;
2708
- }
2709
2785
  /**
2710
2786
  * Settings that are shared by both
2711
2787
  * Webchat and Webchat2
@@ -3069,6 +3145,13 @@ export interface IUserlikeUnifiedMessagingEndpointSettings {
3069
3145
  securityToken: string;
3070
3146
  }
3071
3147
  export declare type IUserlikeEndpointSettings = IUserlikeRestEndpointSettings | IUserlikeUnifiedMessagingEndpointSettings;
3148
+ export interface IBandwidthEndpointSettings {
3149
+ /**
3150
+ * If true the BandwidthWebsocketClient is used.
3151
+ * Default: false
3152
+ */
3153
+ enableAsyncCommunication: boolean;
3154
+ }
3072
3155
  export interface IAudioCodesEndpointSettings {
3073
3156
  /**
3074
3157
  * If true the AudioCodesWebsocketClient is used.
@@ -3202,12 +3285,17 @@ export interface IEightByEightEndpointSettings extends IEndpointSessionSettings
3202
3285
  /** Settings to store attachments at a cloud provider */
3203
3286
  fileStorageSettings?: IFileStorageSettings;
3204
3287
  }
3288
+ export interface IGenesysBotConnectorEndpointSettings {
3289
+ verifyToken: string;
3290
+ }
3291
+ export interface INiceCXOneEndpointSettings {
3292
+ verifyToken: string;
3293
+ }
3205
3294
  declare const arrayNLUConnectorType_2_0: readonly [
3206
3295
  "alexa",
3207
3296
  "dialogflow",
3208
3297
  "dialogflowBuiltIn",
3209
3298
  "amazonLexBuiltIn",
3210
- "twilioAutopilotBuiltIn",
3211
3299
  "luis",
3212
3300
  "watson",
3213
3301
  "noNlu",
@@ -3219,8 +3307,11 @@ declare const arrayNLUConnectorType_2_0: readonly [
3219
3307
  export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
3220
3308
  declare const generativeAIModels: readonly [
3221
3309
  "gpt-3.5-turbo",
3310
+ "gpt-3.5-turbo-instruct",
3311
+ "gpt-4",
3222
3312
  "text-davinci-003",
3223
3313
  "text-embedding-ada-002",
3314
+ "luminous-extended-control",
3224
3315
  "claude-v1-100k",
3225
3316
  "claude-instant-v1",
3226
3317
  "text-bison@001"
@@ -3229,19 +3320,21 @@ export declare type TGenerativeAIModels = typeof generativeAIModels[number];
3229
3320
  declare const generativeAIProviders: readonly [
3230
3321
  "azureOpenAI",
3231
3322
  "openAI",
3323
+ "alephAlpha",
3232
3324
  "anthropic",
3233
3325
  "googleVertexAI"
3234
3326
  ];
3235
3327
  export declare type TGenerativeAIProviders = typeof generativeAIProviders[number];
3236
3328
  declare const generativeAIUseCases: readonly [
3237
- "intentSentenceGeneration",
3329
+ "knowledgeSearch",
3330
+ "gptPromptNode",
3331
+ "gptConversation",
3238
3332
  "aiEnhancedOutputs",
3239
- "lexiconGeneration",
3333
+ "sentimentAnalysis",
3334
+ "intentSentenceGeneration",
3240
3335
  "flowGeneration",
3241
- "gptConversation",
3242
- "gptPromptNode",
3243
3336
  "generateNodeOutput",
3244
- "knowledgeSearch"
3337
+ "lexiconGeneration"
3245
3338
  ];
3246
3339
  export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
3247
3340
  export interface IGenerativeAIUseCaseSettings {
@@ -3936,55 +4029,63 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
3936
4029
  * - google
3937
4030
  * - deepl
3938
4031
  */
3939
- export declare type TTranslationProvider_2_0 = "none" | "microsoft" | "google" | "deepl";
4032
+ export declare type TTranslationProvider_2_0 = "microsoft" | "google" | "deepl" | "none";
3940
4033
  /**
3941
4034
  * @openapi
3942
4035
  *
3943
4036
  * components:
3944
4037
  * schemas:
3945
- * IAgentTranslationSettings_2_0:
4038
+ * TranslationConnection:
3946
4039
  * type: object
3947
4040
  * properties:
3948
- * translationProvider:
3949
- * $ref: '#/components/schemas/TTranslationProvider_2_0'
3950
- * translationAPIKey:
4041
+ * connecionId:
3951
4042
  * type: string
3952
- * maxLength: 30
3953
- * description: Translation Provider API Key
3954
- * translationProviderCustomBaseUrl:
4043
+ * description: ReferenceId to the connection provider
4044
+ * retries:
3955
4045
  * type: string
3956
- * maxLength: 255
3957
- * description: Optional Custom Base URL
3958
- * translationRetries:
3959
- * type: integer
3960
- * minimum: 0
3961
- * maximum: 3
3962
- * description: How often to retry calling the translation provider if an error occurs
3963
- * translationTimeout:
3964
- * type: integer
3965
- * minimum: 0
3966
- * maximum: 8000
3967
- * description: How long to wait for the provider to answer a request (in milliseconds)
3968
- * translationCacheExpiry:
3969
- * type: integer
3970
- * enum:
3971
- * - 0
3972
- * - 3600
3973
- * - 8000
3974
- * description: How long to keep translated sentences in the cache (in seconds)
3975
- * translationRegion:
3976
- * type: string
3977
- * maxLength: 255
3978
- * description: Optional translation region, e.g. Ocp-Apim-Subscription-Region for Microsoft Translator
4046
+ * description: Number of retries
4047
+ * default: 1
4048
+ * timeout:
4049
+ * type: string
4050
+ * description: Timeout in milliseconds
4051
+ * default: 3000
4052
+ * cacheExpiry:
4053
+ * type: string
4054
+ * description: Cache expiry in milliseconds
4055
+ * default: 0
4056
+ * customBaseUrl:
4057
+ * type: string
4058
+ * description: Custom base url
4059
+ * default: ""
4060
+ * IAgentTranslationSettings_2_0:
4061
+ * type: object
4062
+ * properties:
4063
+ * provider:
4064
+ * $ref: '#/components/schemas/TTranslationProvider_2_0'
4065
+ * connections:
4066
+ * type: object
4067
+ * properties:
4068
+ * microsoft:
4069
+ * $ref: '#/components/schemas/TranslationConnection'
4070
+ * deepl:
4071
+ * $ref: '#/components/schemas/TranslationConnection'
4072
+ * google:
4073
+ * $ref: '#/components/schemas/TranslationConnection'
3979
4074
  */
4075
+ export interface ITranslationProviderFieldNames_2_0 {
4076
+ connectionId: string | null;
4077
+ retries: number;
4078
+ timeout: number;
4079
+ cacheExpiry: number;
4080
+ customBaseUrl?: string;
4081
+ }
3980
4082
  export interface IAgentTranslationSettings_2_0 {
3981
- translationProvider: TTranslationProvider_2_0;
3982
- translationAPIKey: string;
3983
- translationProviderCustomBaseUrl?: string;
3984
- translationRetries: number;
3985
- translationTimeout: number;
3986
- translationCacheExpiry: number;
3987
- translationRegion?: string;
4083
+ provider: TTranslationProvider_2_0;
4084
+ connections: {
4085
+ microsoft: ITranslationProviderFieldNames_2_0;
4086
+ google: ITranslationProviderFieldNames_2_0;
4087
+ deepl: ITranslationProviderFieldNames_2_0;
4088
+ };
3988
4089
  }
3989
4090
  /**
3990
4091
  * @openapi
@@ -4057,6 +4158,8 @@ export interface IAudioPreviewSettings_2_0 {
4057
4158
  * enum:
4058
4159
  * - openAI
4059
4160
  * - azureOpenAI
4161
+ * - anthropic
4162
+ * - googleVertexAI
4060
4163
  */
4061
4164
  export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
4062
4165
  /**
@@ -5823,6 +5926,11 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
5823
5926
  * that trigger a handover. If this setting is true,
5824
5927
  * then we will only forward conversations were handover
5825
5928
  * was triggered.
5929
+ * getQueueUpdates:
5930
+ * type: boolean
5931
+ * description: >
5932
+ * (rce) Indicates if queue updates should be enabled
5933
+ * to receive events about the estimated wait time
5826
5934
  * apiVersion:
5827
5935
  * type: string
5828
5936
  * description: (salesforce) Salesforce LiveAgent API Version
@@ -5864,10 +5972,10 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
5864
5972
  * properties:
5865
5973
  * agentAssistFlowId:
5866
5974
  * type: string
5867
- * description: Agent assist flow ID
5975
+ * description: Copilot flow ID
5868
5976
  * agentAssistConfigId:
5869
5977
  * type: string
5870
- * description: Selected Agent Assist Config ReferenceId
5978
+ * description: Selected Copilot Config ReferenceId
5871
5979
  * enableTranscriptTile:
5872
5980
  * type: boolean
5873
5981
  * description: Enable the transcript tile
@@ -6009,6 +6117,15 @@ export interface IHandoverSettings_2_0 {
6009
6117
  * noTranslateMarker:
6010
6118
  * type: string
6011
6119
  * description: Don't translate inputs and outputs which are prefixed with this prefix
6120
+ * glossaryId:
6121
+ * type: string
6122
+ * description: The glossary to use for the bot output translation
6123
+ * glossaryIdInput:
6124
+ * type: string
6125
+ * description: The glossary to use for the user input translation
6126
+ * formality:
6127
+ * type: string
6128
+ * description: Sets whether the translated text should lean towards formal or informal language
6012
6129
  * padPayloads:
6013
6130
  * type: boolean
6014
6131
  * description: If true, prevents all user inputs based on payloads to be translated
@@ -6024,6 +6141,9 @@ export interface IEndpointTranslationSettings_2_0 {
6024
6141
  flowLanguage: string;
6025
6142
  inputLanguage: "auto" | string;
6026
6143
  noTranslateMarker: string;
6144
+ glossaryId?: string;
6145
+ glossaryIdInput?: string;
6146
+ formality?: "default" | "more" | "less" | "prefer_more" | "prefer_less";
6027
6147
  padPayloads: boolean;
6028
6148
  alwaysRemoveNoTranslateMarker: boolean;
6029
6149
  setInputLanguageOnExecutionCount: number;
@@ -6048,6 +6168,8 @@ export interface IEndpointFileStorageSettings_2_0 {
6048
6168
  * description: Whether or not organisation data privacy settings are enabled
6049
6169
  * useAnalytics:
6050
6170
  * type: boolean
6171
+ * storeDataPayload:
6172
+ * type: boolean
6051
6173
  * useContactProfiles:
6052
6174
  * type: boolean
6053
6175
  * useConversations:
@@ -6062,6 +6184,7 @@ export interface IEndpointFileStorageSettings_2_0 {
6062
6184
  export interface IEndpoitOrgDataPrivacySettings_2_0 {
6063
6185
  enabled: boolean;
6064
6186
  useAnalytics: boolean;
6187
+ storeDataPayload?: boolean;
6065
6188
  useContactProfiles: boolean;
6066
6189
  useConversations: boolean;
6067
6190
  maskIPAddress?: boolean;
@@ -7310,9 +7433,17 @@ export interface IGraphConnection {
7310
7433
  referenceId: string;
7311
7434
  properties: Pick<IConnection, "type" | "extension" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
7312
7435
  }
7436
+ export interface ILLModelSelection {
7437
+ customModel: string;
7438
+ }
7439
+ export interface IOpenAIMeta extends ILLModelSelection {
7440
+ }
7441
+ export interface IAlephAlphaMeta extends ILLModelSelection {
7442
+ }
7313
7443
  export interface IAzureOpenAIMeta {
7314
- resourceName: string;
7315
- deploymentName: string;
7444
+ resourceName?: string;
7445
+ deploymentName?: string;
7446
+ baseCustomUrl?: string | null;
7316
7447
  apiVersion?: string;
7317
7448
  }
7318
7449
  export interface IGoogleVertexAIMeta {
@@ -7333,6 +7464,8 @@ export interface ILargeLanguageModel extends IEntityMeta {
7333
7464
  organisationReference: TMongoId;
7334
7465
  azureOpenAI?: IAzureOpenAIMeta;
7335
7466
  googleVertexAI?: IGoogleVertexAIMeta;
7467
+ openAI?: IOpenAIMeta;
7468
+ alephAlpha?: IAlephAlphaMeta;
7336
7469
  }
7337
7470
  export interface IGraphLargeLanguageModelDependencyAttachment {
7338
7471
  _id: string;
@@ -7656,6 +7789,7 @@ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number]
7656
7789
  * - gptPromptNode
7657
7790
  * - generateNodeOutput
7658
7791
  * - knowledgeSearch
7792
+ * - sentimentAnalysis
7659
7793
  */
7660
7794
  export interface IGenerativeAIUseCase {
7661
7795
  useCase: TGenerativeAIUseCases;
@@ -7665,19 +7799,29 @@ export interface IVoiceGateway2VadParams {
7665
7799
  voiceMs?: number;
7666
7800
  mode?: number;
7667
7801
  }
7668
- export declare type TVoiceGateway2TTSVendor = "google" | "aws" | "microsoft" | "nuance" | "default" | "custom";
7802
+ export declare type TVoiceGateway2TTSVendor = "aws" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
7669
7803
  export interface IVoiceGateway2SynthesizerParams {
7670
7804
  vendor?: TVoiceGateway2TTSVendor;
7671
7805
  language?: string;
7672
7806
  voice?: string;
7807
+ label?: string;
7808
+ fallbackVendor?: string;
7809
+ fallbackLabel?: string;
7810
+ fallbackLanguage?: string;
7811
+ fallbackVoice?: string;
7673
7812
  engine?: "standard" | "neural";
7674
7813
  gender?: "MALE" | "FEMALE" | "NEUTRAL";
7675
7814
  azureServiceEndpoint?: string;
7676
7815
  }
7677
- export declare type TVoiceGateway2STTVendor = "google" | "aws" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
7816
+ export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
7817
+ export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
7678
7818
  export interface IVoiceGateway2RecognizerParams {
7679
7819
  vendor?: TVoiceGateway2STTVendor;
7680
7820
  language?: string;
7821
+ label?: string;
7822
+ fallbackVendor?: string;
7823
+ fallbackLabel?: string;
7824
+ fallbackLanguage?: string;
7681
7825
  vad?: IVoiceGateway2VadParams;
7682
7826
  hints?: string[];
7683
7827
  hintsBoost?: number;
@@ -7713,6 +7857,7 @@ export interface IVoiceGateway2RecognizerParams {
7713
7857
  ibmOptions?: TVoiceGateway2IbmOptions;
7714
7858
  nvidiaOptions?: TVoiceGateway2NvidiaOptions;
7715
7859
  sonioxOptions?: TVoiceGateway2SonioxOptions;
7860
+ model?: TVoiceGateway2GoogleModel;
7716
7861
  }
7717
7862
  export declare type TVoiceGateway2NuanceOptions = {
7718
7863
  clientId?: string;
@@ -7761,9 +7906,10 @@ export declare type TVoiceGateway2DeepgramOptions = {
7761
7906
  search?: string[];
7762
7907
  replace?: string[];
7763
7908
  keywords?: string[];
7764
- endpointing?: boolean;
7909
+ endpointing?: boolean | number;
7765
7910
  vadTurnoff?: number;
7766
7911
  tag?: string;
7912
+ smartFormatting?: boolean;
7767
7913
  };
7768
7914
  export declare type TVoiceGateway2NvidiaOptions = {
7769
7915
  rivaUri?: string;
@@ -7898,6 +8044,9 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
7898
8044
  quickReply: string;
7899
8045
  chatwootInboxId: string;
7900
8046
  liveAgentInboxId: string;
8047
+ liveAgentSkills: string[];
8048
+ liveAgentLanguages: string[];
8049
+ liveAgentPriority: "none" | "urgent" | "high" | "medium" | "low";
7901
8050
  additionalCategoryIds: string[];
7902
8051
  sendTranscriptAsFirstMessage: boolean;
7903
8052
  buttonId: string;
@@ -7924,6 +8073,8 @@ export interface ICheckAgentAvailabilityNodeParams extends INodeFunctionBasePara
7924
8073
  config: {
7925
8074
  chatwootInboxId: string;
7926
8075
  liveAgentInboxId: string;
8076
+ liveAgentSkills: Array<string>;
8077
+ liveAgentLanguages: Array<string>;
7927
8078
  genesysCloudSkills: Array<string>;
7928
8079
  genesysCloudProfileSkills: Array<string>;
7929
8080
  genesysCloudLanguageSkills: Array<string>;
@@ -7950,6 +8101,21 @@ export interface ISchedulingErrorNodeParams extends INodeFunctionBaseParams {
7950
8101
  export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
7951
8102
  tile: any;
7952
8103
  }
8104
+ export interface ISendConfigUpdateParams extends INodeFunctionBaseParams {
8105
+ agentAssistConfig: {
8106
+ grid: {
8107
+ columns: number;
8108
+ rows: number;
8109
+ gap: number;
8110
+ };
8111
+ tiles: Record<string, {
8112
+ x: number;
8113
+ y: number;
8114
+ rows: number;
8115
+ columns: number;
8116
+ }>;
8117
+ };
8118
+ }
7953
8119
  export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
7954
8120
  config: {
7955
8121
  lexiconId: string;
@@ -8023,6 +8189,10 @@ export interface ILastConversationEntry {
8023
8189
  source: "user" | "bot";
8024
8190
  text: string;
8025
8191
  }
8192
+ export interface OpenAIChatMessage {
8193
+ role: "system" | "user" | "assistant";
8194
+ content: string;
8195
+ }
8026
8196
  export interface IGenerativeSlot {
8027
8197
  tag: string;
8028
8198
  description: string;
@@ -8053,7 +8223,7 @@ export interface INodeWithAiRephraseConfig {
8053
8223
  generativeAI_amountOfLastUserInputs: number;
8054
8224
  generativeAI_customInputs: string[];
8055
8225
  generativeAI_temperature: number;
8056
- promtType: TPromptTypes;
8226
+ promptType: TPromptTypes;
8057
8227
  questionType?: TRephraseWithAIQuestionType;
8058
8228
  }
8059
8229
  export interface ISayNodeConfigParams {
@@ -8109,6 +8279,19 @@ export interface IQuestionNodeParams extends INodeFunctionBaseParams {
8109
8279
  export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
8110
8280
  validationMessage: string;
8111
8281
  repromptCondition: string;
8282
+ repromptLLMProvider: string;
8283
+ repromptLLMPrompt: string;
8284
+ repromptLLMTurns: number;
8285
+ repromptType: "text" | "say" | "llm" | "execute";
8286
+ repromptSay: ISayParams["config"]["say"];
8287
+ repromptFlowNode: {
8288
+ flow: string;
8289
+ node: string;
8290
+ isGoto?: boolean;
8291
+ };
8292
+ repromptParseIntents?: boolean;
8293
+ repromptParseKeyphrases?: boolean;
8294
+ repromptAbsorbContext?: boolean;
8112
8295
  validationRepeat: boolean;
8113
8296
  storeResultInContext: boolean;
8114
8297
  contextKey: string;
@@ -8284,6 +8467,12 @@ export interface IRunGenerativeAIPromptOptions {
8284
8467
  * @deprecated should not inject the prompt anymore, use getPrompt() instead
8285
8468
  */
8286
8469
  prompt?: string;
8470
+ /** Text to calculate the embedding vector */
8471
+ embeddingText?: string;
8472
+ /**
8473
+ * Instead of a prompt, we can also provide messages in OpenAI's chat format
8474
+ */
8475
+ chat?: OpenAIChatMessage[];
8287
8476
  /** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
8288
8477
  promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
8289
8478
  /** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
@@ -8330,10 +8519,28 @@ export interface IRunGenerativeAIPromptOptions {
8330
8519
  * The useCase of the prompt.
8331
8520
  */
8332
8521
  useCase?: string;
8522
+ /**
8523
+ * Whether to stream the response or not.
8524
+ */
8525
+ stream?: boolean;
8526
+ /**
8527
+ * Callback function for stream data
8528
+ */
8529
+ streamOnDataHandler?: Function;
8530
+ /**
8531
+ * Array of tokens which signal the end of a sentence and trigger
8532
+ * flushing of token buffer to the provided handler
8533
+ */
8534
+ streamStopTokens?: string[];
8535
+ /**
8536
+ * A string denoting the reference ID of the chosen LLM provider
8537
+ */
8538
+ llmProviderReferenceId?: string;
8333
8539
  }
8334
8540
  export interface IOpenAiCredentials {
8335
8541
  apiType?: TGenerativeAIProviders;
8336
8542
  apiKey: string;
8543
+ apiCustomBaseUrl?: string;
8337
8544
  apiResourceName?: string;
8338
8545
  apiDeploymentName?: string;
8339
8546
  apiVersion?: string;
@@ -8347,6 +8554,7 @@ export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
8347
8554
  knowledgeStoreIds?: string[];
8348
8555
  openAiCredentials?: IOpenAiCredentials;
8349
8556
  sessionId?: string;
8557
+ tags?: string[];
8350
8558
  }
8351
8559
  export interface IKnowledgeSearchReturnValue {
8352
8560
  status: "success" | "error";
@@ -8355,15 +8563,19 @@ export interface IKnowledgeSearchReturnValue {
8355
8563
  topK: [
8356
8564
  {
8357
8565
  text: string;
8358
- certainty: number;
8359
8566
  distance: number;
8360
- additional: {
8361
- knowledgeSourceUrl: string;
8362
- order: number;
8363
- data?: {
8364
- [key: string]: any;
8365
- };
8567
+ sourceReferenceId: string;
8568
+ sourceMetaData: {
8569
+ sourceName: string;
8570
+ sourceType: string;
8571
+ title: string;
8572
+ url: string;
8573
+ [key: string]: any;
8574
+ };
8575
+ chunkMetaData?: {
8576
+ [key: string]: any;
8366
8577
  };
8578
+ order: number;
8367
8579
  }
8368
8580
  ];
8369
8581
  };
@@ -8470,6 +8682,7 @@ export interface IActions {
8470
8682
  say?: (text: string, data?: any, settings?: ISayNodeSettings) => void;
8471
8683
  sendHttpRequest?: (httpRequestParams: IHttpRequestNodeParams) => Promise<void>;
8472
8684
  sendTileUpdateToAgentAssistWorkspace: (params: ISendTileUpdateParams) => Promise<void>;
8685
+ sendConfigUpdateToAgentAssistWorkspace: (params: ISendConfigUpdateParams) => Promise<void>;
8473
8686
  setCache?: (key: string, val: any) => void;
8474
8687
  setContext?: (key: string, value: any) => void;
8475
8688
  setContextAndPersist?: (key: string, value: any) => Promise<void>;
@@ -8497,6 +8710,7 @@ export interface IActions {
8497
8710
  updateProfile?: (profileSchemaField: string, value: any) => Promise<any>;
8498
8711
  knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
8499
8712
  matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
8713
+ getAgentAssistConfigId: () => string;
8500
8714
  }
8501
8715
  export interface ICognigyNLPProperties {
8502
8716
  /** The original text of the user */
@@ -9101,6 +9315,8 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
9101
9315
  completeGoal: (goal: string) => void;
9102
9316
  knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
9103
9317
  matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
9318
+ getAgentAssistConfigId: () => string;
9319
+ countGPTTokens?: (prompt: string) => number;
9104
9320
  }
9105
9321
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
9106
9322
  api: INodeExecutionAPI;
@@ -9223,7 +9439,8 @@ declare const nodePreviewTypes: readonly [
9223
9439
  "text",
9224
9440
  "sayNode",
9225
9441
  "custom",
9226
- "resource"
9442
+ "resource",
9443
+ "image"
9227
9444
  ];
9228
9445
  export declare type TNodePreviewType = typeof nodePreviewTypes[number];
9229
9446
  export interface INodePreview {
@@ -9266,6 +9483,7 @@ export interface INodeDependencies {
9266
9483
  }
9267
9484
  declare const nodeFieldTypes: readonly [
9268
9485
  "adaptivecard",
9486
+ "agentAssistConfig",
9269
9487
  "appTemplate",
9270
9488
  "caseNode",
9271
9489
  "checkbox",
@@ -9285,6 +9503,9 @@ declare const nodeFieldTypes: readonly [
9285
9503
  "json",
9286
9504
  "keyValuePairs",
9287
9505
  "knowledgeStore",
9506
+ "knowledgeStoreSelect",
9507
+ "knowledgeSourceTags",
9508
+ "llmSelect",
9288
9509
  "lexicon",
9289
9510
  "localeField",
9290
9511
  "node",
@@ -9299,6 +9520,7 @@ declare const nodeFieldTypes: readonly [
9299
9520
  "sttLanguageAzureSelect",
9300
9521
  "sttLanguageGoogleSelect",
9301
9522
  "sttSelect",
9523
+ "sttTierModelSelect",
9302
9524
  "switchNode",
9303
9525
  "text",
9304
9526
  "textArray",
@@ -9366,6 +9588,8 @@ export interface INodeSection {
9366
9588
  key: string;
9367
9589
  /** Human readable lable of the seciton, e.g. 'Authentication' */
9368
9590
  label: string | INodeFieldTranslations;
9591
+ /** Human readable description of the section, e.g. 'Configure authentication for this node' */
9592
+ description?: string | INodeFieldTranslations;
9369
9593
  /** Condition whether this section should be rendered */
9370
9594
  condition?: TNodeFieldCondition;
9371
9595
  /** Whether the sections should be collapsed by default (default: false) */
@@ -9417,11 +9641,17 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
9417
9641
  /** The form defines how fields and sections should be render in order */
9418
9642
  form?: INodeFieldAndSectionFormElement[];
9419
9643
  }
9644
+ export interface IParams {
9645
+ [key: string]: any;
9646
+ }
9420
9647
  export interface IConnectionSchemaField {
9421
9648
  _id?: TMongoId;
9422
9649
  /** The field name, e.g. 'client_id' */
9423
9650
  fieldName: string;
9424
9651
  required?: boolean;
9652
+ label?: string;
9653
+ description?: string;
9654
+ params?: IParams;
9425
9655
  }
9426
9656
  export interface IConnectionSchema extends IEntityMeta {
9427
9657
  _id: TMongoId;
@@ -9543,7 +9773,9 @@ export interface IGraphFunction {
9543
9773
  }
9544
9774
  declare const knowledgeStoreStatus: readonly [
9545
9775
  "ready",
9546
- "warning"
9776
+ "ingesting",
9777
+ "warning",
9778
+ "empty"
9547
9779
  ];
9548
9780
  export declare type TKnowledgeStoreStatus = typeof knowledgeStoreStatus[number];
9549
9781
  export interface IKnowledgeStore extends IEntityMeta {
@@ -11177,7 +11409,7 @@ export interface INodeAppearance_2_0 {
11177
11409
  variant?: "regular" | "mini" | "hexagon";
11178
11410
  }
11179
11411
  export interface INodePreview_2_0 {
11180
- type: "text" | "sayNode" | "custom" | "resource";
11412
+ type: "text" | "sayNode" | "custom" | "resource" | "image";
11181
11413
  key: string;
11182
11414
  }
11183
11415
  export interface INodeConstraints_2_0 {
@@ -11212,7 +11444,7 @@ export interface INodeField_2_0 {
11212
11444
  };
11213
11445
  }
11214
11446
  export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
11215
- export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect";
11447
+ export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "sttTierModelSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect";
11216
11448
  export interface INodeDependencies_2_0 {
11217
11449
  /** A list of Node types */
11218
11450
  children: string[];
@@ -11291,6 +11523,8 @@ export interface INodeSection_2_0 {
11291
11523
  key: string;
11292
11524
  /** Human readable lable of the seciton, e.g. 'Authentication' */
11293
11525
  label: string | INodeFieldTranslations;
11526
+ /** Human readable description of the section, e.g. 'Configure authentication for this node' */
11527
+ description?: string | INodeFieldTranslations;
11294
11528
  /** Condition whether this section should be rendered */
11295
11529
  condition?: INodeFieldCondition_2_0;
11296
11530
  /** Whether the sections should be collapsed by default (default: false) */
@@ -12762,6 +12996,8 @@ declare const journeyStepGoals: readonly [
12762
12996
  "createEndpoint",
12763
12997
  "createLexicon",
12764
12998
  "createSnapshot",
12999
+ "createKnowledgeStore",
13000
+ "createKnowledgeSource",
12765
13001
  "openWebchat",
12766
13002
  "createCodeNode",
12767
13003
  "createHttpRequestNode",
@@ -12769,6 +13005,10 @@ declare const journeyStepGoals: readonly [
12769
13005
  "createQuestionNode",
12770
13006
  "createSayNode",
12771
13007
  "createLookupNode",
13008
+ "createKnowledgeSearchNode",
13009
+ "createSearchExtractOutputNode",
13010
+ "createGptConversationNode",
13011
+ "createLlmPromptNode",
12772
13012
  "updateCaseNode",
12773
13013
  "updateHttpRequestNode",
12774
13014
  "updateIfNode",
@@ -13892,10 +14132,12 @@ export interface IVoiceConfigParams {
13892
14132
  sttVadEnabled: boolean;
13893
14133
  sttVadMode: number;
13894
14134
  sttVadVoiceMs: number;
14135
+ sttLabel: string;
13895
14136
  ttsDisableCache: boolean;
13896
14137
  ttsVoice: string;
13897
14138
  ttsLanguage: string;
13898
14139
  ttsVendor: TVoiceGateway2TTSVendor;
14140
+ ttsLabel: string;
13899
14141
  azureTtsDeploymentId: string;
13900
14142
  azureSttContextId: string;
13901
14143
  azureSpeechRecognitionMode: string;
@@ -13904,6 +14146,7 @@ export interface IVoiceConfigParams {
13904
14146
  googleDisablePunctuation: boolean;
13905
14147
  googleInteractionType: string;
13906
14148
  googleHintsBoost: number;
14149
+ googleModel: TVoiceGateway2GoogleModel;
13907
14150
  userNoInputMode: TVoiceGateway2UserNoInputMode;
13908
14151
  userNoInputTimeout: number;
13909
14152
  userNoInputRetries: number;
@@ -13934,6 +14177,11 @@ export interface IVoiceConfigParams {
13934
14177
  sttGoogleLang1: string;
13935
14178
  sttGoogleLang2: string;
13936
14179
  sttGoogleLang3: string;
14180
+ sttDeepgramTier: string;
14181
+ sttDeepgramModel: string;
14182
+ deepgramEndpointing: boolean;
14183
+ deepgramEndpointingValue: number;
14184
+ deepgramSmartFormatting: boolean;
13937
14185
  }
13938
14186
  export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
13939
14187
  config: IVoiceConfigParams;
@@ -13953,6 +14201,7 @@ export interface ITransferParams extends INodeFunctionBaseParams {
13953
14201
  config: {
13954
14202
  transferReason: string;
13955
14203
  referTo: string;
14204
+ referredBy: string;
13956
14205
  useTransferSipHeaders: boolean;
13957
14206
  transferSipHeaders: any;
13958
14207
  };
@@ -13979,6 +14228,7 @@ export interface ISendMetadataParams extends INodeFunctionBaseParams {
13979
14228
  }
13980
14229
  export interface IMuteSpeechInputParamsConfig {
13981
14230
  muteSpeechInput: boolean;
14231
+ muteDtmfInput: boolean;
13982
14232
  }
13983
14233
  export interface IMuteSpeechInputParams extends INodeFunctionBaseParams {
13984
14234
  config: IMuteSpeechInputParamsConfig;
@@ -13997,6 +14247,12 @@ export interface IVoiceConfigParams {
13997
14247
  azureEnableAudioLogging: boolean;
13998
14248
  azureTtsDeploymentId: string;
13999
14249
  enableAdvancedTTSConfig: boolean;
14250
+ googleModel: TVoiceGateway2GoogleModel;
14251
+ sttDeepgramTier: string;
14252
+ sttDeepgramModel: string;
14253
+ deepgramEndpointing: boolean;
14254
+ deepgramEndpointingValue: number;
14255
+ deepgramSmartFormatting: boolean;
14000
14256
  }
14001
14257
  export interface ISessionSpeechParams extends INodeFunctionBaseParams {
14002
14258
  config: IVoiceConfigParams;
@@ -14360,16 +14616,28 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
14360
14616
  transferType: "refer" | "dial";
14361
14617
  transferReason: string;
14362
14618
  transferTarget: string;
14619
+ referredBy: string;
14363
14620
  useTransferSipHeaders: boolean;
14364
14621
  transferSipHeaders: {
14365
14622
  [key: string]: string | object;
14366
14623
  };
14624
+ agentAssistEnabled: boolean;
14625
+ agentAssistHeadersKey?: string;
14367
14626
  dialCallerId?: string;
14368
14627
  dialMusic?: string;
14628
+ dialTimeout?: number;
14369
14629
  dialTranscriptionWebhook?: string;
14370
14630
  recognitionChannel: number;
14371
14631
  sttLanguage: string;
14372
14632
  sttVendor: string;
14633
+ sttDeepgramTier: string;
14634
+ sttDeepgramModel: string;
14635
+ sttDisablePunctuation: boolean;
14636
+ googleModel: TVoiceGateway2GoogleModel;
14637
+ sttLabel: string;
14638
+ deepgramEndpointing: boolean;
14639
+ deepgramEndpointingValue: number;
14640
+ deepgramSmartFormatting: boolean;
14373
14641
  amdEnabled: boolean;
14374
14642
  amdRedirectOnMachineDetected: boolean;
14375
14643
  amdRedirectText: string;
@@ -14392,6 +14660,7 @@ export interface IRecordNodeParams extends INodeFunctionBaseParams {
14392
14660
  }
14393
14661
  export interface IMuteSpeechInputParamsConfig {
14394
14662
  muteSpeechInput: boolean;
14663
+ muteDtmfInput: boolean;
14395
14664
  }
14396
14665
  export interface IMuteSpeechInputParams extends INodeFunctionBaseParams {
14397
14666
  config: IMuteSpeechInputParamsConfig;
@@ -14407,6 +14676,48 @@ export interface ICognigyVoiceGateway2Nodes {
14407
14676
  "recordNode": ICreateChartNodeBasicNodesData<"recordNode", IRecordNodeParams, TVOICE_GATEWAY_2_EXTENSION>;
14408
14677
  "muteSpeechInputNode": ICreateChartNodeBasicNodesData<"muteSpeechInput", IMuteSpeechInputParams, TVOICE_GATEWAY_2_EXTENSION>;
14409
14678
  }
14679
+ export interface ISearchExtractOutputNodeParams extends INodeFunctionBaseParams {
14680
+ config: {
14681
+ mode: "seo" | "se" | "s";
14682
+ followUpDetection: "none" | "transcript";
14683
+ followUpDetectionSteps: number;
14684
+ hallucinationShield: boolean;
14685
+ topK: number;
14686
+ searchString: string;
14687
+ searchStoreLocation: "input" | "context" | "default";
14688
+ searchStoreLocationContextKey: string;
14689
+ searchStoreLocationInputKey: string;
14690
+ searchSourceTags: string[];
14691
+ knowledgeStoreId?: string;
14692
+ prompt: string;
14693
+ temperature: number;
14694
+ maxTokens: number;
14695
+ topP: number;
14696
+ presencePenalty: number;
14697
+ frequencyPenalty: number;
14698
+ useStop: boolean;
14699
+ stop: string[];
14700
+ storeLocation: string;
14701
+ contextKey: string;
14702
+ inputKey: string;
14703
+ timeout: number;
14704
+ timeoutMessage: string;
14705
+ outputMode: "text" | "stream" | "adaptiveCard";
14706
+ outputFallback: string;
14707
+ errorHandling: "stop" | "continue" | "goto";
14708
+ errorHandlingGotoTarget: {
14709
+ flow: string;
14710
+ node: string;
14711
+ };
14712
+ organisationId: string;
14713
+ streamStopTokens: string[];
14714
+ streamDescription: string;
14715
+ searchStringDescription: string;
14716
+ debugLogTokenCount: boolean;
14717
+ debugLogRequestAndCompletion: boolean;
14718
+ debugDescription: string;
14719
+ };
14720
+ }
14410
14721
  export interface ICognigyBasicNodes {
14411
14722
  addToContext: ICreateChartNodeBasicNodesData<"addToContext", IAddToContextNodeParams, TBASIC_EXTENSION>;
14412
14723
  copyDataToContext: ICreateChartNodeBasicNodesData<"copyDataToContext", ICopyDataToContextNodeParams, TBASIC_EXTENSION>;
@@ -14452,6 +14763,7 @@ export interface ICognigyBasicNodes {
14452
14763
  handoverV2: ICreateChartNodeBasicNodesData<"handoverV2", IHandoverNodeV2Params, TBASIC_EXTENSION>;
14453
14764
  checkAgentAvailability: ICreateChartNodeBasicNodesData<"checkAgentAvailability", ICheckAgentAvailabilityNodeParams, TBASIC_EXTENSION>;
14454
14765
  sendTileUpdateToAgentAssistWorkspace: ICreateChartNodeBasicNodesData<"sendTileUpdateToAgentAssistWorkspace", ISendTileUpdateParams, TBASIC_EXTENSION>;
14766
+ sendConfigUpdateToAgentAssistWorkspace: ICreateChartNodeBasicNodesData<"sendConfigUpdateToAgentAssistWorkspace", ISendConfigUpdateParams, TBASIC_EXTENSION>;
14455
14767
  httpRequest: ICreateChartNodeBasicNodesData<"httpRequest", IHttpRequestNodeParams, TBASIC_EXTENSION>;
14456
14768
  triggerFunction: ICreateChartNodeBasicNodesData<"triggerFunction", ITriggerFunctionNodeParams, TBASIC_EXTENSION>;
14457
14769
  onScheduled: ICreateChartNodeBasicNodesData<"onScheduled", IScheduledNodeParams, TBASIC_EXTENSION>;
@@ -14472,6 +14784,7 @@ export interface ICognigyBasicNodes {
14472
14784
  muteSpeechInput: ICreateChartNodeBasicNodesData<"muteSpeechInput", IMuteSpeechInputParams, TBASIC_EXTENSION>;
14473
14785
  sendMetadata: ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TBASIC_EXTENSION>;
14474
14786
  assistInfo: ICreateChartNodeBasicNodesData<"assistInfo", IAssistInfoNodeParams, TBASIC_EXTENSION>;
14787
+ searchExtractOutput: ICreateChartNodeBasicNodesData<"searchExtractOutput", ISearchExtractOutputNodeParams, TBASIC_EXTENSION>;
14475
14788
  }
14476
14789
  export interface ICognigyNodes {
14477
14790
  "@cognigy/basic-nodes": ICognigyBasicNodes;
@@ -14703,24 +15016,32 @@ export interface IIndexYesNoSentencesRestReturnValue_2_0 extends ICursorBasedPag
14703
15016
  * properties:
14704
15017
  * columns:
14705
15018
  * type: number
15019
+ * description: Number of columns in the grid.
14706
15020
  * rows:
14707
15021
  * type: number
15022
+ * description: Number of rows in the grid.
14708
15023
  * gap:
14709
15024
  * type: number
15025
+ * description: Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used.
14710
15026
  * tiles:
14711
15027
  * type: object
14712
15028
  * properties:
14713
15029
  * tile-id:
14714
15030
  * type: object
15031
+ * description: The Tile ID is used in the Flow Nodes to fill in this specific tile.
14715
15032
  * properties:
14716
15033
  * x:
14717
15034
  * type: number
15035
+ * description: The row number where the tile is located, starting from 1.
14718
15036
  * y:
14719
15037
  * type: number
15038
+ * description: The column number where the tile is located, starting from 1.
14720
15039
  * columns:
14721
15040
  * type: number
15041
+ * description: The number of columns the tile should occupy. The default value is 1.
14722
15042
  * rows:
14723
15043
  * type: number
15044
+ * description: The number of rows the tile should occupy. The default value is 1.
14724
15045
  *
14725
15046
  * IAgentAssistConfigData_2_0:
14726
15047
  * type: object
@@ -14848,6 +15169,23 @@ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<I
14848
15169
  }
14849
15170
  export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
14850
15171
  }
15172
+ export interface IOpenAIMeta_2_0 {
15173
+ customModel: string;
15174
+ }
15175
+ export interface IAlephAlphaMeta_2_0 {
15176
+ customModel: string;
15177
+ }
15178
+ export interface IAzureOpenAIMeta_2_0 {
15179
+ resourceName?: string;
15180
+ deploymentName?: string;
15181
+ baseCustomUrl?: string | null;
15182
+ apiVersion?: string;
15183
+ }
15184
+ export interface IGoogleVertexAIMeta_2_0 {
15185
+ location: string;
15186
+ apiEndPoint: string;
15187
+ publisher?: string;
15188
+ }
14851
15189
  /**
14852
15190
  * @openapi
14853
15191
  *
@@ -14875,6 +15213,13 @@ export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBas
14875
15213
  * type: boolean
14876
15214
  * description: Sets the LLM to default (fallback) if no other LLM is set
14877
15215
  * example: false
15216
+ * openAI:
15217
+ * type: object
15218
+ * description: OpenAI specific meta data
15219
+ * properties:
15220
+ * customModel:
15221
+ * type: string
15222
+ * example: gpt-4-32k-0613
14878
15223
  * azureOpenAI:
14879
15224
  * type: object
14880
15225
  * description: Azure OpenAI specific meta data
@@ -14919,7 +15264,13 @@ export interface ILargeLanguageModel_2_0 {
14919
15264
  createdBy: TMongoId;
14920
15265
  lastChangedBy: TMongoId;
14921
15266
  /** Meta data for the AzureOpenAI connection */
14922
- azureOpenAI?: IAzureOpenAIMeta;
15267
+ azureOpenAI?: IAzureOpenAIMeta_2_0;
15268
+ /** Meta data for the OpenAI LLM */
15269
+ openAI?: IOpenAIMeta_2_0;
15270
+ /** Meta Data for the AlephAlpha LLM */
15271
+ alephAlpha?: IAlephAlphaMeta_2_0;
15272
+ /** Meta data for the GoogleVertexAI connection */
15273
+ googleVertexAI?: IGoogleVertexAIMeta_2_0;
14923
15274
  }
14924
15275
  export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
14925
15276
  }
@@ -14943,10 +15294,13 @@ export interface IUpdateLargeLanguageModelRestData_2_0 extends IUpdateLargeLangu
14943
15294
  }
14944
15295
  export interface IUpdateLargeLanguageModelRestReturnValue_2_0 {
14945
15296
  }
15297
+ export interface IDeleteLargeLanguageModelRestQuery_2_0 {
15298
+ force?: string;
15299
+ }
14946
15300
  export interface IDeleteLargeLanguageModelRestDataParams_2_0 {
14947
15301
  largeLanguageModelId: string;
14948
15302
  }
14949
- export interface IDeleteLargeLanguageModelRestData_2_0 extends IDeleteLargeLanguageModelRestDataParams_2_0 {
15303
+ export interface IDeleteLargeLanguageModelRestData_2_0 extends IDeleteLargeLanguageModelRestDataParams_2_0, IDeleteLargeLanguageModelRestQuery_2_0 {
14950
15304
  }
14951
15305
  export interface IDeleteLargeLanguageModelRestReturnValue_2_0 {
14952
15306
  }
@@ -15071,12 +15425,16 @@ export interface IUpdateKnowledgeStoreRestReturnValue_2_0 {
15071
15425
  declare const knowledgeSourceStatus: readonly [
15072
15426
  "ready",
15073
15427
  "ingesting",
15074
- "disabled"
15428
+ "disabled",
15429
+ "failure"
15075
15430
  ];
15076
15431
  export declare type TKnowledgeSourceStatus = typeof knowledgeSourceStatus[number];
15077
15432
  declare const knowledgeSourceType: readonly [
15078
- "file",
15079
- "website",
15433
+ "pdf",
15434
+ "txt",
15435
+ "docx",
15436
+ "ctxt",
15437
+ "url",
15080
15438
  "manual"
15081
15439
  ];
15082
15440
  export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
@@ -15085,6 +15443,8 @@ export interface IKnowledgeSourceMetaData {
15085
15443
  fileName?: string;
15086
15444
  mimeType?: string;
15087
15445
  url?: string;
15446
+ failReason?: string;
15447
+ tags?: string[];
15088
15448
  }
15089
15449
  /**
15090
15450
  * @openapi
@@ -15106,10 +15466,20 @@ export interface IKnowledgeSourceMetaData {
15106
15466
  * type:
15107
15467
  * type: string
15108
15468
  * enum:
15109
- * - website
15469
+ * - url
15110
15470
  * - manual
15111
- * - file
15471
+ * - pdf
15472
+ * - txt
15473
+ * - ctxt
15112
15474
  * description: The type of source for the Knowledge store
15475
+ * metaData:
15476
+ * type: object
15477
+ * properties:
15478
+ * tags:
15479
+ * type: array
15480
+ * items:
15481
+ * type: string
15482
+ * example: "tag1"
15113
15483
  * IKnowledgeSourceDataUpdate_2_0:
15114
15484
  * allOf:
15115
15485
  * - type: object
@@ -15136,7 +15506,7 @@ export interface IKnowledgeSourceMetaData {
15136
15506
  * url:
15137
15507
  * type: string
15138
15508
  * example: "https://www.some-article.com"
15139
- * description: The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "website"
15509
+ * description: The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "url"
15140
15510
  *
15141
15511
  * IKnowledgeSourceData_2_0:
15142
15512
  * allOf:
@@ -15176,6 +15546,7 @@ export interface IKnowledgeSource_2_0 {
15176
15546
  type: TKnowledgeSourceType;
15177
15547
  chunkCount: number;
15178
15548
  metaData: IKnowledgeSourceMetaData;
15549
+ data: Record<string, unknown>;
15179
15550
  storeReference: TMongoId;
15180
15551
  projectReference: TMongoId;
15181
15552
  organisationReference: TMongoId;
@@ -15194,7 +15565,7 @@ export interface IIndexKnowledgeSourcesRestReturnValue_2_0 extends ICursorBasedP
15194
15565
  export interface ICreateKnowledgeSourceRestDataParams_2_0 {
15195
15566
  knowledgeStoreId: string;
15196
15567
  }
15197
- export interface ICreateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "type">> {
15568
+ export interface ICreateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "type" | "metaData">> {
15198
15569
  url?: string;
15199
15570
  }
15200
15571
  export interface ICreateKnowledgeSourceRestData_2_0 extends ICreateKnowledgeSourceRestDataParams_2_0, ICreateKnowledgeSourceRestDataBody_2_0 {
@@ -15219,7 +15590,7 @@ export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSour
15219
15590
  }
15220
15591
  export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
15221
15592
  }
15222
- export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status">> {
15593
+ export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
15223
15594
  }
15224
15595
  export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
15225
15596
  knowledgeStoreId: string;
@@ -15234,6 +15605,7 @@ export interface IUploadKnowledgeSourceFileRestDataParams_2_0 {
15234
15605
  }
15235
15606
  export interface IUploadKnowledgeSourceFileRestDataBody_2_0 {
15236
15607
  file: File | Buffer;
15608
+ tags?: string[];
15237
15609
  }
15238
15610
  export interface IUploadKnowledgeSourceFileRestData_2_0 extends IUploadKnowledgeSourceFileRestDataParams_2_0, IUploadKnowledgeSourceFileRestDataBody_2_0 {
15239
15611
  }
@@ -15348,6 +15720,43 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
15348
15720
  }
15349
15721
  export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
15350
15722
  }
15723
+ declare const uploadResumableTypes: readonly [
15724
+ "snapshots"
15725
+ ];
15726
+ export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
15727
+ export interface HttpRequest {
15728
+ getMethod(): string;
15729
+ getURL(): string;
15730
+ setHeader(header: string, value: string): void;
15731
+ getHeader(header: string): string;
15732
+ setProgressHandler(handler: (bytesSent: number) => void): void;
15733
+ send(body: any): Promise<HttpResponse>;
15734
+ abort(): Promise<void>;
15735
+ getUnderlyingObject(): any;
15736
+ }
15737
+ export interface HttpResponse {
15738
+ getStatus(): number;
15739
+ getHeader(header: string): string;
15740
+ getBody(): string;
15741
+ getUnderlyingObject(): any;
15742
+ }
15743
+ export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
15744
+ file: Buffer | File;
15745
+ onError?: ((error: Error) => void) | null;
15746
+ onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
15747
+ onSuccess?: (() => void) | null;
15748
+ onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
15749
+ onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
15750
+ onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
15751
+ onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
15752
+ }
15753
+ export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
15754
+ uploadType: TUploadResumableTypes;
15755
+ }
15756
+ export interface IUploadResumableRestReturnValue_2_0 {
15757
+ fileName: string;
15758
+ url: string;
15759
+ }
15351
15760
  export interface ResourcesAPIGroup_2_0 {
15352
15761
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
15353
15762
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
@@ -15581,6 +15990,7 @@ export interface ResourcesAPIGroup_2_0 {
15581
15990
  readKnowledgeChunk: TRestAPIOperation<IReadKnowledgeChunkRestData_2_0, IReadKnowledgeChunkRestReturnValue_2_0>;
15582
15991
  deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
15583
15992
  updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
15993
+ uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
15584
15994
  }
15585
15995
  declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
15586
15996
  /**
@@ -17348,6 +17758,7 @@ declare const actionTypes: readonly [
17348
17758
  "setupCognigyLiveAgent",
17349
17759
  "setupCognigyLiveAgentInbox",
17350
17760
  "setupCognigyGenerativeAI",
17761
+ "setupVoiceGatewayAccount",
17351
17762
  "updateCognigyLiveAgentInbox",
17352
17763
  "trainAllProjectFlows",
17353
17764
  "trainIntents",
@@ -17391,7 +17802,7 @@ export declare type TActionType = typeof actionTypes[number];
17391
17802
  * description: Additional resource types for audit purposes
17392
17803
  * example: node
17393
17804
  * enum:
17394
- * - agentassistconfig
17805
+ * - aicopilotconfig
17395
17806
  * - apiKey
17396
17807
  * - analytics
17397
17808
  * - connectionField
@@ -17421,7 +17832,7 @@ export declare type TActionType = typeof actionTypes[number];
17421
17832
  * - user
17422
17833
  * - yesNoIntent
17423
17834
  */
17424
- export declare type TResourceTypeAdditional = "agentassistconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
17835
+ export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
17425
17836
  /**
17426
17837
  * @openapi
17427
17838
  * components:
@@ -17668,6 +18079,7 @@ export interface IGetSystemMessageRestReturnValue_2_0 {
17668
18079
  *
17669
18080
  * IUserDataCreate_2_0:
17670
18081
  * type: object
18082
+ * required: ['id', 'name', 'password']
17671
18083
  * properties:
17672
18084
  * id:
17673
18085
  * type: string
@@ -17910,26 +18322,22 @@ export interface ICreateUserRestReturnValue_2_0 extends IUser_2_0 {
17910
18322
  * newPassword:
17911
18323
  * type: string
17912
18324
  *
17913
- * IManagementUserAdditional_2_0:
17914
- * type: object
17915
- * properties:
17916
- * newPassword:
17917
- * type: string
17918
- *
17919
18325
  * IUserUpdate_2_0:
17920
18326
  * allOf:
17921
- * - $ref: '#/components/schemas/IUser_2_0'
18327
+ * - type: object
18328
+ * properties:
18329
+ * name:
18330
+ * type: string
17922
18331
  * - $ref: '#/components/schemas/IUserAdditional_2_0'
17923
18332
  *
17924
18333
  * IUserUpdateMe_2_0:
17925
18334
  * allOf:
17926
- * - $ref: '#/components/schemas/IUser_2_0'
18335
+ * - type: object
18336
+ * properties:
18337
+ * name:
18338
+ * type: string
17927
18339
  * - $ref: '#/components/schemas/IUserMeAdditional_2_0'
17928
18340
  *
17929
- * IManagementUserUpdate_2_0:
17930
- * allOf:
17931
- * - $ref: '#/components/schemas/IUser_2_0'
17932
- * - $ref: '#/components/schemas/IManagementUserAdditional_2_0'
17933
18341
  */
17934
18342
  export interface IUserUpdate_2_0 extends Pick<IUser_2_0, "name"> {
17935
18343
  newPassword: string;
@@ -18296,6 +18704,14 @@ export declare type TServicesNames = typeof servicesNames[number];
18296
18704
  export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
18297
18705
  [key in keyof TServicesNames]: string[];
18298
18706
  };
18707
+ export interface IReadVoiceGatewayAccountRestReturnValue_2_0 {
18708
+ voiceGatewayAccount: string;
18709
+ }
18710
+ export interface ISetupVoiceGatewayRestDataBody_2_0 {
18711
+ accountSid: string;
18712
+ }
18713
+ export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
18714
+ }
18299
18715
  export interface AdministrationAPIGroup_2_0 {
18300
18716
  requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
18301
18717
  validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
@@ -18344,6 +18760,8 @@ export interface AdministrationAPIGroup_2_0 {
18344
18760
  readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
18345
18761
  requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
18346
18762
  readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
18763
+ setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
18764
+ readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
18347
18765
  }
18348
18766
  declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
18349
18767
  /**
@@ -18465,9 +18883,6 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
18465
18883
  * IOrganisationData_2_0:
18466
18884
  * type: object
18467
18885
  * properties:
18468
- * name:
18469
- * type: string
18470
- * description: The name of this organisation
18471
18886
  * disabled:
18472
18887
  * type: boolean
18473
18888
  * description: Flag whether this organisation is currently disabled
@@ -18494,6 +18909,18 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
18494
18909
  * IOrganisation_2_0:
18495
18910
  * allOf:
18496
18911
  * - $ref: '#/components/schemas/IOrganisationData_2_0'
18912
+ * properties:
18913
+ * name:
18914
+ * type: string
18915
+ * description: The name of this organisation
18916
+ * required: ['name']
18917
+ * IUpdateOrganisation_2_0:
18918
+ * allOf:
18919
+ * - $ref: '#/components/schemas/IOrganisationData_2_0'
18920
+ * properties:
18921
+ * name:
18922
+ * type: string
18923
+ * description: The name of this organisation
18497
18924
  */
18498
18925
  export interface IOrganisation_2_0 {
18499
18926
  /** The mongo object id of this organisation */
@@ -18737,12 +19164,13 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
18737
19164
  * schemas:
18738
19165
  * IUserDataManagement_2_0:
18739
19166
  * type: object
19167
+ * required: ['id', 'name', 'password', 'organisation']
18740
19168
  * properties:
18741
19169
  * id:
18742
19170
  * type: string
18743
19171
  * name:
18744
19172
  * type: string
18745
- * password:
19173
+ * password:
18746
19174
  * type: string
18747
19175
  * organisation:
18748
19176
  * $ref: '#/components/schemas/TMongoId'
@@ -18755,6 +19183,29 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
18755
19183
  * disabled:
18756
19184
  * type: boolean
18757
19185
  *
19186
+ * IUserUpdateDataManagement_2_0:
19187
+ * type: object
19188
+ * properties:
19189
+ * id:
19190
+ * type: string
19191
+ * name:
19192
+ * type: string
19193
+ * acceptedTOS:
19194
+ * type: boolean
19195
+ * disabled:
19196
+ * type: boolean
19197
+ *
19198
+ * IManagementUserAdditional_2_0:
19199
+ * type: object
19200
+ * properties:
19201
+ * newPassword:
19202
+ * type: string
19203
+ *
19204
+ * IManagementUserUpdate_2_0:
19205
+ * allOf:
19206
+ * - $ref: '#/components/schemas/IUserUpdateDataManagement_2_0'
19207
+ * - $ref: '#/components/schemas/IManagementUserAdditional_2_0'
19208
+ *
18758
19209
  * IUserManagement_2_0:
18759
19210
  * allOf:
18760
19211
  * - $ref: '#/components/schemas/IUserDataManagement_2_0'
@@ -19011,6 +19462,7 @@ export interface IRestAPIClientConstructor {
19011
19462
  export interface IRestAPIClientProperties<T = IRestAPIClientConfig> {
19012
19463
  config: T;
19013
19464
  setBaseUrl: (baseUrl: string) => void;
19465
+ getBaseUrl: () => string;
19014
19466
  setInterceptors: (data: ISetInterceptors) => void;
19015
19467
  }
19016
19468
  export interface ISetInterceptors {