@cognigy/rest-api-client 0.17.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/build/GenericTusFn.js +6 -1
- package/build/GenericUploadFn.js +3 -5
- package/build/apigroups/ResourcesAPIGroup_2_0.js +12 -1
- package/build/connector/AxiosAdapter.js +35 -15
- package/build/shared/charts/createNodeDescriptor.js +5 -5
- package/build/shared/charts/descriptors/agentAssist/constants/constants.js +16 -1
- package/build/shared/charts/descriptors/agentAssist/helpers/agentAssistTranslator.helper.js +19 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/getFontSizeFieldOptions.js +84 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/getLanguageName.helper.js +33 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/answerExtraction.helper.js +59 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/configValidator.helper.js +20 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/errorHandler.helper.js +64 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/followUpDetection.helper.js +72 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/knowledgeSearch.helper.js +58 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/sentiment.helper.js +7 -13
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/identityAssistTemplate.js +17 -18
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +330 -153
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/nextActionWidgetTemplate.js +212 -80
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/sentimentAnalysisTemplate.js +11 -6
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/transcriptAssistTemplate.js +15 -13
- package/build/shared/charts/descriptors/agentAssist/identityAssist.js +87 -14
- package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +192 -327
- package/build/shared/charts/descriptors/agentAssist/locales/cs.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/de.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/en.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/es.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/fr.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/index.js +22 -0
- package/build/shared/charts/descriptors/agentAssist/locales/ja.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/ko.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/locales/pt.locale.js +11 -0
- package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +485 -10
- package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +31 -8
- package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +40 -2
- package/build/shared/charts/descriptors/analytics/requestRating.js +56 -2
- package/build/shared/charts/descriptors/index.js +1 -3
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +1 -1
- package/build/shared/charts/descriptors/message/question/optionalQuestion.js +1 -1
- package/build/shared/charts/descriptors/message/question/question.js +123 -2
- package/build/shared/charts/descriptors/message/question/utils/evaluateQuestionAnswer.js +44 -3
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +28 -12
- package/build/shared/charts/descriptors/nlu/index.js +1 -3
- package/build/shared/charts/descriptors/service/GPTPrompt.js +320 -22
- package/build/shared/charts/descriptors/service/LLMEntityExtract.js +274 -0
- package/build/shared/charts/descriptors/service/httpRequest.js +33 -1
- package/build/shared/charts/descriptors/service/index.js +3 -1
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +17 -13
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +4 -4
- package/build/shared/charts/descriptors/voice/nodes/play.js +8 -1
- package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +44 -45
- package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +0 -1
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +31 -39
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +17 -25
- package/build/shared/charts/helpers/generativeAI/generativeAIPrompts.js +55 -0
- package/build/shared/interfaces/appsession/IAppSession.js +3 -0
- package/build/shared/interfaces/appsession/ISetAppState.js +3 -0
- package/build/shared/interfaces/appsession/index.js +3 -0
- package/build/shared/interfaces/fileStorage.js +6 -0
- package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +32 -3
- package/build/shared/interfaces/handover.js +2 -1
- package/build/shared/interfaces/messageAPI/endpoints.js +15 -2
- package/build/shared/interfaces/messageAPI/handover.js +5 -1
- package/build/shared/interfaces/nlu/nlu.js +3 -0
- package/build/shared/interfaces/resources/IAuditEvent.js +10 -9
- package/build/shared/interfaces/resources/ILargeLanguageModel.js +34 -20
- package/build/shared/interfaces/resources/IMilestone.js +50 -0
- package/build/shared/interfaces/resources/INodeDescriptorSet.js +84 -75
- package/build/shared/interfaces/resources/TResourceType.js +12 -5
- package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/ICloneMilestoneRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/ICreateMilestoneRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IDeleteMilestoneRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IIndexMilestonesRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneIndexItem_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStepMetric_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStep_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestone_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IReadMilestoneRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IUpdateMilestoneRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/IUploadResumableRest_2_0.js +3 -1
- package/build/shared/interfaces/security/IPermission.js +4 -2
- package/build/shared/interfaces/security/index.js +1 -1
- package/package.json +2 -2
- package/types/index.d.ts +938 -285
- package/build/shared/charts/descriptors/nlu/extractAnswer.js +0 -115
package/types/index.d.ts
CHANGED
|
@@ -446,6 +446,7 @@ declare const projectWidePermissions: readonly [
|
|
|
446
446
|
"logs",
|
|
447
447
|
"memberDetails",
|
|
448
448
|
"members",
|
|
449
|
+
"milestones",
|
|
449
450
|
"nluConnectors",
|
|
450
451
|
"packages",
|
|
451
452
|
"playbooks",
|
|
@@ -1050,6 +1051,8 @@ export interface ICrudPermissions {
|
|
|
1050
1051
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1051
1052
|
* members:
|
|
1052
1053
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1054
|
+
* milestones:
|
|
1055
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1053
1056
|
* nluConnectors:
|
|
1054
1057
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1055
1058
|
* playbooks:
|
|
@@ -1133,6 +1136,8 @@ export interface IOrganisationWideAcl {
|
|
|
1133
1136
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1134
1137
|
* members:
|
|
1135
1138
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1139
|
+
* milestones:
|
|
1140
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1136
1141
|
* nluConnectors:
|
|
1137
1142
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1138
1143
|
* playbooks:
|
|
@@ -1571,6 +1576,7 @@ declare const arrayTResourceType: readonly [
|
|
|
1571
1576
|
"lexiconKeyphrase",
|
|
1572
1577
|
"lexiconSlot",
|
|
1573
1578
|
"locale",
|
|
1579
|
+
"milestone",
|
|
1574
1580
|
"nluconnector",
|
|
1575
1581
|
"nodeData",
|
|
1576
1582
|
"nodeDescriptorSet",
|
|
@@ -1581,11 +1587,11 @@ declare const arrayTResourceType: readonly [
|
|
|
1581
1587
|
"snapshot",
|
|
1582
1588
|
"snippet"
|
|
1583
1589
|
];
|
|
1584
|
-
export declare type TResourceType = typeof arrayTResourceType[number];
|
|
1590
|
+
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
1585
1591
|
declare const arrayTChartableResourceType: readonly [
|
|
1586
1592
|
"flow"
|
|
1587
1593
|
];
|
|
1588
|
-
export declare type TChartableResourceType = typeof arrayTChartableResourceType[number];
|
|
1594
|
+
export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
|
|
1589
1595
|
declare const searchableResourceTypes: readonly [
|
|
1590
1596
|
"endpoint",
|
|
1591
1597
|
"extension",
|
|
@@ -1593,12 +1599,13 @@ declare const searchableResourceTypes: readonly [
|
|
|
1593
1599
|
"function",
|
|
1594
1600
|
"largeLanguageModel",
|
|
1595
1601
|
"lexicon",
|
|
1602
|
+
"milestone",
|
|
1596
1603
|
"nluconnector",
|
|
1597
1604
|
"playbook",
|
|
1598
1605
|
"project",
|
|
1599
1606
|
"snapshot"
|
|
1600
1607
|
];
|
|
1601
|
-
export declare type TSearchableResourceType = typeof searchableResourceTypes[number];
|
|
1608
|
+
export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
|
|
1602
1609
|
declare const arrayNLUConnectorType: readonly [
|
|
1603
1610
|
"alexa",
|
|
1604
1611
|
"dialogflow",
|
|
@@ -2477,12 +2484,12 @@ export interface ICallEventFailoverSettings {
|
|
|
2477
2484
|
dialTranscribeRecognitionChannel?: number;
|
|
2478
2485
|
dialTranscribeRecognitionGoogleModel?: string;
|
|
2479
2486
|
dialTranscribeLabel?: string;
|
|
2480
|
-
dialTranscribeDeepgramTier?: string;
|
|
2481
2487
|
dialTranscribeDeepgramModel?: string;
|
|
2482
2488
|
referredBy?: string;
|
|
2483
2489
|
deepgramSmartFormatting?: boolean;
|
|
2484
2490
|
deepgramEndpointing?: boolean;
|
|
2485
2491
|
deepgramEndpointingValue?: number;
|
|
2492
|
+
dialTranscribeDeepgramTier?: string;
|
|
2486
2493
|
}
|
|
2487
2494
|
export interface ICallEvents {
|
|
2488
2495
|
amd?: ICallEventSettings;
|
|
@@ -3094,17 +3101,156 @@ export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSetting
|
|
|
3094
3101
|
title: string;
|
|
3095
3102
|
};
|
|
3096
3103
|
}
|
|
3097
|
-
export interface
|
|
3104
|
+
export interface IWebchat3EndpointLayoutSettings {
|
|
3098
3105
|
/**
|
|
3099
|
-
|
|
3100
|
-
|
|
3106
|
+
* The title that will show up on top of
|
|
3107
|
+
* the webchat's Header
|
|
3108
|
+
*/
|
|
3109
|
+
title: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* The URL that links to the logo
|
|
3112
|
+
* we display in the header.
|
|
3113
|
+
*/
|
|
3114
|
+
logoUrl: string;
|
|
3115
|
+
/**
|
|
3116
|
+
* Check for using the logo of the other agent.
|
|
3117
|
+
*/
|
|
3118
|
+
useOtherAgentLogo: boolean;
|
|
3119
|
+
/**
|
|
3120
|
+
* bot avatar name
|
|
3101
3121
|
*/
|
|
3102
|
-
|
|
3122
|
+
botAvatarName: string;
|
|
3103
3123
|
/**
|
|
3104
|
-
* The
|
|
3105
|
-
* the
|
|
3124
|
+
* The URL that links to the logo
|
|
3125
|
+
* we display as the chatbot avatar
|
|
3126
|
+
*/
|
|
3127
|
+
botLogoUrl: string;
|
|
3128
|
+
/**
|
|
3129
|
+
* Agemt avatar name.
|
|
3130
|
+
*/
|
|
3131
|
+
agentAvatarName: string;
|
|
3132
|
+
/**
|
|
3133
|
+
* The URL that links to the logo
|
|
3134
|
+
* we display as the agent avatar
|
|
3135
|
+
*/
|
|
3136
|
+
agentLogoUrl: string;
|
|
3137
|
+
/**
|
|
3138
|
+
* Defines the number of line rows the text input
|
|
3139
|
+
* will grow to before showing a vertical scrollbar
|
|
3140
|
+
*/
|
|
3141
|
+
inputAutogrowMaxRows: number;
|
|
3142
|
+
/**
|
|
3143
|
+
* This setting activates the automatic collation
|
|
3144
|
+
* of input messages with a delay for the webchat
|
|
3145
|
+
*/
|
|
3146
|
+
enableInputCollation: boolean;
|
|
3147
|
+
/**
|
|
3148
|
+
* This setting configures the delay for the automatic
|
|
3149
|
+
* input collation in miliseconds. Defaults to 1000
|
|
3150
|
+
*/
|
|
3151
|
+
inputCollationTimeout: number;
|
|
3152
|
+
/**
|
|
3153
|
+
* This setting is used to decide whether images
|
|
3154
|
+
* should be resized dynamically
|
|
3155
|
+
*/
|
|
3156
|
+
dynamicImageAspectRatio: boolean;
|
|
3157
|
+
/**
|
|
3158
|
+
* This setting is used to disable autocomplete
|
|
3159
|
+
* for the input as on Samsung smartphones the
|
|
3160
|
+
* autosuggestion overlaps the virtual keyboard
|
|
3161
|
+
*/
|
|
3162
|
+
disableInputAutocomplete: boolean;
|
|
3163
|
+
/**
|
|
3164
|
+
* If this is true, the webchat will apply
|
|
3165
|
+
* generic styling to HTML message content.
|
|
3166
|
+
* This is e.g. useful if we are using HTML generated by Markdown.
|
|
3167
|
+
*/
|
|
3168
|
+
enableGenericHTMLStyling: boolean;
|
|
3169
|
+
/**
|
|
3170
|
+
* This setting is used to decide whether to
|
|
3171
|
+
* sanitize HTML content in the Webchat or not
|
|
3172
|
+
*/
|
|
3173
|
+
disableHtmlContentSanitization: boolean;
|
|
3174
|
+
/**
|
|
3175
|
+
* This setting is used to decide whether to
|
|
3176
|
+
* sanitize JavaScript from URL buttons /
|
|
3177
|
+
* Default Actions in the Webchat or not
|
|
3178
|
+
*/
|
|
3179
|
+
disableUrlButtonSanitization: boolean;
|
|
3180
|
+
/**
|
|
3181
|
+
* Advanced watermark settings for the webchat
|
|
3106
3182
|
*/
|
|
3107
|
-
|
|
3183
|
+
watermark: TWebchat3LayoutWatermark;
|
|
3184
|
+
/**
|
|
3185
|
+
* Advanced watermark text settings for the webchat
|
|
3186
|
+
*/
|
|
3187
|
+
watermarkText: string;
|
|
3188
|
+
}
|
|
3189
|
+
export interface IWebchat3EndpointColorsSettings {
|
|
3190
|
+
/**
|
|
3191
|
+
* The primary color of the webchat.
|
|
3192
|
+
*/
|
|
3193
|
+
primaryColor: string;
|
|
3194
|
+
/**
|
|
3195
|
+
* The secondary color of the webchat.
|
|
3196
|
+
*/
|
|
3197
|
+
secondaryColor: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* The background color of the webchat.
|
|
3200
|
+
*/
|
|
3201
|
+
chatInterfaceColor: string;
|
|
3202
|
+
/**
|
|
3203
|
+
* Bot message color
|
|
3204
|
+
*/
|
|
3205
|
+
botMessageColor: string;
|
|
3206
|
+
/**
|
|
3207
|
+
* User message color
|
|
3208
|
+
*/
|
|
3209
|
+
userMessageColor: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* Text link color
|
|
3212
|
+
*/
|
|
3213
|
+
textLinkColor: string;
|
|
3214
|
+
}
|
|
3215
|
+
export interface IWebchat3EndpointBehaviorSettings {
|
|
3216
|
+
/**
|
|
3217
|
+
* Whether to enable typing indicators
|
|
3218
|
+
* when the bot is replying
|
|
3219
|
+
*/
|
|
3220
|
+
enableTypingIndicator: boolean;
|
|
3221
|
+
/**
|
|
3222
|
+
* The amount of ms per letter
|
|
3223
|
+
* typed in a message
|
|
3224
|
+
*/
|
|
3225
|
+
messageDelay: number;
|
|
3226
|
+
/**
|
|
3227
|
+
* The placeholder text
|
|
3228
|
+
* we display in the input field
|
|
3229
|
+
*/
|
|
3230
|
+
inputPlaceholder: string;
|
|
3231
|
+
/**
|
|
3232
|
+
* Whether the webchat should use STT.
|
|
3233
|
+
*/
|
|
3234
|
+
enableSTT: boolean;
|
|
3235
|
+
/**
|
|
3236
|
+
* Whether the webchat should use
|
|
3237
|
+
* TTS and thereby display
|
|
3238
|
+
* a record button.
|
|
3239
|
+
*/
|
|
3240
|
+
enableTTS: boolean;
|
|
3241
|
+
/**
|
|
3242
|
+
* This setting is used to decide whether
|
|
3243
|
+
* the input should be focused right
|
|
3244
|
+
* after a postback button is pressed
|
|
3245
|
+
*/
|
|
3246
|
+
focusInputAfterPostback: boolean;
|
|
3247
|
+
/**
|
|
3248
|
+
* This setting is used to decide whether
|
|
3249
|
+
* a connectivity indicator should be displayed
|
|
3250
|
+
*/
|
|
3251
|
+
enableConnectionStatusIndicator: boolean;
|
|
3252
|
+
}
|
|
3253
|
+
export interface IWebchat3EndpointStartBehaviorSettings {
|
|
3108
3254
|
/**
|
|
3109
3255
|
* The start behavior of the
|
|
3110
3256
|
* webchat, e.g. whether a start button
|
|
@@ -3112,184 +3258,369 @@ export interface IWebchat3EndpointSettings extends IWebchatEndpointSharedSetting
|
|
|
3112
3258
|
*/
|
|
3113
3259
|
startBehavior: TWebchat2StartBehavior;
|
|
3114
3260
|
/**
|
|
3115
|
-
*
|
|
3116
|
-
*
|
|
3117
|
-
|
|
3118
|
-
|
|
3261
|
+
* The payload to send
|
|
3262
|
+
* when clicking the getStartedButton
|
|
3263
|
+
*/
|
|
3264
|
+
getStartedPayload: string;
|
|
3265
|
+
/**
|
|
3266
|
+
* The data that will be sent to the chat
|
|
3267
|
+
* when clicking the getStartedButton
|
|
3268
|
+
* or injecting it
|
|
3269
|
+
*/
|
|
3270
|
+
getStartedData: {};
|
|
3271
|
+
/**
|
|
3272
|
+
* The text to display in the chat
|
|
3273
|
+
* when clicking the getStartedButton
|
|
3274
|
+
*/
|
|
3275
|
+
getStartedText: string;
|
|
3276
|
+
/**
|
|
3277
|
+
* The text to display on
|
|
3278
|
+
* the get started button
|
|
3279
|
+
*/
|
|
3280
|
+
getStartedButtonText: string;
|
|
3281
|
+
}
|
|
3282
|
+
export interface IWebchat3EndpointBusinessHoursTimeSettings {
|
|
3283
|
+
/**
|
|
3284
|
+
* Start time of the business hours, e.g. 09:00
|
|
3119
3285
|
*/
|
|
3120
|
-
|
|
3286
|
+
startTime: string;
|
|
3121
3287
|
/**
|
|
3122
|
-
*
|
|
3288
|
+
* End time of the business hours, e.g. 17:00
|
|
3123
3289
|
*/
|
|
3124
|
-
|
|
3290
|
+
endTime: string;
|
|
3125
3291
|
/**
|
|
3126
|
-
*
|
|
3292
|
+
* Week day of the business hours in lower case, e.g. "monday"
|
|
3127
3293
|
*/
|
|
3128
|
-
|
|
3294
|
+
weekDay: string;
|
|
3295
|
+
}
|
|
3296
|
+
export interface IWebchat3EndpointBusinessHoursSettings {
|
|
3129
3297
|
/**
|
|
3130
|
-
*
|
|
3298
|
+
* Whether the Office Hours are enabled
|
|
3299
|
+
*/
|
|
3300
|
+
enabled: boolean;
|
|
3301
|
+
/**
|
|
3302
|
+
* The business hours mode. Possible values are:
|
|
3303
|
+
* "hide" - The chat window will be hidden out of business hours
|
|
3304
|
+
* "disable" - The message bubble will be disabled with a mouse over text out of business hours
|
|
3305
|
+
* "inform" - The Webchat Widget will start normally, but show an out of business hours message
|
|
3306
|
+
*/
|
|
3307
|
+
mode: TWebchat3Mode;
|
|
3308
|
+
/**
|
|
3309
|
+
* The text that is displayed in the mouse over
|
|
3310
|
+
* text of the bubble or the out of business hours message
|
|
3311
|
+
*/
|
|
3312
|
+
text: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* The title that is displayed to the user in the
|
|
3315
|
+
* information when opening the bot out of business hours
|
|
3316
|
+
*/
|
|
3317
|
+
title: string;
|
|
3318
|
+
/**
|
|
3319
|
+
* The timezone that is used to calculate of the user is
|
|
3320
|
+
* calling out of business hours
|
|
3321
|
+
*/
|
|
3322
|
+
timeZone: string;
|
|
3323
|
+
times: IWebchat3EndpointBusinessHoursTimeSettings[];
|
|
3324
|
+
}
|
|
3325
|
+
export interface IWebchat3EndpointUnreadMessagesSettings {
|
|
3326
|
+
/**
|
|
3327
|
+
* This setting is used to decide whether unread messages
|
|
3328
|
+
* should be indicated in the title of a minimized webchat widget
|
|
3329
|
+
*/
|
|
3330
|
+
enableIndicator: boolean;
|
|
3331
|
+
/**
|
|
3332
|
+
* This setting is used to decide whether a badge with the number
|
|
3333
|
+
* of unread messages should be displayed in the minimized webchat widget
|
|
3334
|
+
*/
|
|
3335
|
+
enableBadge: boolean;
|
|
3336
|
+
/**
|
|
3337
|
+
* This setting is used to decide whether to show a message preview
|
|
3338
|
+
* for incoming messages if the webchat widget is minimized
|
|
3339
|
+
*/
|
|
3340
|
+
enablePreview: boolean;
|
|
3341
|
+
/**
|
|
3342
|
+
* This setting is used to decide whether a sound should be triggered
|
|
3343
|
+
* for incoming messages if the webchat widget is minimized
|
|
3344
|
+
*/
|
|
3345
|
+
enableSound: boolean;
|
|
3346
|
+
}
|
|
3347
|
+
export interface IWebchat3EndpointHomeScreenSettings {
|
|
3348
|
+
/**
|
|
3349
|
+
* Whether the Home Screen is enabled
|
|
3350
|
+
*/
|
|
3351
|
+
enabled: boolean;
|
|
3352
|
+
/**
|
|
3353
|
+
* The welcome text that is displayed in the Home Screen
|
|
3354
|
+
*/
|
|
3355
|
+
welcomeText: string;
|
|
3356
|
+
background: {
|
|
3357
|
+
/**
|
|
3358
|
+
* The background image url of the Home Screen
|
|
3359
|
+
*/
|
|
3360
|
+
imageUrl: string;
|
|
3361
|
+
/**
|
|
3362
|
+
* The background color of the Home Screen
|
|
3363
|
+
*/
|
|
3364
|
+
color: string;
|
|
3365
|
+
};
|
|
3366
|
+
/**
|
|
3367
|
+
* The text of the start conversation button
|
|
3368
|
+
*/
|
|
3369
|
+
startConversationButtonText: string;
|
|
3370
|
+
previousConversations: {
|
|
3371
|
+
/**
|
|
3372
|
+
* Whether the previous conversations are enabled
|
|
3373
|
+
*/
|
|
3374
|
+
enabled: boolean;
|
|
3375
|
+
/**
|
|
3376
|
+
* The text of the previous conversations button
|
|
3377
|
+
*/
|
|
3378
|
+
buttonText: string;
|
|
3379
|
+
/**
|
|
3380
|
+
* The title of the previous conversations title
|
|
3381
|
+
*/
|
|
3382
|
+
title: string;
|
|
3383
|
+
};
|
|
3384
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3385
|
+
}
|
|
3386
|
+
export interface IWebchat3EndpointTeaserMessageSettings {
|
|
3387
|
+
/**
|
|
3388
|
+
* teaser message text
|
|
3389
|
+
*/
|
|
3390
|
+
text: string;
|
|
3391
|
+
/**
|
|
3392
|
+
* teaser message button text
|
|
3393
|
+
*/
|
|
3394
|
+
showInChat: boolean;
|
|
3395
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3396
|
+
}
|
|
3397
|
+
export interface IWebchat3EndpointConversationStartersSettings {
|
|
3398
|
+
/**
|
|
3399
|
+
* Whether the conversation starters are enabled
|
|
3400
|
+
*/
|
|
3401
|
+
enabled: boolean;
|
|
3402
|
+
starters: {
|
|
3403
|
+
/**
|
|
3404
|
+
* The type of the conversation starter
|
|
3405
|
+
*/
|
|
3406
|
+
type: string;
|
|
3407
|
+
/**
|
|
3408
|
+
* The title of the conversation starter
|
|
3409
|
+
*/
|
|
3410
|
+
title: string;
|
|
3411
|
+
/**
|
|
3412
|
+
* The url of the conversation starter
|
|
3413
|
+
*/
|
|
3414
|
+
url: string;
|
|
3415
|
+
/**
|
|
3416
|
+
* The payload of the conversation starter
|
|
3417
|
+
*/
|
|
3418
|
+
payload: string;
|
|
3419
|
+
}[];
|
|
3420
|
+
}
|
|
3421
|
+
export interface IWebchat3EndpointChatOptionsSettings {
|
|
3422
|
+
/**
|
|
3423
|
+
* Whether the chat options are enabled
|
|
3424
|
+
*/
|
|
3425
|
+
enabled: boolean;
|
|
3426
|
+
/**
|
|
3427
|
+
* The title of the chat options
|
|
3428
|
+
*/
|
|
3429
|
+
title: string;
|
|
3430
|
+
/**
|
|
3431
|
+
* The quick reply of the chat options
|
|
3432
|
+
*/
|
|
3433
|
+
quickReplyOptions: {
|
|
3434
|
+
/**
|
|
3435
|
+
* Whether the quick reply is enabled
|
|
3436
|
+
*/
|
|
3437
|
+
enabled: boolean;
|
|
3438
|
+
/**
|
|
3439
|
+
* The title of the quick reply
|
|
3440
|
+
*/
|
|
3441
|
+
sectionTitle: string;
|
|
3442
|
+
/**
|
|
3443
|
+
* The configuration of the quick reply
|
|
3444
|
+
*/
|
|
3445
|
+
quickReplies: {
|
|
3446
|
+
type: string;
|
|
3447
|
+
title: string;
|
|
3448
|
+
url: string;
|
|
3449
|
+
payload: string;
|
|
3450
|
+
}[];
|
|
3451
|
+
};
|
|
3452
|
+
/**
|
|
3453
|
+
* Whether show the tts toggle
|
|
3454
|
+
*/
|
|
3455
|
+
showTTSToggle: boolean;
|
|
3456
|
+
/**
|
|
3457
|
+
* Whether activate the tts toggle
|
|
3458
|
+
*/
|
|
3459
|
+
activateTTSToggle: boolean;
|
|
3460
|
+
/**
|
|
3461
|
+
* The label of the tts toggle
|
|
3462
|
+
*/
|
|
3463
|
+
labelTTSToggle: string;
|
|
3464
|
+
/**
|
|
3465
|
+
* Rating configuration
|
|
3466
|
+
*/
|
|
3467
|
+
rating: {
|
|
3468
|
+
enabled: string;
|
|
3469
|
+
title: string;
|
|
3470
|
+
commentPlaceholder: string;
|
|
3471
|
+
submitButtonText: string;
|
|
3472
|
+
eventBannerText: string;
|
|
3473
|
+
};
|
|
3474
|
+
/**
|
|
3475
|
+
* The configuration of the chat options footer
|
|
3476
|
+
*/
|
|
3477
|
+
footer: {
|
|
3478
|
+
enabled: boolean;
|
|
3479
|
+
items: {
|
|
3480
|
+
title: string;
|
|
3481
|
+
url: string;
|
|
3482
|
+
}[];
|
|
3483
|
+
};
|
|
3484
|
+
}
|
|
3485
|
+
export interface IWebchat3EndpointPrivacyNoticeSettings {
|
|
3486
|
+
/**
|
|
3487
|
+
* Whether the privacy notice is enabled
|
|
3488
|
+
*/
|
|
3489
|
+
enabled: boolean;
|
|
3490
|
+
/**
|
|
3491
|
+
* The title of the privacy notice
|
|
3492
|
+
*/
|
|
3493
|
+
title: string;
|
|
3494
|
+
/**
|
|
3495
|
+
* The text of the privacy notice
|
|
3496
|
+
*/
|
|
3497
|
+
text: string;
|
|
3498
|
+
/**
|
|
3499
|
+
* the submit button text of the privacy notice
|
|
3500
|
+
*/
|
|
3501
|
+
submitButtonText: string;
|
|
3502
|
+
/**
|
|
3503
|
+
* the url text of the privacy notice
|
|
3504
|
+
*/
|
|
3505
|
+
urlText: string;
|
|
3506
|
+
/**
|
|
3507
|
+
* the url of the privacy notice
|
|
3508
|
+
*/
|
|
3509
|
+
url: string;
|
|
3510
|
+
}
|
|
3511
|
+
export interface IWebchat3EndpointMaintenanceSettings {
|
|
3512
|
+
/**
|
|
3513
|
+
* Whether the Maintenance mode is enabled
|
|
3131
3514
|
*/
|
|
3132
|
-
|
|
3515
|
+
enabled: boolean;
|
|
3133
3516
|
/**
|
|
3134
|
-
* The
|
|
3135
|
-
*
|
|
3517
|
+
* The maintenance mode. Possible values are:
|
|
3518
|
+
* "hide" - The chat window will be hidden during maintenance
|
|
3519
|
+
* "disable" - The message bubble will be disabled with a mouse over text during maintenance
|
|
3520
|
+
* "inform" - The Webchat Widget will start normally, but show a maintenance mode message
|
|
3136
3521
|
*/
|
|
3137
|
-
|
|
3522
|
+
mode: TWebchat3Mode;
|
|
3138
3523
|
/**
|
|
3139
|
-
* The text displayed in the
|
|
3140
|
-
* (text is followed by the actual comment)
|
|
3524
|
+
* The text that is displayed in the mouse over text of the bubble or the maintenance mode message
|
|
3141
3525
|
*/
|
|
3142
|
-
|
|
3526
|
+
text: string;
|
|
3143
3527
|
/**
|
|
3144
|
-
*
|
|
3528
|
+
* The title that is displayed to the user in the information when opening the bot during maintenance
|
|
3145
3529
|
*/
|
|
3146
|
-
|
|
3530
|
+
title: string;
|
|
3531
|
+
}
|
|
3532
|
+
export interface IWebchat3EndpointDemoWebchatSettings {
|
|
3147
3533
|
/**
|
|
3148
|
-
*
|
|
3149
|
-
* in the Webchat or not
|
|
3534
|
+
* Whether the Demo Webchat is enabled
|
|
3150
3535
|
*/
|
|
3151
|
-
|
|
3536
|
+
enabled: boolean;
|
|
3152
3537
|
/**
|
|
3153
|
-
*
|
|
3538
|
+
* Background image url of the Demo Webchat
|
|
3154
3539
|
*/
|
|
3155
|
-
|
|
3540
|
+
backgroundImageUrl: string;
|
|
3156
3541
|
/**
|
|
3157
|
-
*
|
|
3542
|
+
* Position of the Demo Webchat
|
|
3158
3543
|
*/
|
|
3159
|
-
|
|
3544
|
+
position: TWebchat3DemoWebchatPosition;
|
|
3160
3545
|
/**
|
|
3161
|
-
*
|
|
3546
|
+
* Whether the Demo Webchat is draggable
|
|
3547
|
+
|
|
3162
3548
|
*/
|
|
3163
|
-
|
|
3549
|
+
shouldOverwriteWebchatBundleUrl: boolean;
|
|
3164
3550
|
/**
|
|
3165
|
-
*
|
|
3551
|
+
* The webchat bundle URL for demo webchat
|
|
3166
3552
|
*/
|
|
3167
|
-
|
|
3553
|
+
webchatBundleUrl: string;
|
|
3554
|
+
}
|
|
3555
|
+
export interface IWebchat3EndpointSettings {
|
|
3168
3556
|
/**
|
|
3169
|
-
*
|
|
3557
|
+
* control the layout of the Webchat Widget
|
|
3170
3558
|
*/
|
|
3171
|
-
|
|
3559
|
+
layout: IWebchat3EndpointLayoutSettings;
|
|
3172
3560
|
/**
|
|
3173
|
-
*
|
|
3561
|
+
* control the colors of the Webchat Widget
|
|
3174
3562
|
*/
|
|
3175
|
-
|
|
3563
|
+
colors: IWebchat3EndpointColorsSettings;
|
|
3176
3564
|
/**
|
|
3177
|
-
*
|
|
3565
|
+
* control the behavior of the Webchat Widget
|
|
3178
3566
|
*/
|
|
3179
|
-
|
|
3567
|
+
behavior: IWebchat3EndpointBehaviorSettings;
|
|
3180
3568
|
/**
|
|
3181
|
-
*
|
|
3569
|
+
* control the start behavior of the Webchat Widget
|
|
3182
3570
|
*/
|
|
3183
|
-
|
|
3571
|
+
startBehavior: IWebchat3EndpointStartBehaviorSettings;
|
|
3184
3572
|
/**
|
|
3185
|
-
*
|
|
3573
|
+
* Settings to store attachments at a cloud provider
|
|
3186
3574
|
*/
|
|
3187
|
-
|
|
3575
|
+
fileStorageSettings?: IFileStorageSettings;
|
|
3188
3576
|
/**
|
|
3189
|
-
*
|
|
3577
|
+
* Office Hours configuration for the Webchat Widget
|
|
3190
3578
|
*/
|
|
3191
|
-
|
|
3579
|
+
businessHours: IWebchat3EndpointBusinessHoursSettings;
|
|
3192
3580
|
/**
|
|
3193
|
-
*
|
|
3581
|
+
* Control the unread messages of the Webchat Widget
|
|
3194
3582
|
*/
|
|
3195
|
-
|
|
3583
|
+
unreadMessages: IWebchat3EndpointUnreadMessagesSettings;
|
|
3196
3584
|
/**
|
|
3197
|
-
*
|
|
3585
|
+
* Control the home screen of the Webchat Widget
|
|
3198
3586
|
*/
|
|
3199
|
-
|
|
3587
|
+
homeScreen: IWebchat3EndpointHomeScreenSettings;
|
|
3200
3588
|
/**
|
|
3201
|
-
*
|
|
3589
|
+
* Control the teaser message of the Webchat Widget
|
|
3202
3590
|
*/
|
|
3203
|
-
|
|
3591
|
+
teaserMessage: IWebchat3EndpointTeaserMessageSettings;
|
|
3204
3592
|
/**
|
|
3205
|
-
*
|
|
3593
|
+
* Control the conversation starters of the Webchat Widget
|
|
3206
3594
|
*/
|
|
3207
|
-
|
|
3595
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3208
3596
|
/**
|
|
3209
|
-
*
|
|
3597
|
+
* Control the chat options of the Webchat Widget
|
|
3210
3598
|
*/
|
|
3211
|
-
|
|
3599
|
+
chatOptions: IWebchat3EndpointChatOptionsSettings;
|
|
3212
3600
|
/**
|
|
3213
|
-
*
|
|
3601
|
+
* Control the privacy notice of the Webchat Widget
|
|
3214
3602
|
*/
|
|
3215
|
-
|
|
3603
|
+
privacyNotice: IWebchat3EndpointPrivacyNoticeSettings;
|
|
3216
3604
|
/**
|
|
3217
|
-
*
|
|
3605
|
+
* Webchat Widget custom settings
|
|
3218
3606
|
*/
|
|
3219
|
-
|
|
3607
|
+
customJSON?: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* Wwbchat Plugins
|
|
3610
|
+
*/
|
|
3611
|
+
pluginUrls?: string[];
|
|
3220
3612
|
/**
|
|
3221
3613
|
* The maximum allowed size of the attachment
|
|
3222
3614
|
*/
|
|
3223
3615
|
fileAttachmentMaxSize: number;
|
|
3224
3616
|
/**
|
|
3225
|
-
* Maintenance mode
|
|
3617
|
+
* Maintenance mode configuration for the Webchat Widget
|
|
3226
3618
|
*/
|
|
3227
|
-
maintenance:
|
|
3228
|
-
/**
|
|
3229
|
-
* Whether the Maintenance mode is enabled
|
|
3230
|
-
*/
|
|
3231
|
-
enabled: boolean;
|
|
3232
|
-
/**
|
|
3233
|
-
* The maintenance mode. Possible values are:
|
|
3234
|
-
* "hide" - The chat window will be hidden during maintenance
|
|
3235
|
-
* "disable" - The message bubble will be disabled with a mouse over text during maintenance
|
|
3236
|
-
* "inform" - The Webchat Widget will start normally, but show a maintenance mode message
|
|
3237
|
-
*/
|
|
3238
|
-
mode: string;
|
|
3239
|
-
/**
|
|
3240
|
-
* The text that is displayed in the mouse over text of the bubble or the maintenance mode message
|
|
3241
|
-
*/
|
|
3242
|
-
text: string;
|
|
3243
|
-
/**
|
|
3244
|
-
* The title that is displayed to the user in the information when opening the bot during maintenance
|
|
3245
|
-
*/
|
|
3246
|
-
title: string;
|
|
3247
|
-
};
|
|
3619
|
+
maintenance: IWebchat3EndpointMaintenanceSettings;
|
|
3248
3620
|
/**
|
|
3249
|
-
*
|
|
3621
|
+
* Control the demo webchat of the Webchat Widget
|
|
3250
3622
|
*/
|
|
3251
|
-
|
|
3252
|
-
/**
|
|
3253
|
-
* Specified hours during which the Webchat Widget should be available
|
|
3254
|
-
*/
|
|
3255
|
-
businessHours: {
|
|
3256
|
-
/**
|
|
3257
|
-
* Start time of the business hours, e.g. 09:00
|
|
3258
|
-
*/
|
|
3259
|
-
startTime: string;
|
|
3260
|
-
/**
|
|
3261
|
-
* End time of the business hours, e.g. 17:00
|
|
3262
|
-
*/
|
|
3263
|
-
endTime: string;
|
|
3264
|
-
/**
|
|
3265
|
-
* Week day of the business hours in lower case, e.g. "monday"
|
|
3266
|
-
*/
|
|
3267
|
-
weekDay: string;
|
|
3268
|
-
}[];
|
|
3269
|
-
/**
|
|
3270
|
-
* Whether the Office Hours are enabled
|
|
3271
|
-
*/
|
|
3272
|
-
enabled: boolean;
|
|
3273
|
-
/**
|
|
3274
|
-
* The business hours mode. Possible values are:
|
|
3275
|
-
* "hide" - The chat window will be hidden out of business hours
|
|
3276
|
-
* "disable" - The message bubble will be disabled with a mouse over text out of business hours
|
|
3277
|
-
* "inform" - The Webchat Widget will start normally, but show an out of business hours message
|
|
3278
|
-
*/
|
|
3279
|
-
mode: string;
|
|
3280
|
-
/**
|
|
3281
|
-
* The text that is displayed in the mouse over text of the bubble or the out of business hours message
|
|
3282
|
-
*/
|
|
3283
|
-
text: string;
|
|
3284
|
-
/**
|
|
3285
|
-
* The timezone that is used to calculate of the user is calling out of business hours
|
|
3286
|
-
*/
|
|
3287
|
-
timeZone: string;
|
|
3288
|
-
/**
|
|
3289
|
-
* The title that is displayed to the user in the information when opening the bot out of business hours
|
|
3290
|
-
*/
|
|
3291
|
-
title: string;
|
|
3292
|
-
};
|
|
3623
|
+
demoWebchat: IWebchat3EndpointDemoWebchatSettings;
|
|
3293
3624
|
}
|
|
3294
3625
|
/**
|
|
3295
3626
|
* Setting to enable rating for the Webchat.
|
|
@@ -3309,6 +3640,9 @@ export declare type TWebchatEnableRating = "always" | "once" | "onRequest";
|
|
|
3309
3640
|
* Flow when the Webchat connects
|
|
3310
3641
|
*/
|
|
3311
3642
|
export declare type TWebchat2StartBehavior = "none" | "button" | "injection";
|
|
3643
|
+
export declare type TWebchat3Mode = "inform" | "hide" | "disable";
|
|
3644
|
+
export declare type TWebchat3LayoutWatermark = "default" | "custom" | "none";
|
|
3645
|
+
export declare type TWebchat3DemoWebchatPosition = "centered" | "bottomRight";
|
|
3312
3646
|
export interface IAmazonLexEndpointSettings {
|
|
3313
3647
|
/**
|
|
3314
3648
|
* Whether to reparse slots found
|
|
@@ -3396,6 +3730,8 @@ export interface IWhatsAppEndpointSettings extends IEndpointSessionSettings {
|
|
|
3396
3730
|
fileStorageSettings?: IFileStorageSettings;
|
|
3397
3731
|
}
|
|
3398
3732
|
export interface IFileStorageSettings {
|
|
3733
|
+
enabled?: boolean;
|
|
3734
|
+
dropzoneText?: string;
|
|
3399
3735
|
storageProvider: "none" | "aws" | "azure" | "googleCloud";
|
|
3400
3736
|
awsConnection?: string;
|
|
3401
3737
|
azureConnection?: string;
|
|
@@ -3525,14 +3861,24 @@ declare const generativeAIModels: readonly [
|
|
|
3525
3861
|
"gpt-3.5-turbo-instruct",
|
|
3526
3862
|
"gpt-4",
|
|
3527
3863
|
"text-davinci-003",
|
|
3528
|
-
"text-embedding-ada-002",
|
|
3529
3864
|
"luminous-extended-control",
|
|
3530
|
-
"luminous-embedding-128",
|
|
3531
3865
|
"claude-v1-100k",
|
|
3532
3866
|
"claude-instant-v1",
|
|
3533
|
-
"
|
|
3867
|
+
"claude-3-opus-20240229",
|
|
3868
|
+
"claude-3-haiku-20240307",
|
|
3869
|
+
"claude-3-sonnet-20240229",
|
|
3870
|
+
"text-bison@001",
|
|
3871
|
+
"custom-model",
|
|
3872
|
+
"text-embedding-3-large",
|
|
3873
|
+
"text-embedding-ada-002",
|
|
3874
|
+
"luminous-embedding-128"
|
|
3534
3875
|
];
|
|
3535
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];
|
|
3536
3882
|
declare const generativeAIProviders: readonly [
|
|
3537
3883
|
"azureOpenAI",
|
|
3538
3884
|
"openAI",
|
|
@@ -3542,6 +3888,7 @@ declare const generativeAIProviders: readonly [
|
|
|
3542
3888
|
];
|
|
3543
3889
|
export declare type TGenerativeAIProviders = typeof generativeAIProviders[number];
|
|
3544
3890
|
declare const generativeAIUseCases: readonly [
|
|
3891
|
+
"nlu",
|
|
3545
3892
|
"knowledgeSearch",
|
|
3546
3893
|
"gptPromptNode",
|
|
3547
3894
|
"gptConversation",
|
|
@@ -4376,6 +4723,7 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
4376
4723
|
* - azureOpenAI
|
|
4377
4724
|
* - anthropic
|
|
4378
4725
|
* - googleVertexAI
|
|
4726
|
+
* - alephAlpha
|
|
4379
4727
|
*/
|
|
4380
4728
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
4381
4729
|
/**
|
|
@@ -5502,16 +5850,22 @@ export interface IIndexLexiconEntriesRestReturnValue_2_0 extends ICursorBasedPag
|
|
|
5502
5850
|
* schemas:
|
|
5503
5851
|
* ILexiconEntryData_2_0:
|
|
5504
5852
|
* type: object
|
|
5853
|
+
* required:
|
|
5854
|
+
* - mainKeyphrase
|
|
5505
5855
|
* properties:
|
|
5506
5856
|
* data:
|
|
5507
5857
|
* type: string
|
|
5508
5858
|
* description: Additional JSON-data of the lexicon entry
|
|
5509
|
-
* example: {}
|
|
5859
|
+
* example: "{\"key1\": \"value1\" }"
|
|
5510
5860
|
* slotReferences:
|
|
5511
5861
|
* type: array
|
|
5512
5862
|
* description: The used slots by the lexicon entry
|
|
5513
5863
|
* items:
|
|
5514
5864
|
* $ref: '#/components/schemas/TMongoId'
|
|
5865
|
+
* mainKeyphrase:
|
|
5866
|
+
* type: string
|
|
5867
|
+
* description: the keyphrase value
|
|
5868
|
+
* example: pizza
|
|
5515
5869
|
*
|
|
5516
5870
|
* ILexiconEntryGeneratedData_2_0:
|
|
5517
5871
|
* type: object
|
|
@@ -7649,23 +8003,28 @@ export interface IGraphConnection {
|
|
|
7649
8003
|
referenceId: string;
|
|
7650
8004
|
properties: Pick<IConnection, "type" | "extension" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
7651
8005
|
}
|
|
7652
|
-
export interface
|
|
7653
|
-
customModel
|
|
8006
|
+
export interface IOpenAIMeta {
|
|
8007
|
+
customModel?: string;
|
|
7654
8008
|
}
|
|
7655
|
-
export interface
|
|
8009
|
+
export interface IAlephAlphaMeta {
|
|
8010
|
+
customModel?: string;
|
|
8011
|
+
baseCustomUrl?: string | null;
|
|
7656
8012
|
}
|
|
7657
|
-
export interface
|
|
8013
|
+
export interface IAnthropicMeta {
|
|
8014
|
+
customModel?: string;
|
|
7658
8015
|
}
|
|
7659
8016
|
export interface IAzureOpenAIMeta {
|
|
7660
8017
|
resourceName?: string;
|
|
7661
8018
|
deploymentName?: string;
|
|
7662
8019
|
baseCustomUrl?: string | null;
|
|
7663
8020
|
apiVersion?: string;
|
|
8021
|
+
customModel?: string;
|
|
7664
8022
|
}
|
|
7665
8023
|
export interface IGoogleVertexAIMeta {
|
|
7666
8024
|
location: string;
|
|
7667
8025
|
apiEndPoint: string;
|
|
7668
8026
|
publisher?: string;
|
|
8027
|
+
customModel?: string;
|
|
7669
8028
|
}
|
|
7670
8029
|
export interface ILargeLanguageModel extends IEntityMeta {
|
|
7671
8030
|
_id: TMongoId;
|
|
@@ -7673,6 +8032,8 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7673
8032
|
name: string;
|
|
7674
8033
|
description: string;
|
|
7675
8034
|
modelType: TGenerativeAIModels;
|
|
8035
|
+
modelGroup?: TModelGroups;
|
|
8036
|
+
isCustomModel?: boolean;
|
|
7676
8037
|
provider: TGenerativeAIProviders;
|
|
7677
8038
|
connectionId: string;
|
|
7678
8039
|
isDefault: boolean;
|
|
@@ -7682,6 +8043,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7682
8043
|
googleVertexAI?: IGoogleVertexAIMeta;
|
|
7683
8044
|
openAI?: IOpenAIMeta;
|
|
7684
8045
|
alephAlpha?: IAlephAlphaMeta;
|
|
8046
|
+
anthropic?: IAnthropicMeta;
|
|
7685
8047
|
}
|
|
7686
8048
|
export interface IGraphLargeLanguageModelDependencyAttachment {
|
|
7687
8049
|
_id: string;
|
|
@@ -7842,6 +8204,8 @@ export interface IHttpRequestNodeSharedConfig {
|
|
|
7842
8204
|
async: boolean;
|
|
7843
8205
|
cache: boolean;
|
|
7844
8206
|
cacheExpiry: number;
|
|
8207
|
+
timeout: number;
|
|
8208
|
+
retryAttempts: number;
|
|
7845
8209
|
storeResponseHeaders: boolean;
|
|
7846
8210
|
allowSelfSigned: boolean;
|
|
7847
8211
|
abortOnError: boolean;
|
|
@@ -8010,6 +8374,15 @@ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number]
|
|
|
8010
8374
|
export interface IGenerativeAIUseCase {
|
|
8011
8375
|
useCase: TGenerativeAIUseCases;
|
|
8012
8376
|
}
|
|
8377
|
+
export interface INluEmbeddingCredentials {
|
|
8378
|
+
apiType: TGenerativeAIProviders;
|
|
8379
|
+
apiKey: string;
|
|
8380
|
+
apiModel: TGenerativeAIModels;
|
|
8381
|
+
apiCustomBaseUrl?: string;
|
|
8382
|
+
apiResourceName?: string;
|
|
8383
|
+
apiDeploymentName?: string;
|
|
8384
|
+
apiVersion?: string;
|
|
8385
|
+
}
|
|
8013
8386
|
export interface IVoiceGateway2VadParams {
|
|
8014
8387
|
enable?: boolean;
|
|
8015
8388
|
voiceMs?: number;
|
|
@@ -8032,6 +8405,7 @@ export interface IVoiceGateway2SynthesizerParams {
|
|
|
8032
8405
|
}
|
|
8033
8406
|
export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
|
|
8034
8407
|
export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
|
|
8408
|
+
export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
|
|
8035
8409
|
export interface IVoiceGateway2RecognizerParams {
|
|
8036
8410
|
vendor?: TVoiceGateway2STTVendor | "default" | "none";
|
|
8037
8411
|
language?: string;
|
|
@@ -8073,7 +8447,7 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
8073
8447
|
ibmOptions?: TVoiceGateway2IbmOptions;
|
|
8074
8448
|
nvidiaOptions?: TVoiceGateway2NvidiaOptions;
|
|
8075
8449
|
sonioxOptions?: TVoiceGateway2SonioxOptions;
|
|
8076
|
-
model?: TVoiceGateway2GoogleModel;
|
|
8450
|
+
model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
|
|
8077
8451
|
}
|
|
8078
8452
|
export declare type TVoiceGateway2NuanceOptions = {
|
|
8079
8453
|
clientId?: string;
|
|
@@ -8105,12 +8479,15 @@ export declare type TVoiceGateway2NuanceOptions = {
|
|
|
8105
8479
|
];
|
|
8106
8480
|
};
|
|
8107
8481
|
export declare type TVoiceGateway2DeepgramOptions = {
|
|
8482
|
+
deepgramSttUri?: string;
|
|
8483
|
+
deepgramSttUseTls?: boolean;
|
|
8108
8484
|
apiKey?: string;
|
|
8109
8485
|
tier?: string;
|
|
8110
8486
|
model?: string;
|
|
8111
8487
|
customModel?: string;
|
|
8112
8488
|
version?: string;
|
|
8113
8489
|
punctuate?: boolean;
|
|
8490
|
+
smartFormatting?: boolean;
|
|
8114
8491
|
profanityFilter?: boolean;
|
|
8115
8492
|
redact?: string;
|
|
8116
8493
|
diarize?: boolean;
|
|
@@ -8123,9 +8500,10 @@ export declare type TVoiceGateway2DeepgramOptions = {
|
|
|
8123
8500
|
replace?: string[];
|
|
8124
8501
|
keywords?: string[];
|
|
8125
8502
|
endpointing?: boolean | number;
|
|
8503
|
+
utteranceEndMs?: number;
|
|
8504
|
+
shortUtterance?: boolean;
|
|
8126
8505
|
vadTurnoff?: number;
|
|
8127
8506
|
tag?: string;
|
|
8128
|
-
smartFormatting?: boolean;
|
|
8129
8507
|
};
|
|
8130
8508
|
export declare type TVoiceGateway2NvidiaOptions = {
|
|
8131
8509
|
rivaUri?: string;
|
|
@@ -8332,107 +8710,6 @@ export interface ISendConfigUpdateParams extends INodeFunctionBaseParams {
|
|
|
8332
8710
|
}>;
|
|
8333
8711
|
};
|
|
8334
8712
|
}
|
|
8335
|
-
export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
|
|
8336
|
-
config: {
|
|
8337
|
-
lexiconId: string;
|
|
8338
|
-
keyphrase: string;
|
|
8339
|
-
slots: string[];
|
|
8340
|
-
synonyms: string[];
|
|
8341
|
-
};
|
|
8342
|
-
}
|
|
8343
|
-
export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
|
|
8344
|
-
config: {
|
|
8345
|
-
text: string;
|
|
8346
|
-
data: any;
|
|
8347
|
-
mode: string;
|
|
8348
|
-
contextKey: string;
|
|
8349
|
-
inputKey: string;
|
|
8350
|
-
parseIntents: boolean;
|
|
8351
|
-
parseSlots: boolean;
|
|
8352
|
-
parseSystemSlots: boolean;
|
|
8353
|
-
findType: boolean;
|
|
8354
|
-
processDefaultReply: boolean;
|
|
8355
|
-
};
|
|
8356
|
-
}
|
|
8357
|
-
export interface IExtractAnswerNodeParams extends INodeFunctionBaseParams {
|
|
8358
|
-
config: {
|
|
8359
|
-
text: string;
|
|
8360
|
-
question: string;
|
|
8361
|
-
storeLocation: "input" | "context";
|
|
8362
|
-
contextKey: string;
|
|
8363
|
-
inputKey: string;
|
|
8364
|
-
};
|
|
8365
|
-
}
|
|
8366
|
-
export interface IRegexSlotFillerConfig {
|
|
8367
|
-
regex: string;
|
|
8368
|
-
flags: string;
|
|
8369
|
-
slot: string;
|
|
8370
|
-
}
|
|
8371
|
-
export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
|
|
8372
|
-
config: IRegexSlotFillerConfig;
|
|
8373
|
-
}
|
|
8374
|
-
export interface IMatchPatternParams extends INodeFunctionBaseParams {
|
|
8375
|
-
config: {
|
|
8376
|
-
patterns: string[];
|
|
8377
|
-
patternGroupName: string;
|
|
8378
|
-
alternateInput: string;
|
|
8379
|
-
detailedCompoundSlots: boolean;
|
|
8380
|
-
createNewSlots: boolean;
|
|
8381
|
-
tagExistingSlots: boolean;
|
|
8382
|
-
useFullSystemslotText: boolean;
|
|
8383
|
-
};
|
|
8384
|
-
}
|
|
8385
|
-
export interface IFuzzySearchParams extends INodeFunctionBaseParams {
|
|
8386
|
-
config: {
|
|
8387
|
-
searchPattern: string;
|
|
8388
|
-
items: any;
|
|
8389
|
-
isCaseSensitive: boolean;
|
|
8390
|
-
includeScore: boolean;
|
|
8391
|
-
includeMatches: boolean;
|
|
8392
|
-
minMatchCharLength: number;
|
|
8393
|
-
shouldSort: boolean;
|
|
8394
|
-
findAllMatches: boolean;
|
|
8395
|
-
location: number;
|
|
8396
|
-
threshold: number;
|
|
8397
|
-
distance: number;
|
|
8398
|
-
ignoreLocation: boolean;
|
|
8399
|
-
storeLocation: string;
|
|
8400
|
-
inputKey: string;
|
|
8401
|
-
contextKey: string;
|
|
8402
|
-
};
|
|
8403
|
-
}
|
|
8404
|
-
export interface ILastConversationEntry {
|
|
8405
|
-
source: "user" | "bot";
|
|
8406
|
-
text: string;
|
|
8407
|
-
}
|
|
8408
|
-
export interface OpenAIChatMessage {
|
|
8409
|
-
role: "system" | "user" | "assistant";
|
|
8410
|
-
content: string;
|
|
8411
|
-
}
|
|
8412
|
-
export interface IGenerativeSlot {
|
|
8413
|
-
tag: string;
|
|
8414
|
-
description: string;
|
|
8415
|
-
value: string;
|
|
8416
|
-
optional?: boolean;
|
|
8417
|
-
validation?: {
|
|
8418
|
-
type: string;
|
|
8419
|
-
value: string;
|
|
8420
|
-
invalidReason: string;
|
|
8421
|
-
};
|
|
8422
|
-
invalid?: boolean;
|
|
8423
|
-
}
|
|
8424
|
-
export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
8425
|
-
config: {
|
|
8426
|
-
slotsConfig: IGenerativeSlot[];
|
|
8427
|
-
amountOfLastUserInputs: number;
|
|
8428
|
-
maxQuestions: number;
|
|
8429
|
-
temperature: number;
|
|
8430
|
-
storeLocation: string;
|
|
8431
|
-
contextKey: string;
|
|
8432
|
-
inputKey: string;
|
|
8433
|
-
timeout: number;
|
|
8434
|
-
};
|
|
8435
|
-
}
|
|
8436
8713
|
export declare type INodeAiEnhancedRephraseOutputMode = "none" | "userInputs" | "customInputs";
|
|
8437
8714
|
export interface INodeWithAiRephraseConfig {
|
|
8438
8715
|
generativeAI_rephraseOutputMode: INodeAiEnhancedRephraseOutputMode;
|
|
@@ -8614,6 +8891,13 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
|
8614
8891
|
additionalMappedSymbols: {
|
|
8615
8892
|
[key: string]: string;
|
|
8616
8893
|
};
|
|
8894
|
+
llmEntityExtractLLMProviderReferenceId: string;
|
|
8895
|
+
entityName: string;
|
|
8896
|
+
entityDescription: string;
|
|
8897
|
+
examples: JSON;
|
|
8898
|
+
llmEntityExtractDescription: string;
|
|
8899
|
+
llmentityTemperature: number;
|
|
8900
|
+
llmentityTimeout: number;
|
|
8617
8901
|
}
|
|
8618
8902
|
export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig {
|
|
8619
8903
|
type: "date";
|
|
@@ -8646,7 +8930,7 @@ export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig
|
|
|
8646
8930
|
}
|
|
8647
8931
|
export interface IActiveQuestion {
|
|
8648
8932
|
nodeId: string;
|
|
8649
|
-
type: "date" | "keyphrase" | "regex" | "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber";
|
|
8933
|
+
type: "date" | "keyphrase" | "regex" | "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber" | "llm_entity";
|
|
8650
8934
|
lastExecutedAt: number;
|
|
8651
8935
|
forgetQuestionThreshold: number;
|
|
8652
8936
|
repromptCount?: number;
|
|
@@ -8665,10 +8949,30 @@ export interface IQuestionNodeRegexConfig extends IQuestionNodeSharedConfig {
|
|
|
8665
8949
|
type: "regex";
|
|
8666
8950
|
regex: string;
|
|
8667
8951
|
}
|
|
8668
|
-
export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
|
|
8669
|
-
type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber";
|
|
8952
|
+
export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
|
|
8953
|
+
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
|
+
}
|
|
8955
|
+
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;
|
|
8973
|
+
};
|
|
8974
|
+
invalid?: boolean;
|
|
8670
8975
|
}
|
|
8671
|
-
export declare type TRephraseWithAIQuestionType = IActiveQuestion["type"] | IOptionalQuestionNodeOtherConfig["type"];
|
|
8672
8976
|
export declare type TCompletionPrompt = {
|
|
8673
8977
|
prompt: string;
|
|
8674
8978
|
};
|
|
@@ -8752,6 +9056,26 @@ export interface IRunGenerativeAIPromptOptions {
|
|
|
8752
9056
|
* A string denoting the reference ID of the chosen LLM provider
|
|
8753
9057
|
*/
|
|
8754
9058
|
llmProviderReferenceId?: string;
|
|
9059
|
+
/**
|
|
9060
|
+
* Response Format (can be json for some providers), text and default means none
|
|
9061
|
+
*/
|
|
9062
|
+
responseFormat?: "json_object" | "text" | "default";
|
|
9063
|
+
/**
|
|
9064
|
+
* Option to output detailed results, including finish_reason, etc
|
|
9065
|
+
*/
|
|
9066
|
+
detailedResults?: boolean;
|
|
9067
|
+
/**
|
|
9068
|
+
* Developers can now specify seed parameter in the OpenAI Chat Completion request to receive (mostly) consistent outputs
|
|
9069
|
+
*/
|
|
9070
|
+
seed?: number;
|
|
9071
|
+
/**
|
|
9072
|
+
* JSON object with options to pass to the LLM Model
|
|
9073
|
+
*/
|
|
9074
|
+
customModelOptions?: any;
|
|
9075
|
+
/**
|
|
9076
|
+
* JSON object with options to pass to the LLM Request
|
|
9077
|
+
*/
|
|
9078
|
+
customRequestOptions?: any;
|
|
8755
9079
|
}
|
|
8756
9080
|
export interface IOpenAiCredentials {
|
|
8757
9081
|
apiType?: TGenerativeAIProviders;
|
|
@@ -8864,7 +9188,6 @@ export interface IActions {
|
|
|
8864
9188
|
executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
|
|
8865
9189
|
executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
|
|
8866
9190
|
handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
|
|
8867
|
-
extractAnswer?: (extractAnswerParams: IExtractAnswerNodeParams) => Promise<void>;
|
|
8868
9191
|
getAnalyticsData?: () => IAnalyticsSourceData;
|
|
8869
9192
|
setAnalyticsData?: (key: string, value: any) => void;
|
|
8870
9193
|
getInjectedAnySlots?: () => {
|
|
@@ -8895,7 +9218,7 @@ export interface IActions {
|
|
|
8895
9218
|
rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
|
|
8896
9219
|
rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
|
|
8897
9220
|
requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], agentAssistInitMessage?: string, providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
|
|
8898
|
-
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<
|
|
9221
|
+
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<any>;
|
|
8899
9222
|
resetContext?: () => object;
|
|
8900
9223
|
resetFormBrain?: () => Promise<void>;
|
|
8901
9224
|
resetState?: () => Promise<string>;
|
|
@@ -8931,6 +9254,7 @@ export interface IActions {
|
|
|
8931
9254
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
8932
9255
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
8933
9256
|
getAgentAssistConfigId: () => string;
|
|
9257
|
+
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
8934
9258
|
}
|
|
8935
9259
|
export interface ICognigyNLPProperties {
|
|
8936
9260
|
/** The original text of the user */
|
|
@@ -9330,6 +9654,14 @@ export interface IMongoAggregateNodeParams extends INodeFunctionBaseParams {
|
|
|
9330
9654
|
stopOnError: boolean;
|
|
9331
9655
|
};
|
|
9332
9656
|
}
|
|
9657
|
+
export interface IRegexSlotFillerConfig {
|
|
9658
|
+
regex: string;
|
|
9659
|
+
flags: string;
|
|
9660
|
+
slot: string;
|
|
9661
|
+
}
|
|
9662
|
+
export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
|
|
9663
|
+
config: IRegexSlotFillerConfig;
|
|
9664
|
+
}
|
|
9333
9665
|
declare const ruleOperands: readonly [
|
|
9334
9666
|
"lt",
|
|
9335
9667
|
"lte",
|
|
@@ -9448,6 +9780,7 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
|
|
|
9448
9780
|
};
|
|
9449
9781
|
}
|
|
9450
9782
|
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal" | "getConversationTranscript"> {
|
|
9783
|
+
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
9451
9784
|
setNextNode: (nodeId: string, newFlowId?: string) => void;
|
|
9452
9785
|
resetNextNodes: () => void;
|
|
9453
9786
|
stopExecution: () => void;
|
|
@@ -9592,7 +9925,7 @@ export interface INodeFunctionBaseParams {
|
|
|
9592
9925
|
inputOptions?: INodeFunctionInputOptions;
|
|
9593
9926
|
}
|
|
9594
9927
|
export declare type TNodeChildConfigs = Pick<IChartExecutableNode, "id" | "type" | "config">;
|
|
9595
|
-
export declare type TNodeFunction = (params:
|
|
9928
|
+
export declare type TNodeFunction<T extends INodeFunctionBaseParams = any> = (params: T) => Promise<void>;
|
|
9596
9929
|
export declare type THttpRequestMethod = "get" | "GET" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK";
|
|
9597
9930
|
export interface IHttpRequestParams {
|
|
9598
9931
|
method: THttpRequestMethod;
|
|
@@ -9663,7 +9996,7 @@ declare const nodePreviewTypes: readonly [
|
|
|
9663
9996
|
"resource",
|
|
9664
9997
|
"image"
|
|
9665
9998
|
];
|
|
9666
|
-
export declare type TNodePreviewType = typeof nodePreviewTypes[number];
|
|
9999
|
+
export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
|
|
9667
10000
|
export interface INodePreview {
|
|
9668
10001
|
type: TNodePreviewType;
|
|
9669
10002
|
key: string;
|
|
@@ -9752,7 +10085,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
9752
10085
|
"typescript",
|
|
9753
10086
|
"xml"
|
|
9754
10087
|
];
|
|
9755
|
-
export declare type TNodeFieldType = typeof nodeFieldTypes[number];
|
|
10088
|
+
export declare type TNodeFieldType = (typeof nodeFieldTypes)[number];
|
|
9756
10089
|
export declare type TComparableValue = string | number | boolean;
|
|
9757
10090
|
export declare type TNodeFieldCondition = INodeFieldSingleCondition | INodeFieldANDCondition | INodeFieldORCondition;
|
|
9758
10091
|
export interface INodeFieldSingleCondition {
|
|
@@ -9827,10 +10160,10 @@ export interface INodeFieldAndSectionFormElement {
|
|
|
9827
10160
|
}
|
|
9828
10161
|
export declare type TCognigyNodeTagType = "basic" | "logic" | "message" | "analytics" | "service" | "nlu" | "data";
|
|
9829
10162
|
export declare type TNodeTagType = TCognigyNodeTagType | string;
|
|
9830
|
-
export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U extends string = string> {
|
|
10163
|
+
export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U extends string = string, FunctionParams extends INodeFunctionBaseParams = any> {
|
|
9831
10164
|
_id?: TMongoId;
|
|
9832
10165
|
type: U;
|
|
9833
|
-
parentType?: string;
|
|
10166
|
+
parentType?: string | null;
|
|
9834
10167
|
defaultLabel: string | INodeFieldTranslations;
|
|
9835
10168
|
summary?: string | INodeFieldTranslations;
|
|
9836
10169
|
appearance: INodeAppearance;
|
|
@@ -9838,7 +10171,7 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
9838
10171
|
constraints?: INodeConstraints;
|
|
9839
10172
|
dependencies?: INodeDependencies;
|
|
9840
10173
|
fields?: INodeFieldSet<T>;
|
|
9841
|
-
function?: TNodeFunction;
|
|
10174
|
+
function?: TNodeFunction<FunctionParams> | null;
|
|
9842
10175
|
/** Defines how the preview should be generated for nodes using this descriptor */
|
|
9843
10176
|
preview?: INodePreview;
|
|
9844
10177
|
/**
|
|
@@ -10154,7 +10487,39 @@ export interface IGraphPlaybook {
|
|
|
10154
10487
|
name: string;
|
|
10155
10488
|
properties: Pick<IPlaybook, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10156
10489
|
}
|
|
10157
|
-
export
|
|
10490
|
+
export interface IMilestone extends IEntityMeta {
|
|
10491
|
+
_id: TMongoId;
|
|
10492
|
+
name: string;
|
|
10493
|
+
version: number;
|
|
10494
|
+
steps: IMilestoneStep[];
|
|
10495
|
+
description: string;
|
|
10496
|
+
referenceId: string;
|
|
10497
|
+
projectReference: TMongoId;
|
|
10498
|
+
organisationReference: TMongoId;
|
|
10499
|
+
}
|
|
10500
|
+
export interface IMilestoneStep {
|
|
10501
|
+
_id?: string;
|
|
10502
|
+
name?: string;
|
|
10503
|
+
description?: string;
|
|
10504
|
+
order?: number;
|
|
10505
|
+
type?: "start" | "completion";
|
|
10506
|
+
metrics?: IMilestoneStepMetric[];
|
|
10507
|
+
}
|
|
10508
|
+
export interface IMilestoneStepMetric {
|
|
10509
|
+
_id?: string;
|
|
10510
|
+
name: string;
|
|
10511
|
+
description: string;
|
|
10512
|
+
type?: "currency" | "duration";
|
|
10513
|
+
value?: number;
|
|
10514
|
+
}
|
|
10515
|
+
export interface IGraphMilestone {
|
|
10516
|
+
type: "milestone";
|
|
10517
|
+
_id: TMongoId;
|
|
10518
|
+
referenceId: string;
|
|
10519
|
+
name: string;
|
|
10520
|
+
properties: Pick<IMilestone, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10521
|
+
}
|
|
10522
|
+
export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphMilestone;
|
|
10158
10523
|
export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
|
|
10159
10524
|
export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
|
|
10160
10525
|
/**
|
|
@@ -14321,6 +14686,70 @@ export interface IDatePickerNodeParams extends INodeFunctionBaseParams {
|
|
|
14321
14686
|
config: IDatePickerConfig;
|
|
14322
14687
|
}
|
|
14323
14688
|
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
|
+
}
|
|
14324
14753
|
export interface IContinuousASRParams extends INodeFunctionBaseParams {
|
|
14325
14754
|
config: {
|
|
14326
14755
|
asrEnabled: boolean;
|
|
@@ -14409,8 +14838,7 @@ export interface IVoiceConfigParams {
|
|
|
14409
14838
|
sttGoogleLang1: string;
|
|
14410
14839
|
sttGoogleLang2: string;
|
|
14411
14840
|
sttGoogleLang3: string;
|
|
14412
|
-
|
|
14413
|
-
sttDeepgramModel: string;
|
|
14841
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14414
14842
|
deepgramEndpointing: boolean;
|
|
14415
14843
|
deepgramEndpointingValue: number;
|
|
14416
14844
|
deepgramSmartFormatting: boolean;
|
|
@@ -14479,8 +14907,7 @@ export interface IVoiceConfigParams {
|
|
|
14479
14907
|
azureSttContextId: string;
|
|
14480
14908
|
azureEnableAudioLogging: boolean;
|
|
14481
14909
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14482
|
-
|
|
14483
|
-
sttDeepgramModel: string;
|
|
14910
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14484
14911
|
deepgramEndpointing: boolean;
|
|
14485
14912
|
deepgramEndpointingValue: number;
|
|
14486
14913
|
deepgramSmartFormatting: boolean;
|
|
@@ -14556,8 +14983,12 @@ export interface ISetRatingParams extends INodeFunctionBaseParams {
|
|
|
14556
14983
|
}
|
|
14557
14984
|
export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
|
|
14558
14985
|
config: {
|
|
14986
|
+
ratingScreenTitleText: string;
|
|
14559
14987
|
ratingTitleText: string;
|
|
14560
14988
|
ratingCommentText: string;
|
|
14989
|
+
ratingSubmitButtonText: string;
|
|
14990
|
+
ratingEventBannerText: string;
|
|
14991
|
+
ratingChatStatusMessage: string;
|
|
14561
14992
|
};
|
|
14562
14993
|
}
|
|
14563
14994
|
export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
|
|
@@ -14861,8 +15292,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
|
14861
15292
|
recognitionChannel: number;
|
|
14862
15293
|
sttLanguage: string;
|
|
14863
15294
|
sttVendor: string;
|
|
14864
|
-
|
|
14865
|
-
sttDeepgramModel: string;
|
|
15295
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14866
15296
|
sttDisablePunctuation: boolean;
|
|
14867
15297
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14868
15298
|
sttLabel: string;
|
|
@@ -14985,7 +15415,6 @@ export interface ICognigyBasicNodes {
|
|
|
14985
15415
|
say: ICreateChartNodeBasicNodesData<"say", ISayNodeParams, TBASIC_EXTENSION>;
|
|
14986
15416
|
addLexiconKeyphrase: ICreateChartNodeBasicNodesData<"addLexiconKeyphrase", IAddLexiconKeyphraseNodeParams, TBASIC_EXTENSION>;
|
|
14987
15417
|
executeCognigyNLU: ICreateChartNodeBasicNodesData<"executeCognigyNLU", IExecuteCognigyNLUNodeParams, TBASIC_EXTENSION>;
|
|
14988
|
-
extractAnswer: ICreateChartNodeBasicNodesData<"extractAnswer", IExtractAnswerNodeParams, TBASIC_EXTENSION>;
|
|
14989
15418
|
regexSlotFiller: ICreateChartNodeBasicNodesData<"regexSlotFiller", IRegexSlotFillerParams, TBASIC_EXTENSION>;
|
|
14990
15419
|
matchPattern: ICreateChartNodeBasicNodesData<"matchPattern", IMatchPatternParams, TBASIC_EXTENSION>;
|
|
14991
15420
|
fuzzySearch: ICreateChartNodeBasicNodesData<"fuzzySearch", IFuzzySearchParams, TBASIC_EXTENSION>;
|
|
@@ -15401,10 +15830,14 @@ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<I
|
|
|
15401
15830
|
export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
|
|
15402
15831
|
}
|
|
15403
15832
|
export interface IOpenAIMeta_2_0 {
|
|
15404
|
-
customModel
|
|
15833
|
+
customModel?: string;
|
|
15834
|
+
}
|
|
15835
|
+
export interface IAnthropicMeta_2_0 {
|
|
15836
|
+
customModel?: string;
|
|
15405
15837
|
}
|
|
15406
15838
|
export interface IAlephAlphaMeta_2_0 {
|
|
15407
|
-
customModel
|
|
15839
|
+
customModel?: string;
|
|
15840
|
+
baseCustomUrl?: string;
|
|
15408
15841
|
}
|
|
15409
15842
|
export interface IAzureOpenAIMeta_2_0 {
|
|
15410
15843
|
resourceName?: string;
|
|
@@ -15425,6 +15858,7 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15425
15858
|
* ILargeLanguageModelFields_2_0:
|
|
15426
15859
|
* allOf:
|
|
15427
15860
|
* - type: object
|
|
15861
|
+
* required: ['name', 'modelType', 'provider', 'connectionId']
|
|
15428
15862
|
* properties:
|
|
15429
15863
|
* name:
|
|
15430
15864
|
* type: string
|
|
@@ -15434,7 +15868,12 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15434
15868
|
* example: "LLM meaningful description"
|
|
15435
15869
|
* modelType:
|
|
15436
15870
|
* $ref: '#/components/schemas/TGenerativeAIModels'
|
|
15437
|
-
|
|
15871
|
+
* modelGroup:
|
|
15872
|
+
* $ref: '#/components/schemas/TModelGroups'
|
|
15873
|
+
* isCustomModel:
|
|
15874
|
+
* type: boolean
|
|
15875
|
+
* example: true
|
|
15876
|
+
* provider:
|
|
15438
15877
|
* $ref: '#/components/schemas/TGenerativeAIProviders'
|
|
15439
15878
|
* connectionId:
|
|
15440
15879
|
* type: string
|
|
@@ -15451,6 +15890,15 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15451
15890
|
* customModel:
|
|
15452
15891
|
* type: string
|
|
15453
15892
|
* example: gpt-4-32k-0613
|
|
15893
|
+
* description: The custom model name. This does not work with embedding models
|
|
15894
|
+
* anthropic:
|
|
15895
|
+
* type: object
|
|
15896
|
+
* description: Anthropic specific meta data
|
|
15897
|
+
* properties:
|
|
15898
|
+
* customModel:
|
|
15899
|
+
* type: string
|
|
15900
|
+
* example: claude-3-opus-20240229
|
|
15901
|
+
* description: The custom model name. This does not work with embedding models
|
|
15454
15902
|
* azureOpenAI:
|
|
15455
15903
|
* type: object
|
|
15456
15904
|
* description: Azure OpenAI specific meta data
|
|
@@ -15461,6 +15909,33 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15461
15909
|
* type: string
|
|
15462
15910
|
* apiVersion:
|
|
15463
15911
|
* type: string
|
|
15912
|
+
* baseCustomUrl:
|
|
15913
|
+
* type: string
|
|
15914
|
+
* example:
|
|
15915
|
+
* - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
|
|
15916
|
+
* - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
|
|
15917
|
+
* - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
|
|
15918
|
+
* googleVertexAI:
|
|
15919
|
+
* type: object
|
|
15920
|
+
* description: Google VertexAI specific meta data
|
|
15921
|
+
* properties:
|
|
15922
|
+
* location:
|
|
15923
|
+
* type: string
|
|
15924
|
+
* apiEndpoint:
|
|
15925
|
+
* type: string
|
|
15926
|
+
* publisher:
|
|
15927
|
+
* type: string
|
|
15928
|
+
* alephAlpha:
|
|
15929
|
+
* type: object
|
|
15930
|
+
* description: Aleph Alpha specific meta data
|
|
15931
|
+
* properties:
|
|
15932
|
+
* customModel:
|
|
15933
|
+
* type: string
|
|
15934
|
+
* example: luminous-003
|
|
15935
|
+
* description: The custom model name. This does not work with embedding models
|
|
15936
|
+
* baseCustomUrl:
|
|
15937
|
+
* type: string
|
|
15938
|
+
* example: https://api.aleph-alpha.com
|
|
15464
15939
|
*
|
|
15465
15940
|
* ILargeLanguageModelCreate_2_0:
|
|
15466
15941
|
* allOf:
|
|
@@ -15487,6 +15962,9 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15487
15962
|
name: string;
|
|
15488
15963
|
description: string;
|
|
15489
15964
|
modelType: TGenerativeAIModels;
|
|
15965
|
+
/** model type e.g. chat */
|
|
15966
|
+
modelGroup?: TModelGroups;
|
|
15967
|
+
isCustomModel?: boolean;
|
|
15490
15968
|
provider: TGenerativeAIProviders;
|
|
15491
15969
|
connectionId: string;
|
|
15492
15970
|
isDefault: boolean;
|
|
@@ -15502,6 +15980,8 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15502
15980
|
alephAlpha?: IAlephAlphaMeta_2_0;
|
|
15503
15981
|
/** Meta data for the GoogleVertexAI connection */
|
|
15504
15982
|
googleVertexAI?: IGoogleVertexAIMeta_2_0;
|
|
15983
|
+
/** Meta data for the Anthropic connection */
|
|
15984
|
+
anthropic?: IAnthropicMeta_2_0;
|
|
15505
15985
|
}
|
|
15506
15986
|
export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
|
|
15507
15987
|
}
|
|
@@ -15676,6 +16156,7 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15676
16156
|
url?: string;
|
|
15677
16157
|
failReason?: string;
|
|
15678
16158
|
tags?: string[];
|
|
16159
|
+
extractedChunks?: number;
|
|
15679
16160
|
}
|
|
15680
16161
|
/**
|
|
15681
16162
|
* @openapi
|
|
@@ -15951,8 +16432,173 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
|
|
|
15951
16432
|
}
|
|
15952
16433
|
export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
|
|
15953
16434
|
}
|
|
16435
|
+
/**
|
|
16436
|
+
* @openapi
|
|
16437
|
+
*
|
|
16438
|
+
* components:
|
|
16439
|
+
* schemas:
|
|
16440
|
+
* IMilestoneIndexItem_2_0:
|
|
16441
|
+
* allOf:
|
|
16442
|
+
* - type: object
|
|
16443
|
+
* properties:
|
|
16444
|
+
* name:
|
|
16445
|
+
* type: string
|
|
16446
|
+
* description: The name of the milestone
|
|
16447
|
+
* example: New Milestone
|
|
16448
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
16449
|
+
*/
|
|
16450
|
+
export interface IMilestoneIndexItem_2_0 {
|
|
16451
|
+
_id: TMongoId;
|
|
16452
|
+
name: string;
|
|
16453
|
+
createdAt: number;
|
|
16454
|
+
lastChanged: number;
|
|
16455
|
+
createdBy: TMongoId;
|
|
16456
|
+
lastChangedBy: TMongoId;
|
|
16457
|
+
}
|
|
16458
|
+
export interface IIndexMilestonesRestData_2_0 extends IRestPagination<IMilestoneIndexItem_2_0>, Partial<IProjectScope> {
|
|
16459
|
+
}
|
|
16460
|
+
export interface IIndexMilestonesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IMilestoneIndexItem_2_0> {
|
|
16461
|
+
}
|
|
16462
|
+
/**
|
|
16463
|
+
* @openapi
|
|
16464
|
+
*
|
|
16465
|
+
* components:
|
|
16466
|
+
* schemas:
|
|
16467
|
+
* IMilestoneStepMetric_2_0:
|
|
16468
|
+
* type: object
|
|
16469
|
+
* properties:
|
|
16470
|
+
* name:
|
|
16471
|
+
* type: string
|
|
16472
|
+
* description: The name of the metric
|
|
16473
|
+
* example: Duration
|
|
16474
|
+
* description:
|
|
16475
|
+
* type: string
|
|
16476
|
+
* description: The description of the metric
|
|
16477
|
+
* example: Time taken to complete the step
|
|
16478
|
+
* type:
|
|
16479
|
+
* type: string
|
|
16480
|
+
* description: Metric type
|
|
16481
|
+
* example: "duration"
|
|
16482
|
+
* value:
|
|
16483
|
+
* type: number
|
|
16484
|
+
* description: Metric value
|
|
16485
|
+
* example: 30
|
|
16486
|
+
*/
|
|
16487
|
+
export interface IMilestoneStepMetric_2_0 {
|
|
16488
|
+
name: string;
|
|
16489
|
+
description: string;
|
|
16490
|
+
type?: "currency" | "duration";
|
|
16491
|
+
value?: number;
|
|
16492
|
+
}
|
|
16493
|
+
/**
|
|
16494
|
+
* @openapi
|
|
16495
|
+
* components:
|
|
16496
|
+
* schemas:
|
|
16497
|
+
* IMilestoneStep_2_0:
|
|
16498
|
+
* type: object
|
|
16499
|
+
* properties:
|
|
16500
|
+
* name:
|
|
16501
|
+
* type: string
|
|
16502
|
+
* description: The name of the milestone step
|
|
16503
|
+
* example: Step 1
|
|
16504
|
+
* description:
|
|
16505
|
+
* type: string
|
|
16506
|
+
* description: The description of the milestone step
|
|
16507
|
+
* example: This is the first step
|
|
16508
|
+
* order:
|
|
16509
|
+
* type: number
|
|
16510
|
+
* description: Step order in the milestone configuration
|
|
16511
|
+
* example: 1
|
|
16512
|
+
* type:
|
|
16513
|
+
* type: string
|
|
16514
|
+
* description: Step type
|
|
16515
|
+
* example: "start"
|
|
16516
|
+
* metrics:
|
|
16517
|
+
* type: array
|
|
16518
|
+
* items:
|
|
16519
|
+
* $ref: '#/components/schemas/IMilestoneStepMetric_2_0'
|
|
16520
|
+
*/
|
|
16521
|
+
export interface IMilestoneStep_2_0 {
|
|
16522
|
+
name?: string;
|
|
16523
|
+
description?: string;
|
|
16524
|
+
order?: number;
|
|
16525
|
+
type?: "start" | "completion";
|
|
16526
|
+
metrics?: IMilestoneStepMetric_2_0[];
|
|
16527
|
+
}
|
|
16528
|
+
/**
|
|
16529
|
+
* @openapi
|
|
16530
|
+
*
|
|
16531
|
+
* components:
|
|
16532
|
+
* schemas:
|
|
16533
|
+
* IMilestoneData_2_0:
|
|
16534
|
+
* type: object
|
|
16535
|
+
* properties:
|
|
16536
|
+
* name:
|
|
16537
|
+
* type: string
|
|
16538
|
+
* description: The name of the Milestone
|
|
16539
|
+
* example: New Milestone
|
|
16540
|
+
* version:
|
|
16541
|
+
* type: number
|
|
16542
|
+
* description: Current version of the milestone.
|
|
16543
|
+
* example: 1
|
|
16544
|
+
* description:
|
|
16545
|
+
* type: string
|
|
16546
|
+
* description: The description of the milestone
|
|
16547
|
+
* example: "This is a sample milestone"
|
|
16548
|
+
* steps:
|
|
16549
|
+
* type: array
|
|
16550
|
+
* items:
|
|
16551
|
+
* $ref: '#/components/schemas/IMilestoneStep_2_0'
|
|
16552
|
+
*
|
|
16553
|
+
* IMilestone_2_0:
|
|
16554
|
+
* allOf:
|
|
16555
|
+
* - $ref: '#/components/schemas/IMilestoneData_2_0'
|
|
16556
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
16557
|
+
*
|
|
16558
|
+
*/
|
|
16559
|
+
export interface IMilestone_2_0 {
|
|
16560
|
+
_id: TMongoId;
|
|
16561
|
+
name: string;
|
|
16562
|
+
version: number;
|
|
16563
|
+
createdAt: number;
|
|
16564
|
+
lastChanged: number;
|
|
16565
|
+
createdBy: TMongoId;
|
|
16566
|
+
lastChangedBy: TMongoId;
|
|
16567
|
+
description: string;
|
|
16568
|
+
steps: IMilestoneStep_2_0[];
|
|
16569
|
+
}
|
|
16570
|
+
export interface ICreateMilestoneRestDataBody_2_0 extends IProjectScope, Partial<Omit<IMilestone_2_0, keyof IEntityMeta>> {
|
|
16571
|
+
}
|
|
16572
|
+
export interface ICreateMilestoneRestData_2_0 extends ICreateMilestoneRestDataBody_2_0 {
|
|
16573
|
+
}
|
|
16574
|
+
export interface ICreateMilestoneRestReturnValue_2_0 extends IMilestone_2_0 {
|
|
16575
|
+
}
|
|
16576
|
+
export interface IReadMilestoneRestDataParams_2_0 {
|
|
16577
|
+
milestoneId: string;
|
|
16578
|
+
}
|
|
16579
|
+
export interface IReadMilestoneRestData_2_0 extends IReadMilestoneRestDataParams_2_0 {
|
|
16580
|
+
}
|
|
16581
|
+
export interface IReadMilestoneRestReturnValue_2_0 extends IMilestone_2_0 {
|
|
16582
|
+
}
|
|
16583
|
+
export interface IUpdateMilestoneRestDataParams_2_0 {
|
|
16584
|
+
milestoneId: string;
|
|
16585
|
+
}
|
|
16586
|
+
export interface IUpdateMilestoneRestDataBody_2_0 extends Partial<Omit<IMilestone_2_0, keyof IEntityMeta>> {
|
|
16587
|
+
}
|
|
16588
|
+
export interface IUpdateMilestoneRestData_2_0 extends IUpdateMilestoneRestDataBody_2_0, IUpdateMilestoneRestDataParams_2_0 {
|
|
16589
|
+
}
|
|
16590
|
+
export interface IUpdateMilestoneRestReturnValue_2_0 {
|
|
16591
|
+
}
|
|
16592
|
+
export interface IDeleteMilestoneRestDataParams_2_0 {
|
|
16593
|
+
milestoneId: string;
|
|
16594
|
+
}
|
|
16595
|
+
export interface IDeleteMilestoneRestData_2_0 extends IDeleteMilestoneRestDataParams_2_0 {
|
|
16596
|
+
}
|
|
16597
|
+
export interface IDeleteMilestoneRestReturnValue_2_0 {
|
|
16598
|
+
}
|
|
15954
16599
|
declare const uploadResumableTypes: readonly [
|
|
15955
|
-
"snapshots"
|
|
16600
|
+
"snapshots",
|
|
16601
|
+
"packages"
|
|
15956
16602
|
];
|
|
15957
16603
|
export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
|
|
15958
16604
|
export interface HttpRequest {
|
|
@@ -15987,6 +16633,7 @@ export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBo
|
|
|
15987
16633
|
export interface IUploadResumableRestReturnValue_2_0 {
|
|
15988
16634
|
fileName: string;
|
|
15989
16635
|
url: string;
|
|
16636
|
+
uploadId: string;
|
|
15990
16637
|
}
|
|
15991
16638
|
export interface ResourcesAPIGroup_2_0 {
|
|
15992
16639
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
@@ -16054,6 +16701,11 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16054
16701
|
readEndpoint: TRestAPIOperation<IReadEndpointRestData_2_0, IReadEndpointRestReturnValue_2_0>;
|
|
16055
16702
|
updateEndpoint: TRestAPIOperation<IUpdateEndpointRestData_2_0, IUpdateEndpointRestReturnValue_2_0>;
|
|
16056
16703
|
deleteEndpoint: TRestAPIOperation<IDeleteEndpointRestData_2_0, IDeleteEndpointRestReturnValue_2_0>;
|
|
16704
|
+
indexMilestones: TRestAPIOperation<TRestAPIOptionalParameter<IIndexMilestonesRestData_2_0>, IIndexMilestonesRestReturnValue_2_0>;
|
|
16705
|
+
createMilestone: TRestAPIOperation<ICreateMilestoneRestData_2_0, ICreateMilestoneRestReturnValue_2_0>;
|
|
16706
|
+
readMilestone: TRestAPIOperation<IReadMilestoneRestData_2_0, IReadMilestoneRestReturnValue_2_0>;
|
|
16707
|
+
updateMilestone: TRestAPIOperation<IUpdateMilestoneRestData_2_0, IUpdateMilestoneRestReturnValue_2_0>;
|
|
16708
|
+
deleteMilestone: TRestAPIOperation<IDeleteMilestoneRestData_2_0, IDeleteMilestoneRestReturnValue_2_0>;
|
|
16057
16709
|
indexPlaybooks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexPlaybooksRestData_2_0>, IIndexPlaybooksRestReturnValue_2_0>;
|
|
16058
16710
|
batchPlaybooks: TRestAPIOperation<IBatchPlaybooksRestData_2_0, IBatchPlaybooksRestReturnValue_2_0>;
|
|
16059
16711
|
createPlaybook: TRestAPIOperation<ICreatePlaybookRestData_2_0, ICreatePlaybookRestReturnValue_2_0>;
|
|
@@ -17951,6 +18603,7 @@ declare const actionTypes: readonly [
|
|
|
17951
18603
|
"cancelTask",
|
|
17952
18604
|
"changePlaybookStepOrder",
|
|
17953
18605
|
"cloneFlow",
|
|
18606
|
+
"cloneMilestone",
|
|
17954
18607
|
"cloneLargeLanguageModel",
|
|
17955
18608
|
"configureIdentityProvider",
|
|
17956
18609
|
"createKnowledgeSearchIndex",
|
|
@@ -18065,14 +18718,14 @@ export declare type TActionType = typeof actionTypes[number];
|
|
|
18065
18718
|
*/
|
|
18066
18719
|
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";
|
|
18067
18720
|
/**
|
|
18068
|
-
* @openapi
|
|
18069
|
-
* components:
|
|
18070
|
-
* schemas:
|
|
18071
|
-
* TAuditEventChainElementType:
|
|
18072
|
-
* allOf:
|
|
18073
|
-
* - $ref: '#/components/schemas/TResourceType'
|
|
18074
|
-
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
18075
|
-
*/
|
|
18721
|
+
* @openapi
|
|
18722
|
+
* components:
|
|
18723
|
+
* schemas:
|
|
18724
|
+
* TAuditEventChainElementType:
|
|
18725
|
+
* allOf:
|
|
18726
|
+
* - $ref: '#/components/schemas/TResourceType'
|
|
18727
|
+
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
18728
|
+
*/
|
|
18076
18729
|
export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional;
|
|
18077
18730
|
/***
|
|
18078
18731
|
* @openapi
|
|
@@ -18097,16 +18750,16 @@ export interface IAuditEventData {
|
|
|
18097
18750
|
type: TAuditEventType;
|
|
18098
18751
|
actionType?: TActionType;
|
|
18099
18752
|
/**
|
|
18100
|
-
|
|
18101
|
-
|
|
18102
|
-
|
|
18103
|
-
|
|
18104
|
-
|
|
18105
|
-
|
|
18106
|
-
|
|
18107
|
-
|
|
18108
|
-
|
|
18109
|
-
|
|
18753
|
+
* Some resources contain sub-resource (and they might have sub-sub-resources)
|
|
18754
|
+
* on which operations get executed. We actually want to track the whole path
|
|
18755
|
+
* in order to understand which resource was modified. Let me give you an example:
|
|
18756
|
+
*
|
|
18757
|
+
* 'A user modified an example sentence within an intent within some flow' - so
|
|
18758
|
+
* in this case we have to track:
|
|
18759
|
+
* - "flow"
|
|
18760
|
+
* - "intent"
|
|
18761
|
+
* - "exampleSentence"
|
|
18762
|
+
*/
|
|
18110
18763
|
chain: IAuditEventModificationChainElement[];
|
|
18111
18764
|
projectId?: TMongoId;
|
|
18112
18765
|
}
|