@cognigy/rest-api-client 0.16.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 +12 -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 +345 -152
- 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/setAgentAssistGrid.js +31 -16
- package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +40 -2
- package/build/shared/charts/descriptors/allFields.js +6 -0
- 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/logic/goTo.js +3 -3
- 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 +27 -7
- 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 +35 -25
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +15 -11
- package/build/shared/charts/descriptors/voice/nodes/play.js +8 -1
- package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +51 -75
- package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +0 -1
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +38 -71
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +17 -25
- package/build/shared/charts/helpers/generativeAI/generativeAIPrompts.js +55 -0
- package/build/shared/helper/BaseContext.js +31 -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 +33 -2
- package/build/shared/interfaces/handover.js +2 -1
- package/build/shared/interfaces/messageAPI/endpoints.js +17 -2
- package/build/shared/interfaces/messageAPI/handover.js +9 -5
- 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 +85 -75
- package/build/shared/interfaces/resources/TResourceType.js +12 -5
- package/build/shared/interfaces/resources/TSocketChannelType.js +5 -1
- package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/ICallCounterAggregatedValue_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/IGetCallCounterOrganisationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/IGetCallCounterRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/index.js +3 -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/ICallCounterAggregatedValue.js +3 -0
- package/build/shared/interfaces/security/IPermission.js +5 -2
- package/build/shared/interfaces/security/IRole.js +6 -0
- package/build/shared/interfaces/security/index.js +2 -1
- package/build/shared/interfaces/trainer/ITrainerRecord.js +2 -0
- package/package.json +2 -2
- package/types/index.d.ts +1053 -169
- package/build/shared/charts/descriptors/nlu/extractAnswer.js +0 -115
package/types/index.d.ts
CHANGED
|
@@ -414,6 +414,7 @@ export interface IGetAuthorizationCodeParameters {
|
|
|
414
414
|
declare const organisationWidePermissions: readonly [
|
|
415
415
|
"analyticsOdata",
|
|
416
416
|
"apiKeys",
|
|
417
|
+
"assignProject",
|
|
417
418
|
"liveAgentAccount",
|
|
418
419
|
"projects",
|
|
419
420
|
"userDetails",
|
|
@@ -445,6 +446,7 @@ declare const projectWidePermissions: readonly [
|
|
|
445
446
|
"logs",
|
|
446
447
|
"memberDetails",
|
|
447
448
|
"members",
|
|
449
|
+
"milestones",
|
|
448
450
|
"nluConnectors",
|
|
449
451
|
"packages",
|
|
450
452
|
"playbooks",
|
|
@@ -914,11 +916,14 @@ declare const organisationWideRoles: readonly [
|
|
|
914
916
|
"admin",
|
|
915
917
|
"apiKeys",
|
|
916
918
|
"base_role",
|
|
919
|
+
"basicSupportUser",
|
|
920
|
+
"fullSupportUser",
|
|
917
921
|
"liveAgentAdmin",
|
|
918
922
|
"liveAgentAgent",
|
|
919
923
|
"liveAgentSupervisor",
|
|
920
924
|
"livechat",
|
|
921
925
|
"odata",
|
|
926
|
+
"projectAssigner",
|
|
922
927
|
"projectManager",
|
|
923
928
|
"userManager",
|
|
924
929
|
"userDetailsViewer",
|
|
@@ -1046,6 +1051,8 @@ export interface ICrudPermissions {
|
|
|
1046
1051
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1047
1052
|
* members:
|
|
1048
1053
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1054
|
+
* milestones:
|
|
1055
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1049
1056
|
* nluConnectors:
|
|
1050
1057
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1051
1058
|
* playbooks:
|
|
@@ -1129,6 +1136,8 @@ export interface IOrganisationWideAcl {
|
|
|
1129
1136
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1130
1137
|
* members:
|
|
1131
1138
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1139
|
+
* milestones:
|
|
1140
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1132
1141
|
* nluConnectors:
|
|
1133
1142
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1134
1143
|
* playbooks:
|
|
@@ -1567,6 +1576,7 @@ declare const arrayTResourceType: readonly [
|
|
|
1567
1576
|
"lexiconKeyphrase",
|
|
1568
1577
|
"lexiconSlot",
|
|
1569
1578
|
"locale",
|
|
1579
|
+
"milestone",
|
|
1570
1580
|
"nluconnector",
|
|
1571
1581
|
"nodeData",
|
|
1572
1582
|
"nodeDescriptorSet",
|
|
@@ -1577,11 +1587,11 @@ declare const arrayTResourceType: readonly [
|
|
|
1577
1587
|
"snapshot",
|
|
1578
1588
|
"snippet"
|
|
1579
1589
|
];
|
|
1580
|
-
export declare type TResourceType = typeof arrayTResourceType[number];
|
|
1590
|
+
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
1581
1591
|
declare const arrayTChartableResourceType: readonly [
|
|
1582
1592
|
"flow"
|
|
1583
1593
|
];
|
|
1584
|
-
export declare type TChartableResourceType = typeof arrayTChartableResourceType[number];
|
|
1594
|
+
export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
|
|
1585
1595
|
declare const searchableResourceTypes: readonly [
|
|
1586
1596
|
"endpoint",
|
|
1587
1597
|
"extension",
|
|
@@ -1589,12 +1599,13 @@ declare const searchableResourceTypes: readonly [
|
|
|
1589
1599
|
"function",
|
|
1590
1600
|
"largeLanguageModel",
|
|
1591
1601
|
"lexicon",
|
|
1602
|
+
"milestone",
|
|
1592
1603
|
"nluconnector",
|
|
1593
1604
|
"playbook",
|
|
1594
1605
|
"project",
|
|
1595
1606
|
"snapshot"
|
|
1596
1607
|
];
|
|
1597
|
-
export declare type TSearchableResourceType = typeof searchableResourceTypes[number];
|
|
1608
|
+
export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
|
|
1598
1609
|
declare const arrayNLUConnectorType: readonly [
|
|
1599
1610
|
"alexa",
|
|
1600
1611
|
"dialogflow",
|
|
@@ -1844,7 +1855,8 @@ declare const socketChannelTypes: readonly [
|
|
|
1844
1855
|
"admin-webchat",
|
|
1845
1856
|
"socket",
|
|
1846
1857
|
"voiceGateway2",
|
|
1847
|
-
"liveAgentAssist"
|
|
1858
|
+
"liveAgentAssist",
|
|
1859
|
+
"webchat3"
|
|
1848
1860
|
];
|
|
1849
1861
|
export declare type TSocketChannelType = typeof socketChannelTypes[number];
|
|
1850
1862
|
export interface IBaseTransformerFunction {
|
|
@@ -2382,6 +2394,7 @@ export interface IGraphEndpointDependency {
|
|
|
2382
2394
|
* - genesysBotConnector
|
|
2383
2395
|
* - niceCXOne
|
|
2384
2396
|
* - agentAssistVoice
|
|
2397
|
+
* - webchat3
|
|
2385
2398
|
*/
|
|
2386
2399
|
export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
|
|
2387
2400
|
declare const endpointTypes: readonly [
|
|
@@ -2415,7 +2428,8 @@ declare const endpointTypes: readonly [
|
|
|
2415
2428
|
"bandwidth",
|
|
2416
2429
|
"genesysBotConnector",
|
|
2417
2430
|
"niceCXOne",
|
|
2418
|
-
"agentAssistVoice"
|
|
2431
|
+
"agentAssistVoice",
|
|
2432
|
+
"webchat3"
|
|
2419
2433
|
];
|
|
2420
2434
|
export declare type TEndpointType = typeof endpointTypes[number];
|
|
2421
2435
|
declare const transferTypes: readonly [
|
|
@@ -2470,11 +2484,12 @@ export interface ICallEventFailoverSettings {
|
|
|
2470
2484
|
dialTranscribeRecognitionChannel?: number;
|
|
2471
2485
|
dialTranscribeRecognitionGoogleModel?: string;
|
|
2472
2486
|
dialTranscribeLabel?: string;
|
|
2473
|
-
dialTranscribeDeepgramTier?: string;
|
|
2474
2487
|
dialTranscribeDeepgramModel?: string;
|
|
2488
|
+
referredBy?: string;
|
|
2475
2489
|
deepgramSmartFormatting?: boolean;
|
|
2476
2490
|
deepgramEndpointing?: boolean;
|
|
2477
2491
|
deepgramEndpointingValue?: number;
|
|
2492
|
+
dialTranscribeDeepgramTier?: string;
|
|
2478
2493
|
}
|
|
2479
2494
|
export interface ICallEvents {
|
|
2480
2495
|
amd?: ICallEventSettings;
|
|
@@ -2492,11 +2507,21 @@ export interface ICallEvents {
|
|
|
2492
2507
|
userBusy?: ICallEventSettings;
|
|
2493
2508
|
noAnswer?: ICallEventSettings;
|
|
2494
2509
|
}
|
|
2510
|
+
export interface IVGProsodySettings {
|
|
2511
|
+
outputSpeed?: number;
|
|
2512
|
+
outputPitch?: number;
|
|
2513
|
+
outputVolume?: number;
|
|
2514
|
+
}
|
|
2515
|
+
export interface IVGGenericSettings {
|
|
2516
|
+
prosodySettings?: IVGProsodySettings;
|
|
2517
|
+
showBestTranscriptOnly?: boolean;
|
|
2518
|
+
}
|
|
2495
2519
|
export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
|
|
2496
2520
|
callEvents: ICallEvents;
|
|
2497
2521
|
failover?: ICallEventFailoverSettings;
|
|
2522
|
+
genericSettings?: IVGGenericSettings;
|
|
2498
2523
|
}
|
|
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 | {};
|
|
2524
|
+
export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
|
|
2500
2525
|
export declare type TAvayaVoice = "man" | "woman" | string;
|
|
2501
2526
|
declare const avayaSttTtsLanguages: readonly [
|
|
2502
2527
|
"cy-GB",
|
|
@@ -3076,6 +3101,527 @@ export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSetting
|
|
|
3076
3101
|
title: string;
|
|
3077
3102
|
};
|
|
3078
3103
|
}
|
|
3104
|
+
export interface IWebchat3EndpointLayoutSettings {
|
|
3105
|
+
/**
|
|
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
|
|
3121
|
+
*/
|
|
3122
|
+
botAvatarName: string;
|
|
3123
|
+
/**
|
|
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
|
|
3182
|
+
*/
|
|
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 {
|
|
3254
|
+
/**
|
|
3255
|
+
* The start behavior of the
|
|
3256
|
+
* webchat, e.g. whether a start button
|
|
3257
|
+
* should be rendered.
|
|
3258
|
+
*/
|
|
3259
|
+
startBehavior: TWebchat2StartBehavior;
|
|
3260
|
+
/**
|
|
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
|
|
3285
|
+
*/
|
|
3286
|
+
startTime: string;
|
|
3287
|
+
/**
|
|
3288
|
+
* End time of the business hours, e.g. 17:00
|
|
3289
|
+
*/
|
|
3290
|
+
endTime: string;
|
|
3291
|
+
/**
|
|
3292
|
+
* Week day of the business hours in lower case, e.g. "monday"
|
|
3293
|
+
*/
|
|
3294
|
+
weekDay: string;
|
|
3295
|
+
}
|
|
3296
|
+
export interface IWebchat3EndpointBusinessHoursSettings {
|
|
3297
|
+
/**
|
|
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
|
|
3514
|
+
*/
|
|
3515
|
+
enabled: boolean;
|
|
3516
|
+
/**
|
|
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
|
|
3521
|
+
*/
|
|
3522
|
+
mode: TWebchat3Mode;
|
|
3523
|
+
/**
|
|
3524
|
+
* The text that is displayed in the mouse over text of the bubble or the maintenance mode message
|
|
3525
|
+
*/
|
|
3526
|
+
text: string;
|
|
3527
|
+
/**
|
|
3528
|
+
* The title that is displayed to the user in the information when opening the bot during maintenance
|
|
3529
|
+
*/
|
|
3530
|
+
title: string;
|
|
3531
|
+
}
|
|
3532
|
+
export interface IWebchat3EndpointDemoWebchatSettings {
|
|
3533
|
+
/**
|
|
3534
|
+
* Whether the Demo Webchat is enabled
|
|
3535
|
+
*/
|
|
3536
|
+
enabled: boolean;
|
|
3537
|
+
/**
|
|
3538
|
+
* Background image url of the Demo Webchat
|
|
3539
|
+
*/
|
|
3540
|
+
backgroundImageUrl: string;
|
|
3541
|
+
/**
|
|
3542
|
+
* Position of the Demo Webchat
|
|
3543
|
+
*/
|
|
3544
|
+
position: TWebchat3DemoWebchatPosition;
|
|
3545
|
+
/**
|
|
3546
|
+
* Whether the Demo Webchat is draggable
|
|
3547
|
+
|
|
3548
|
+
*/
|
|
3549
|
+
shouldOverwriteWebchatBundleUrl: boolean;
|
|
3550
|
+
/**
|
|
3551
|
+
* The webchat bundle URL for demo webchat
|
|
3552
|
+
*/
|
|
3553
|
+
webchatBundleUrl: string;
|
|
3554
|
+
}
|
|
3555
|
+
export interface IWebchat3EndpointSettings {
|
|
3556
|
+
/**
|
|
3557
|
+
* control the layout of the Webchat Widget
|
|
3558
|
+
*/
|
|
3559
|
+
layout: IWebchat3EndpointLayoutSettings;
|
|
3560
|
+
/**
|
|
3561
|
+
* control the colors of the Webchat Widget
|
|
3562
|
+
*/
|
|
3563
|
+
colors: IWebchat3EndpointColorsSettings;
|
|
3564
|
+
/**
|
|
3565
|
+
* control the behavior of the Webchat Widget
|
|
3566
|
+
*/
|
|
3567
|
+
behavior: IWebchat3EndpointBehaviorSettings;
|
|
3568
|
+
/**
|
|
3569
|
+
* control the start behavior of the Webchat Widget
|
|
3570
|
+
*/
|
|
3571
|
+
startBehavior: IWebchat3EndpointStartBehaviorSettings;
|
|
3572
|
+
/**
|
|
3573
|
+
* Settings to store attachments at a cloud provider
|
|
3574
|
+
*/
|
|
3575
|
+
fileStorageSettings?: IFileStorageSettings;
|
|
3576
|
+
/**
|
|
3577
|
+
* Office Hours configuration for the Webchat Widget
|
|
3578
|
+
*/
|
|
3579
|
+
businessHours: IWebchat3EndpointBusinessHoursSettings;
|
|
3580
|
+
/**
|
|
3581
|
+
* Control the unread messages of the Webchat Widget
|
|
3582
|
+
*/
|
|
3583
|
+
unreadMessages: IWebchat3EndpointUnreadMessagesSettings;
|
|
3584
|
+
/**
|
|
3585
|
+
* Control the home screen of the Webchat Widget
|
|
3586
|
+
*/
|
|
3587
|
+
homeScreen: IWebchat3EndpointHomeScreenSettings;
|
|
3588
|
+
/**
|
|
3589
|
+
* Control the teaser message of the Webchat Widget
|
|
3590
|
+
*/
|
|
3591
|
+
teaserMessage: IWebchat3EndpointTeaserMessageSettings;
|
|
3592
|
+
/**
|
|
3593
|
+
* Control the conversation starters of the Webchat Widget
|
|
3594
|
+
*/
|
|
3595
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3596
|
+
/**
|
|
3597
|
+
* Control the chat options of the Webchat Widget
|
|
3598
|
+
*/
|
|
3599
|
+
chatOptions: IWebchat3EndpointChatOptionsSettings;
|
|
3600
|
+
/**
|
|
3601
|
+
* Control the privacy notice of the Webchat Widget
|
|
3602
|
+
*/
|
|
3603
|
+
privacyNotice: IWebchat3EndpointPrivacyNoticeSettings;
|
|
3604
|
+
/**
|
|
3605
|
+
* Webchat Widget custom settings
|
|
3606
|
+
*/
|
|
3607
|
+
customJSON?: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* Wwbchat Plugins
|
|
3610
|
+
*/
|
|
3611
|
+
pluginUrls?: string[];
|
|
3612
|
+
/**
|
|
3613
|
+
* The maximum allowed size of the attachment
|
|
3614
|
+
*/
|
|
3615
|
+
fileAttachmentMaxSize: number;
|
|
3616
|
+
/**
|
|
3617
|
+
* Maintenance mode configuration for the Webchat Widget
|
|
3618
|
+
*/
|
|
3619
|
+
maintenance: IWebchat3EndpointMaintenanceSettings;
|
|
3620
|
+
/**
|
|
3621
|
+
* Control the demo webchat of the Webchat Widget
|
|
3622
|
+
*/
|
|
3623
|
+
demoWebchat: IWebchat3EndpointDemoWebchatSettings;
|
|
3624
|
+
}
|
|
3079
3625
|
/**
|
|
3080
3626
|
* Setting to enable rating for the Webchat.
|
|
3081
3627
|
* Valid types are:
|
|
@@ -3094,6 +3640,9 @@ export declare type TWebchatEnableRating = "always" | "once" | "onRequest";
|
|
|
3094
3640
|
* Flow when the Webchat connects
|
|
3095
3641
|
*/
|
|
3096
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";
|
|
3097
3646
|
export interface IAmazonLexEndpointSettings {
|
|
3098
3647
|
/**
|
|
3099
3648
|
* Whether to reparse slots found
|
|
@@ -3181,6 +3730,8 @@ export interface IWhatsAppEndpointSettings extends IEndpointSessionSettings {
|
|
|
3181
3730
|
fileStorageSettings?: IFileStorageSettings;
|
|
3182
3731
|
}
|
|
3183
3732
|
export interface IFileStorageSettings {
|
|
3733
|
+
enabled?: boolean;
|
|
3734
|
+
dropzoneText?: string;
|
|
3184
3735
|
storageProvider: "none" | "aws" | "azure" | "googleCloud";
|
|
3185
3736
|
awsConnection?: string;
|
|
3186
3737
|
azureConnection?: string;
|
|
@@ -3310,13 +3861,24 @@ declare const generativeAIModels: readonly [
|
|
|
3310
3861
|
"gpt-3.5-turbo-instruct",
|
|
3311
3862
|
"gpt-4",
|
|
3312
3863
|
"text-davinci-003",
|
|
3313
|
-
"text-embedding-ada-002",
|
|
3314
3864
|
"luminous-extended-control",
|
|
3315
3865
|
"claude-v1-100k",
|
|
3316
3866
|
"claude-instant-v1",
|
|
3317
|
-
"
|
|
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"
|
|
3318
3875
|
];
|
|
3319
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];
|
|
3320
3882
|
declare const generativeAIProviders: readonly [
|
|
3321
3883
|
"azureOpenAI",
|
|
3322
3884
|
"openAI",
|
|
@@ -3326,6 +3888,7 @@ declare const generativeAIProviders: readonly [
|
|
|
3326
3888
|
];
|
|
3327
3889
|
export declare type TGenerativeAIProviders = typeof generativeAIProviders[number];
|
|
3328
3890
|
declare const generativeAIUseCases: readonly [
|
|
3891
|
+
"nlu",
|
|
3329
3892
|
"knowledgeSearch",
|
|
3330
3893
|
"gptPromptNode",
|
|
3331
3894
|
"gptConversation",
|
|
@@ -4160,6 +4723,7 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
4160
4723
|
* - azureOpenAI
|
|
4161
4724
|
* - anthropic
|
|
4162
4725
|
* - googleVertexAI
|
|
4726
|
+
* - alephAlpha
|
|
4163
4727
|
*/
|
|
4164
4728
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
4165
4729
|
/**
|
|
@@ -5286,16 +5850,22 @@ export interface IIndexLexiconEntriesRestReturnValue_2_0 extends ICursorBasedPag
|
|
|
5286
5850
|
* schemas:
|
|
5287
5851
|
* ILexiconEntryData_2_0:
|
|
5288
5852
|
* type: object
|
|
5853
|
+
* required:
|
|
5854
|
+
* - mainKeyphrase
|
|
5289
5855
|
* properties:
|
|
5290
5856
|
* data:
|
|
5291
5857
|
* type: string
|
|
5292
5858
|
* description: Additional JSON-data of the lexicon entry
|
|
5293
|
-
* example: {}
|
|
5859
|
+
* example: "{\"key1\": \"value1\" }"
|
|
5294
5860
|
* slotReferences:
|
|
5295
5861
|
* type: array
|
|
5296
5862
|
* description: The used slots by the lexicon entry
|
|
5297
5863
|
* items:
|
|
5298
5864
|
* $ref: '#/components/schemas/TMongoId'
|
|
5865
|
+
* mainKeyphrase:
|
|
5866
|
+
* type: string
|
|
5867
|
+
* description: the keyphrase value
|
|
5868
|
+
* example: pizza
|
|
5299
5869
|
*
|
|
5300
5870
|
* ILexiconEntryGeneratedData_2_0:
|
|
5301
5871
|
* type: object
|
|
@@ -7433,23 +8003,28 @@ export interface IGraphConnection {
|
|
|
7433
8003
|
referenceId: string;
|
|
7434
8004
|
properties: Pick<IConnection, "type" | "extension" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
7435
8005
|
}
|
|
7436
|
-
export interface
|
|
7437
|
-
customModel
|
|
8006
|
+
export interface IOpenAIMeta {
|
|
8007
|
+
customModel?: string;
|
|
7438
8008
|
}
|
|
7439
|
-
export interface
|
|
8009
|
+
export interface IAlephAlphaMeta {
|
|
8010
|
+
customModel?: string;
|
|
8011
|
+
baseCustomUrl?: string | null;
|
|
7440
8012
|
}
|
|
7441
|
-
export interface
|
|
8013
|
+
export interface IAnthropicMeta {
|
|
8014
|
+
customModel?: string;
|
|
7442
8015
|
}
|
|
7443
8016
|
export interface IAzureOpenAIMeta {
|
|
7444
8017
|
resourceName?: string;
|
|
7445
8018
|
deploymentName?: string;
|
|
7446
8019
|
baseCustomUrl?: string | null;
|
|
7447
8020
|
apiVersion?: string;
|
|
8021
|
+
customModel?: string;
|
|
7448
8022
|
}
|
|
7449
8023
|
export interface IGoogleVertexAIMeta {
|
|
7450
8024
|
location: string;
|
|
7451
8025
|
apiEndPoint: string;
|
|
7452
8026
|
publisher?: string;
|
|
8027
|
+
customModel?: string;
|
|
7453
8028
|
}
|
|
7454
8029
|
export interface ILargeLanguageModel extends IEntityMeta {
|
|
7455
8030
|
_id: TMongoId;
|
|
@@ -7457,6 +8032,8 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7457
8032
|
name: string;
|
|
7458
8033
|
description: string;
|
|
7459
8034
|
modelType: TGenerativeAIModels;
|
|
8035
|
+
modelGroup?: TModelGroups;
|
|
8036
|
+
isCustomModel?: boolean;
|
|
7460
8037
|
provider: TGenerativeAIProviders;
|
|
7461
8038
|
connectionId: string;
|
|
7462
8039
|
isDefault: boolean;
|
|
@@ -7466,6 +8043,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7466
8043
|
googleVertexAI?: IGoogleVertexAIMeta;
|
|
7467
8044
|
openAI?: IOpenAIMeta;
|
|
7468
8045
|
alephAlpha?: IAlephAlphaMeta;
|
|
8046
|
+
anthropic?: IAnthropicMeta;
|
|
7469
8047
|
}
|
|
7470
8048
|
export interface IGraphLargeLanguageModelDependencyAttachment {
|
|
7471
8049
|
_id: string;
|
|
@@ -7626,6 +8204,8 @@ export interface IHttpRequestNodeSharedConfig {
|
|
|
7626
8204
|
async: boolean;
|
|
7627
8205
|
cache: boolean;
|
|
7628
8206
|
cacheExpiry: number;
|
|
8207
|
+
timeout: number;
|
|
8208
|
+
retryAttempts: number;
|
|
7629
8209
|
storeResponseHeaders: boolean;
|
|
7630
8210
|
allowSelfSigned: boolean;
|
|
7631
8211
|
abortOnError: boolean;
|
|
@@ -7794,14 +8374,23 @@ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number]
|
|
|
7794
8374
|
export interface IGenerativeAIUseCase {
|
|
7795
8375
|
useCase: TGenerativeAIUseCases;
|
|
7796
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
|
+
}
|
|
7797
8386
|
export interface IVoiceGateway2VadParams {
|
|
7798
8387
|
enable?: boolean;
|
|
7799
8388
|
voiceMs?: number;
|
|
7800
8389
|
mode?: number;
|
|
7801
8390
|
}
|
|
7802
|
-
export declare type TVoiceGateway2TTSVendor = "aws" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
|
|
8391
|
+
export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
|
|
7803
8392
|
export interface IVoiceGateway2SynthesizerParams {
|
|
7804
|
-
vendor?: TVoiceGateway2TTSVendor;
|
|
8393
|
+
vendor?: TVoiceGateway2TTSVendor | "default" | "none";
|
|
7805
8394
|
language?: string;
|
|
7806
8395
|
voice?: string;
|
|
7807
8396
|
label?: string;
|
|
@@ -7812,11 +8401,13 @@ export interface IVoiceGateway2SynthesizerParams {
|
|
|
7812
8401
|
engine?: "standard" | "neural";
|
|
7813
8402
|
gender?: "MALE" | "FEMALE" | "NEUTRAL";
|
|
7814
8403
|
azureServiceEndpoint?: string;
|
|
8404
|
+
options?: object;
|
|
7815
8405
|
}
|
|
7816
8406
|
export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
|
|
7817
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";
|
|
7818
8409
|
export interface IVoiceGateway2RecognizerParams {
|
|
7819
|
-
vendor?: TVoiceGateway2STTVendor;
|
|
8410
|
+
vendor?: TVoiceGateway2STTVendor | "default" | "none";
|
|
7820
8411
|
language?: string;
|
|
7821
8412
|
label?: string;
|
|
7822
8413
|
fallbackVendor?: string;
|
|
@@ -7848,7 +8439,6 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
7848
8439
|
requestSnr?: boolean;
|
|
7849
8440
|
initialSpeechTimeoutMs?: number;
|
|
7850
8441
|
azureSttEndpointId?: string;
|
|
7851
|
-
azureTtsDeploymentId?: string;
|
|
7852
8442
|
audioLogging?: boolean;
|
|
7853
8443
|
asrDtmfTerminationDigit?: string;
|
|
7854
8444
|
asrTimeout?: number;
|
|
@@ -7857,7 +8447,7 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
7857
8447
|
ibmOptions?: TVoiceGateway2IbmOptions;
|
|
7858
8448
|
nvidiaOptions?: TVoiceGateway2NvidiaOptions;
|
|
7859
8449
|
sonioxOptions?: TVoiceGateway2SonioxOptions;
|
|
7860
|
-
model?: TVoiceGateway2GoogleModel;
|
|
8450
|
+
model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
|
|
7861
8451
|
}
|
|
7862
8452
|
export declare type TVoiceGateway2NuanceOptions = {
|
|
7863
8453
|
clientId?: string;
|
|
@@ -7889,12 +8479,15 @@ export declare type TVoiceGateway2NuanceOptions = {
|
|
|
7889
8479
|
];
|
|
7890
8480
|
};
|
|
7891
8481
|
export declare type TVoiceGateway2DeepgramOptions = {
|
|
8482
|
+
deepgramSttUri?: string;
|
|
8483
|
+
deepgramSttUseTls?: boolean;
|
|
7892
8484
|
apiKey?: string;
|
|
7893
8485
|
tier?: string;
|
|
7894
8486
|
model?: string;
|
|
7895
8487
|
customModel?: string;
|
|
7896
8488
|
version?: string;
|
|
7897
8489
|
punctuate?: boolean;
|
|
8490
|
+
smartFormatting?: boolean;
|
|
7898
8491
|
profanityFilter?: boolean;
|
|
7899
8492
|
redact?: string;
|
|
7900
8493
|
diarize?: boolean;
|
|
@@ -7907,9 +8500,10 @@ export declare type TVoiceGateway2DeepgramOptions = {
|
|
|
7907
8500
|
replace?: string[];
|
|
7908
8501
|
keywords?: string[];
|
|
7909
8502
|
endpointing?: boolean | number;
|
|
8503
|
+
utteranceEndMs?: number;
|
|
8504
|
+
shortUtterance?: boolean;
|
|
7910
8505
|
vadTurnoff?: number;
|
|
7911
8506
|
tag?: string;
|
|
7912
|
-
smartFormatting?: boolean;
|
|
7913
8507
|
};
|
|
7914
8508
|
export declare type TVoiceGateway2NvidiaOptions = {
|
|
7915
8509
|
rivaUri?: string;
|
|
@@ -8116,107 +8710,6 @@ export interface ISendConfigUpdateParams extends INodeFunctionBaseParams {
|
|
|
8116
8710
|
}>;
|
|
8117
8711
|
};
|
|
8118
8712
|
}
|
|
8119
|
-
export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
|
|
8120
|
-
config: {
|
|
8121
|
-
lexiconId: string;
|
|
8122
|
-
keyphrase: string;
|
|
8123
|
-
slots: string[];
|
|
8124
|
-
synonyms: string[];
|
|
8125
|
-
};
|
|
8126
|
-
}
|
|
8127
|
-
export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
|
|
8128
|
-
config: {
|
|
8129
|
-
text: string;
|
|
8130
|
-
data: any;
|
|
8131
|
-
mode: string;
|
|
8132
|
-
contextKey: string;
|
|
8133
|
-
inputKey: string;
|
|
8134
|
-
parseIntents: boolean;
|
|
8135
|
-
parseSlots: boolean;
|
|
8136
|
-
parseSystemSlots: boolean;
|
|
8137
|
-
findType: boolean;
|
|
8138
|
-
processDefaultReply: boolean;
|
|
8139
|
-
};
|
|
8140
|
-
}
|
|
8141
|
-
export interface IExtractAnswerNodeParams extends INodeFunctionBaseParams {
|
|
8142
|
-
config: {
|
|
8143
|
-
text: string;
|
|
8144
|
-
question: string;
|
|
8145
|
-
storeLocation: "input" | "context";
|
|
8146
|
-
contextKey: string;
|
|
8147
|
-
inputKey: string;
|
|
8148
|
-
};
|
|
8149
|
-
}
|
|
8150
|
-
export interface IRegexSlotFillerConfig {
|
|
8151
|
-
regex: string;
|
|
8152
|
-
flags: string;
|
|
8153
|
-
slot: string;
|
|
8154
|
-
}
|
|
8155
|
-
export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
|
|
8156
|
-
config: IRegexSlotFillerConfig;
|
|
8157
|
-
}
|
|
8158
|
-
export interface IMatchPatternParams extends INodeFunctionBaseParams {
|
|
8159
|
-
config: {
|
|
8160
|
-
patterns: string[];
|
|
8161
|
-
patternGroupName: string;
|
|
8162
|
-
alternateInput: string;
|
|
8163
|
-
detailedCompoundSlots: boolean;
|
|
8164
|
-
createNewSlots: boolean;
|
|
8165
|
-
tagExistingSlots: boolean;
|
|
8166
|
-
useFullSystemslotText: boolean;
|
|
8167
|
-
};
|
|
8168
|
-
}
|
|
8169
|
-
export interface IFuzzySearchParams extends INodeFunctionBaseParams {
|
|
8170
|
-
config: {
|
|
8171
|
-
searchPattern: string;
|
|
8172
|
-
items: any;
|
|
8173
|
-
isCaseSensitive: boolean;
|
|
8174
|
-
includeScore: boolean;
|
|
8175
|
-
includeMatches: boolean;
|
|
8176
|
-
minMatchCharLength: number;
|
|
8177
|
-
shouldSort: boolean;
|
|
8178
|
-
findAllMatches: boolean;
|
|
8179
|
-
location: number;
|
|
8180
|
-
threshold: number;
|
|
8181
|
-
distance: number;
|
|
8182
|
-
ignoreLocation: boolean;
|
|
8183
|
-
storeLocation: string;
|
|
8184
|
-
inputKey: string;
|
|
8185
|
-
contextKey: string;
|
|
8186
|
-
};
|
|
8187
|
-
}
|
|
8188
|
-
export interface ILastConversationEntry {
|
|
8189
|
-
source: "user" | "bot";
|
|
8190
|
-
text: string;
|
|
8191
|
-
}
|
|
8192
|
-
export interface OpenAIChatMessage {
|
|
8193
|
-
role: "system" | "user" | "assistant";
|
|
8194
|
-
content: string;
|
|
8195
|
-
}
|
|
8196
|
-
export interface IGenerativeSlot {
|
|
8197
|
-
tag: string;
|
|
8198
|
-
description: string;
|
|
8199
|
-
value: string;
|
|
8200
|
-
optional?: boolean;
|
|
8201
|
-
validation?: {
|
|
8202
|
-
type: string;
|
|
8203
|
-
value: string;
|
|
8204
|
-
invalidReason: string;
|
|
8205
|
-
};
|
|
8206
|
-
invalid?: boolean;
|
|
8207
|
-
}
|
|
8208
|
-
export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
8209
|
-
config: {
|
|
8210
|
-
slotsConfig: IGenerativeSlot[];
|
|
8211
|
-
amountOfLastUserInputs: number;
|
|
8212
|
-
maxQuestions: number;
|
|
8213
|
-
temperature: number;
|
|
8214
|
-
storeLocation: string;
|
|
8215
|
-
contextKey: string;
|
|
8216
|
-
inputKey: string;
|
|
8217
|
-
timeout: number;
|
|
8218
|
-
};
|
|
8219
|
-
}
|
|
8220
8713
|
export declare type INodeAiEnhancedRephraseOutputMode = "none" | "userInputs" | "customInputs";
|
|
8221
8714
|
export interface INodeWithAiRephraseConfig {
|
|
8222
8715
|
generativeAI_rephraseOutputMode: INodeAiEnhancedRephraseOutputMode;
|
|
@@ -8398,6 +8891,13 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
|
8398
8891
|
additionalMappedSymbols: {
|
|
8399
8892
|
[key: string]: string;
|
|
8400
8893
|
};
|
|
8894
|
+
llmEntityExtractLLMProviderReferenceId: string;
|
|
8895
|
+
entityName: string;
|
|
8896
|
+
entityDescription: string;
|
|
8897
|
+
examples: JSON;
|
|
8898
|
+
llmEntityExtractDescription: string;
|
|
8899
|
+
llmentityTemperature: number;
|
|
8900
|
+
llmentityTimeout: number;
|
|
8401
8901
|
}
|
|
8402
8902
|
export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig {
|
|
8403
8903
|
type: "date";
|
|
@@ -8430,7 +8930,7 @@ export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig
|
|
|
8430
8930
|
}
|
|
8431
8931
|
export interface IActiveQuestion {
|
|
8432
8932
|
nodeId: string;
|
|
8433
|
-
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";
|
|
8434
8934
|
lastExecutedAt: number;
|
|
8435
8935
|
forgetQuestionThreshold: number;
|
|
8436
8936
|
repromptCount?: number;
|
|
@@ -8450,9 +8950,29 @@ export interface IQuestionNodeRegexConfig extends IQuestionNodeSharedConfig {
|
|
|
8450
8950
|
regex: string;
|
|
8451
8951
|
}
|
|
8452
8952
|
export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
|
|
8453
|
-
type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber";
|
|
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;
|
|
8454
8975
|
}
|
|
8455
|
-
export declare type TRephraseWithAIQuestionType = IActiveQuestion["type"] | IOptionalQuestionNodeOtherConfig["type"];
|
|
8456
8976
|
export declare type TCompletionPrompt = {
|
|
8457
8977
|
prompt: string;
|
|
8458
8978
|
};
|
|
@@ -8536,6 +9056,26 @@ export interface IRunGenerativeAIPromptOptions {
|
|
|
8536
9056
|
* A string denoting the reference ID of the chosen LLM provider
|
|
8537
9057
|
*/
|
|
8538
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;
|
|
8539
9079
|
}
|
|
8540
9080
|
export interface IOpenAiCredentials {
|
|
8541
9081
|
apiType?: TGenerativeAIProviders;
|
|
@@ -8580,6 +9120,9 @@ export interface IKnowledgeSearchReturnValue {
|
|
|
8580
9120
|
];
|
|
8581
9121
|
};
|
|
8582
9122
|
}
|
|
9123
|
+
export interface IGetConversationTranscriptParams {
|
|
9124
|
+
turnLimit: number;
|
|
9125
|
+
}
|
|
8583
9126
|
export interface ISensitiveLoggingSettings {
|
|
8584
9127
|
maskLogging: boolean;
|
|
8585
9128
|
maskAnalytics: boolean;
|
|
@@ -8637,6 +9180,7 @@ export interface IActions {
|
|
|
8637
9180
|
deleteSystemContext?: (key: string) => void;
|
|
8638
9181
|
getCache?: (key: string) => void;
|
|
8639
9182
|
getContext?: (key: string) => any;
|
|
9183
|
+
getConversationTranscript?: (mode: "string" | "json", options: IGetConversationTranscriptParams) => ILastConversationEntry[];
|
|
8640
9184
|
getLastTopic?: (type: any, age: number) => void;
|
|
8641
9185
|
getState?: () => string;
|
|
8642
9186
|
getSystemContext?: (key: string) => any;
|
|
@@ -8644,7 +9188,6 @@ export interface IActions {
|
|
|
8644
9188
|
executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
|
|
8645
9189
|
executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
|
|
8646
9190
|
handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
|
|
8647
|
-
extractAnswer?: (extractAnswerParams: IExtractAnswerNodeParams) => Promise<void>;
|
|
8648
9191
|
getAnalyticsData?: () => IAnalyticsSourceData;
|
|
8649
9192
|
setAnalyticsData?: (key: string, value: any) => void;
|
|
8650
9193
|
getInjectedAnySlots?: () => {
|
|
@@ -8675,7 +9218,7 @@ export interface IActions {
|
|
|
8675
9218
|
rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
|
|
8676
9219
|
rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
|
|
8677
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;
|
|
8678
|
-
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<
|
|
9221
|
+
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<any>;
|
|
8679
9222
|
resetContext?: () => object;
|
|
8680
9223
|
resetFormBrain?: () => Promise<void>;
|
|
8681
9224
|
resetState?: () => Promise<string>;
|
|
@@ -8711,6 +9254,7 @@ export interface IActions {
|
|
|
8711
9254
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
8712
9255
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
8713
9256
|
getAgentAssistConfigId: () => string;
|
|
9257
|
+
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
8714
9258
|
}
|
|
8715
9259
|
export interface ICognigyNLPProperties {
|
|
8716
9260
|
/** The original text of the user */
|
|
@@ -9110,6 +9654,14 @@ export interface IMongoAggregateNodeParams extends INodeFunctionBaseParams {
|
|
|
9110
9654
|
stopOnError: boolean;
|
|
9111
9655
|
};
|
|
9112
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
|
+
}
|
|
9113
9665
|
declare const ruleOperands: readonly [
|
|
9114
9666
|
"lt",
|
|
9115
9667
|
"lte",
|
|
@@ -9227,7 +9779,8 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
|
|
|
9227
9779
|
setInputLanguageOnExecutionCount: number;
|
|
9228
9780
|
};
|
|
9229
9781
|
}
|
|
9230
|
-
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal"> {
|
|
9782
|
+
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal" | "getConversationTranscript"> {
|
|
9783
|
+
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
9231
9784
|
setNextNode: (nodeId: string, newFlowId?: string) => void;
|
|
9232
9785
|
resetNextNodes: () => void;
|
|
9233
9786
|
stopExecution: () => void;
|
|
@@ -9317,6 +9870,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
9317
9870
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
9318
9871
|
getAgentAssistConfigId: () => string;
|
|
9319
9872
|
countGPTTokens?: (prompt: string) => number;
|
|
9873
|
+
getConversationTranscript?: (mode: string, options?: any) => any;
|
|
9320
9874
|
}
|
|
9321
9875
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
9322
9876
|
api: INodeExecutionAPI;
|
|
@@ -9371,7 +9925,7 @@ export interface INodeFunctionBaseParams {
|
|
|
9371
9925
|
inputOptions?: INodeFunctionInputOptions;
|
|
9372
9926
|
}
|
|
9373
9927
|
export declare type TNodeChildConfigs = Pick<IChartExecutableNode, "id" | "type" | "config">;
|
|
9374
|
-
export declare type TNodeFunction = (params:
|
|
9928
|
+
export declare type TNodeFunction<T extends INodeFunctionBaseParams = any> = (params: T) => Promise<void>;
|
|
9375
9929
|
export declare type THttpRequestMethod = "get" | "GET" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK";
|
|
9376
9930
|
export interface IHttpRequestParams {
|
|
9377
9931
|
method: THttpRequestMethod;
|
|
@@ -9442,7 +9996,7 @@ declare const nodePreviewTypes: readonly [
|
|
|
9442
9996
|
"resource",
|
|
9443
9997
|
"image"
|
|
9444
9998
|
];
|
|
9445
|
-
export declare type TNodePreviewType = typeof nodePreviewTypes[number];
|
|
9999
|
+
export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
|
|
9446
10000
|
export interface INodePreview {
|
|
9447
10001
|
type: TNodePreviewType;
|
|
9448
10002
|
key: string;
|
|
@@ -9485,6 +10039,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
9485
10039
|
"adaptivecard",
|
|
9486
10040
|
"agentAssistConfig",
|
|
9487
10041
|
"appTemplate",
|
|
10042
|
+
"backgroundSelector",
|
|
9488
10043
|
"caseNode",
|
|
9489
10044
|
"checkbox",
|
|
9490
10045
|
"chipInput",
|
|
@@ -9530,7 +10085,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
9530
10085
|
"typescript",
|
|
9531
10086
|
"xml"
|
|
9532
10087
|
];
|
|
9533
|
-
export declare type TNodeFieldType = typeof nodeFieldTypes[number];
|
|
10088
|
+
export declare type TNodeFieldType = (typeof nodeFieldTypes)[number];
|
|
9534
10089
|
export declare type TComparableValue = string | number | boolean;
|
|
9535
10090
|
export declare type TNodeFieldCondition = INodeFieldSingleCondition | INodeFieldANDCondition | INodeFieldORCondition;
|
|
9536
10091
|
export interface INodeFieldSingleCondition {
|
|
@@ -9605,10 +10160,10 @@ export interface INodeFieldAndSectionFormElement {
|
|
|
9605
10160
|
}
|
|
9606
10161
|
export declare type TCognigyNodeTagType = "basic" | "logic" | "message" | "analytics" | "service" | "nlu" | "data";
|
|
9607
10162
|
export declare type TNodeTagType = TCognigyNodeTagType | string;
|
|
9608
|
-
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> {
|
|
9609
10164
|
_id?: TMongoId;
|
|
9610
10165
|
type: U;
|
|
9611
|
-
parentType?: string;
|
|
10166
|
+
parentType?: string | null;
|
|
9612
10167
|
defaultLabel: string | INodeFieldTranslations;
|
|
9613
10168
|
summary?: string | INodeFieldTranslations;
|
|
9614
10169
|
appearance: INodeAppearance;
|
|
@@ -9616,7 +10171,7 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
9616
10171
|
constraints?: INodeConstraints;
|
|
9617
10172
|
dependencies?: INodeDependencies;
|
|
9618
10173
|
fields?: INodeFieldSet<T>;
|
|
9619
|
-
function?: TNodeFunction;
|
|
10174
|
+
function?: TNodeFunction<FunctionParams> | null;
|
|
9620
10175
|
/** Defines how the preview should be generated for nodes using this descriptor */
|
|
9621
10176
|
preview?: INodePreview;
|
|
9622
10177
|
/**
|
|
@@ -9683,7 +10238,9 @@ export interface IAppTemplate extends IEntityMeta {
|
|
|
9683
10238
|
organisationReference: TMongoId;
|
|
9684
10239
|
}
|
|
9685
10240
|
export declare type IExtensionType = "nodes";
|
|
9686
|
-
export interface IExtension extends
|
|
10241
|
+
export interface IExtension extends IExtensionData, IExtensionNodePackage {
|
|
10242
|
+
}
|
|
10243
|
+
export interface IExtensionData extends IEntityMeta {
|
|
9687
10244
|
/** The name of the extension */
|
|
9688
10245
|
name: string;
|
|
9689
10246
|
/** Optional human readable name of the extension */
|
|
@@ -9788,12 +10345,21 @@ export interface IKnowledgeStore extends IEntityMeta {
|
|
|
9788
10345
|
projectReference: TMongoId;
|
|
9789
10346
|
organisationReference: TMongoId;
|
|
9790
10347
|
}
|
|
10348
|
+
export interface IGraphKnowledgeStoreAttachmentSource {
|
|
10349
|
+
_id: string;
|
|
10350
|
+
type: "attachedSource";
|
|
10351
|
+
}
|
|
10352
|
+
export interface IGraphKnowledgeStoreAttachmentChunk {
|
|
10353
|
+
_id: string;
|
|
10354
|
+
type: "attachedChunk";
|
|
10355
|
+
}
|
|
9791
10356
|
export interface IGraphKnowledgeStore {
|
|
9792
10357
|
type: "knowledgeStore";
|
|
9793
10358
|
_id: TMongoId;
|
|
9794
10359
|
name: string;
|
|
9795
10360
|
referenceId: string;
|
|
9796
10361
|
properties: Pick<IKnowledgeStore, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10362
|
+
dependencies?: (IGraphKnowledgeStoreAttachmentSource | IGraphKnowledgeStoreAttachmentChunk)[];
|
|
9797
10363
|
}
|
|
9798
10364
|
export interface ILexicon extends IEntityMeta {
|
|
9799
10365
|
name: string;
|
|
@@ -9921,7 +10487,39 @@ export interface IGraphPlaybook {
|
|
|
9921
10487
|
name: string;
|
|
9922
10488
|
properties: Pick<IPlaybook, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
9923
10489
|
}
|
|
9924
|
-
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;
|
|
9925
10523
|
export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
|
|
9926
10524
|
export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
|
|
9927
10525
|
/**
|
|
@@ -14088,6 +14686,70 @@ export interface IDatePickerNodeParams extends INodeFunctionBaseParams {
|
|
|
14088
14686
|
config: IDatePickerConfig;
|
|
14089
14687
|
}
|
|
14090
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
|
+
}
|
|
14091
14753
|
export interface IContinuousASRParams extends INodeFunctionBaseParams {
|
|
14092
14754
|
config: {
|
|
14093
14755
|
asrEnabled: boolean;
|
|
@@ -14123,7 +14785,6 @@ export interface IVoiceConfigParams {
|
|
|
14123
14785
|
bargeInOnDtmf: boolean;
|
|
14124
14786
|
bargeInSticky: boolean;
|
|
14125
14787
|
enableAdvancedSTTConfig: boolean;
|
|
14126
|
-
enableAdvancedTTSConfig: boolean;
|
|
14127
14788
|
sttLanguage: string;
|
|
14128
14789
|
sttVendor: string;
|
|
14129
14790
|
sttHints: string[];
|
|
@@ -14136,9 +14797,9 @@ export interface IVoiceConfigParams {
|
|
|
14136
14797
|
ttsDisableCache: boolean;
|
|
14137
14798
|
ttsVoice: string;
|
|
14138
14799
|
ttsLanguage: string;
|
|
14139
|
-
|
|
14800
|
+
ttsModel: string;
|
|
14801
|
+
ttsVendor: TVoiceGateway2TTSVendor | "default" | "none";
|
|
14140
14802
|
ttsLabel: string;
|
|
14141
|
-
azureTtsDeploymentId: string;
|
|
14142
14803
|
azureSttContextId: string;
|
|
14143
14804
|
azureSpeechRecognitionMode: string;
|
|
14144
14805
|
azureEnableAudioLogging: boolean;
|
|
@@ -14177,8 +14838,7 @@ export interface IVoiceConfigParams {
|
|
|
14177
14838
|
sttGoogleLang1: string;
|
|
14178
14839
|
sttGoogleLang2: string;
|
|
14179
14840
|
sttGoogleLang3: string;
|
|
14180
|
-
|
|
14181
|
-
sttDeepgramModel: string;
|
|
14841
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14182
14842
|
deepgramEndpointing: boolean;
|
|
14183
14843
|
deepgramEndpointingValue: number;
|
|
14184
14844
|
deepgramSmartFormatting: boolean;
|
|
@@ -14242,14 +14902,12 @@ export interface IVoiceConfigParams {
|
|
|
14242
14902
|
ttsVoice: string;
|
|
14243
14903
|
ttsLanguage: string;
|
|
14244
14904
|
ttsVendor: TVoiceGateway2TTSVendor;
|
|
14905
|
+
ttsModel: string;
|
|
14245
14906
|
sttDisablePunctuation: boolean;
|
|
14246
14907
|
azureSttContextId: string;
|
|
14247
14908
|
azureEnableAudioLogging: boolean;
|
|
14248
|
-
azureTtsDeploymentId: string;
|
|
14249
|
-
enableAdvancedTTSConfig: boolean;
|
|
14250
14909
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14251
|
-
|
|
14252
|
-
sttDeepgramModel: string;
|
|
14910
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14253
14911
|
deepgramEndpointing: boolean;
|
|
14254
14912
|
deepgramEndpointingValue: number;
|
|
14255
14913
|
deepgramSmartFormatting: boolean;
|
|
@@ -14325,8 +14983,12 @@ export interface ISetRatingParams extends INodeFunctionBaseParams {
|
|
|
14325
14983
|
}
|
|
14326
14984
|
export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
|
|
14327
14985
|
config: {
|
|
14986
|
+
ratingScreenTitleText: string;
|
|
14328
14987
|
ratingTitleText: string;
|
|
14329
14988
|
ratingCommentText: string;
|
|
14989
|
+
ratingSubmitButtonText: string;
|
|
14990
|
+
ratingEventBannerText: string;
|
|
14991
|
+
ratingChatStatusMessage: string;
|
|
14330
14992
|
};
|
|
14331
14993
|
}
|
|
14332
14994
|
export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
|
|
@@ -14630,8 +15292,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
|
14630
15292
|
recognitionChannel: number;
|
|
14631
15293
|
sttLanguage: string;
|
|
14632
15294
|
sttVendor: string;
|
|
14633
|
-
|
|
14634
|
-
sttDeepgramModel: string;
|
|
15295
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14635
15296
|
sttDisablePunctuation: boolean;
|
|
14636
15297
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14637
15298
|
sttLabel: string;
|
|
@@ -14754,7 +15415,6 @@ export interface ICognigyBasicNodes {
|
|
|
14754
15415
|
say: ICreateChartNodeBasicNodesData<"say", ISayNodeParams, TBASIC_EXTENSION>;
|
|
14755
15416
|
addLexiconKeyphrase: ICreateChartNodeBasicNodesData<"addLexiconKeyphrase", IAddLexiconKeyphraseNodeParams, TBASIC_EXTENSION>;
|
|
14756
15417
|
executeCognigyNLU: ICreateChartNodeBasicNodesData<"executeCognigyNLU", IExecuteCognigyNLUNodeParams, TBASIC_EXTENSION>;
|
|
14757
|
-
extractAnswer: ICreateChartNodeBasicNodesData<"extractAnswer", IExtractAnswerNodeParams, TBASIC_EXTENSION>;
|
|
14758
15418
|
regexSlotFiller: ICreateChartNodeBasicNodesData<"regexSlotFiller", IRegexSlotFillerParams, TBASIC_EXTENSION>;
|
|
14759
15419
|
matchPattern: ICreateChartNodeBasicNodesData<"matchPattern", IMatchPatternParams, TBASIC_EXTENSION>;
|
|
14760
15420
|
fuzzySearch: ICreateChartNodeBasicNodesData<"fuzzySearch", IFuzzySearchParams, TBASIC_EXTENSION>;
|
|
@@ -15170,10 +15830,14 @@ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<I
|
|
|
15170
15830
|
export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
|
|
15171
15831
|
}
|
|
15172
15832
|
export interface IOpenAIMeta_2_0 {
|
|
15173
|
-
customModel
|
|
15833
|
+
customModel?: string;
|
|
15834
|
+
}
|
|
15835
|
+
export interface IAnthropicMeta_2_0 {
|
|
15836
|
+
customModel?: string;
|
|
15174
15837
|
}
|
|
15175
15838
|
export interface IAlephAlphaMeta_2_0 {
|
|
15176
|
-
customModel
|
|
15839
|
+
customModel?: string;
|
|
15840
|
+
baseCustomUrl?: string;
|
|
15177
15841
|
}
|
|
15178
15842
|
export interface IAzureOpenAIMeta_2_0 {
|
|
15179
15843
|
resourceName?: string;
|
|
@@ -15194,6 +15858,7 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15194
15858
|
* ILargeLanguageModelFields_2_0:
|
|
15195
15859
|
* allOf:
|
|
15196
15860
|
* - type: object
|
|
15861
|
+
* required: ['name', 'modelType', 'provider', 'connectionId']
|
|
15197
15862
|
* properties:
|
|
15198
15863
|
* name:
|
|
15199
15864
|
* type: string
|
|
@@ -15203,7 +15868,12 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15203
15868
|
* example: "LLM meaningful description"
|
|
15204
15869
|
* modelType:
|
|
15205
15870
|
* $ref: '#/components/schemas/TGenerativeAIModels'
|
|
15206
|
-
|
|
15871
|
+
* modelGroup:
|
|
15872
|
+
* $ref: '#/components/schemas/TModelGroups'
|
|
15873
|
+
* isCustomModel:
|
|
15874
|
+
* type: boolean
|
|
15875
|
+
* example: true
|
|
15876
|
+
* provider:
|
|
15207
15877
|
* $ref: '#/components/schemas/TGenerativeAIProviders'
|
|
15208
15878
|
* connectionId:
|
|
15209
15879
|
* type: string
|
|
@@ -15220,6 +15890,15 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15220
15890
|
* customModel:
|
|
15221
15891
|
* type: string
|
|
15222
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
|
|
15223
15902
|
* azureOpenAI:
|
|
15224
15903
|
* type: object
|
|
15225
15904
|
* description: Azure OpenAI specific meta data
|
|
@@ -15230,6 +15909,33 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15230
15909
|
* type: string
|
|
15231
15910
|
* apiVersion:
|
|
15232
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
|
|
15233
15939
|
*
|
|
15234
15940
|
* ILargeLanguageModelCreate_2_0:
|
|
15235
15941
|
* allOf:
|
|
@@ -15256,6 +15962,9 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15256
15962
|
name: string;
|
|
15257
15963
|
description: string;
|
|
15258
15964
|
modelType: TGenerativeAIModels;
|
|
15965
|
+
/** model type e.g. chat */
|
|
15966
|
+
modelGroup?: TModelGroups;
|
|
15967
|
+
isCustomModel?: boolean;
|
|
15259
15968
|
provider: TGenerativeAIProviders;
|
|
15260
15969
|
connectionId: string;
|
|
15261
15970
|
isDefault: boolean;
|
|
@@ -15271,6 +15980,8 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15271
15980
|
alephAlpha?: IAlephAlphaMeta_2_0;
|
|
15272
15981
|
/** Meta data for the GoogleVertexAI connection */
|
|
15273
15982
|
googleVertexAI?: IGoogleVertexAIMeta_2_0;
|
|
15983
|
+
/** Meta data for the Anthropic connection */
|
|
15984
|
+
anthropic?: IAnthropicMeta_2_0;
|
|
15274
15985
|
}
|
|
15275
15986
|
export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
|
|
15276
15987
|
}
|
|
@@ -15445,6 +16156,7 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15445
16156
|
url?: string;
|
|
15446
16157
|
failReason?: string;
|
|
15447
16158
|
tags?: string[];
|
|
16159
|
+
extractedChunks?: number;
|
|
15448
16160
|
}
|
|
15449
16161
|
/**
|
|
15450
16162
|
* @openapi
|
|
@@ -15720,8 +16432,173 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
|
|
|
15720
16432
|
}
|
|
15721
16433
|
export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
|
|
15722
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
|
+
}
|
|
15723
16599
|
declare const uploadResumableTypes: readonly [
|
|
15724
|
-
"snapshots"
|
|
16600
|
+
"snapshots",
|
|
16601
|
+
"packages"
|
|
15725
16602
|
];
|
|
15726
16603
|
export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
|
|
15727
16604
|
export interface HttpRequest {
|
|
@@ -15756,6 +16633,7 @@ export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBo
|
|
|
15756
16633
|
export interface IUploadResumableRestReturnValue_2_0 {
|
|
15757
16634
|
fileName: string;
|
|
15758
16635
|
url: string;
|
|
16636
|
+
uploadId: string;
|
|
15759
16637
|
}
|
|
15760
16638
|
export interface ResourcesAPIGroup_2_0 {
|
|
15761
16639
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
@@ -15823,6 +16701,11 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
15823
16701
|
readEndpoint: TRestAPIOperation<IReadEndpointRestData_2_0, IReadEndpointRestReturnValue_2_0>;
|
|
15824
16702
|
updateEndpoint: TRestAPIOperation<IUpdateEndpointRestData_2_0, IUpdateEndpointRestReturnValue_2_0>;
|
|
15825
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>;
|
|
15826
16709
|
indexPlaybooks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexPlaybooksRestData_2_0>, IIndexPlaybooksRestReturnValue_2_0>;
|
|
15827
16710
|
batchPlaybooks: TRestAPIOperation<IBatchPlaybooksRestData_2_0, IBatchPlaybooksRestReturnValue_2_0>;
|
|
15828
16711
|
createPlaybook: TRestAPIOperation<ICreatePlaybookRestData_2_0, ICreatePlaybookRestReturnValue_2_0>;
|
|
@@ -17720,6 +18603,7 @@ declare const actionTypes: readonly [
|
|
|
17720
18603
|
"cancelTask",
|
|
17721
18604
|
"changePlaybookStepOrder",
|
|
17722
18605
|
"cloneFlow",
|
|
18606
|
+
"cloneMilestone",
|
|
17723
18607
|
"cloneLargeLanguageModel",
|
|
17724
18608
|
"configureIdentityProvider",
|
|
17725
18609
|
"createKnowledgeSearchIndex",
|
|
@@ -17834,14 +18718,14 @@ export declare type TActionType = typeof actionTypes[number];
|
|
|
17834
18718
|
*/
|
|
17835
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";
|
|
17836
18720
|
/**
|
|
17837
|
-
* @openapi
|
|
17838
|
-
* components:
|
|
17839
|
-
* schemas:
|
|
17840
|
-
* TAuditEventChainElementType:
|
|
17841
|
-
* allOf:
|
|
17842
|
-
* - $ref: '#/components/schemas/TResourceType'
|
|
17843
|
-
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
17844
|
-
*/
|
|
18721
|
+
* @openapi
|
|
18722
|
+
* components:
|
|
18723
|
+
* schemas:
|
|
18724
|
+
* TAuditEventChainElementType:
|
|
18725
|
+
* allOf:
|
|
18726
|
+
* - $ref: '#/components/schemas/TResourceType'
|
|
18727
|
+
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
18728
|
+
*/
|
|
17845
18729
|
export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional;
|
|
17846
18730
|
/***
|
|
17847
18731
|
* @openapi
|
|
@@ -17866,16 +18750,16 @@ export interface IAuditEventData {
|
|
|
17866
18750
|
type: TAuditEventType;
|
|
17867
18751
|
actionType?: TActionType;
|
|
17868
18752
|
/**
|
|
17869
|
-
|
|
17870
|
-
|
|
17871
|
-
|
|
17872
|
-
|
|
17873
|
-
|
|
17874
|
-
|
|
17875
|
-
|
|
17876
|
-
|
|
17877
|
-
|
|
17878
|
-
|
|
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
|
+
*/
|
|
17879
18763
|
chain: IAuditEventModificationChainElement[];
|
|
17880
18764
|
projectId?: TMongoId;
|
|
17881
18765
|
}
|