@cognigy/rest-api-client 0.17.0 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/build/GenericTusFn.js +6 -1
- package/build/GenericUploadFn.js +3 -5
- package/build/apigroups/AdministrationAPIGroup_2_0.js +3 -1
- package/build/apigroups/MetricsAPIGroup_2_0.js +5 -0
- package/build/apigroups/ResourcesAPIGroup_2_0.js +21 -7
- 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/determineMetadata.js +15 -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 +88 -15
- 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 +484 -10
- package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +32 -9
- package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js +2 -0
- package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +2 -1
- package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js +5 -3
- package/build/shared/charts/descriptors/agentAssist/setIframeTile.js +5 -3
- package/build/shared/charts/descriptors/agentAssist/setSecureFormsTile.js +2 -2
- package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +42 -3
- package/build/shared/charts/descriptors/analytics/activateProfile.js +1 -0
- package/build/shared/charts/descriptors/analytics/blindMode.js +2 -0
- package/build/shared/charts/descriptors/analytics/completeGoal.js +1 -0
- package/build/shared/charts/descriptors/analytics/deactivateProfile.js +1 -0
- package/build/shared/charts/descriptors/analytics/deleteProfile.js +1 -0
- package/build/shared/charts/descriptors/analytics/index.js +3 -1
- package/build/shared/charts/descriptors/analytics/mergeProfile.js +1 -0
- package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +9 -0
- package/build/shared/charts/descriptors/analytics/requestRating.js +56 -2
- package/build/shared/charts/descriptors/analytics/setRating.js +4 -2
- package/build/shared/charts/descriptors/analytics/trackMilestone.js +95 -0
- package/build/shared/charts/descriptors/analytics/updateProfile.js +1 -0
- package/build/shared/charts/descriptors/apps/initAppSession.js +1 -0
- package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js +35 -10
- package/build/shared/charts/descriptors/apps/setHtmlAppState.js +25 -2
- package/build/shared/charts/descriptors/apps/utils/getXAppsOverlaySettings.js +54 -0
- package/build/shared/charts/descriptors/connectionNodes/documentParserProviders/azureAIDocumentIntelligenceConnection.js +12 -0
- package/build/shared/charts/descriptors/connectionNodes/documentParserProviders/index.js +13 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/awsBedrockProviderConnection.js +12 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnection.js +4 -3
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnectionV2.js +3 -3
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderOauth2Connection.js +14 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +16 -8
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +3 -3
- package/build/shared/charts/descriptors/data/addToContext.js +7 -0
- package/build/shared/charts/descriptors/data/copyDataToContext.js +3 -0
- package/build/shared/charts/descriptors/data/copySlotsToContext.js +3 -0
- package/build/shared/charts/descriptors/data/debugMessage.js +73 -0
- package/build/shared/charts/descriptors/data/index.js +3 -1
- package/build/shared/charts/descriptors/data/removeFromContext.js +9 -1
- package/build/shared/charts/descriptors/data/resetContext.js +1 -0
- package/build/shared/charts/descriptors/index.js +8 -4
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +36 -11
- package/build/shared/charts/descriptors/logic/resetState.js +1 -0
- package/build/shared/charts/descriptors/logic/setState.js +2 -1
- package/build/shared/charts/descriptors/logic/setTranslation.js +3 -1
- package/build/shared/charts/descriptors/logic/switchLocale.js +1 -0
- package/build/shared/charts/descriptors/logic/think.js +3 -1
- package/build/shared/charts/descriptors/logic/thinkV2.js +2 -0
- package/build/shared/charts/descriptors/message/question/optionalQuestion.js +1 -1
- package/build/shared/charts/descriptors/message/question/question.js +173 -7
- package/build/shared/charts/descriptors/message/question/utils/evaluateQuestionAnswer.js +44 -3
- package/build/shared/charts/descriptors/message/question/utils/validateQuestionAnswer.js +4 -2
- package/build/shared/charts/descriptors/nlu/cleanText.js +1 -0
- package/build/shared/charts/descriptors/nlu/fuzzySearch.js +23 -1
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +45 -19
- package/build/shared/charts/descriptors/nlu/index.js +1 -3
- package/build/shared/charts/descriptors/service/GPTPrompt.js +362 -29
- package/build/shared/charts/descriptors/service/LLMEntityExtract.js +283 -0
- package/build/shared/charts/descriptors/service/handoverV2.js +84 -1
- package/build/shared/charts/descriptors/service/httpRequest.js +68 -3
- package/build/shared/charts/descriptors/service/index.js +3 -1
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +110 -27
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +4 -4
- package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +2 -0
- package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +2 -0
- package/build/shared/charts/descriptors/voice/nodes/dtmf.js +2 -0
- package/build/shared/charts/descriptors/voice/nodes/muteSpeechInput.js +1 -0
- package/build/shared/charts/descriptors/voice/nodes/noUserInput.js +2 -0
- package/build/shared/charts/descriptors/voice/nodes/play.js +8 -1
- package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +46 -45
- package/build/shared/charts/descriptors/voice/nodes/transfer.js +2 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/dtmf.js +2 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/hangup.js +2 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/muteSpeechInput.js +3 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +1 -1
- package/build/shared/charts/descriptors/voicegateway2/nodes/record.js +1 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js +1 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/sendMetadata.js +1 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +329 -47
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +27 -31
- package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +2 -2
- package/build/shared/charts/helpers/generativeAI/generativeAIPrompts.js +55 -0
- package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +4 -2
- package/build/shared/constants.js +10 -1
- package/build/shared/handoverClients/interfaces/THandoverEventType.js +1 -0
- package/build/shared/helper/logFullConfigToDebugMode.js +30 -0
- package/build/shared/helper/nlu/textCleaner.js +3 -1
- package/build/shared/interfaces/IOrganisation.js +1 -0
- package/build/shared/interfaces/IProfile.js +1 -0
- package/build/shared/interfaces/IProfileSchema.js +3 -0
- package/build/shared/interfaces/analytics/IAnalyticsSourceData.js +20 -20
- package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyProgress_2_0.js → analytics/IMilestoneAnalytics.js} +1 -1
- package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourney_2_0.js → appsession/IAppSession.js} +1 -1
- package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyStep_2_0.js → appsession/ISetAppState.js} +1 -1
- package/build/shared/interfaces/appsession/ISetAppStateOptions.js +3 -0
- package/build/shared/interfaces/appsession/ISetAppStateOverlaySettings.js +3 -0
- package/build/shared/interfaces/appsession/ISetAppStateOverlaySettingsMetaData.js +3 -0
- package/build/shared/interfaces/debugEvents/TDebugEventMessagePayload.js +3 -0
- package/build/shared/interfaces/debugEvents/TDebugEventType.js +2 -0
- package/build/shared/interfaces/fileStorage.js +6 -0
- package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +45 -52
- package/build/shared/interfaces/handover.js +44 -2
- package/build/shared/interfaces/license.js +3 -2
- package/build/shared/interfaces/license.js.map +1 -1
- package/build/shared/interfaces/messageAPI/endpoints.js +17 -2
- package/build/shared/interfaces/messageAPI/handover.js +25 -2
- package/build/shared/interfaces/nlu/nlu.js +3 -0
- package/build/shared/interfaces/resources/IAuditEvent.js +10 -9
- package/build/shared/interfaces/resources/IConnection.js +1 -0
- package/build/shared/interfaces/resources/IEndpoint.js +1 -2
- package/build/shared/interfaces/resources/ILargeLanguageModel.js +56 -21
- package/build/shared/interfaces/resources/IMilestone.js +50 -0
- package/build/shared/interfaces/resources/INodeDescriptorSet.js +96 -75
- package/build/shared/interfaces/resources/TResourceType.js +12 -5
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
- package/build/shared/interfaces/resources/settings/IAgentSettings.js +12 -7
- package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +8 -0
- package/build/shared/interfaces/resources/settings/IKnowledgeAISettings.js +18 -0
- package/build/shared/interfaces/resources/settings/index.js +4 -1
- package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadCollectionsToBeDeletedRest_2_0.js +0 -1
- package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadOrganisationKnowledgeChunksCountRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/operations/index.js +3 -0
- package/build/shared/interfaces/restAPI/operations/nlu/v2.0/IGenerateNluScoresRest_2_0.js +57 -0
- package/build/shared/interfaces/restAPI/operations/nlu/v2.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IAvailableModelsForLLMProvider_2_0 .js +18 -0
- package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IGetAvailableModelsForLLMRest_2_0 .js +3 -0
- package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyIndexItem_2_0.js → milestone/v2.0/ICloneMilestoneRest_2_0.js} +1 -1
- 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/{journey/v2.0/IIndexJourneysRest_2_0.js → milestone/v2.0/IReadMilestoneRest_2_0.js} +1 -1
- 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/IRole.js +2 -0
- package/build/shared/interfaces/security/ISystemCapabilities.js +3 -0
- package/build/shared/interfaces/security/index.js +1 -1
- package/build/shared/interfaces/trainer/ITrainerRecord.js +2 -2
- package/build/shared/interfaces/user.js +1 -1
- package/package.json +2 -2
- package/types/index.d.ts +2194 -957
- package/build/shared/charts/descriptors/nlu/extractAnswer.js +0 -115
- package/build/shared/interfaces/journeys/IJourney.js +0 -83
- package/build/shared/interfaces/journeys/IJourneyProgress.js +0 -40
- package/build/shared/interfaces/journeys/IJourneyTrackEvent.js +0 -35
- package/build/shared/interfaces/journeys/index.js +0 -14
- package/build/shared/interfaces/restAPI/resources/journey/v2.0/IJourneyTrackEvents_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyProgressRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/journey/v2.0/ITrackJourneyEventRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/journey/v2.0/IUpdateSelectedJourneyRest_2_0.js +0 -3
- /package/build/shared/interfaces/{restAPI/resources/journey/v2.0 → appsession}/index.js +0 -0
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",
|
|
@@ -951,6 +952,7 @@ declare const projectWideRoles: readonly [
|
|
|
951
952
|
"function_admin",
|
|
952
953
|
"function_editor",
|
|
953
954
|
"intents",
|
|
955
|
+
"knowledgeAdmin",
|
|
954
956
|
"large_language_model_admin",
|
|
955
957
|
"lexicon_admin",
|
|
956
958
|
"lexicon_editor",
|
|
@@ -1050,6 +1052,8 @@ export interface ICrudPermissions {
|
|
|
1050
1052
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1051
1053
|
* members:
|
|
1052
1054
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1055
|
+
* milestones:
|
|
1056
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1053
1057
|
* nluConnectors:
|
|
1054
1058
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1055
1059
|
* playbooks:
|
|
@@ -1133,6 +1137,8 @@ export interface IOrganisationWideAcl {
|
|
|
1133
1137
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1134
1138
|
* members:
|
|
1135
1139
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1140
|
+
* milestones:
|
|
1141
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1136
1142
|
* nluConnectors:
|
|
1137
1143
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1138
1144
|
* playbooks:
|
|
@@ -1571,6 +1577,7 @@ declare const arrayTResourceType: readonly [
|
|
|
1571
1577
|
"lexiconKeyphrase",
|
|
1572
1578
|
"lexiconSlot",
|
|
1573
1579
|
"locale",
|
|
1580
|
+
"milestone",
|
|
1574
1581
|
"nluconnector",
|
|
1575
1582
|
"nodeData",
|
|
1576
1583
|
"nodeDescriptorSet",
|
|
@@ -1581,11 +1588,11 @@ declare const arrayTResourceType: readonly [
|
|
|
1581
1588
|
"snapshot",
|
|
1582
1589
|
"snippet"
|
|
1583
1590
|
];
|
|
1584
|
-
export declare type TResourceType = typeof arrayTResourceType[number];
|
|
1591
|
+
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
1585
1592
|
declare const arrayTChartableResourceType: readonly [
|
|
1586
1593
|
"flow"
|
|
1587
1594
|
];
|
|
1588
|
-
export declare type TChartableResourceType = typeof arrayTChartableResourceType[number];
|
|
1595
|
+
export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
|
|
1589
1596
|
declare const searchableResourceTypes: readonly [
|
|
1590
1597
|
"endpoint",
|
|
1591
1598
|
"extension",
|
|
@@ -1593,12 +1600,13 @@ declare const searchableResourceTypes: readonly [
|
|
|
1593
1600
|
"function",
|
|
1594
1601
|
"largeLanguageModel",
|
|
1595
1602
|
"lexicon",
|
|
1603
|
+
"milestone",
|
|
1596
1604
|
"nluconnector",
|
|
1597
1605
|
"playbook",
|
|
1598
1606
|
"project",
|
|
1599
1607
|
"snapshot"
|
|
1600
1608
|
];
|
|
1601
|
-
export declare type TSearchableResourceType = typeof searchableResourceTypes[number];
|
|
1609
|
+
export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
|
|
1602
1610
|
declare const arrayNLUConnectorType: readonly [
|
|
1603
1611
|
"alexa",
|
|
1604
1612
|
"dialogflow",
|
|
@@ -2008,6 +2016,7 @@ export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyti
|
|
|
2008
2016
|
handoverEscalations: number;
|
|
2009
2017
|
snapshotName?: string;
|
|
2010
2018
|
flowHistory?: IAnalyticsFlowHistoryData[];
|
|
2019
|
+
allowDataOnly: boolean;
|
|
2011
2020
|
custom1?: string;
|
|
2012
2021
|
custom2?: string;
|
|
2013
2022
|
custom3?: string;
|
|
@@ -2055,6 +2064,12 @@ declare const whisperAssistConfigurations: readonly [
|
|
|
2055
2064
|
"template"
|
|
2056
2065
|
];
|
|
2057
2066
|
export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
|
|
2067
|
+
declare const copilotType: readonly [
|
|
2068
|
+
"none",
|
|
2069
|
+
"workspace",
|
|
2070
|
+
"whisper"
|
|
2071
|
+
];
|
|
2072
|
+
export declare type TCopilotType = typeof copilotType[number];
|
|
2058
2073
|
export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
|
|
2059
2074
|
export interface IRCEHandoverSettings {
|
|
2060
2075
|
/**
|
|
@@ -2188,6 +2203,7 @@ export interface ISalesForceHandoverSettings {
|
|
|
2188
2203
|
forwardUnknownEventsToFlow: boolean;
|
|
2189
2204
|
}
|
|
2190
2205
|
export interface IAgentAssistSettings {
|
|
2206
|
+
copilotType: TCopilotType;
|
|
2191
2207
|
agentAssistFlowId: string;
|
|
2192
2208
|
agentAssistConfigId: string;
|
|
2193
2209
|
enableTranscriptTile?: boolean;
|
|
@@ -2230,7 +2246,7 @@ export interface IGenesysCloudOMHandoverSettings {
|
|
|
2230
2246
|
}
|
|
2231
2247
|
export interface IHandoverStatusInputObject {
|
|
2232
2248
|
status: THandoverStatus;
|
|
2233
|
-
eventType?: "queueUpdate" | "handoverInactivity";
|
|
2249
|
+
eventType?: "queueUpdate" | "handoverInactivity" | "genericHandoverUpdate";
|
|
2234
2250
|
inactivityCount?: number;
|
|
2235
2251
|
error?: {
|
|
2236
2252
|
reason: "unsupported" | "error";
|
|
@@ -2238,7 +2254,7 @@ export interface IHandoverStatusInputObject {
|
|
|
2238
2254
|
};
|
|
2239
2255
|
data?: any;
|
|
2240
2256
|
}
|
|
2241
|
-
export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject";
|
|
2257
|
+
export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject" | "genericHandoverUpdate";
|
|
2242
2258
|
export interface IEndpointTranslationSettings {
|
|
2243
2259
|
translationEnabled: boolean;
|
|
2244
2260
|
flowLanguage: string;
|
|
@@ -2294,10 +2310,6 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2294
2310
|
useAnalytics: boolean;
|
|
2295
2311
|
/** Whether we should store data payloads into analytics for this endpoint */
|
|
2296
2312
|
storeDataPayload: boolean;
|
|
2297
|
-
/** Whether we should use Chatbase to collect analytics */
|
|
2298
|
-
useChatbaseAnalytics: boolean;
|
|
2299
|
-
/** The apikey for the Chatbase bot */
|
|
2300
|
-
chatbaseApikey: string;
|
|
2301
2313
|
/** Whether we should use Dashbot to collect analytics */
|
|
2302
2314
|
useDashbotAnalytics: boolean;
|
|
2303
2315
|
/** The apikey for the dashbot bot */
|
|
@@ -2309,6 +2321,10 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2309
2321
|
* is true.
|
|
2310
2322
|
*/
|
|
2311
2323
|
dashbotPlatform: TDashbotPlatform;
|
|
2324
|
+
/**
|
|
2325
|
+
* If set to `true`, disables input sanitization
|
|
2326
|
+
*/
|
|
2327
|
+
disableInputSanitization: boolean;
|
|
2312
2328
|
/**
|
|
2313
2329
|
* Optional endpoint specific settings e.g. Facebook Page token
|
|
2314
2330
|
*/
|
|
@@ -2477,12 +2493,12 @@ export interface ICallEventFailoverSettings {
|
|
|
2477
2493
|
dialTranscribeRecognitionChannel?: number;
|
|
2478
2494
|
dialTranscribeRecognitionGoogleModel?: string;
|
|
2479
2495
|
dialTranscribeLabel?: string;
|
|
2480
|
-
dialTranscribeDeepgramTier?: string;
|
|
2481
2496
|
dialTranscribeDeepgramModel?: string;
|
|
2482
2497
|
referredBy?: string;
|
|
2483
2498
|
deepgramSmartFormatting?: boolean;
|
|
2484
2499
|
deepgramEndpointing?: boolean;
|
|
2485
2500
|
deepgramEndpointingValue?: number;
|
|
2501
|
+
dialTranscribeDeepgramTier?: string;
|
|
2486
2502
|
}
|
|
2487
2503
|
export interface ICallEvents {
|
|
2488
2504
|
amd?: ICallEventSettings;
|
|
@@ -3094,208 +3110,537 @@ export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSetting
|
|
|
3094
3110
|
title: string;
|
|
3095
3111
|
};
|
|
3096
3112
|
}
|
|
3097
|
-
export interface
|
|
3113
|
+
export interface IWebchat3EndpointLayoutSettings {
|
|
3098
3114
|
/**
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
pluginUrls: string[];
|
|
3103
|
-
/**
|
|
3104
|
-
* The title that will show up on top of
|
|
3105
|
-
* the webchat's Header
|
|
3106
|
-
*/
|
|
3115
|
+
* The title that will show up on top of
|
|
3116
|
+
* the webchat's Header
|
|
3117
|
+
*/
|
|
3107
3118
|
title: string;
|
|
3108
3119
|
/**
|
|
3109
|
-
|
|
3110
|
-
|
|
3111
|
-
|
|
3120
|
+
* The URL that links to the logo
|
|
3121
|
+
* we display in the header.
|
|
3122
|
+
*/
|
|
3123
|
+
logoUrl: string;
|
|
3124
|
+
/**
|
|
3125
|
+
* Check for using the logo of the other agent.
|
|
3126
|
+
*/
|
|
3127
|
+
useOtherAgentLogo: boolean;
|
|
3128
|
+
/**
|
|
3129
|
+
* bot avatar name
|
|
3112
3130
|
*/
|
|
3113
|
-
|
|
3131
|
+
botAvatarName: string;
|
|
3132
|
+
/**
|
|
3133
|
+
* The URL that links to the logo
|
|
3134
|
+
* we display as the chatbot avatar
|
|
3135
|
+
*/
|
|
3136
|
+
botLogoUrl: string;
|
|
3137
|
+
/**
|
|
3138
|
+
* Agemt avatar name.
|
|
3139
|
+
*/
|
|
3140
|
+
agentAvatarName: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* The URL that links to the logo
|
|
3143
|
+
* we display as the agent avatar
|
|
3144
|
+
*/
|
|
3145
|
+
agentLogoUrl: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* Defines the number of line rows the text input
|
|
3148
|
+
* will grow to before showing a vertical scrollbar
|
|
3149
|
+
*/
|
|
3150
|
+
inputAutogrowMaxRows: number;
|
|
3151
|
+
/**
|
|
3152
|
+
* This setting activates the automatic collation
|
|
3153
|
+
* of input messages with a delay for the webchat
|
|
3154
|
+
*/
|
|
3155
|
+
enableInputCollation: boolean;
|
|
3156
|
+
/**
|
|
3157
|
+
* This setting configures the delay for the automatic
|
|
3158
|
+
* input collation in miliseconds. Defaults to 1000
|
|
3159
|
+
*/
|
|
3160
|
+
inputCollationTimeout: number;
|
|
3161
|
+
/**
|
|
3162
|
+
* This setting is used to decide whether images
|
|
3163
|
+
* should be resized dynamically
|
|
3164
|
+
*/
|
|
3165
|
+
dynamicImageAspectRatio: boolean;
|
|
3166
|
+
/**
|
|
3167
|
+
* This setting is used to disable autocomplete
|
|
3168
|
+
* for the input as on Samsung smartphones the
|
|
3169
|
+
* autosuggestion overlaps the virtual keyboard
|
|
3170
|
+
*/
|
|
3171
|
+
disableInputAutocomplete: boolean;
|
|
3114
3172
|
/**
|
|
3115
3173
|
* If this is true, the webchat will apply
|
|
3116
3174
|
* generic styling to HTML message content.
|
|
3117
|
-
*
|
|
3118
3175
|
* This is e.g. useful if we are using HTML generated by Markdown.
|
|
3119
|
-
|
|
3176
|
+
*/
|
|
3120
3177
|
enableGenericHTMLStyling: boolean;
|
|
3121
3178
|
/**
|
|
3122
|
-
*
|
|
3123
|
-
|
|
3124
|
-
|
|
3179
|
+
* This setting is used to decide whether to
|
|
3180
|
+
* sanitize HTML content in the Webchat or not
|
|
3181
|
+
*/
|
|
3182
|
+
disableHtmlContentSanitization: boolean;
|
|
3125
3183
|
/**
|
|
3126
|
-
*
|
|
3184
|
+
* This setting is used to decide whether to
|
|
3185
|
+
* sanitize JavaScript from URL buttons /
|
|
3186
|
+
* Default Actions in the Webchat or not
|
|
3187
|
+
*/
|
|
3188
|
+
disableUrlButtonSanitization: boolean;
|
|
3189
|
+
/**
|
|
3190
|
+
* Advanced watermark settings for the webchat
|
|
3127
3191
|
*/
|
|
3128
|
-
|
|
3192
|
+
watermark: TWebchat3LayoutWatermark;
|
|
3129
3193
|
/**
|
|
3130
|
-
*
|
|
3194
|
+
* Advanced watermark text settings for the webchat
|
|
3131
3195
|
*/
|
|
3132
|
-
|
|
3196
|
+
watermarkText: string;
|
|
3197
|
+
}
|
|
3198
|
+
export interface IWebchat3EndpointColorsSettings {
|
|
3133
3199
|
/**
|
|
3134
|
-
* The
|
|
3135
|
-
|
|
3200
|
+
* The primary color of the webchat.
|
|
3201
|
+
*/
|
|
3202
|
+
primaryColor: string;
|
|
3203
|
+
/**
|
|
3204
|
+
* The secondary color of the webchat.
|
|
3205
|
+
*/
|
|
3206
|
+
secondaryColor: string;
|
|
3207
|
+
/**
|
|
3208
|
+
* The background color of the webchat.
|
|
3136
3209
|
*/
|
|
3137
|
-
|
|
3210
|
+
chatInterfaceColor: string;
|
|
3138
3211
|
/**
|
|
3139
|
-
*
|
|
3140
|
-
* (text is followed by the actual comment)
|
|
3212
|
+
* Bot message color
|
|
3141
3213
|
*/
|
|
3142
|
-
|
|
3214
|
+
botMessageColor: string;
|
|
3143
3215
|
/**
|
|
3144
|
-
*
|
|
3216
|
+
* User message color
|
|
3145
3217
|
*/
|
|
3146
|
-
|
|
3218
|
+
userMessageColor: string;
|
|
3147
3219
|
/**
|
|
3148
|
-
*
|
|
3149
|
-
* in the Webchat or not
|
|
3220
|
+
* Text link color
|
|
3150
3221
|
*/
|
|
3151
|
-
|
|
3222
|
+
textLinkColor: string;
|
|
3223
|
+
}
|
|
3224
|
+
export interface IWebchat3EndpointBehaviorSettings {
|
|
3152
3225
|
/**
|
|
3153
|
-
*
|
|
3226
|
+
* Whether to enable collecting
|
|
3227
|
+
* addtional meatadata from customers
|
|
3228
|
+
*/
|
|
3229
|
+
enableCollectMetadata: boolean;
|
|
3230
|
+
/**
|
|
3231
|
+
* Whether to enable typing indicators
|
|
3232
|
+
* when the bot is replying
|
|
3233
|
+
*/
|
|
3234
|
+
enableTypingIndicator: boolean;
|
|
3235
|
+
/**
|
|
3236
|
+
* The amount of ms per letter
|
|
3237
|
+
* typed in a message
|
|
3154
3238
|
*/
|
|
3239
|
+
messageDelay: number;
|
|
3240
|
+
/**
|
|
3241
|
+
* The placeholder text
|
|
3242
|
+
* we display in the input field
|
|
3243
|
+
*/
|
|
3244
|
+
inputPlaceholder: string;
|
|
3245
|
+
/**
|
|
3246
|
+
* Whether the webchat should use STT.
|
|
3247
|
+
*/
|
|
3248
|
+
enableSTT: boolean;
|
|
3249
|
+
/**
|
|
3250
|
+
* Whether the webchat should use
|
|
3251
|
+
* TTS and thereby display
|
|
3252
|
+
* a record button.
|
|
3253
|
+
*/
|
|
3254
|
+
enableTTS: boolean;
|
|
3255
|
+
/**
|
|
3256
|
+
* This setting is used to decide whether
|
|
3257
|
+
* the input should be focused right
|
|
3258
|
+
* after a postback button is pressed
|
|
3259
|
+
*/
|
|
3260
|
+
focusInputAfterPostback: boolean;
|
|
3261
|
+
/**
|
|
3262
|
+
* This setting is used to decide whether
|
|
3263
|
+
* a connectivity indicator should be displayed
|
|
3264
|
+
*/
|
|
3155
3265
|
enableConnectionStatusIndicator: boolean;
|
|
3266
|
+
}
|
|
3267
|
+
export interface IWebchat3EndpointStartBehaviorSettings {
|
|
3156
3268
|
/**
|
|
3157
|
-
*
|
|
3269
|
+
* The start behavior of the
|
|
3270
|
+
* webchat, e.g. whether a start button
|
|
3271
|
+
* should be rendered.
|
|
3158
3272
|
*/
|
|
3159
|
-
|
|
3273
|
+
startBehavior: TWebchat2StartBehavior;
|
|
3160
3274
|
/**
|
|
3161
|
-
*
|
|
3162
|
-
|
|
3163
|
-
|
|
3275
|
+
* The payload to send
|
|
3276
|
+
* when clicking the getStartedButton
|
|
3277
|
+
*/
|
|
3278
|
+
getStartedPayload: string;
|
|
3164
3279
|
/**
|
|
3165
|
-
*
|
|
3166
|
-
|
|
3167
|
-
|
|
3280
|
+
* The data that will be sent to the chat
|
|
3281
|
+
* when clicking the getStartedButton
|
|
3282
|
+
* or injecting it
|
|
3283
|
+
*/
|
|
3284
|
+
getStartedData: {};
|
|
3168
3285
|
/**
|
|
3169
|
-
*
|
|
3170
|
-
|
|
3171
|
-
|
|
3286
|
+
* The text to display in the chat
|
|
3287
|
+
* when clicking the getStartedButton
|
|
3288
|
+
*/
|
|
3289
|
+
getStartedText: string;
|
|
3172
3290
|
/**
|
|
3173
|
-
* The text
|
|
3174
|
-
|
|
3175
|
-
|
|
3291
|
+
* The text to display on
|
|
3292
|
+
* the get started button
|
|
3293
|
+
*/
|
|
3294
|
+
getStartedButtonText: string;
|
|
3295
|
+
}
|
|
3296
|
+
export interface IWebchat3EndpointBusinessHoursTimeSettings {
|
|
3176
3297
|
/**
|
|
3177
|
-
*
|
|
3298
|
+
* Start time of the business hours, e.g. 09:00
|
|
3178
3299
|
*/
|
|
3179
|
-
|
|
3300
|
+
startTime: string;
|
|
3180
3301
|
/**
|
|
3181
|
-
*
|
|
3302
|
+
* End time of the business hours, e.g. 17:00
|
|
3182
3303
|
*/
|
|
3183
|
-
|
|
3304
|
+
endTime: string;
|
|
3184
3305
|
/**
|
|
3185
|
-
*
|
|
3306
|
+
* Week day of the business hours in lower case, e.g. "monday"
|
|
3186
3307
|
*/
|
|
3187
|
-
|
|
3308
|
+
weekDay: string;
|
|
3309
|
+
}
|
|
3310
|
+
export interface IWebchat3EndpointBusinessHoursSettings {
|
|
3188
3311
|
/**
|
|
3189
|
-
*
|
|
3190
|
-
|
|
3191
|
-
|
|
3312
|
+
* Whether the Office Hours are enabled
|
|
3313
|
+
*/
|
|
3314
|
+
enabled: boolean;
|
|
3192
3315
|
/**
|
|
3193
|
-
*
|
|
3194
|
-
|
|
3195
|
-
|
|
3316
|
+
* The business hours mode. Possible values are:
|
|
3317
|
+
* "hide" - The chat window will be hidden out of business hours
|
|
3318
|
+
* "disable" - The message bubble will be disabled with a mouse over text out of business hours
|
|
3319
|
+
* "inform" - The Webchat Widget will start normally, but show an out of business hours message
|
|
3320
|
+
*/
|
|
3321
|
+
mode: TWebchat3Mode;
|
|
3196
3322
|
/**
|
|
3197
|
-
*
|
|
3198
|
-
|
|
3199
|
-
|
|
3323
|
+
* The text that is displayed in the mouse over
|
|
3324
|
+
* text of the bubble or the out of business hours message
|
|
3325
|
+
*/
|
|
3326
|
+
text: string;
|
|
3200
3327
|
/**
|
|
3201
|
-
*
|
|
3202
|
-
|
|
3203
|
-
|
|
3328
|
+
* The title that is displayed to the user in the
|
|
3329
|
+
* information when opening the bot out of business hours
|
|
3330
|
+
*/
|
|
3331
|
+
title: string;
|
|
3204
3332
|
/**
|
|
3205
|
-
*
|
|
3206
|
-
|
|
3207
|
-
|
|
3333
|
+
* The timezone that is used to calculate of the user is
|
|
3334
|
+
* calling out of business hours
|
|
3335
|
+
*/
|
|
3336
|
+
timeZone: string;
|
|
3337
|
+
times: IWebchat3EndpointBusinessHoursTimeSettings[];
|
|
3338
|
+
}
|
|
3339
|
+
export interface IWebchat3EndpointUnreadMessagesSettings {
|
|
3208
3340
|
/**
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3341
|
+
* This setting is used to decide whether unread messages
|
|
3342
|
+
* should be indicated in the title of a minimized webchat widget
|
|
3343
|
+
*/
|
|
3344
|
+
enableIndicator: boolean;
|
|
3212
3345
|
/**
|
|
3213
|
-
* This setting is used to
|
|
3214
|
-
|
|
3215
|
-
|
|
3346
|
+
* This setting is used to decide whether a badge with the number
|
|
3347
|
+
* of unread messages should be displayed in the minimized webchat widget
|
|
3348
|
+
*/
|
|
3349
|
+
enableBadge: boolean;
|
|
3216
3350
|
/**
|
|
3217
|
-
*
|
|
3218
|
-
|
|
3219
|
-
|
|
3351
|
+
* This setting is used to decide whether to show a message preview
|
|
3352
|
+
* for incoming messages if the webchat widget is minimized
|
|
3353
|
+
*/
|
|
3354
|
+
enablePreview: boolean;
|
|
3220
3355
|
/**
|
|
3221
|
-
*
|
|
3222
|
-
|
|
3223
|
-
|
|
3356
|
+
* This setting is used to decide whether a sound should be triggered
|
|
3357
|
+
* for incoming messages if the webchat widget is minimized
|
|
3358
|
+
*/
|
|
3359
|
+
enableSound: boolean;
|
|
3360
|
+
}
|
|
3361
|
+
export interface IWebchat3EndpointHomeScreenSettings {
|
|
3224
3362
|
/**
|
|
3225
|
-
*
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
|
|
3230
|
-
|
|
3231
|
-
|
|
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;
|
|
3363
|
+
* Whether the Home Screen is enabled
|
|
3364
|
+
*/
|
|
3365
|
+
enabled: boolean;
|
|
3366
|
+
/**
|
|
3367
|
+
* The welcome text that is displayed in the Home Screen
|
|
3368
|
+
*/
|
|
3369
|
+
welcomeText: string;
|
|
3370
|
+
background: {
|
|
3239
3371
|
/**
|
|
3240
|
-
* The
|
|
3241
|
-
|
|
3242
|
-
|
|
3372
|
+
* The background image url of the Home Screen
|
|
3373
|
+
*/
|
|
3374
|
+
imageUrl: string;
|
|
3243
3375
|
/**
|
|
3244
|
-
* The
|
|
3245
|
-
|
|
3246
|
-
|
|
3376
|
+
* The background color of the Home Screen
|
|
3377
|
+
*/
|
|
3378
|
+
color: string;
|
|
3247
3379
|
};
|
|
3248
3380
|
/**
|
|
3249
|
-
*
|
|
3250
|
-
|
|
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
|
-
}[];
|
|
3381
|
+
* The text of the start conversation button
|
|
3382
|
+
*/
|
|
3383
|
+
startConversationButtonText: string;
|
|
3384
|
+
previousConversations: {
|
|
3269
3385
|
/**
|
|
3270
|
-
* Whether the
|
|
3271
|
-
|
|
3386
|
+
* Whether the previous conversations are enabled
|
|
3387
|
+
*/
|
|
3272
3388
|
enabled: boolean;
|
|
3273
3389
|
/**
|
|
3274
|
-
* The
|
|
3275
|
-
|
|
3276
|
-
|
|
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;
|
|
3390
|
+
* The text of the previous conversations button
|
|
3391
|
+
*/
|
|
3392
|
+
buttonText: string;
|
|
3288
3393
|
/**
|
|
3289
|
-
* The title
|
|
3290
|
-
|
|
3394
|
+
* The title of the previous conversations title
|
|
3395
|
+
*/
|
|
3291
3396
|
title: string;
|
|
3292
3397
|
};
|
|
3398
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3293
3399
|
}
|
|
3294
|
-
|
|
3295
|
-
|
|
3296
|
-
|
|
3297
|
-
|
|
3298
|
-
|
|
3400
|
+
export interface IWebchat3EndpointTeaserMessageSettings {
|
|
3401
|
+
/**
|
|
3402
|
+
* teaser message text
|
|
3403
|
+
*/
|
|
3404
|
+
text: string;
|
|
3405
|
+
/**
|
|
3406
|
+
* teaser message button text
|
|
3407
|
+
*/
|
|
3408
|
+
showInChat: boolean;
|
|
3409
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3410
|
+
}
|
|
3411
|
+
export interface IWebchat3EndpointConversationStartersSettings {
|
|
3412
|
+
/**
|
|
3413
|
+
* Whether the conversation starters are enabled
|
|
3414
|
+
*/
|
|
3415
|
+
enabled: boolean;
|
|
3416
|
+
starters: {
|
|
3417
|
+
/**
|
|
3418
|
+
* The type of the conversation starter
|
|
3419
|
+
*/
|
|
3420
|
+
type: string;
|
|
3421
|
+
/**
|
|
3422
|
+
* The title of the conversation starter
|
|
3423
|
+
*/
|
|
3424
|
+
title: string;
|
|
3425
|
+
/**
|
|
3426
|
+
* The url of the conversation starter
|
|
3427
|
+
*/
|
|
3428
|
+
url: string;
|
|
3429
|
+
/**
|
|
3430
|
+
* The payload of the conversation starter
|
|
3431
|
+
*/
|
|
3432
|
+
payload: string;
|
|
3433
|
+
}[];
|
|
3434
|
+
}
|
|
3435
|
+
export interface IWebchat3EndpointChatOptionsSettings {
|
|
3436
|
+
/**
|
|
3437
|
+
* Whether the chat options are enabled
|
|
3438
|
+
*/
|
|
3439
|
+
enabled: boolean;
|
|
3440
|
+
/**
|
|
3441
|
+
* The title of the chat options
|
|
3442
|
+
*/
|
|
3443
|
+
title: string;
|
|
3444
|
+
/**
|
|
3445
|
+
* The quick reply of the chat options
|
|
3446
|
+
*/
|
|
3447
|
+
quickReplyOptions: {
|
|
3448
|
+
/**
|
|
3449
|
+
* Whether the quick reply is enabled
|
|
3450
|
+
*/
|
|
3451
|
+
enabled: boolean;
|
|
3452
|
+
/**
|
|
3453
|
+
* The title of the quick reply
|
|
3454
|
+
*/
|
|
3455
|
+
sectionTitle: string;
|
|
3456
|
+
/**
|
|
3457
|
+
* The configuration of the quick reply
|
|
3458
|
+
*/
|
|
3459
|
+
quickReplies: {
|
|
3460
|
+
type: string;
|
|
3461
|
+
title: string;
|
|
3462
|
+
url: string;
|
|
3463
|
+
payload: string;
|
|
3464
|
+
}[];
|
|
3465
|
+
};
|
|
3466
|
+
/**
|
|
3467
|
+
* Whether show the tts toggle
|
|
3468
|
+
*/
|
|
3469
|
+
showTTSToggle: boolean;
|
|
3470
|
+
/**
|
|
3471
|
+
* Whether activate the tts toggle
|
|
3472
|
+
*/
|
|
3473
|
+
activateTTSToggle: boolean;
|
|
3474
|
+
/**
|
|
3475
|
+
* The label of the tts toggle
|
|
3476
|
+
*/
|
|
3477
|
+
labelTTSToggle: string;
|
|
3478
|
+
/**
|
|
3479
|
+
* Rating configuration
|
|
3480
|
+
*/
|
|
3481
|
+
rating: {
|
|
3482
|
+
enabled: string;
|
|
3483
|
+
title: string;
|
|
3484
|
+
commentPlaceholder: string;
|
|
3485
|
+
submitButtonText: string;
|
|
3486
|
+
eventBannerText: string;
|
|
3487
|
+
};
|
|
3488
|
+
/**
|
|
3489
|
+
* The configuration of the chat options footer
|
|
3490
|
+
*/
|
|
3491
|
+
footer: {
|
|
3492
|
+
enabled: boolean;
|
|
3493
|
+
items: {
|
|
3494
|
+
title: string;
|
|
3495
|
+
url: string;
|
|
3496
|
+
}[];
|
|
3497
|
+
};
|
|
3498
|
+
}
|
|
3499
|
+
export interface IWebchat3EndpointPrivacyNoticeSettings {
|
|
3500
|
+
/**
|
|
3501
|
+
* Whether the privacy notice is enabled
|
|
3502
|
+
*/
|
|
3503
|
+
enabled: boolean;
|
|
3504
|
+
/**
|
|
3505
|
+
* The title of the privacy notice
|
|
3506
|
+
*/
|
|
3507
|
+
title: string;
|
|
3508
|
+
/**
|
|
3509
|
+
* The text of the privacy notice
|
|
3510
|
+
*/
|
|
3511
|
+
text: string;
|
|
3512
|
+
/**
|
|
3513
|
+
* the submit button text of the privacy notice
|
|
3514
|
+
*/
|
|
3515
|
+
submitButtonText: string;
|
|
3516
|
+
/**
|
|
3517
|
+
* the url text of the privacy notice
|
|
3518
|
+
*/
|
|
3519
|
+
urlText: string;
|
|
3520
|
+
/**
|
|
3521
|
+
* the url of the privacy notice
|
|
3522
|
+
*/
|
|
3523
|
+
url: string;
|
|
3524
|
+
}
|
|
3525
|
+
export interface IWebchat3EndpointMaintenanceSettings {
|
|
3526
|
+
/**
|
|
3527
|
+
* Whether the Maintenance mode is enabled
|
|
3528
|
+
*/
|
|
3529
|
+
enabled: boolean;
|
|
3530
|
+
/**
|
|
3531
|
+
* The maintenance mode. Possible values are:
|
|
3532
|
+
* "hide" - The chat window will be hidden during maintenance
|
|
3533
|
+
* "disable" - The message bubble will be disabled with a mouse over text during maintenance
|
|
3534
|
+
* "inform" - The Webchat Widget will start normally, but show a maintenance mode message
|
|
3535
|
+
*/
|
|
3536
|
+
mode: TWebchat3Mode;
|
|
3537
|
+
/**
|
|
3538
|
+
* The text that is displayed in the mouse over text of the bubble or the maintenance mode message
|
|
3539
|
+
*/
|
|
3540
|
+
text: string;
|
|
3541
|
+
/**
|
|
3542
|
+
* The title that is displayed to the user in the information when opening the bot during maintenance
|
|
3543
|
+
*/
|
|
3544
|
+
title: string;
|
|
3545
|
+
}
|
|
3546
|
+
export interface IWebchat3EndpointDemoWebchatSettings {
|
|
3547
|
+
/**
|
|
3548
|
+
* Whether the Demo Webchat is enabled
|
|
3549
|
+
*/
|
|
3550
|
+
enabled: boolean;
|
|
3551
|
+
/**
|
|
3552
|
+
* Background image url of the Demo Webchat
|
|
3553
|
+
*/
|
|
3554
|
+
backgroundImageUrl: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* Position of the Demo Webchat
|
|
3557
|
+
*/
|
|
3558
|
+
position: TWebchat3DemoWebchatPosition;
|
|
3559
|
+
/**
|
|
3560
|
+
* Whether the Demo Webchat is draggable
|
|
3561
|
+
|
|
3562
|
+
*/
|
|
3563
|
+
shouldOverwriteWebchatBundleUrl: boolean;
|
|
3564
|
+
/**
|
|
3565
|
+
* The webchat bundle URL for demo webchat
|
|
3566
|
+
*/
|
|
3567
|
+
webchatBundleUrl: string;
|
|
3568
|
+
}
|
|
3569
|
+
export interface IWebchat3EndpointSettings {
|
|
3570
|
+
/**
|
|
3571
|
+
* control the layout of the Webchat Widget
|
|
3572
|
+
*/
|
|
3573
|
+
layout: IWebchat3EndpointLayoutSettings;
|
|
3574
|
+
/**
|
|
3575
|
+
* control the colors of the Webchat Widget
|
|
3576
|
+
*/
|
|
3577
|
+
colors: IWebchat3EndpointColorsSettings;
|
|
3578
|
+
/**
|
|
3579
|
+
* control the behavior of the Webchat Widget
|
|
3580
|
+
*/
|
|
3581
|
+
behavior: IWebchat3EndpointBehaviorSettings;
|
|
3582
|
+
/**
|
|
3583
|
+
* control the start behavior of the Webchat Widget
|
|
3584
|
+
*/
|
|
3585
|
+
startBehavior: IWebchat3EndpointStartBehaviorSettings;
|
|
3586
|
+
/**
|
|
3587
|
+
* Settings to store attachments at a cloud provider
|
|
3588
|
+
*/
|
|
3589
|
+
fileStorageSettings?: IFileStorageSettings;
|
|
3590
|
+
/**
|
|
3591
|
+
* Office Hours configuration for the Webchat Widget
|
|
3592
|
+
*/
|
|
3593
|
+
businessHours: IWebchat3EndpointBusinessHoursSettings;
|
|
3594
|
+
/**
|
|
3595
|
+
* Control the unread messages of the Webchat Widget
|
|
3596
|
+
*/
|
|
3597
|
+
unreadMessages: IWebchat3EndpointUnreadMessagesSettings;
|
|
3598
|
+
/**
|
|
3599
|
+
* Control the home screen of the Webchat Widget
|
|
3600
|
+
*/
|
|
3601
|
+
homeScreen: IWebchat3EndpointHomeScreenSettings;
|
|
3602
|
+
/**
|
|
3603
|
+
* Control the teaser message of the Webchat Widget
|
|
3604
|
+
*/
|
|
3605
|
+
teaserMessage: IWebchat3EndpointTeaserMessageSettings;
|
|
3606
|
+
/**
|
|
3607
|
+
* Control the conversation starters of the Webchat Widget
|
|
3608
|
+
*/
|
|
3609
|
+
conversationStarters: IWebchat3EndpointConversationStartersSettings;
|
|
3610
|
+
/**
|
|
3611
|
+
* Control the chat options of the Webchat Widget
|
|
3612
|
+
*/
|
|
3613
|
+
chatOptions: IWebchat3EndpointChatOptionsSettings;
|
|
3614
|
+
/**
|
|
3615
|
+
* Control the privacy notice of the Webchat Widget
|
|
3616
|
+
*/
|
|
3617
|
+
privacyNotice: IWebchat3EndpointPrivacyNoticeSettings;
|
|
3618
|
+
/**
|
|
3619
|
+
* Webchat Widget custom settings
|
|
3620
|
+
*/
|
|
3621
|
+
customJSON?: string;
|
|
3622
|
+
/**
|
|
3623
|
+
* Wwbchat Plugins
|
|
3624
|
+
*/
|
|
3625
|
+
pluginUrls?: string[];
|
|
3626
|
+
/**
|
|
3627
|
+
* The maximum allowed size of the attachment
|
|
3628
|
+
*/
|
|
3629
|
+
fileAttachmentMaxSize: number;
|
|
3630
|
+
/**
|
|
3631
|
+
* Maintenance mode configuration for the Webchat Widget
|
|
3632
|
+
*/
|
|
3633
|
+
maintenance: IWebchat3EndpointMaintenanceSettings;
|
|
3634
|
+
/**
|
|
3635
|
+
* Control the demo webchat of the Webchat Widget
|
|
3636
|
+
*/
|
|
3637
|
+
demoWebchat: IWebchat3EndpointDemoWebchatSettings;
|
|
3638
|
+
}
|
|
3639
|
+
/**
|
|
3640
|
+
* Setting to enable rating for the Webchat.
|
|
3641
|
+
* Valid types are:
|
|
3642
|
+
* - onRequest: Rating can be given after a request was sent from the flow
|
|
3643
|
+
* - once: Rating can be given at any time, once per session
|
|
3299
3644
|
* - always: Rating can be given at any time
|
|
3300
3645
|
*/
|
|
3301
3646
|
export declare type TWebchatEnableRating = "always" | "once" | "onRequest";
|
|
@@ -3309,6 +3654,9 @@ export declare type TWebchatEnableRating = "always" | "once" | "onRequest";
|
|
|
3309
3654
|
* Flow when the Webchat connects
|
|
3310
3655
|
*/
|
|
3311
3656
|
export declare type TWebchat2StartBehavior = "none" | "button" | "injection";
|
|
3657
|
+
export declare type TWebchat3Mode = "inform" | "hide" | "disable";
|
|
3658
|
+
export declare type TWebchat3LayoutWatermark = "default" | "custom" | "none";
|
|
3659
|
+
export declare type TWebchat3DemoWebchatPosition = "centered" | "bottomRight";
|
|
3312
3660
|
export interface IAmazonLexEndpointSettings {
|
|
3313
3661
|
/**
|
|
3314
3662
|
* Whether to reparse slots found
|
|
@@ -3396,32 +3744,215 @@ export interface IWhatsAppEndpointSettings extends IEndpointSessionSettings {
|
|
|
3396
3744
|
fileStorageSettings?: IFileStorageSettings;
|
|
3397
3745
|
}
|
|
3398
3746
|
export interface IFileStorageSettings {
|
|
3747
|
+
enabled?: boolean;
|
|
3748
|
+
dropzoneText?: string;
|
|
3399
3749
|
storageProvider: "none" | "aws" | "azure" | "googleCloud";
|
|
3400
3750
|
awsConnection?: string;
|
|
3401
3751
|
azureConnection?: string;
|
|
3402
3752
|
googleCloudConnection?: string;
|
|
3403
3753
|
}
|
|
3754
|
+
/**
|
|
3755
|
+
* @openapi
|
|
3756
|
+
*
|
|
3757
|
+
* components:
|
|
3758
|
+
* schemas:
|
|
3759
|
+
* IMediaAttachment:
|
|
3760
|
+
* type: object
|
|
3761
|
+
* properties:
|
|
3762
|
+
* name:
|
|
3763
|
+
* type: string
|
|
3764
|
+
* caption:
|
|
3765
|
+
* type: string
|
|
3766
|
+
* url:
|
|
3767
|
+
* type: string
|
|
3768
|
+
* type:
|
|
3769
|
+
* type: string
|
|
3770
|
+
* required:
|
|
3771
|
+
* - name
|
|
3772
|
+
* - url
|
|
3773
|
+
* - type
|
|
3774
|
+
*/
|
|
3404
3775
|
export interface IMediaAttachment {
|
|
3405
3776
|
name: string;
|
|
3406
3777
|
caption?: string;
|
|
3407
3778
|
url: string;
|
|
3408
3779
|
type: string;
|
|
3409
3780
|
}
|
|
3781
|
+
/**
|
|
3782
|
+
* @openapi
|
|
3783
|
+
*
|
|
3784
|
+
* components:
|
|
3785
|
+
* schemas:
|
|
3786
|
+
* IFileAttachment:
|
|
3787
|
+
* allOf:
|
|
3788
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3789
|
+
* - type: object
|
|
3790
|
+
* properties:
|
|
3791
|
+
* type:
|
|
3792
|
+
* type: string
|
|
3793
|
+
* enum: [file, document]
|
|
3794
|
+
* required:
|
|
3795
|
+
* - type
|
|
3796
|
+
*/
|
|
3410
3797
|
export interface IFileAttachment extends IMediaAttachment {
|
|
3411
3798
|
type: "file" | "document";
|
|
3412
3799
|
}
|
|
3800
|
+
/**
|
|
3801
|
+
* @openapi
|
|
3802
|
+
*
|
|
3803
|
+
* components:
|
|
3804
|
+
* schemas:
|
|
3805
|
+
* IImageAttachment:
|
|
3806
|
+
* allOf:
|
|
3807
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3808
|
+
* - type: object
|
|
3809
|
+
* properties:
|
|
3810
|
+
* type:
|
|
3811
|
+
* type: string
|
|
3812
|
+
* enum: [image]
|
|
3813
|
+
* required:
|
|
3814
|
+
* - type
|
|
3815
|
+
*/
|
|
3413
3816
|
export interface IImageAttachment extends IMediaAttachment {
|
|
3414
3817
|
type: "image";
|
|
3415
3818
|
}
|
|
3819
|
+
/**
|
|
3820
|
+
* @openapi
|
|
3821
|
+
*
|
|
3822
|
+
* components:
|
|
3823
|
+
* schemas:
|
|
3824
|
+
* IStickerAttachment:
|
|
3825
|
+
* allOf:
|
|
3826
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3827
|
+
* - type: object
|
|
3828
|
+
* properties:
|
|
3829
|
+
* type:
|
|
3830
|
+
* type: string
|
|
3831
|
+
* enum: [sticker]
|
|
3832
|
+
* required:
|
|
3833
|
+
* - type
|
|
3834
|
+
*/
|
|
3416
3835
|
export interface IStickerAttachment extends IMediaAttachment {
|
|
3417
3836
|
type: "sticker";
|
|
3418
3837
|
}
|
|
3838
|
+
/**
|
|
3839
|
+
* @openapi
|
|
3840
|
+
*
|
|
3841
|
+
* components:
|
|
3842
|
+
* schemas:
|
|
3843
|
+
* IVideoAttachment:
|
|
3844
|
+
* allOf:
|
|
3845
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3846
|
+
* - type: object
|
|
3847
|
+
* properties:
|
|
3848
|
+
* type:
|
|
3849
|
+
* type: string
|
|
3850
|
+
* enum: [video]
|
|
3851
|
+
* required:
|
|
3852
|
+
* - type
|
|
3853
|
+
*/
|
|
3419
3854
|
export interface IVideoAttachment extends IMediaAttachment {
|
|
3420
3855
|
type: "video";
|
|
3421
3856
|
}
|
|
3857
|
+
/**
|
|
3858
|
+
* @openapi
|
|
3859
|
+
*
|
|
3860
|
+
* components:
|
|
3861
|
+
* schemas:
|
|
3862
|
+
* IAudioAttachment:
|
|
3863
|
+
* allOf:
|
|
3864
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3865
|
+
* - type: object
|
|
3866
|
+
* properties:
|
|
3867
|
+
* type:
|
|
3868
|
+
* type: string
|
|
3869
|
+
* enum: [audio]
|
|
3870
|
+
* required:
|
|
3871
|
+
* - type
|
|
3872
|
+
*/
|
|
3422
3873
|
export interface IAudioAttachment extends IMediaAttachment {
|
|
3423
3874
|
type: "audio";
|
|
3424
3875
|
}
|
|
3876
|
+
/**
|
|
3877
|
+
* @openapi
|
|
3878
|
+
*
|
|
3879
|
+
* components:
|
|
3880
|
+
* schemas:
|
|
3881
|
+
* IContactAttachment:
|
|
3882
|
+
* type: object
|
|
3883
|
+
* properties:
|
|
3884
|
+
* type:
|
|
3885
|
+
* type: string
|
|
3886
|
+
* enum: [contact]
|
|
3887
|
+
* addresses:
|
|
3888
|
+
* type: array
|
|
3889
|
+
* items:
|
|
3890
|
+
* type: object
|
|
3891
|
+
* properties:
|
|
3892
|
+
* city:
|
|
3893
|
+
* type: string
|
|
3894
|
+
* country:
|
|
3895
|
+
* type: string
|
|
3896
|
+
* countryCode:
|
|
3897
|
+
* type: string
|
|
3898
|
+
* state:
|
|
3899
|
+
* type: string
|
|
3900
|
+
* street:
|
|
3901
|
+
* type: string
|
|
3902
|
+
* type:
|
|
3903
|
+
* type: string
|
|
3904
|
+
* enum: [HOME, WORK]
|
|
3905
|
+
* zip:
|
|
3906
|
+
* type: string
|
|
3907
|
+
* postOfficeBox:
|
|
3908
|
+
* type: string
|
|
3909
|
+
* extendedAddress:
|
|
3910
|
+
* type: string
|
|
3911
|
+
* latitude:
|
|
3912
|
+
* type: number
|
|
3913
|
+
* longitude:
|
|
3914
|
+
* type: number
|
|
3915
|
+
* birthday:
|
|
3916
|
+
* type: string
|
|
3917
|
+
* emails:
|
|
3918
|
+
* type: array
|
|
3919
|
+
* items:
|
|
3920
|
+
* type: object
|
|
3921
|
+
* properties:
|
|
3922
|
+
* email:
|
|
3923
|
+
* type: string
|
|
3924
|
+
* type:
|
|
3925
|
+
* type: string
|
|
3926
|
+
* enum: [HOME, WORK]
|
|
3927
|
+
* urls:
|
|
3928
|
+
* type: array
|
|
3929
|
+
* items:
|
|
3930
|
+
* type: object
|
|
3931
|
+
* properties:
|
|
3932
|
+
* url:
|
|
3933
|
+
* type: string
|
|
3934
|
+
* type:
|
|
3935
|
+
* type: string
|
|
3936
|
+
* enum: [HOME, WORK]
|
|
3937
|
+
* photos:
|
|
3938
|
+
* type: array
|
|
3939
|
+
* items:
|
|
3940
|
+
* type: string
|
|
3941
|
+
* gender:
|
|
3942
|
+
* type: string
|
|
3943
|
+
* languages:
|
|
3944
|
+
* type: array
|
|
3945
|
+
* items:
|
|
3946
|
+
* type: string
|
|
3947
|
+
* timeZone:
|
|
3948
|
+
* type: string
|
|
3949
|
+
* notes:
|
|
3950
|
+
* type: array
|
|
3951
|
+
* items:
|
|
3952
|
+
* type: string
|
|
3953
|
+
* required:
|
|
3954
|
+
* - type
|
|
3955
|
+
*/
|
|
3425
3956
|
export interface IContactAttachment {
|
|
3426
3957
|
type: "contact";
|
|
3427
3958
|
addresses?: {
|
|
@@ -3472,6 +4003,32 @@ export interface IContactAttachment {
|
|
|
3472
4003
|
timeZone?: string;
|
|
3473
4004
|
notes?: string[];
|
|
3474
4005
|
}
|
|
4006
|
+
/**
|
|
4007
|
+
* @openapi
|
|
4008
|
+
*
|
|
4009
|
+
* components:
|
|
4010
|
+
* schemas:
|
|
4011
|
+
* ILocationAttachment:
|
|
4012
|
+
* type: object
|
|
4013
|
+
* properties:
|
|
4014
|
+
* type:
|
|
4015
|
+
* type: string
|
|
4016
|
+
* enum: [location]
|
|
4017
|
+
* latitude:
|
|
4018
|
+
* type: number
|
|
4019
|
+
* longitude:
|
|
4020
|
+
* type: number
|
|
4021
|
+
* name:
|
|
4022
|
+
* type: string
|
|
4023
|
+
* title:
|
|
4024
|
+
* type: string
|
|
4025
|
+
* address:
|
|
4026
|
+
* type: string
|
|
4027
|
+
* required:
|
|
4028
|
+
* - type
|
|
4029
|
+
* - latitude
|
|
4030
|
+
* - longitude
|
|
4031
|
+
*/
|
|
3475
4032
|
export interface ILocationAttachment {
|
|
3476
4033
|
type: "location";
|
|
3477
4034
|
latitude: number;
|
|
@@ -3480,8 +4037,23 @@ export interface ILocationAttachment {
|
|
|
3480
4037
|
title?: string;
|
|
3481
4038
|
address?: string;
|
|
3482
4039
|
}
|
|
3483
|
-
export declare type
|
|
3484
|
-
|
|
4040
|
+
export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
|
|
4041
|
+
/**
|
|
4042
|
+
* @openapi
|
|
4043
|
+
*
|
|
4044
|
+
* components:
|
|
4045
|
+
* schemas:
|
|
4046
|
+
* TAttachments:
|
|
4047
|
+
* oneOf:
|
|
4048
|
+
* - $ref: '#/components/schemas/IFileAttachment'
|
|
4049
|
+
* - $ref: '#/components/schemas/IImageAttachment'
|
|
4050
|
+
* - $ref: '#/components/schemas/IVideoAttachment'
|
|
4051
|
+
* - $ref: '#/components/schemas/IAudioAttachment'
|
|
4052
|
+
* - $ref: '#/components/schemas/IStickerAttachment'
|
|
4053
|
+
* - $ref: '#/components/schemas/IContactAttachment'
|
|
4054
|
+
* - $ref: '#/components/schemas/ILocationAttachment'
|
|
4055
|
+
*/
|
|
4056
|
+
export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
|
|
3485
4057
|
export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
|
|
3486
4058
|
/** The base 8x8 server url */
|
|
3487
4059
|
baseUrl: string;
|
|
@@ -3524,24 +4096,74 @@ declare const generativeAIModels: readonly [
|
|
|
3524
4096
|
"gpt-3.5-turbo",
|
|
3525
4097
|
"gpt-3.5-turbo-instruct",
|
|
3526
4098
|
"gpt-4",
|
|
3527
|
-
"
|
|
3528
|
-
"
|
|
4099
|
+
"gpt-4o",
|
|
4100
|
+
"gpt-4o-mini",
|
|
3529
4101
|
"luminous-extended-control",
|
|
3530
|
-
"luminous-embedding-128",
|
|
3531
4102
|
"claude-v1-100k",
|
|
3532
4103
|
"claude-instant-v1",
|
|
3533
|
-
"
|
|
4104
|
+
"claude-3-opus-20240229",
|
|
4105
|
+
"claude-3-haiku-20240307",
|
|
4106
|
+
"claude-3-sonnet-20240229",
|
|
4107
|
+
"text-bison@001",
|
|
4108
|
+
"custom-model",
|
|
4109
|
+
"gemini-1.0-pro",
|
|
4110
|
+
"text-embedding-3-small",
|
|
4111
|
+
"text-embedding-3-large",
|
|
4112
|
+
"text-embedding-ada-002",
|
|
4113
|
+
"luminous-embedding-128"
|
|
3534
4114
|
];
|
|
3535
|
-
|
|
4115
|
+
/**
|
|
4116
|
+
* @openapi
|
|
4117
|
+
*
|
|
4118
|
+
* components:
|
|
4119
|
+
* schemas:
|
|
4120
|
+
* TGenerativeAIModels:
|
|
4121
|
+
* type: string
|
|
4122
|
+
* enum:
|
|
4123
|
+
* - gpt-3.5-turbo
|
|
4124
|
+
* - gpt-3.5-turbo-instruct
|
|
4125
|
+
* - gpt-4
|
|
4126
|
+
* - gpt-4o
|
|
4127
|
+
* - gpt-4o-mini
|
|
4128
|
+
* - text-embedding-ada-002
|
|
4129
|
+
* - luminous-extended-control
|
|
4130
|
+
* - luminous-embedding-128
|
|
4131
|
+
* - claude-v1-100k
|
|
4132
|
+
* - claude-instant-v1
|
|
4133
|
+
* - claude-3-opus-20240229
|
|
4134
|
+
* - text-bison@001
|
|
4135
|
+
* - custom-model
|
|
4136
|
+
* - gemini-1.0-pro
|
|
4137
|
+
*/
|
|
4138
|
+
export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
|
|
3536
4139
|
declare const generativeAIProviders: readonly [
|
|
3537
4140
|
"azureOpenAI",
|
|
3538
4141
|
"openAI",
|
|
3539
4142
|
"alephAlpha",
|
|
3540
4143
|
"anthropic",
|
|
3541
|
-
"googleVertexAI"
|
|
4144
|
+
"googleVertexAI",
|
|
4145
|
+
"googleGemini",
|
|
4146
|
+
"awsBedrock"
|
|
3542
4147
|
];
|
|
3543
|
-
|
|
4148
|
+
/**
|
|
4149
|
+
* @openapi
|
|
4150
|
+
*
|
|
4151
|
+
* components:
|
|
4152
|
+
* schemas:
|
|
4153
|
+
* TGenerativeAIProviders:
|
|
4154
|
+
* type: string
|
|
4155
|
+
* enum:
|
|
4156
|
+
* - azureOpenAI
|
|
4157
|
+
* - openAI
|
|
4158
|
+
* - anthropic
|
|
4159
|
+
* - googleVertexAI
|
|
4160
|
+
* - googleGemini
|
|
4161
|
+
* - alephAlpha
|
|
4162
|
+
* - awsBedrock
|
|
4163
|
+
*/
|
|
4164
|
+
export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
|
|
3544
4165
|
declare const generativeAIUseCases: readonly [
|
|
4166
|
+
"nlu",
|
|
3545
4167
|
"knowledgeSearch",
|
|
3546
4168
|
"gptPromptNode",
|
|
3547
4169
|
"gptConversation",
|
|
@@ -3550,9 +4172,16 @@ declare const generativeAIUseCases: readonly [
|
|
|
3550
4172
|
"intentSentenceGeneration",
|
|
3551
4173
|
"flowGeneration",
|
|
3552
4174
|
"generateNodeOutput",
|
|
3553
|
-
"lexiconGeneration"
|
|
4175
|
+
"lexiconGeneration",
|
|
4176
|
+
"answerExtraction"
|
|
3554
4177
|
];
|
|
3555
4178
|
export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
|
|
4179
|
+
declare const modeType: readonly [
|
|
4180
|
+
"chat",
|
|
4181
|
+
"completion",
|
|
4182
|
+
"embedding"
|
|
4183
|
+
];
|
|
4184
|
+
export declare type TModeType = typeof modeType[number];
|
|
3556
4185
|
export interface IGenerativeAIUseCaseSettings {
|
|
3557
4186
|
largeLanguageModelId: string | null;
|
|
3558
4187
|
temperature: number;
|
|
@@ -4206,6 +4835,14 @@ export interface ISharedSettings_2_0 {
|
|
|
4206
4835
|
* $ref: '#/components/schemas/IAudioPreviewSettings_2_0'
|
|
4207
4836
|
* generativeAISettings:
|
|
4208
4837
|
* $ref: '#/components/schemas/IGenerativeAIModelSettings_2_0'
|
|
4838
|
+
* currencySettings:
|
|
4839
|
+
* type: object
|
|
4840
|
+
* properties:
|
|
4841
|
+
* currency:
|
|
4842
|
+
* type: string
|
|
4843
|
+
* example: "USD"
|
|
4844
|
+
* knowledgeAISettings:
|
|
4845
|
+
* $ref: '#/components/schemas/IKnowledgeAISettings_2_0'
|
|
4209
4846
|
*
|
|
4210
4847
|
* IAgentSettings_2_0:
|
|
4211
4848
|
* allOf:
|
|
@@ -4230,6 +4867,10 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
|
|
|
4230
4867
|
translationSettings: IAgentTranslationSettings_2_0;
|
|
4231
4868
|
audioPreviewSettings: IAudioPreviewSettings_2_0;
|
|
4232
4869
|
generativeAISettings: IGenerativeAISettings_2_0;
|
|
4870
|
+
currencySettings: {
|
|
4871
|
+
currency: string;
|
|
4872
|
+
};
|
|
4873
|
+
knowledgeAISettings: IKnowledgeAISettings_2_0;
|
|
4233
4874
|
}
|
|
4234
4875
|
/**
|
|
4235
4876
|
* @openapi
|
|
@@ -4376,6 +5017,9 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
4376
5017
|
* - azureOpenAI
|
|
4377
5018
|
* - anthropic
|
|
4378
5019
|
* - googleVertexAI
|
|
5020
|
+
* - googleGemini
|
|
5021
|
+
* - alephAlpha
|
|
5022
|
+
* - awsBedrock
|
|
4379
5023
|
*/
|
|
4380
5024
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
4381
5025
|
/**
|
|
@@ -4414,6 +5058,40 @@ export interface IGenerativeAISettings_2_0 {
|
|
|
4414
5058
|
[key in TGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
|
|
4415
5059
|
};
|
|
4416
5060
|
}
|
|
5061
|
+
/**
|
|
5062
|
+
* @openapi
|
|
5063
|
+
*
|
|
5064
|
+
* components:
|
|
5065
|
+
* schemas:
|
|
5066
|
+
* TFileExtractorOptions_2_0:
|
|
5067
|
+
* type: string
|
|
5068
|
+
* description: Options for the Knowledge AI File Extractor
|
|
5069
|
+
* enum:
|
|
5070
|
+
* - default
|
|
5071
|
+
* - legacy
|
|
5072
|
+
* - azure
|
|
5073
|
+
*/
|
|
5074
|
+
export declare type TFileExtractorOptions_2_0 = "default" | "legacy" | "azure";
|
|
5075
|
+
/**
|
|
5076
|
+
* @openapi
|
|
5077
|
+
*
|
|
5078
|
+
* components:
|
|
5079
|
+
* schemas:
|
|
5080
|
+
* IKnowledgeAISettings_2_0:
|
|
5081
|
+
* type: object
|
|
5082
|
+
* properties:
|
|
5083
|
+
* fileExtractor:
|
|
5084
|
+
* $ref: '#/components/schemas/TFileExtractorOptions_2_0'
|
|
5085
|
+
* azureDIConnectionId:
|
|
5086
|
+
* type: string
|
|
5087
|
+
* description: ReferenceId of the Azure AI Document Intelligence Connection
|
|
5088
|
+
* example: "f66e99eb-db8f-433c-977f-69160d9a6bdb"
|
|
5089
|
+
*
|
|
5090
|
+
*/
|
|
5091
|
+
export interface IKnowledgeAISettings_2_0 {
|
|
5092
|
+
fileExtractor: TFileExtractorOptions_2_0;
|
|
5093
|
+
azureDIConnectionId?: string;
|
|
5094
|
+
}
|
|
4417
5095
|
/**
|
|
4418
5096
|
* @openapi
|
|
4419
5097
|
*
|
|
@@ -5502,16 +6180,22 @@ export interface IIndexLexiconEntriesRestReturnValue_2_0 extends ICursorBasedPag
|
|
|
5502
6180
|
* schemas:
|
|
5503
6181
|
* ILexiconEntryData_2_0:
|
|
5504
6182
|
* type: object
|
|
6183
|
+
* required:
|
|
6184
|
+
* - mainKeyphrase
|
|
5505
6185
|
* properties:
|
|
5506
6186
|
* data:
|
|
5507
6187
|
* type: string
|
|
5508
6188
|
* description: Additional JSON-data of the lexicon entry
|
|
5509
|
-
* example: {}
|
|
6189
|
+
* example: "{\"key1\": \"value1\" }"
|
|
5510
6190
|
* slotReferences:
|
|
5511
6191
|
* type: array
|
|
5512
6192
|
* description: The used slots by the lexicon entry
|
|
5513
6193
|
* items:
|
|
5514
6194
|
* $ref: '#/components/schemas/TMongoId'
|
|
6195
|
+
* mainKeyphrase:
|
|
6196
|
+
* type: string
|
|
6197
|
+
* description: the keyphrase value
|
|
6198
|
+
* example: pizza
|
|
5515
6199
|
*
|
|
5516
6200
|
* ILexiconEntryGeneratedData_2_0:
|
|
5517
6201
|
* type: object
|
|
@@ -5868,7 +6552,9 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
5868
6552
|
* description: The name of the endpoint
|
|
5869
6553
|
* example: New Endpoint
|
|
5870
6554
|
* entrypoint:
|
|
5871
|
-
*
|
|
6555
|
+
* type: string
|
|
6556
|
+
* description: The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.
|
|
6557
|
+
* example: 667ed4ae16d66f47dc2a9400
|
|
5872
6558
|
* active:
|
|
5873
6559
|
* type: boolean
|
|
5874
6560
|
* description: Toggle whether the endpoint is active or not
|
|
@@ -5894,12 +6580,6 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
5894
6580
|
* useAnalytics:
|
|
5895
6581
|
* type: boolean
|
|
5896
6582
|
* description: Whether we should store analytics for this endpoint
|
|
5897
|
-
* useChatbaseAnalytics:
|
|
5898
|
-
* type: boolean
|
|
5899
|
-
* description: Whether we should use Chatbase to collect analytics
|
|
5900
|
-
* chatbaseApikey:
|
|
5901
|
-
* type: string
|
|
5902
|
-
* description: The apikey for the Chatbase bot
|
|
5903
6583
|
* useDashbotAnalytics:
|
|
5904
6584
|
* type: boolean
|
|
5905
6585
|
* description: Whether we should use Dashbot to collect analytics
|
|
@@ -5908,6 +6588,9 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
5908
6588
|
* description: The apikey for the dashbot bot
|
|
5909
6589
|
* dashbotPlatform:
|
|
5910
6590
|
* type: string
|
|
6591
|
+
* disableInputSanitization:
|
|
6592
|
+
* type: string
|
|
6593
|
+
* description: If true, disables input text sanitization after Input Transformer
|
|
5911
6594
|
* overrideSnapshotConnections:
|
|
5912
6595
|
* type: boolean
|
|
5913
6596
|
* settings:
|
|
@@ -5979,6 +6662,8 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
5979
6662
|
* type: boolean
|
|
5980
6663
|
* dynamicImageAspectRatio:
|
|
5981
6664
|
* type: boolean
|
|
6665
|
+
* enableCollectMetadata:
|
|
6666
|
+
* type: boolean
|
|
5982
6667
|
* enableConnectionStatusIndicator:
|
|
5983
6668
|
* type: boolean
|
|
5984
6669
|
* enableDemoWebchat:
|
|
@@ -6186,6 +6871,13 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6186
6871
|
* agentAssistSettings:
|
|
6187
6872
|
* type: object
|
|
6188
6873
|
* properties:
|
|
6874
|
+
* copilotType:
|
|
6875
|
+
* type: string
|
|
6876
|
+
* enum:
|
|
6877
|
+
* - none
|
|
6878
|
+
* - workspace
|
|
6879
|
+
* - whisper
|
|
6880
|
+
* description: Copilot Type
|
|
6189
6881
|
* agentAssistFlowId:
|
|
6190
6882
|
* type: string
|
|
6191
6883
|
* description: Copilot flow ID
|
|
@@ -6245,10 +6937,6 @@ export interface IEndpoint_2_0 {
|
|
|
6245
6937
|
useContactProfiles: boolean;
|
|
6246
6938
|
/** Whether we should store analytics for this endpoint */
|
|
6247
6939
|
useAnalytics: boolean;
|
|
6248
|
-
/** Whether we should use Chatbase to collect analytics */
|
|
6249
|
-
useChatbaseAnalytics: boolean;
|
|
6250
|
-
/** The apikey for the Chatbase bot */
|
|
6251
|
-
chatbaseApikey: string;
|
|
6252
6940
|
/** Whether we should use Dashbot to collect analytics */
|
|
6253
6941
|
useDashbotAnalytics: boolean;
|
|
6254
6942
|
/** The apikey for the dashbot bot */
|
|
@@ -6260,6 +6948,10 @@ export interface IEndpoint_2_0 {
|
|
|
6260
6948
|
* is true.
|
|
6261
6949
|
*/
|
|
6262
6950
|
dashbotPlatform: TDashbotPlatform;
|
|
6951
|
+
/**
|
|
6952
|
+
* If set to `true`, disables input sanitization
|
|
6953
|
+
*/
|
|
6954
|
+
disableInputSanitization: boolean;
|
|
6263
6955
|
/**
|
|
6264
6956
|
* Optional endpoint specific settings e.g. Facebook Page token
|
|
6265
6957
|
*/
|
|
@@ -7641,6 +8333,7 @@ export interface IConnection extends IEntityMeta {
|
|
|
7641
8333
|
type: string;
|
|
7642
8334
|
projectReference: TMongoId;
|
|
7643
8335
|
organisationReference: TMongoId;
|
|
8336
|
+
isDeprecated: boolean;
|
|
7644
8337
|
}
|
|
7645
8338
|
export interface IGraphConnection {
|
|
7646
8339
|
type: "connection";
|
|
@@ -7649,23 +8342,36 @@ export interface IGraphConnection {
|
|
|
7649
8342
|
referenceId: string;
|
|
7650
8343
|
properties: Pick<IConnection, "type" | "extension" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
7651
8344
|
}
|
|
7652
|
-
export interface
|
|
7653
|
-
customModel
|
|
8345
|
+
export interface IOpenAIMeta {
|
|
8346
|
+
customModel?: string;
|
|
8347
|
+
}
|
|
8348
|
+
export interface IAlephAlphaMeta {
|
|
8349
|
+
customModel?: string;
|
|
8350
|
+
baseCustomUrl?: string | null;
|
|
7654
8351
|
}
|
|
7655
|
-
export interface
|
|
8352
|
+
export interface IAnthropicMeta {
|
|
8353
|
+
customModel?: string;
|
|
7656
8354
|
}
|
|
7657
|
-
export interface
|
|
8355
|
+
export interface IAwsBedrockMeta {
|
|
8356
|
+
region: string;
|
|
8357
|
+
customModel?: string;
|
|
7658
8358
|
}
|
|
7659
8359
|
export interface IAzureOpenAIMeta {
|
|
7660
8360
|
resourceName?: string;
|
|
7661
8361
|
deploymentName?: string;
|
|
7662
8362
|
baseCustomUrl?: string | null;
|
|
7663
8363
|
apiVersion?: string;
|
|
8364
|
+
customModel?: string;
|
|
7664
8365
|
}
|
|
7665
8366
|
export interface IGoogleVertexAIMeta {
|
|
7666
8367
|
location: string;
|
|
7667
8368
|
apiEndPoint: string;
|
|
7668
8369
|
publisher?: string;
|
|
8370
|
+
customModel?: string;
|
|
8371
|
+
}
|
|
8372
|
+
export interface IGoogleGeminiMeta {
|
|
8373
|
+
location: string;
|
|
8374
|
+
customModel?: string;
|
|
7669
8375
|
}
|
|
7670
8376
|
export interface ILargeLanguageModel extends IEntityMeta {
|
|
7671
8377
|
_id: TMongoId;
|
|
@@ -7673,6 +8379,8 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7673
8379
|
name: string;
|
|
7674
8380
|
description: string;
|
|
7675
8381
|
modelType: TGenerativeAIModels;
|
|
8382
|
+
modelGroup?: TModeType;
|
|
8383
|
+
isCustomModel?: boolean;
|
|
7676
8384
|
provider: TGenerativeAIProviders;
|
|
7677
8385
|
connectionId: string;
|
|
7678
8386
|
isDefault: boolean;
|
|
@@ -7680,8 +8388,11 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7680
8388
|
organisationReference: TMongoId;
|
|
7681
8389
|
azureOpenAI?: IAzureOpenAIMeta;
|
|
7682
8390
|
googleVertexAI?: IGoogleVertexAIMeta;
|
|
8391
|
+
googleGemini?: IGoogleGeminiMeta;
|
|
7683
8392
|
openAI?: IOpenAIMeta;
|
|
7684
8393
|
alephAlpha?: IAlephAlphaMeta;
|
|
8394
|
+
anthropic?: IAnthropicMeta;
|
|
8395
|
+
awsBedrock?: IAwsBedrockMeta;
|
|
7685
8396
|
}
|
|
7686
8397
|
export interface IGraphLargeLanguageModelDependencyAttachment {
|
|
7687
8398
|
_id: string;
|
|
@@ -7842,10 +8553,13 @@ export interface IHttpRequestNodeSharedConfig {
|
|
|
7842
8553
|
async: boolean;
|
|
7843
8554
|
cache: boolean;
|
|
7844
8555
|
cacheExpiry: number;
|
|
8556
|
+
timeout: number;
|
|
8557
|
+
retryAttempts: number;
|
|
7845
8558
|
storeResponseHeaders: boolean;
|
|
7846
8559
|
allowSelfSigned: boolean;
|
|
7847
8560
|
abortOnError: boolean;
|
|
7848
8561
|
errorLogging: "none" | "basic" | "full";
|
|
8562
|
+
debugLogging: "none" | "request" | "response" | "full";
|
|
7849
8563
|
logWarning: string;
|
|
7850
8564
|
}
|
|
7851
8565
|
export interface IHttpRequestNodeOAuthConfig extends IHttpRequestNodeSharedConfig {
|
|
@@ -7898,7 +8612,9 @@ declare const arrayTDebugEventTypes: readonly [
|
|
|
7898
8612
|
"input",
|
|
7899
8613
|
"output",
|
|
7900
8614
|
"switchedFlow",
|
|
7901
|
-
"nluWarning"
|
|
8615
|
+
"nluWarning",
|
|
8616
|
+
"debugMessage",
|
|
8617
|
+
"debugError"
|
|
7902
8618
|
];
|
|
7903
8619
|
export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
|
|
7904
8620
|
export interface IInputChangedEventPayload {
|
|
@@ -7981,7 +8697,21 @@ export interface INluWarningEventPayload {
|
|
|
7981
8697
|
errorMessage: string;
|
|
7982
8698
|
sessionId?: string;
|
|
7983
8699
|
}
|
|
7984
|
-
export
|
|
8700
|
+
export interface IDebugEventMessagePayloadBase {
|
|
8701
|
+
sessionId?: string;
|
|
8702
|
+
header?: string;
|
|
8703
|
+
metadata?: IOutputEventMetadata;
|
|
8704
|
+
}
|
|
8705
|
+
export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
|
|
8706
|
+
type: "text";
|
|
8707
|
+
message: string;
|
|
8708
|
+
}
|
|
8709
|
+
export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
|
|
8710
|
+
type: "json";
|
|
8711
|
+
message: object;
|
|
8712
|
+
}
|
|
8713
|
+
export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
|
|
8714
|
+
export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload;
|
|
7985
8715
|
declare const audioPreviewProviders: readonly [
|
|
7986
8716
|
"microsoft",
|
|
7987
8717
|
"google",
|
|
@@ -8010,6 +8740,29 @@ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number]
|
|
|
8010
8740
|
export interface IGenerativeAIUseCase {
|
|
8011
8741
|
useCase: TGenerativeAIUseCases;
|
|
8012
8742
|
}
|
|
8743
|
+
export interface INluEmbeddingCredentials {
|
|
8744
|
+
apiType: TGenerativeAIProviders;
|
|
8745
|
+
apiKey: string;
|
|
8746
|
+
apiModel: TGenerativeAIModels;
|
|
8747
|
+
apiCustomBaseUrl?: string;
|
|
8748
|
+
apiResourceName?: string;
|
|
8749
|
+
apiDeploymentName?: string;
|
|
8750
|
+
apiVersion?: string;
|
|
8751
|
+
}
|
|
8752
|
+
export interface ISetAppStateOverlaySettings {
|
|
8753
|
+
autoOpen: boolean;
|
|
8754
|
+
closeOnSubmit: boolean;
|
|
8755
|
+
feedbackMessage: string;
|
|
8756
|
+
screenTitle: string;
|
|
8757
|
+
sendEventOnCloseIconClick: boolean;
|
|
8758
|
+
showCloseIcon: boolean;
|
|
8759
|
+
}
|
|
8760
|
+
export interface ISetAppStateOverlaySettingsMetaData {
|
|
8761
|
+
overlaySettings: ISetAppStateOverlaySettings;
|
|
8762
|
+
endpointType: TEndpointType;
|
|
8763
|
+
url: string;
|
|
8764
|
+
URLToken: string;
|
|
8765
|
+
}
|
|
8013
8766
|
export interface IVoiceGateway2VadParams {
|
|
8014
8767
|
enable?: boolean;
|
|
8015
8768
|
voiceMs?: number;
|
|
@@ -8032,6 +8785,7 @@ export interface IVoiceGateway2SynthesizerParams {
|
|
|
8032
8785
|
}
|
|
8033
8786
|
export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
|
|
8034
8787
|
export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
|
|
8788
|
+
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
8789
|
export interface IVoiceGateway2RecognizerParams {
|
|
8036
8790
|
vendor?: TVoiceGateway2STTVendor | "default" | "none";
|
|
8037
8791
|
language?: string;
|
|
@@ -8073,7 +8827,7 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
8073
8827
|
ibmOptions?: TVoiceGateway2IbmOptions;
|
|
8074
8828
|
nvidiaOptions?: TVoiceGateway2NvidiaOptions;
|
|
8075
8829
|
sonioxOptions?: TVoiceGateway2SonioxOptions;
|
|
8076
|
-
model?: TVoiceGateway2GoogleModel;
|
|
8830
|
+
model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
|
|
8077
8831
|
}
|
|
8078
8832
|
export declare type TVoiceGateway2NuanceOptions = {
|
|
8079
8833
|
clientId?: string;
|
|
@@ -8105,12 +8859,15 @@ export declare type TVoiceGateway2NuanceOptions = {
|
|
|
8105
8859
|
];
|
|
8106
8860
|
};
|
|
8107
8861
|
export declare type TVoiceGateway2DeepgramOptions = {
|
|
8862
|
+
deepgramSttUri?: string;
|
|
8863
|
+
deepgramSttUseTls?: boolean;
|
|
8108
8864
|
apiKey?: string;
|
|
8109
8865
|
tier?: string;
|
|
8110
8866
|
model?: string;
|
|
8111
8867
|
customModel?: string;
|
|
8112
8868
|
version?: string;
|
|
8113
8869
|
punctuate?: boolean;
|
|
8870
|
+
smartFormatting?: boolean;
|
|
8114
8871
|
profanityFilter?: boolean;
|
|
8115
8872
|
redact?: string;
|
|
8116
8873
|
diarize?: boolean;
|
|
@@ -8123,9 +8880,10 @@ export declare type TVoiceGateway2DeepgramOptions = {
|
|
|
8123
8880
|
replace?: string[];
|
|
8124
8881
|
keywords?: string[];
|
|
8125
8882
|
endpointing?: boolean | number;
|
|
8883
|
+
utteranceEndMs?: number;
|
|
8884
|
+
shortUtterance?: boolean;
|
|
8126
8885
|
vadTurnoff?: number;
|
|
8127
8886
|
tag?: string;
|
|
8128
|
-
smartFormatting?: boolean;
|
|
8129
8887
|
};
|
|
8130
8888
|
export declare type TVoiceGateway2NvidiaOptions = {
|
|
8131
8889
|
rivaUri?: string;
|
|
@@ -8181,6 +8939,7 @@ export declare type TVoiceGatewayNuanceFormatting = {
|
|
|
8181
8939
|
};
|
|
8182
8940
|
export declare type TVoiceGateway2InputType = "digits" | "speech";
|
|
8183
8941
|
export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
|
|
8942
|
+
export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
|
|
8184
8943
|
export interface IVoiceGateway2BargeInParams {
|
|
8185
8944
|
enable?: boolean;
|
|
8186
8945
|
sticky?: boolean;
|
|
@@ -8201,7 +8960,15 @@ export interface IVoiceGateway2ActivityParams {
|
|
|
8201
8960
|
user?: IVoiceGateway2CognigyUserInputConfigParams;
|
|
8202
8961
|
dtmf?: boolean;
|
|
8203
8962
|
sessionParams?: IVoiceGateway2ActivityParams;
|
|
8963
|
+
fillerNoise?: IVoiceGateway2FillerNoiseParams;
|
|
8964
|
+
flow?: IVoiceGateway2CognigyFlowInputConfigParams;
|
|
8204
8965
|
}
|
|
8966
|
+
export interface IVoiceGateway2FillerNoiseParams {
|
|
8967
|
+
enable: boolean;
|
|
8968
|
+
url?: string;
|
|
8969
|
+
startDelaySecs?: number;
|
|
8970
|
+
}
|
|
8971
|
+
export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
|
|
8205
8972
|
export interface IVoiceGateway2CognigyUserInputConfigParams {
|
|
8206
8973
|
noInputMode?: TVoiceGateway2UserNoInputMode;
|
|
8207
8974
|
noInputTimeout?: number;
|
|
@@ -8210,6 +8977,14 @@ export interface IVoiceGateway2CognigyUserInputConfigParams {
|
|
|
8210
8977
|
noInputUrl?: string;
|
|
8211
8978
|
userNoInputAutoHangup?: boolean;
|
|
8212
8979
|
}
|
|
8980
|
+
export interface IVoiceGateway2CognigyFlowInputConfigParams {
|
|
8981
|
+
flowNoInputEnable?: boolean;
|
|
8982
|
+
flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
|
|
8983
|
+
flowNoInputTimeout?: number;
|
|
8984
|
+
flowNoInputRetries?: number;
|
|
8985
|
+
flowNoInputSpeech?: string;
|
|
8986
|
+
flowNoInputUrl?: string;
|
|
8987
|
+
}
|
|
8213
8988
|
export interface IGetNluPipelineParams {
|
|
8214
8989
|
parseIntents?: boolean;
|
|
8215
8990
|
parseSlots?: boolean;
|
|
@@ -8245,6 +9020,10 @@ export interface IHandoverRequestStatus {
|
|
|
8245
9020
|
nodeType: "question" | "handoverToAgent";
|
|
8246
9021
|
agentAssistInitMessage: string;
|
|
8247
9022
|
processedInitMessage?: boolean;
|
|
9023
|
+
/**
|
|
9024
|
+
* Indicates whether an "Assist / Copilot Flow"
|
|
9025
|
+
* should be used during the Handover Request
|
|
9026
|
+
*/
|
|
8248
9027
|
agentAssistConfigured: boolean;
|
|
8249
9028
|
providerResponse: TAnyProviderResponse;
|
|
8250
9029
|
sendOnQueueEvent?: boolean;
|
|
@@ -8282,6 +9061,14 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
|
|
|
8282
9061
|
agentAssistInitMessage: string;
|
|
8283
9062
|
sendOnQueueEvent: boolean;
|
|
8284
9063
|
sendOnActiveEvent: boolean;
|
|
9064
|
+
getQueuePosition: boolean;
|
|
9065
|
+
getEstimatedWaitTime: boolean;
|
|
9066
|
+
alternativeUpdate: boolean;
|
|
9067
|
+
updateIntervalQueuePosition: number;
|
|
9068
|
+
updateIntervalEstimatedWaitTime: number;
|
|
9069
|
+
maximumQueuePosition: number;
|
|
9070
|
+
maximumEstimatedWaitTime: number;
|
|
9071
|
+
alternativeText: string;
|
|
8285
9072
|
};
|
|
8286
9073
|
nodeType?: "question" | "handoverToAgent";
|
|
8287
9074
|
}
|
|
@@ -8304,133 +9091,32 @@ export interface ICheckAgentAvailabilityNodeParams extends INodeFunctionBasePara
|
|
|
8304
9091
|
}
|
|
8305
9092
|
export interface ITriggerFunctionNodeParams extends INodeFunctionBaseParams {
|
|
8306
9093
|
config: {
|
|
8307
|
-
functionReferenceId: string;
|
|
8308
|
-
parameters: {
|
|
8309
|
-
[key: string]: any;
|
|
8310
|
-
};
|
|
8311
|
-
};
|
|
8312
|
-
}
|
|
8313
|
-
export interface IScheduledNodeParams extends INodeFunctionBaseParams {
|
|
8314
|
-
}
|
|
8315
|
-
export interface ISchedulingErrorNodeParams extends INodeFunctionBaseParams {
|
|
8316
|
-
}
|
|
8317
|
-
export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
|
|
8318
|
-
tile: any;
|
|
8319
|
-
}
|
|
8320
|
-
export interface ISendConfigUpdateParams extends INodeFunctionBaseParams {
|
|
8321
|
-
agentAssistConfig: {
|
|
8322
|
-
grid: {
|
|
8323
|
-
columns: number;
|
|
8324
|
-
rows: number;
|
|
8325
|
-
gap: number;
|
|
8326
|
-
};
|
|
8327
|
-
tiles: Record<string, {
|
|
8328
|
-
x: number;
|
|
8329
|
-
y: number;
|
|
8330
|
-
rows: number;
|
|
8331
|
-
columns: number;
|
|
8332
|
-
}>;
|
|
8333
|
-
};
|
|
8334
|
-
}
|
|
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;
|
|
9094
|
+
functionReferenceId: string;
|
|
9095
|
+
parameters: {
|
|
9096
|
+
[key: string]: any;
|
|
9097
|
+
};
|
|
8402
9098
|
};
|
|
8403
9099
|
}
|
|
8404
|
-
export interface
|
|
8405
|
-
source: "user" | "bot";
|
|
8406
|
-
text: string;
|
|
9100
|
+
export interface IScheduledNodeParams extends INodeFunctionBaseParams {
|
|
8407
9101
|
}
|
|
8408
|
-
export interface
|
|
8409
|
-
role: "system" | "user" | "assistant";
|
|
8410
|
-
content: string;
|
|
9102
|
+
export interface ISchedulingErrorNodeParams extends INodeFunctionBaseParams {
|
|
8411
9103
|
}
|
|
8412
|
-
export interface
|
|
8413
|
-
|
|
8414
|
-
description: string;
|
|
8415
|
-
value: string;
|
|
8416
|
-
optional?: boolean;
|
|
8417
|
-
validation?: {
|
|
8418
|
-
type: string;
|
|
8419
|
-
value: string;
|
|
8420
|
-
invalidReason: string;
|
|
8421
|
-
};
|
|
8422
|
-
invalid?: boolean;
|
|
9104
|
+
export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
|
|
9105
|
+
tile: any;
|
|
8423
9106
|
}
|
|
8424
|
-
export interface
|
|
8425
|
-
|
|
8426
|
-
|
|
8427
|
-
|
|
8428
|
-
|
|
8429
|
-
|
|
8430
|
-
|
|
8431
|
-
|
|
8432
|
-
|
|
8433
|
-
|
|
9107
|
+
export interface ISendConfigUpdateParams extends INodeFunctionBaseParams {
|
|
9108
|
+
agentAssistConfig: {
|
|
9109
|
+
grid: {
|
|
9110
|
+
columns: number;
|
|
9111
|
+
rows: number;
|
|
9112
|
+
gap: number;
|
|
9113
|
+
};
|
|
9114
|
+
tiles: Record<string, {
|
|
9115
|
+
x: number;
|
|
9116
|
+
y: number;
|
|
9117
|
+
rows: number;
|
|
9118
|
+
columns: number;
|
|
9119
|
+
}>;
|
|
8434
9120
|
};
|
|
8435
9121
|
}
|
|
8436
9122
|
export declare type INodeAiEnhancedRephraseOutputMode = "none" | "userInputs" | "customInputs";
|
|
@@ -8498,6 +9184,8 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
|
8498
9184
|
repromptLLMProvider: string;
|
|
8499
9185
|
repromptLLMPrompt: string;
|
|
8500
9186
|
repromptLLMTurns: number;
|
|
9187
|
+
repromptLLMStream: boolean;
|
|
9188
|
+
repromptLLMStreamStopTokens: string[];
|
|
8501
9189
|
repromptType: "text" | "say" | "llm" | "execute";
|
|
8502
9190
|
repromptSay: ISayParams["config"]["say"];
|
|
8503
9191
|
repromptFlowNode: {
|
|
@@ -8614,6 +9302,13 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
|
8614
9302
|
additionalMappedSymbols: {
|
|
8615
9303
|
[key: string]: string;
|
|
8616
9304
|
};
|
|
9305
|
+
llmEntityExtractLLMProviderReferenceId: string;
|
|
9306
|
+
entityName: string;
|
|
9307
|
+
entityDescription: string;
|
|
9308
|
+
examples: JSON;
|
|
9309
|
+
llmEntityExtractDescription: string;
|
|
9310
|
+
llmentityTemperature: number;
|
|
9311
|
+
llmentityTimeout: number;
|
|
8617
9312
|
}
|
|
8618
9313
|
export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig {
|
|
8619
9314
|
type: "date";
|
|
@@ -8646,7 +9341,7 @@ export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig
|
|
|
8646
9341
|
}
|
|
8647
9342
|
export interface IActiveQuestion {
|
|
8648
9343
|
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";
|
|
9344
|
+
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
9345
|
lastExecutedAt: number;
|
|
8651
9346
|
forgetQuestionThreshold: number;
|
|
8652
9347
|
repromptCount?: number;
|
|
@@ -8666,9 +9361,154 @@ export interface IQuestionNodeRegexConfig extends IQuestionNodeSharedConfig {
|
|
|
8666
9361
|
regex: string;
|
|
8667
9362
|
}
|
|
8668
9363
|
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";
|
|
9364
|
+
type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber" | "llm_entity";
|
|
8670
9365
|
}
|
|
8671
9366
|
export declare type TRephraseWithAIQuestionType = IActiveQuestion["type"] | IOptionalQuestionNodeOtherConfig["type"];
|
|
9367
|
+
export interface INodeToExecute {
|
|
9368
|
+
nodeId: string;
|
|
9369
|
+
flowExecutionCallerId?: string;
|
|
9370
|
+
flowId: string;
|
|
9371
|
+
cognigyScriptInput?: IExecutionObjects["input"];
|
|
9372
|
+
inputObjectToRestore?: IExecutionObjects["input"];
|
|
9373
|
+
nextMainFlowNodeInputObject?: IExecutionObjects["input"];
|
|
9374
|
+
ignoreSlotScope?: boolean;
|
|
9375
|
+
trackAnalyticsStepOptions?: {
|
|
9376
|
+
entityReferenceId: string;
|
|
9377
|
+
flowName: string;
|
|
9378
|
+
flowReferenceId: string;
|
|
9379
|
+
type: "intent" | "node";
|
|
9380
|
+
stepLabel: string;
|
|
9381
|
+
};
|
|
9382
|
+
type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
|
|
9383
|
+
}
|
|
9384
|
+
export interface ISessionState extends ISessionStateWithoutMeta {
|
|
9385
|
+
/**
|
|
9386
|
+
* The Mongo ObjectId. Typed as any due
|
|
9387
|
+
* to extending the mongoose document below.
|
|
9388
|
+
*/
|
|
9389
|
+
_id: any;
|
|
9390
|
+
/**
|
|
9391
|
+
* The id of the user.
|
|
9392
|
+
*/
|
|
9393
|
+
userId: string;
|
|
9394
|
+
/**
|
|
9395
|
+
* The unique identifier of the
|
|
9396
|
+
* current session (conversation) the
|
|
9397
|
+
* user is having.
|
|
9398
|
+
*/
|
|
9399
|
+
sessionId: string;
|
|
9400
|
+
/**
|
|
9401
|
+
* The 'epoch' is a value which we will increase whenever
|
|
9402
|
+
* we dispatch a change for the session state. We use it
|
|
9403
|
+
* to avoid that we apply outdated updates to the session state
|
|
9404
|
+
*/
|
|
9405
|
+
epoch: number;
|
|
9406
|
+
/**
|
|
9407
|
+
* Date when this object will expire in the database. We utilize a
|
|
9408
|
+
* time-based index in MongoDB.
|
|
9409
|
+
*/
|
|
9410
|
+
expiresAt: Date;
|
|
9411
|
+
}
|
|
9412
|
+
export interface ISessionStateWithoutMeta {
|
|
9413
|
+
/**
|
|
9414
|
+
* The context object that the user
|
|
9415
|
+
* can manipulate in the Flow.
|
|
9416
|
+
* Moves from string at storage to object in memory
|
|
9417
|
+
*/
|
|
9418
|
+
context: {
|
|
9419
|
+
[key: string]: any;
|
|
9420
|
+
} | string;
|
|
9421
|
+
/**
|
|
9422
|
+
* The system context stores information
|
|
9423
|
+
* like execution number and Flow paths.
|
|
9424
|
+
*/
|
|
9425
|
+
systemContext: {
|
|
9426
|
+
[key: string]: any;
|
|
9427
|
+
};
|
|
9428
|
+
/**
|
|
9429
|
+
* The current Flow state.
|
|
9430
|
+
*/
|
|
9431
|
+
state: string;
|
|
9432
|
+
flowId: string;
|
|
9433
|
+
thinkFlowReferenceIdMarker: string;
|
|
9434
|
+
localeReferenceId: string;
|
|
9435
|
+
/**
|
|
9436
|
+
* The snapshot / project
|
|
9437
|
+
* the user is using
|
|
9438
|
+
*/
|
|
9439
|
+
entrypoint: string;
|
|
9440
|
+
entrypointType: "project" | "snapshot";
|
|
9441
|
+
projectId: string;
|
|
9442
|
+
timezoneOffset: number | string;
|
|
9443
|
+
/**
|
|
9444
|
+
* Forms/Processes need the any slots of the calling flow to map injected any slots
|
|
9445
|
+
*/
|
|
9446
|
+
injectedAnySlots: {
|
|
9447
|
+
[key: string]: string;
|
|
9448
|
+
};
|
|
9449
|
+
reconfirmedSentences: {
|
|
9450
|
+
[key: string]: string[];
|
|
9451
|
+
};
|
|
9452
|
+
endpointClientInstanceId?: string;
|
|
9453
|
+
endpointId?: string;
|
|
9454
|
+
previousInputId: string | null;
|
|
9455
|
+
previousInputMessageAmount: number;
|
|
9456
|
+
sensitiveLoggingSettings: ISensitiveLoggingSettings;
|
|
9457
|
+
sentWelcomeMessage?: boolean;
|
|
9458
|
+
nodesToExecuteStack?: INodeToExecute[];
|
|
9459
|
+
trackedSteps?: IAnalyticsStepData["trackedSteps"];
|
|
9460
|
+
trackedGoals?: IAnalyticsSourceData["trackedGoals"];
|
|
9461
|
+
handoverEscalations?: IAnalyticsSourceData["handoverEscalations"];
|
|
9462
|
+
previousInputText?: IAnalyticsSourceData["previousInputText"];
|
|
9463
|
+
previousInputData?: IAnalyticsSourceData["previousInputData"];
|
|
9464
|
+
previousInputAttachments?: IAnalyticsSourceData["previousInputAttachments"] | any;
|
|
9465
|
+
previousSource?: IAnalyticsSourceData["previousSource"];
|
|
9466
|
+
handoverRequest?: IHandoverRequestStatus;
|
|
9467
|
+
frustration?: number;
|
|
9468
|
+
/**
|
|
9469
|
+
* The list of nodes that were visited in the last
|
|
9470
|
+
* Flow execution
|
|
9471
|
+
*/
|
|
9472
|
+
lastFlowPath?: string;
|
|
9473
|
+
apps?: IAppsSessionState;
|
|
9474
|
+
/**
|
|
9475
|
+
* The last user input and bot output strings.
|
|
9476
|
+
* Only filled & used if Generative AI feature is enabled.
|
|
9477
|
+
*/
|
|
9478
|
+
lastConversationEntries?: ILastConversationEntry[];
|
|
9479
|
+
analytics: ISessionStateAnalytcis;
|
|
9480
|
+
}
|
|
9481
|
+
export interface ISessionStateAnalytcis {
|
|
9482
|
+
milestoneCycleIds: {
|
|
9483
|
+
[milestoneId: string]: string;
|
|
9484
|
+
};
|
|
9485
|
+
}
|
|
9486
|
+
export interface ILastConversationEntry {
|
|
9487
|
+
source: "user" | "bot";
|
|
9488
|
+
text: string;
|
|
9489
|
+
}
|
|
9490
|
+
export interface IAppsSessionState {
|
|
9491
|
+
session: {
|
|
9492
|
+
token: string;
|
|
9493
|
+
};
|
|
9494
|
+
customization: {};
|
|
9495
|
+
}
|
|
9496
|
+
export interface OpenAIChatMessage {
|
|
9497
|
+
role: "system" | "user" | "assistant";
|
|
9498
|
+
content: string;
|
|
9499
|
+
}
|
|
9500
|
+
export interface IGenerativeSlot {
|
|
9501
|
+
tag: string;
|
|
9502
|
+
description: string;
|
|
9503
|
+
value: string;
|
|
9504
|
+
optional?: boolean;
|
|
9505
|
+
validation?: {
|
|
9506
|
+
type: string;
|
|
9507
|
+
value: string;
|
|
9508
|
+
invalidReason: string;
|
|
9509
|
+
};
|
|
9510
|
+
invalid?: boolean;
|
|
9511
|
+
}
|
|
8672
9512
|
export declare type TCompletionPrompt = {
|
|
8673
9513
|
prompt: string;
|
|
8674
9514
|
};
|
|
@@ -8693,7 +9533,7 @@ export interface IRunGenerativeAIPromptOptions {
|
|
|
8693
9533
|
promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
|
|
8694
9534
|
/** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
|
|
8695
9535
|
temperature?: number;
|
|
8696
|
-
/** model - (Optional) The OpenAI model to use. Defaults to '
|
|
9536
|
+
/** model - (Optional) The OpenAI model to use. Defaults to 'gpt-4o' */
|
|
8697
9537
|
model?: TGenerativeAIModels;
|
|
8698
9538
|
/** timeoutInMs - (Optional) The timeout for the request in ms. Defaults to 10000 */
|
|
8699
9539
|
timeoutInMs?: number;
|
|
@@ -8748,18 +9588,82 @@ export interface IRunGenerativeAIPromptOptions {
|
|
|
8748
9588
|
* flushing of token buffer to the provided handler
|
|
8749
9589
|
*/
|
|
8750
9590
|
streamStopTokens?: string[];
|
|
9591
|
+
/**
|
|
9592
|
+
* Array of regular expressions which prevent the stream buffer to be flushed
|
|
9593
|
+
*/
|
|
9594
|
+
streamStopTokenOverrides?: string[];
|
|
8751
9595
|
/**
|
|
8752
9596
|
* A string denoting the reference ID of the chosen LLM provider
|
|
8753
9597
|
*/
|
|
8754
9598
|
llmProviderReferenceId?: string;
|
|
9599
|
+
/**
|
|
9600
|
+
* Response Format (can be json for some providers), text and default means none
|
|
9601
|
+
*/
|
|
9602
|
+
responseFormat?: "json_object" | "text" | "default";
|
|
9603
|
+
/**
|
|
9604
|
+
* Option to output detailed results, including finish_reason, etc
|
|
9605
|
+
*/
|
|
9606
|
+
detailedResults?: boolean;
|
|
9607
|
+
/**
|
|
9608
|
+
* Developers can now specify seed parameter in the OpenAI Chat Completion request to receive (mostly) consistent outputs
|
|
9609
|
+
*/
|
|
9610
|
+
seed?: number;
|
|
9611
|
+
/**
|
|
9612
|
+
* JSON object with options to pass to the LLM Model
|
|
9613
|
+
*/
|
|
9614
|
+
customModelOptions?: any;
|
|
9615
|
+
/**
|
|
9616
|
+
* JSON object with options to pass to the LLM Request
|
|
9617
|
+
*/
|
|
9618
|
+
customRequestOptions?: any;
|
|
8755
9619
|
}
|
|
8756
|
-
export interface
|
|
8757
|
-
apiType?: TGenerativeAIProviders;
|
|
9620
|
+
export interface IAzureOpenAIProviderFieldsV2 {
|
|
8758
9621
|
apiKey: string;
|
|
8759
|
-
|
|
8760
|
-
|
|
8761
|
-
|
|
8762
|
-
|
|
9622
|
+
}
|
|
9623
|
+
export interface IAzureOpenAIProviderOauth2Fields {
|
|
9624
|
+
clientId: string;
|
|
9625
|
+
clientSecret: string;
|
|
9626
|
+
oauthUrl: string;
|
|
9627
|
+
scope: string;
|
|
9628
|
+
}
|
|
9629
|
+
export interface IParams {
|
|
9630
|
+
[key: string]: any;
|
|
9631
|
+
}
|
|
9632
|
+
export interface IConnectionSchemaField {
|
|
9633
|
+
_id?: TMongoId;
|
|
9634
|
+
/** The field name, e.g. 'client_id' */
|
|
9635
|
+
fieldName: string;
|
|
9636
|
+
required?: boolean;
|
|
9637
|
+
label?: string;
|
|
9638
|
+
description?: string;
|
|
9639
|
+
params?: IParams;
|
|
9640
|
+
}
|
|
9641
|
+
export interface IConnectionSchema extends IEntityMeta {
|
|
9642
|
+
_id: TMongoId;
|
|
9643
|
+
extension: string;
|
|
9644
|
+
isCognigy: boolean;
|
|
9645
|
+
/** The type of the connection, e.g. 'oauth' */
|
|
9646
|
+
type: string;
|
|
9647
|
+
/** An additional label for the connection schema - by default we will pick the 'type' */
|
|
9648
|
+
label: string;
|
|
9649
|
+
/** The actual fields */
|
|
9650
|
+
fields: IConnectionSchemaField[];
|
|
9651
|
+
projectReference: TMongoId;
|
|
9652
|
+
organisationReference: TMongoId;
|
|
9653
|
+
}
|
|
9654
|
+
/** Logical operators that can be used when filtering tags for search */
|
|
9655
|
+
export declare type ISearchTagsFilterOps = "and" | "or";
|
|
9656
|
+
export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields {
|
|
9657
|
+
tokenCacheKey: string;
|
|
9658
|
+
}
|
|
9659
|
+
export interface ISearchLLMCredentials {
|
|
9660
|
+
provider: TGenerativeAIProviders;
|
|
9661
|
+
connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields;
|
|
9662
|
+
providerMetaData: IAzureOpenAIMeta;
|
|
9663
|
+
}
|
|
9664
|
+
export interface ISearchTagsData {
|
|
9665
|
+
tags: string[];
|
|
9666
|
+
op: ISearchTagsFilterOps;
|
|
8763
9667
|
}
|
|
8764
9668
|
export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
|
|
8765
9669
|
query: string;
|
|
@@ -8768,9 +9672,9 @@ export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
|
|
|
8768
9672
|
topK: number;
|
|
8769
9673
|
language: string;
|
|
8770
9674
|
knowledgeStoreIds?: string[];
|
|
8771
|
-
|
|
9675
|
+
llmCredentials?: ISearchLLMCredentials;
|
|
8772
9676
|
sessionId?: string;
|
|
8773
|
-
|
|
9677
|
+
tagsData?: ISearchTagsData;
|
|
8774
9678
|
}
|
|
8775
9679
|
export interface IKnowledgeSearchReturnValue {
|
|
8776
9680
|
status: "success" | "error";
|
|
@@ -8796,6 +9700,95 @@ export interface IKnowledgeSearchReturnValue {
|
|
|
8796
9700
|
];
|
|
8797
9701
|
};
|
|
8798
9702
|
}
|
|
9703
|
+
export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
|
|
9704
|
+
config: {
|
|
9705
|
+
lexiconId: string;
|
|
9706
|
+
keyphrase: string;
|
|
9707
|
+
slots: string[];
|
|
9708
|
+
synonyms: string[];
|
|
9709
|
+
};
|
|
9710
|
+
}
|
|
9711
|
+
export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
|
|
9712
|
+
config: {
|
|
9713
|
+
text: string;
|
|
9714
|
+
data: any;
|
|
9715
|
+
mode: string;
|
|
9716
|
+
contextKey: string;
|
|
9717
|
+
inputKey: string;
|
|
9718
|
+
parseIntents: boolean;
|
|
9719
|
+
parseSlots: boolean;
|
|
9720
|
+
parseSystemSlots: boolean;
|
|
9721
|
+
findType: boolean;
|
|
9722
|
+
processDefaultReply: boolean;
|
|
9723
|
+
};
|
|
9724
|
+
}
|
|
9725
|
+
export interface IRegexSlotFillerConfig {
|
|
9726
|
+
regex: string;
|
|
9727
|
+
flags: string;
|
|
9728
|
+
slot: string;
|
|
9729
|
+
}
|
|
9730
|
+
export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
|
|
9731
|
+
config: IRegexSlotFillerConfig;
|
|
9732
|
+
}
|
|
9733
|
+
export interface IMatchPatternParams extends INodeFunctionBaseParams {
|
|
9734
|
+
config: {
|
|
9735
|
+
patterns: string[];
|
|
9736
|
+
patternGroupName: string;
|
|
9737
|
+
alternateInput: string;
|
|
9738
|
+
detailedCompoundSlots: boolean;
|
|
9739
|
+
createNewSlots: boolean;
|
|
9740
|
+
tagExistingSlots: boolean;
|
|
9741
|
+
useFullSystemslotText: boolean;
|
|
9742
|
+
};
|
|
9743
|
+
}
|
|
9744
|
+
export interface IFuzzySearchParams extends INodeFunctionBaseParams {
|
|
9745
|
+
config: {
|
|
9746
|
+
searchPattern: string;
|
|
9747
|
+
items: any;
|
|
9748
|
+
isCaseSensitive: boolean;
|
|
9749
|
+
includeScore: boolean;
|
|
9750
|
+
includeMatches: boolean;
|
|
9751
|
+
minMatchCharLength: number;
|
|
9752
|
+
shouldSort: boolean;
|
|
9753
|
+
findAllMatches: boolean;
|
|
9754
|
+
location: number;
|
|
9755
|
+
threshold: number;
|
|
9756
|
+
distance: number;
|
|
9757
|
+
ignoreLocation: boolean;
|
|
9758
|
+
storeLocation: string;
|
|
9759
|
+
inputKey: string;
|
|
9760
|
+
contextKey: string;
|
|
9761
|
+
};
|
|
9762
|
+
}
|
|
9763
|
+
export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
9764
|
+
config: {
|
|
9765
|
+
slotsConfig: IGenerativeSlot[];
|
|
9766
|
+
amountOfLastUserInputs: number;
|
|
9767
|
+
maxQuestions: number;
|
|
9768
|
+
temperature: number;
|
|
9769
|
+
storeLocation: string;
|
|
9770
|
+
contextKey: string;
|
|
9771
|
+
inputKey: string;
|
|
9772
|
+
timeout: number;
|
|
9773
|
+
};
|
|
9774
|
+
}
|
|
9775
|
+
export interface IMilestoneAnalyticsPayload {
|
|
9776
|
+
analyticsdata: IMilestoneEscalations;
|
|
9777
|
+
data: IPayloadBaseMetaData;
|
|
9778
|
+
}
|
|
9779
|
+
export interface IMilestoneAnalyticsData {
|
|
9780
|
+
projectId: string;
|
|
9781
|
+
organisationId: string;
|
|
9782
|
+
sessionId: string;
|
|
9783
|
+
version: string;
|
|
9784
|
+
timestamp: Date;
|
|
9785
|
+
milestoneCycleId: string;
|
|
9786
|
+
stepId: string;
|
|
9787
|
+
milestoneId: string;
|
|
9788
|
+
contactId: string;
|
|
9789
|
+
}
|
|
9790
|
+
export interface IMilestoneEscalations extends IMilestoneAnalyticsData, IAnalytiscEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
|
|
9791
|
+
}
|
|
8799
9792
|
export interface IGetConversationTranscriptParams {
|
|
8800
9793
|
turnLimit: number;
|
|
8801
9794
|
}
|
|
@@ -8837,6 +9830,7 @@ export interface IRephraseSentenceWithAIOptions {
|
|
|
8837
9830
|
question?: string;
|
|
8838
9831
|
answer?: string;
|
|
8839
9832
|
}
|
|
9833
|
+
export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics">>;
|
|
8840
9834
|
export interface IActions {
|
|
8841
9835
|
addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
|
|
8842
9836
|
addHandoverInactivityTimer?: (params: {
|
|
@@ -8844,12 +9838,13 @@ export interface IActions {
|
|
|
8844
9838
|
}) => Promise<void>;
|
|
8845
9839
|
activateProfile?: () => Promise<any>;
|
|
8846
9840
|
addLexiconKeyphrase?: (lexicon: string, keyphrase: string, slots: Array<string>, synonyms: Array<string>, data?: Object) => void;
|
|
8847
|
-
addToContext?: (key: string, value: any, mode:
|
|
9841
|
+
addToContext?: (key: string, value: any, mode: "simple" | "array") => void;
|
|
8848
9842
|
cancelHandoverRequest?: (cancelHandoverInProvider?: boolean) => Promise<void>;
|
|
8849
9843
|
checkAgentAvailability?: (params: ICheckAgentAvailabilityNodeParams) => void;
|
|
8850
9844
|
checkFrustration?: (nodeId: string, input: any) => void;
|
|
8851
9845
|
checkThink?: (id: string) => boolean;
|
|
8852
9846
|
completeGoal?: (goalData: IAnalyticsDataGoals) => void;
|
|
9847
|
+
countGPTTokens: (prompt: string) => number;
|
|
8853
9848
|
deactivateProfile?: (deleteData: boolean) => Promise<any>;
|
|
8854
9849
|
deleteContext?: (key: string) => void;
|
|
8855
9850
|
deleteProfile?: () => Promise<any>;
|
|
@@ -8864,9 +9859,18 @@ export interface IActions {
|
|
|
8864
9859
|
executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
|
|
8865
9860
|
executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
|
|
8866
9861
|
handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
|
|
8867
|
-
|
|
8868
|
-
|
|
8869
|
-
|
|
9862
|
+
/**
|
|
9863
|
+
* returns the analytics data object - mutable
|
|
9864
|
+
* @deprecated
|
|
9865
|
+
*/
|
|
9866
|
+
getAnalyticsData: () => IAnalyticsSourceData;
|
|
9867
|
+
/** returns a copy of the analytics data object - immutable */
|
|
9868
|
+
getAnalyticsDataCopy: (key: string, value: any) => void;
|
|
9869
|
+
setAnalyticsData?: (key: keyof IAnalyticsSourceData, value: any) => void;
|
|
9870
|
+
/** returns a copy of the analytics data object - immutable */
|
|
9871
|
+
getSessionStateCopy: () => ISessionState;
|
|
9872
|
+
/** sets a key value pair in the session state in the brain */
|
|
9873
|
+
setSessionState: (key: keyof TBrainSessionState, value: any) => void;
|
|
8870
9874
|
getInjectedAnySlots?: () => {
|
|
8871
9875
|
[key: string]: string;
|
|
8872
9876
|
};
|
|
@@ -8884,6 +9888,10 @@ export interface IActions {
|
|
|
8884
9888
|
targetRuntimeVersion: number;
|
|
8885
9889
|
}) => boolean;
|
|
8886
9890
|
log?: (level: string, text: string) => void;
|
|
9891
|
+
logDebugMessage?: (message: string | object, header?: string) => void;
|
|
9892
|
+
logDebugError?: (message: string | object, header?: string) => void;
|
|
9893
|
+
logDebugMessageWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
|
|
9894
|
+
logDebugErrorWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
|
|
8887
9895
|
mergeProfile?: (contactId: string) => Promise<any>;
|
|
8888
9896
|
parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
|
|
8889
9897
|
parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
|
|
@@ -8895,7 +9903,7 @@ export interface IActions {
|
|
|
8895
9903
|
rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
|
|
8896
9904
|
rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
|
|
8897
9905
|
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<
|
|
9906
|
+
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<any>;
|
|
8899
9907
|
resetContext?: () => object;
|
|
8900
9908
|
resetFormBrain?: () => Promise<void>;
|
|
8901
9909
|
resetState?: () => Promise<string>;
|
|
@@ -8916,6 +9924,7 @@ export interface IActions {
|
|
|
8916
9924
|
}) => void;
|
|
8917
9925
|
setLastTopic?: (text: string, type: any, age: number) => void;
|
|
8918
9926
|
setLocaleReferenceId?: (localeReferenceID: string) => void;
|
|
9927
|
+
setRegexSlot: (regexSlotFillerParams: IRegexSlotFillerParams) => void;
|
|
8919
9928
|
setSensitiveLoggingSettings?: (settings: ISensitiveLoggingSettings, traceId: string) => void;
|
|
8920
9929
|
setState?: (state: string) => void;
|
|
8921
9930
|
setSystemContext?: (key: string, value: any) => void;
|
|
@@ -8931,6 +9940,25 @@ export interface IActions {
|
|
|
8931
9940
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
8932
9941
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
8933
9942
|
getAgentAssistConfigId: () => string;
|
|
9943
|
+
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
9944
|
+
getMetadata: () => IGetMetaDataActionValue;
|
|
9945
|
+
sendTrackMilestone: (payload: IMilestoneAnalyticsPayload) => Promise<void>;
|
|
9946
|
+
}
|
|
9947
|
+
export interface IGetMetaDataActionValue {
|
|
9948
|
+
sessionId: string;
|
|
9949
|
+
projectId: string;
|
|
9950
|
+
organisationId: string;
|
|
9951
|
+
traceId: string;
|
|
9952
|
+
endpointUrlToken: string;
|
|
9953
|
+
endpointName: string;
|
|
9954
|
+
channel: string;
|
|
9955
|
+
localeReferenceId: string;
|
|
9956
|
+
localeName: string;
|
|
9957
|
+
endpointType: TEndpointType;
|
|
9958
|
+
snapshotId: string;
|
|
9959
|
+
snapshotName: string;
|
|
9960
|
+
isFollowSessionActive: boolean;
|
|
9961
|
+
contactId: string;
|
|
8934
9962
|
}
|
|
8935
9963
|
export interface ICognigyNLPProperties {
|
|
8936
9964
|
/** The original text of the user */
|
|
@@ -9517,7 +10545,6 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
9517
10545
|
traceId: string;
|
|
9518
10546
|
}) => Promise<any>;
|
|
9519
10547
|
fuseSearch?: (list: any, options: any, pattern: string) => any;
|
|
9520
|
-
setRegexSlot: (regexSlotFillerParams: IRegexSlotFillerParams) => void;
|
|
9521
10548
|
addToInput: (key: string, value: any) => void;
|
|
9522
10549
|
resetCognigyScriptInput?: () => void;
|
|
9523
10550
|
setForwardDatesOnly?: () => void;
|
|
@@ -9529,14 +10556,18 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
9529
10556
|
appInterimScreenOverride?: string;
|
|
9530
10557
|
appConnectScreenOverride?: string;
|
|
9531
10558
|
}) => Promise<string>;
|
|
9532
|
-
setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown
|
|
10559
|
+
setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown>, options?: {
|
|
10560
|
+
webchat3?: {
|
|
10561
|
+
overlaySettingsMetaData?: ISetAppStateOverlaySettingsMetaData;
|
|
10562
|
+
};
|
|
10563
|
+
}) => void;
|
|
9533
10564
|
getAppSessionPin: () => Promise<string>;
|
|
9534
10565
|
validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
|
|
9535
10566
|
completeGoal: (goal: string) => void;
|
|
9536
10567
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
9537
10568
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
9538
10569
|
getAgentAssistConfigId: () => string;
|
|
9539
|
-
countGPTTokens
|
|
10570
|
+
countGPTTokens: (prompt: string) => number;
|
|
9540
10571
|
getConversationTranscript?: (mode: string, options?: any) => any;
|
|
9541
10572
|
}
|
|
9542
10573
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
@@ -9592,7 +10623,7 @@ export interface INodeFunctionBaseParams {
|
|
|
9592
10623
|
inputOptions?: INodeFunctionInputOptions;
|
|
9593
10624
|
}
|
|
9594
10625
|
export declare type TNodeChildConfigs = Pick<IChartExecutableNode, "id" | "type" | "config">;
|
|
9595
|
-
export declare type TNodeFunction = (params:
|
|
10626
|
+
export declare type TNodeFunction<T extends INodeFunctionBaseParams = any> = (params: T) => Promise<void>;
|
|
9596
10627
|
export declare type THttpRequestMethod = "get" | "GET" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK";
|
|
9597
10628
|
export interface IHttpRequestParams {
|
|
9598
10629
|
method: THttpRequestMethod;
|
|
@@ -9663,7 +10694,7 @@ declare const nodePreviewTypes: readonly [
|
|
|
9663
10694
|
"resource",
|
|
9664
10695
|
"image"
|
|
9665
10696
|
];
|
|
9666
|
-
export declare type TNodePreviewType = typeof nodePreviewTypes[number];
|
|
10697
|
+
export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
|
|
9667
10698
|
export interface INodePreview {
|
|
9668
10699
|
type: TNodePreviewType;
|
|
9669
10700
|
key: string;
|
|
@@ -9728,6 +10759,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
9728
10759
|
"knowledgeStoreSelect",
|
|
9729
10760
|
"knowledgeSourceTags",
|
|
9730
10761
|
"llmSelect",
|
|
10762
|
+
"milestoneAndStepsSelect",
|
|
9731
10763
|
"lexicon",
|
|
9732
10764
|
"localeField",
|
|
9733
10765
|
"node",
|
|
@@ -9752,7 +10784,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
9752
10784
|
"typescript",
|
|
9753
10785
|
"xml"
|
|
9754
10786
|
];
|
|
9755
|
-
export declare type TNodeFieldType = typeof nodeFieldTypes[number];
|
|
10787
|
+
export declare type TNodeFieldType = (typeof nodeFieldTypes)[number];
|
|
9756
10788
|
export declare type TComparableValue = string | number | boolean;
|
|
9757
10789
|
export declare type TNodeFieldCondition = INodeFieldSingleCondition | INodeFieldANDCondition | INodeFieldORCondition;
|
|
9758
10790
|
export interface INodeFieldSingleCondition {
|
|
@@ -9804,6 +10836,11 @@ export interface INodeField<K extends string | number | symbol = string> {
|
|
|
9804
10836
|
[key: string]: any;
|
|
9805
10837
|
};
|
|
9806
10838
|
optionsResolver?: INodeOptionsResolver;
|
|
10839
|
+
resetOption?: IResetOption;
|
|
10840
|
+
}
|
|
10841
|
+
export interface IResetOption {
|
|
10842
|
+
lookupValue: string;
|
|
10843
|
+
fieldsToReset: string[];
|
|
9807
10844
|
}
|
|
9808
10845
|
export interface INodeSection {
|
|
9809
10846
|
/** Unique identifier for this section within all sections of a descriptor, e.g. 'authentication' */
|
|
@@ -9827,10 +10864,10 @@ export interface INodeFieldAndSectionFormElement {
|
|
|
9827
10864
|
}
|
|
9828
10865
|
export declare type TCognigyNodeTagType = "basic" | "logic" | "message" | "analytics" | "service" | "nlu" | "data";
|
|
9829
10866
|
export declare type TNodeTagType = TCognigyNodeTagType | string;
|
|
9830
|
-
export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U extends string = string> {
|
|
10867
|
+
export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U extends string = string, FunctionParams extends INodeFunctionBaseParams = any> {
|
|
9831
10868
|
_id?: TMongoId;
|
|
9832
10869
|
type: U;
|
|
9833
|
-
parentType?: string;
|
|
10870
|
+
parentType?: string | null;
|
|
9834
10871
|
defaultLabel: string | INodeFieldTranslations;
|
|
9835
10872
|
summary?: string | INodeFieldTranslations;
|
|
9836
10873
|
appearance: INodeAppearance;
|
|
@@ -9838,7 +10875,7 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
9838
10875
|
constraints?: INodeConstraints;
|
|
9839
10876
|
dependencies?: INodeDependencies;
|
|
9840
10877
|
fields?: INodeFieldSet<T>;
|
|
9841
|
-
function?: TNodeFunction;
|
|
10878
|
+
function?: TNodeFunction<FunctionParams> | null;
|
|
9842
10879
|
/** Defines how the preview should be generated for nodes using this descriptor */
|
|
9843
10880
|
preview?: INodePreview;
|
|
9844
10881
|
/**
|
|
@@ -9863,31 +10900,6 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
9863
10900
|
/** The form defines how fields and sections should be render in order */
|
|
9864
10901
|
form?: INodeFieldAndSectionFormElement[];
|
|
9865
10902
|
}
|
|
9866
|
-
export interface IParams {
|
|
9867
|
-
[key: string]: any;
|
|
9868
|
-
}
|
|
9869
|
-
export interface IConnectionSchemaField {
|
|
9870
|
-
_id?: TMongoId;
|
|
9871
|
-
/** The field name, e.g. 'client_id' */
|
|
9872
|
-
fieldName: string;
|
|
9873
|
-
required?: boolean;
|
|
9874
|
-
label?: string;
|
|
9875
|
-
description?: string;
|
|
9876
|
-
params?: IParams;
|
|
9877
|
-
}
|
|
9878
|
-
export interface IConnectionSchema extends IEntityMeta {
|
|
9879
|
-
_id: TMongoId;
|
|
9880
|
-
extension: string;
|
|
9881
|
-
isCognigy: boolean;
|
|
9882
|
-
/** The type of the connection, e.g. 'oauth' */
|
|
9883
|
-
type: string;
|
|
9884
|
-
/** An additional label for the connection schema - by default we will pick the 'type' */
|
|
9885
|
-
label: string;
|
|
9886
|
-
/** The actual fields */
|
|
9887
|
-
fields: IConnectionSchemaField[];
|
|
9888
|
-
projectReference: TMongoId;
|
|
9889
|
-
organisationReference: TMongoId;
|
|
9890
|
-
}
|
|
9891
10903
|
export interface IAppTemplate extends IEntityMeta {
|
|
9892
10904
|
/** The object id of this app template */
|
|
9893
10905
|
_id: TMongoId;
|
|
@@ -10154,7 +11166,39 @@ export interface IGraphPlaybook {
|
|
|
10154
11166
|
name: string;
|
|
10155
11167
|
properties: Pick<IPlaybook, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10156
11168
|
}
|
|
10157
|
-
export
|
|
11169
|
+
export interface IMilestone extends IEntityMeta {
|
|
11170
|
+
_id: TMongoId;
|
|
11171
|
+
name: string;
|
|
11172
|
+
version: string;
|
|
11173
|
+
steps: IMilestoneStep[];
|
|
11174
|
+
description: string;
|
|
11175
|
+
referenceId: string;
|
|
11176
|
+
projectReference: TMongoId;
|
|
11177
|
+
organisationReference: TMongoId;
|
|
11178
|
+
}
|
|
11179
|
+
export interface IMilestoneStep {
|
|
11180
|
+
_id?: string;
|
|
11181
|
+
name?: string;
|
|
11182
|
+
description?: string;
|
|
11183
|
+
order?: number;
|
|
11184
|
+
type?: "start" | "completion";
|
|
11185
|
+
metrics?: IMilestoneStepMetric[];
|
|
11186
|
+
}
|
|
11187
|
+
export interface IMilestoneStepMetric {
|
|
11188
|
+
_id?: string;
|
|
11189
|
+
name: string;
|
|
11190
|
+
description: string;
|
|
11191
|
+
type?: "currency" | "duration";
|
|
11192
|
+
value?: number;
|
|
11193
|
+
}
|
|
11194
|
+
export interface IGraphMilestone {
|
|
11195
|
+
type: "milestone";
|
|
11196
|
+
_id: TMongoId;
|
|
11197
|
+
referenceId: string;
|
|
11198
|
+
name: string;
|
|
11199
|
+
properties: Pick<IMilestone, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
11200
|
+
}
|
|
11201
|
+
export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphMilestone;
|
|
10158
11202
|
export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
|
|
10159
11203
|
export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
|
|
10160
11204
|
/**
|
|
@@ -13047,6 +14091,9 @@ export interface IComposeSnapshotDownloadLinkRestReturnValue_2_0 {
|
|
|
13047
14091
|
* type: string
|
|
13048
14092
|
* description: The name of the Connection
|
|
13049
14093
|
* example: azure
|
|
14094
|
+
* isDeprecated:
|
|
14095
|
+
* type: boolean
|
|
14096
|
+
* description: Marked 'true' if the connection type is deprecated
|
|
13050
14097
|
* connectionSchema:
|
|
13051
14098
|
* type: object
|
|
13052
14099
|
* properties:
|
|
@@ -13062,6 +14109,7 @@ export interface IConnectionIndexItem_2_0 {
|
|
|
13062
14109
|
_id: TMongoId;
|
|
13063
14110
|
referenceId: string;
|
|
13064
14111
|
name: string;
|
|
14112
|
+
isDeprecated: boolean;
|
|
13065
14113
|
extension: string;
|
|
13066
14114
|
type: string;
|
|
13067
14115
|
createdAt: number;
|
|
@@ -13095,6 +14143,9 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
|
|
|
13095
14143
|
* name:
|
|
13096
14144
|
* type: string
|
|
13097
14145
|
* example: "some name"
|
|
14146
|
+
* isDeprecated:
|
|
14147
|
+
* type: boolean
|
|
14148
|
+
* description: Marked 'true' if the connection type is deprecated
|
|
13098
14149
|
* type:
|
|
13099
14150
|
* type: string
|
|
13100
14151
|
* example: "http_basic"
|
|
@@ -13115,6 +14166,9 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
|
|
|
13115
14166
|
* type: string
|
|
13116
14167
|
* description: The name of the Connection
|
|
13117
14168
|
* example: Azure API
|
|
14169
|
+
* isDeprecated:
|
|
14170
|
+
* type: boolean
|
|
14171
|
+
* description: Marked 'true' if the connection type is deprecated
|
|
13118
14172
|
* connectionSchema:
|
|
13119
14173
|
* type: object
|
|
13120
14174
|
* description: Identifies the schema which should be used to validate the connection fields.
|
|
@@ -13138,6 +14192,7 @@ export interface IConnection_2_0 {
|
|
|
13138
14192
|
referenceId: string;
|
|
13139
14193
|
_id: TMongoId;
|
|
13140
14194
|
name: string;
|
|
14195
|
+
isDeprecated: boolean;
|
|
13141
14196
|
fields: IConnectionFields;
|
|
13142
14197
|
extension: string;
|
|
13143
14198
|
type: string;
|
|
@@ -13167,349 +14222,61 @@ export interface IReadConnectionRestDataParams_2_0 {
|
|
|
13167
14222
|
}
|
|
13168
14223
|
export interface IReadConnectionRestData_2_0 extends IReadConnectionRestDataParams_2_0 {
|
|
13169
14224
|
}
|
|
13170
|
-
export interface IReadConnectionRestReturnValue_2_0 extends IConnection_2_0 {
|
|
13171
|
-
}
|
|
13172
|
-
export interface IUpdateConnectionRestDataBody_2_0 extends Partial<Pick<IConnection_2_0, "fields">> {
|
|
13173
|
-
}
|
|
13174
|
-
export interface IUpdateConnectionRestDataParams_2_0 {
|
|
13175
|
-
connectionId: string;
|
|
13176
|
-
}
|
|
13177
|
-
export interface IUpdateConnectionRestData_2_0 extends IUpdateConnectionRestDataBody_2_0, IUpdateConnectionRestDataParams_2_0 {
|
|
13178
|
-
}
|
|
13179
|
-
export interface IUpdateConnectionRestReturnValue_2_0 {
|
|
13180
|
-
}
|
|
13181
|
-
export interface IDeleteConnectionRestDataParams_2_0 {
|
|
13182
|
-
connectionId: string;
|
|
13183
|
-
}
|
|
13184
|
-
export interface IDeleteConnectionRestData_2_0 extends IDeleteConnectionRestDataParams_2_0 {
|
|
13185
|
-
}
|
|
13186
|
-
export interface IDeleteConnectionRestReturnValue_2_0 {
|
|
13187
|
-
}
|
|
13188
|
-
/**
|
|
13189
|
-
* @openapi
|
|
13190
|
-
*
|
|
13191
|
-
* components:
|
|
13192
|
-
* schemas:
|
|
13193
|
-
* IConnectionData_2_0:
|
|
13194
|
-
* type: object
|
|
13195
|
-
* properties:
|
|
13196
|
-
* key:
|
|
13197
|
-
* type: string
|
|
13198
|
-
* description: The key of the connection field. The key should match the connection schema of the specific connection type.
|
|
13199
|
-
* example: some-key-from-connection-schema
|
|
13200
|
-
* value:
|
|
13201
|
-
* type: string
|
|
13202
|
-
* description: The value of the connection field
|
|
13203
|
-
* example: x123w123
|
|
13204
|
-
*/
|
|
13205
|
-
export interface IConnectionField_2_0 {
|
|
13206
|
-
key: string;
|
|
13207
|
-
value: string;
|
|
13208
|
-
}
|
|
13209
|
-
export interface ICreateConnectionFieldRestDataParams_2_0 {
|
|
13210
|
-
connectionId: string;
|
|
13211
|
-
}
|
|
13212
|
-
export interface ICreateConnectionFieldRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnectionField_2_0, keyof IEntityMeta>> {
|
|
13213
|
-
}
|
|
13214
|
-
export interface ICreateConnectionFieldRestData_2_0 extends ICreateConnectionFieldRestDataParams_2_0, ICreateConnectionFieldRestDataBody_2_0 {
|
|
13215
|
-
}
|
|
13216
|
-
export interface ICreateConnectionFieldRestReturnValue_2_0 {
|
|
13217
|
-
}
|
|
13218
|
-
export interface IDeleteConnectionFieldRestDataParams_2_0 {
|
|
13219
|
-
connectionId: string;
|
|
13220
|
-
fieldName: string;
|
|
13221
|
-
}
|
|
13222
|
-
export interface IDeleteConnectionFieldRestData_2_0 extends IDeleteConnectionFieldRestDataParams_2_0 {
|
|
13223
|
-
}
|
|
13224
|
-
export interface IDeleteConnectionFieldRestReturnValue_2_0 {
|
|
13225
|
-
}
|
|
13226
|
-
declare const journeyStepGoals: readonly [
|
|
13227
|
-
"createAgent",
|
|
13228
|
-
"createFlow",
|
|
13229
|
-
"createEndpoint",
|
|
13230
|
-
"createLexicon",
|
|
13231
|
-
"createSnapshot",
|
|
13232
|
-
"createKnowledgeStore",
|
|
13233
|
-
"createKnowledgeSource",
|
|
13234
|
-
"openWebchat",
|
|
13235
|
-
"createCodeNode",
|
|
13236
|
-
"createHttpRequestNode",
|
|
13237
|
-
"createIfNode",
|
|
13238
|
-
"createQuestionNode",
|
|
13239
|
-
"createSayNode",
|
|
13240
|
-
"createLookupNode",
|
|
13241
|
-
"createKnowledgeSearchNode",
|
|
13242
|
-
"createSearchExtractOutputNode",
|
|
13243
|
-
"createGptConversationNode",
|
|
13244
|
-
"createLlmPromptNode",
|
|
13245
|
-
"updateCaseNode",
|
|
13246
|
-
"updateHttpRequestNode",
|
|
13247
|
-
"updateIfNode",
|
|
13248
|
-
"updateQuestionNode",
|
|
13249
|
-
"updateSayNode",
|
|
13250
|
-
"createIntent",
|
|
13251
|
-
"trainIntents",
|
|
13252
|
-
"activateLexicon",
|
|
13253
|
-
"useToken",
|
|
13254
|
-
"addKeyphrase",
|
|
13255
|
-
"expertModeOn",
|
|
13256
|
-
"openContextTab",
|
|
13257
|
-
"openInfoTab",
|
|
13258
|
-
"openIP",
|
|
13259
|
-
"sendMessage",
|
|
13260
|
-
"prepareSnapshotDownload",
|
|
13261
|
-
"restoreSnapshot"
|
|
13262
|
-
];
|
|
13263
|
-
export declare type TJourneyStepGoals = typeof journeyStepGoals[number];
|
|
13264
|
-
/**
|
|
13265
|
-
* @openapi
|
|
13266
|
-
*
|
|
13267
|
-
* components:
|
|
13268
|
-
* schemas:
|
|
13269
|
-
* IJourneyStep_2_0:
|
|
13270
|
-
* allOf:
|
|
13271
|
-
* - type: object
|
|
13272
|
-
* properties:
|
|
13273
|
-
* referenceId:
|
|
13274
|
-
* type: string
|
|
13275
|
-
* name:
|
|
13276
|
-
* type: string
|
|
13277
|
-
* description: The name of this journey step, e.g. 'Create a Virtual Agent'
|
|
13278
|
-
* link:
|
|
13279
|
-
* type: string
|
|
13280
|
-
* description: A hyperlink to our helpdesk for this journey step.
|
|
13281
|
-
* summary:
|
|
13282
|
-
* type: string
|
|
13283
|
-
* description: A quick summary what this journey step is about.
|
|
13284
|
-
* description:
|
|
13285
|
-
* type: string
|
|
13286
|
-
* description: The full-blown description for this journey step containing rich media.
|
|
13287
|
-
* goals:
|
|
13288
|
-
* type: array
|
|
13289
|
-
* items:
|
|
13290
|
-
* type: string
|
|
13291
|
-
* description: Internal name of the goal.
|
|
13292
|
-
*/
|
|
13293
|
-
export interface IJourneyStep_2_0 {
|
|
13294
|
-
/** The reference id of the journey step */
|
|
13295
|
-
referenceId: string;
|
|
13296
|
-
/** The name of this journey step */
|
|
13297
|
-
name: string;
|
|
13298
|
-
/** Hyperlink to our helpdesk */
|
|
13299
|
-
link: string;
|
|
13300
|
-
/** Summary of this journey step */
|
|
13301
|
-
summary: string;
|
|
13302
|
-
/** Full description */
|
|
13303
|
-
description: string;
|
|
13304
|
-
/** The goals which need to be completed in order to complete this step */
|
|
13305
|
-
goals: TJourneyStepGoals[];
|
|
13306
|
-
}
|
|
13307
|
-
/**
|
|
13308
|
-
* @openapi
|
|
13309
|
-
*
|
|
13310
|
-
* components:
|
|
13311
|
-
* schemas:
|
|
13312
|
-
* IJourney_2_0:
|
|
13313
|
-
* allOf:
|
|
13314
|
-
* - type: object
|
|
13315
|
-
* properties:
|
|
13316
|
-
* name:
|
|
13317
|
-
* type: string
|
|
13318
|
-
* description: The name of the journey.
|
|
13319
|
-
* link:
|
|
13320
|
-
* type: string
|
|
13321
|
-
* description: A hyperlink to the help-center for this journey.
|
|
13322
|
-
* summary:
|
|
13323
|
-
* type: string
|
|
13324
|
-
* description: A quick summary for what the journey is about.
|
|
13325
|
-
* steps:
|
|
13326
|
-
* $ref: '#/components/schemas/IJourneyStep_2_0'
|
|
13327
|
-
* - $ref: '#/components/schemas/IEntityMeta'
|
|
13328
|
-
*/
|
|
13329
|
-
export interface IJourney_2_0 {
|
|
13330
|
-
/** The object id of the journey */
|
|
13331
|
-
_id: TMongoId;
|
|
13332
|
-
/** The reference id of the journey */
|
|
13333
|
-
referenceId: string;
|
|
13334
|
-
/** The name of the journey */
|
|
13335
|
-
name: string;
|
|
13336
|
-
/** The hyperlink to the helpdesk for this journey */
|
|
13337
|
-
link: string;
|
|
13338
|
-
/** Summary of the journey */
|
|
13339
|
-
summary: string;
|
|
13340
|
-
/** The list of journey steps in this journey */
|
|
13341
|
-
steps: IJourneyStep_2_0[];
|
|
13342
|
-
createdAt: number;
|
|
13343
|
-
lastChanged: number;
|
|
13344
|
-
createdBy: TMongoId;
|
|
13345
|
-
lastChangedBy: TMongoId;
|
|
13346
|
-
}
|
|
13347
|
-
/**
|
|
13348
|
-
* @openapi
|
|
13349
|
-
*
|
|
13350
|
-
* components:
|
|
13351
|
-
* schemas:
|
|
13352
|
-
* IJourneyIndexItem_2_0:
|
|
13353
|
-
* allOf:
|
|
13354
|
-
* - type: object
|
|
13355
|
-
* properties:
|
|
13356
|
-
* referenceId:
|
|
13357
|
-
* type: string
|
|
13358
|
-
* name:
|
|
13359
|
-
* type: string
|
|
13360
|
-
* description: The name of the journey.
|
|
13361
|
-
* link:
|
|
13362
|
-
* type: string
|
|
13363
|
-
* description: A hyperlink to the help-center for this journey.
|
|
13364
|
-
* summary:
|
|
13365
|
-
* type: string
|
|
13366
|
-
* description: A quick summary for what the journey is about.
|
|
13367
|
-
* - $ref: '#/components/schemas/IEntityMeta'
|
|
13368
|
-
*/
|
|
13369
|
-
export interface IJourneyIndexItem_2_0 {
|
|
13370
|
-
/** The object id of the journey */
|
|
13371
|
-
_id: TMongoId;
|
|
13372
|
-
/** The reference id of the journey */
|
|
13373
|
-
referenceId: string;
|
|
13374
|
-
/** The name of the journey */
|
|
13375
|
-
name: string;
|
|
13376
|
-
/** The hyperlink to the helpdesk for this journey */
|
|
13377
|
-
link: string;
|
|
13378
|
-
/** Summary of the journey */
|
|
13379
|
-
summary: string;
|
|
13380
|
-
/** Unix-timestamp when the entity was created initially */
|
|
13381
|
-
createdAt: number;
|
|
13382
|
-
/** Unix-timestamp when the entity was changed last time */
|
|
13383
|
-
lastChanged: number;
|
|
13384
|
-
/** Id of the user who created the entity initially */
|
|
13385
|
-
createdBy: TMongoId;
|
|
13386
|
-
/** Id of the user who did the last modification */
|
|
13387
|
-
lastChangedBy: TMongoId;
|
|
13388
|
-
}
|
|
13389
|
-
/**
|
|
13390
|
-
* @openapi
|
|
13391
|
-
*
|
|
13392
|
-
* components:
|
|
13393
|
-
* schemas:
|
|
13394
|
-
* IJourneyProgress_2_0:
|
|
13395
|
-
* allOf:
|
|
13396
|
-
* - type: object
|
|
13397
|
-
* properties:
|
|
13398
|
-
* userReference:
|
|
13399
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
13400
|
-
* organisationReference:
|
|
13401
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
13402
|
-
* isCurrent:
|
|
13403
|
-
* type: boolean
|
|
13404
|
-
* description: Information whether this progress object keeps track of the currently selected journey.
|
|
13405
|
-
* isComplete:
|
|
13406
|
-
* type: boolean
|
|
13407
|
-
* description: Information whether the currently selected journey is complete.
|
|
13408
|
-
* journeyReferenceId:
|
|
13409
|
-
* type: string
|
|
13410
|
-
* journeySteps:
|
|
13411
|
-
* $ref: '#/components/schemas/IJourneyStepProgress_2_0'
|
|
13412
|
-
*/
|
|
13413
|
-
export interface IJourneyProgress_2_0 {
|
|
13414
|
-
/** The user who owns this journey progress object */
|
|
13415
|
-
userReference: TMongoId;
|
|
13416
|
-
/** The organisation id the user belongs to who owns the progress object */
|
|
13417
|
-
organisationReference: TMongoId;
|
|
13418
|
-
/** Whether this is the current journey */
|
|
13419
|
-
isCurrent: boolean;
|
|
13420
|
-
/** Whether this journey was completed already */
|
|
13421
|
-
isComplete: boolean;
|
|
13422
|
-
/** A reference to the journey this progress object is for */
|
|
13423
|
-
journeyReferenceId: TMongoId;
|
|
13424
|
-
/** Stores information about the steps and their progress */
|
|
13425
|
-
journeySteps: IJourneyStepProgress_2_0[];
|
|
13426
|
-
}
|
|
13427
|
-
/**
|
|
13428
|
-
* @openapi
|
|
13429
|
-
*
|
|
13430
|
-
* components:
|
|
13431
|
-
* schemas:
|
|
13432
|
-
* IJourneyStepProgress_2_0:
|
|
13433
|
-
* allOf:
|
|
13434
|
-
* - type: object
|
|
13435
|
-
* properties:
|
|
13436
|
-
* journeyStepReferenceId:
|
|
13437
|
-
* type: string
|
|
13438
|
-
* isComplete:
|
|
13439
|
-
* type: boolean
|
|
13440
|
-
* completedGoals:
|
|
13441
|
-
* type: array
|
|
13442
|
-
* items:
|
|
13443
|
-
* type: string
|
|
13444
|
-
*/
|
|
13445
|
-
export interface IJourneyStepProgress_2_0 {
|
|
13446
|
-
/** The id of this journey progress step */
|
|
13447
|
-
journeyStepReferenceId: TMongoId;
|
|
13448
|
-
/** Whether this step is complete */
|
|
13449
|
-
isComplete: boolean;
|
|
13450
|
-
/** The already completed goals */
|
|
13451
|
-
completedGoals: string[];
|
|
13452
|
-
}
|
|
13453
|
-
export interface IIndexJourneysRestData_2_0 extends IRestPagination<IJourneyIndexItem_2_0> {
|
|
13454
|
-
}
|
|
13455
|
-
export interface IIndexJourneysRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IJourneyIndexItem_2_0> {
|
|
13456
|
-
}
|
|
13457
|
-
export interface IReadJourneyRestDataParams_2_0 {
|
|
13458
|
-
journeyReferenceId: string;
|
|
13459
|
-
}
|
|
13460
|
-
export interface IReadJourneyRestData_2_0 extends IReadJourneyRestDataParams_2_0 {
|
|
13461
|
-
}
|
|
13462
|
-
export interface IReadJourneyRestReturnValue_2_0 extends IJourney_2_0 {
|
|
13463
|
-
}
|
|
13464
|
-
export interface IReadJourneyProgressRestData_2_0 {
|
|
13465
|
-
}
|
|
13466
|
-
export interface IReadJourneyProgressRestReturnValue_2_0 extends IJourneyProgress_2_0 {
|
|
13467
|
-
}
|
|
13468
|
-
/**
|
|
13469
|
-
* @openapi
|
|
13470
|
-
*
|
|
13471
|
-
* components:
|
|
13472
|
-
* schemas:
|
|
13473
|
-
* IJourneyTrackEventBase_2_0:
|
|
13474
|
-
* allOf:
|
|
13475
|
-
* - type: object
|
|
13476
|
-
* properties:
|
|
13477
|
-
* event:
|
|
13478
|
-
* type: string
|
|
13479
|
-
* description: The name of the event to track.
|
|
13480
|
-
* example: createFlow
|
|
13481
|
-
* payload:
|
|
13482
|
-
* type: object
|
|
13483
|
-
*/
|
|
13484
|
-
export interface IJourneyTrackEventBase_2_0 {
|
|
13485
|
-
event: string;
|
|
13486
|
-
payload: {
|
|
13487
|
-
[key: string]: any;
|
|
13488
|
-
};
|
|
13489
|
-
}
|
|
13490
|
-
export interface ITrackJourneyEventRestDataBody_2_0 extends IJourneyTrackEventBase_2_0 {
|
|
14225
|
+
export interface IReadConnectionRestReturnValue_2_0 extends IConnection_2_0 {
|
|
14226
|
+
}
|
|
14227
|
+
export interface IUpdateConnectionRestDataBody_2_0 extends Partial<Pick<IConnection_2_0, "fields">> {
|
|
14228
|
+
}
|
|
14229
|
+
export interface IUpdateConnectionRestDataParams_2_0 {
|
|
14230
|
+
connectionId: string;
|
|
14231
|
+
}
|
|
14232
|
+
export interface IUpdateConnectionRestData_2_0 extends IUpdateConnectionRestDataBody_2_0, IUpdateConnectionRestDataParams_2_0 {
|
|
13491
14233
|
}
|
|
13492
|
-
export interface
|
|
14234
|
+
export interface IUpdateConnectionRestReturnValue_2_0 {
|
|
14235
|
+
}
|
|
14236
|
+
export interface IDeleteConnectionRestDataParams_2_0 {
|
|
14237
|
+
connectionId: string;
|
|
13493
14238
|
}
|
|
13494
|
-
export interface
|
|
14239
|
+
export interface IDeleteConnectionRestData_2_0 extends IDeleteConnectionRestDataParams_2_0 {
|
|
14240
|
+
}
|
|
14241
|
+
export interface IDeleteConnectionRestReturnValue_2_0 {
|
|
13495
14242
|
}
|
|
13496
14243
|
/**
|
|
13497
14244
|
* @openapi
|
|
13498
14245
|
*
|
|
13499
14246
|
* components:
|
|
13500
14247
|
* schemas:
|
|
13501
|
-
*
|
|
14248
|
+
* IConnectionData_2_0:
|
|
13502
14249
|
* type: object
|
|
13503
14250
|
* properties:
|
|
13504
|
-
*
|
|
14251
|
+
* key:
|
|
14252
|
+
* type: string
|
|
14253
|
+
* description: The key of the connection field. The key should match the connection schema of the specific connection type.
|
|
14254
|
+
* example: some-key-from-connection-schema
|
|
14255
|
+
* value:
|
|
13505
14256
|
* type: string
|
|
14257
|
+
* description: The value of the connection field
|
|
14258
|
+
* example: x123w123
|
|
13506
14259
|
*/
|
|
13507
|
-
export interface
|
|
13508
|
-
|
|
14260
|
+
export interface IConnectionField_2_0 {
|
|
14261
|
+
key: string;
|
|
14262
|
+
value: string;
|
|
14263
|
+
}
|
|
14264
|
+
export interface ICreateConnectionFieldRestDataParams_2_0 {
|
|
14265
|
+
connectionId: string;
|
|
14266
|
+
}
|
|
14267
|
+
export interface ICreateConnectionFieldRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnectionField_2_0, keyof IEntityMeta>> {
|
|
14268
|
+
}
|
|
14269
|
+
export interface ICreateConnectionFieldRestData_2_0 extends ICreateConnectionFieldRestDataParams_2_0, ICreateConnectionFieldRestDataBody_2_0 {
|
|
14270
|
+
}
|
|
14271
|
+
export interface ICreateConnectionFieldRestReturnValue_2_0 {
|
|
14272
|
+
}
|
|
14273
|
+
export interface IDeleteConnectionFieldRestDataParams_2_0 {
|
|
14274
|
+
connectionId: string;
|
|
14275
|
+
fieldName: string;
|
|
13509
14276
|
}
|
|
13510
|
-
export interface
|
|
14277
|
+
export interface IDeleteConnectionFieldRestData_2_0 extends IDeleteConnectionFieldRestDataParams_2_0 {
|
|
13511
14278
|
}
|
|
13512
|
-
export interface
|
|
14279
|
+
export interface IDeleteConnectionFieldRestReturnValue_2_0 {
|
|
13513
14280
|
}
|
|
13514
14281
|
declare const slotFillerTypesGeneric: readonly [
|
|
13515
14282
|
"age",
|
|
@@ -14289,6 +15056,13 @@ export interface ILogNodeParams extends INodeFunctionBaseParams {
|
|
|
14289
15056
|
message: string;
|
|
14290
15057
|
};
|
|
14291
15058
|
}
|
|
15059
|
+
export interface IDebugMessageNodeParams extends INodeFunctionBaseParams {
|
|
15060
|
+
config: {
|
|
15061
|
+
level: "info" | "error";
|
|
15062
|
+
message: string;
|
|
15063
|
+
header: string;
|
|
15064
|
+
};
|
|
15065
|
+
}
|
|
14292
15066
|
export interface IDatePickerConfig {
|
|
14293
15067
|
datepicker_eventName: string;
|
|
14294
15068
|
datepicker_locale: string;
|
|
@@ -14381,15 +15155,16 @@ export interface IVoiceConfigParams {
|
|
|
14381
15155
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14382
15156
|
userNoInputMode: TVoiceGateway2UserNoInputMode;
|
|
14383
15157
|
userNoInputTimeout: number;
|
|
15158
|
+
userNoInputTimeoutEnable: boolean;
|
|
14384
15159
|
userNoInputRetries: number;
|
|
14385
15160
|
userNoInputSpeech: string;
|
|
14386
15161
|
userNoInputUrl: string;
|
|
14387
|
-
|
|
14388
|
-
|
|
14389
|
-
|
|
14390
|
-
|
|
14391
|
-
|
|
14392
|
-
|
|
15162
|
+
flowNoInputTimeoutEnable: boolean;
|
|
15163
|
+
flowNoInputTimeout: number;
|
|
15164
|
+
flowNoInputMode: TVoiceGateway2FlowNoInputMode;
|
|
15165
|
+
flowNoInputRetries: number;
|
|
15166
|
+
flowNoInputSpeech: string;
|
|
15167
|
+
flowNoInputUrl: string;
|
|
14393
15168
|
dtmfEnable: boolean;
|
|
14394
15169
|
dtmfInterDigitTimeout: number;
|
|
14395
15170
|
dtmfMaxDigits: number;
|
|
@@ -14409,11 +15184,17 @@ export interface IVoiceConfigParams {
|
|
|
14409
15184
|
sttGoogleLang1: string;
|
|
14410
15185
|
sttGoogleLang2: string;
|
|
14411
15186
|
sttGoogleLang3: string;
|
|
14412
|
-
|
|
14413
|
-
sttDeepgramModel: string;
|
|
15187
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14414
15188
|
deepgramEndpointing: boolean;
|
|
14415
15189
|
deepgramEndpointingValue: number;
|
|
14416
15190
|
deepgramSmartFormatting: boolean;
|
|
15191
|
+
atmosphereAction: TVoiceGateway2DubActionType;
|
|
15192
|
+
atmosphereUrl: string;
|
|
15193
|
+
atmosphereLoop: boolean;
|
|
15194
|
+
atmosphereVolume: number;
|
|
15195
|
+
silenceOverlayAction: boolean | string;
|
|
15196
|
+
silenceOverlayURL: string;
|
|
15197
|
+
silenceOverlayDelay: number;
|
|
14417
15198
|
}
|
|
14418
15199
|
export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
|
|
14419
15200
|
config: IVoiceConfigParams;
|
|
@@ -14479,8 +15260,7 @@ export interface IVoiceConfigParams {
|
|
|
14479
15260
|
azureSttContextId: string;
|
|
14480
15261
|
azureEnableAudioLogging: boolean;
|
|
14481
15262
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14482
|
-
|
|
14483
|
-
sttDeepgramModel: string;
|
|
15263
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14484
15264
|
deepgramEndpointing: boolean;
|
|
14485
15265
|
deepgramEndpointingValue: number;
|
|
14486
15266
|
deepgramSmartFormatting: boolean;
|
|
@@ -14556,8 +15336,25 @@ export interface ISetRatingParams extends INodeFunctionBaseParams {
|
|
|
14556
15336
|
}
|
|
14557
15337
|
export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
|
|
14558
15338
|
config: {
|
|
15339
|
+
ratingScreenTitleText: string;
|
|
14559
15340
|
ratingTitleText: string;
|
|
14560
15341
|
ratingCommentText: string;
|
|
15342
|
+
ratingSubmitButtonText: string;
|
|
15343
|
+
ratingEventBannerText: string;
|
|
15344
|
+
ratingChatStatusMessage: string;
|
|
15345
|
+
};
|
|
15346
|
+
}
|
|
15347
|
+
export interface ITrackMilestoneNodeParams extends INodeFunctionBaseParams {
|
|
15348
|
+
config: {
|
|
15349
|
+
milestone: {
|
|
15350
|
+
milestoneId: string;
|
|
15351
|
+
name: string;
|
|
15352
|
+
version: string;
|
|
15353
|
+
selectedSteps: {
|
|
15354
|
+
stepId: string;
|
|
15355
|
+
type: string;
|
|
15356
|
+
}[];
|
|
15357
|
+
};
|
|
14561
15358
|
};
|
|
14562
15359
|
}
|
|
14563
15360
|
export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
|
|
@@ -14861,8 +15658,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
|
14861
15658
|
recognitionChannel: number;
|
|
14862
15659
|
sttLanguage: string;
|
|
14863
15660
|
sttVendor: string;
|
|
14864
|
-
|
|
14865
|
-
sttDeepgramModel: string;
|
|
15661
|
+
sttDeepgramModel: VoiceGatewayDeepgramModel;
|
|
14866
15662
|
sttDisablePunctuation: boolean;
|
|
14867
15663
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14868
15664
|
sttLabel: string;
|
|
@@ -14919,6 +15715,7 @@ export interface ISearchExtractOutputNodeParams extends INodeFunctionBaseParams
|
|
|
14919
15715
|
searchStoreLocationContextKey: string;
|
|
14920
15716
|
searchStoreLocationInputKey: string;
|
|
14921
15717
|
searchSourceTags: string[];
|
|
15718
|
+
searchSourceTagsFilterOp: ISearchTagsFilterOps;
|
|
14922
15719
|
knowledgeStoreId?: string;
|
|
14923
15720
|
prompt: string;
|
|
14924
15721
|
temperature: number;
|
|
@@ -14957,6 +15754,7 @@ export interface ICognigyBasicNodes {
|
|
|
14957
15754
|
resetContext: ICreateChartNodeBasicNodesData<"resetContext", IResetContextNodeParams, TBASIC_EXTENSION>;
|
|
14958
15755
|
code: ICreateChartNodeBasicNodesData<"code", ICodeNodeBasicParams, TBASIC_EXTENSION>;
|
|
14959
15756
|
log: ICreateChartNodeBasicNodesData<"log", ILogNodeParams, TBASIC_EXTENSION>;
|
|
15757
|
+
debugMessage: ICreateChartNodeBasicNodesData<"debugMessage", IDebugMessageNodeParams, TBASIC_EXTENSION>;
|
|
14960
15758
|
activateProfile: ICreateChartNodeBasicNodesData<"activateProfile", IActivateProfileNodeParams, TBASIC_EXTENSION>;
|
|
14961
15759
|
blindMode: ICreateChartNodeBasicNodesData<"blindMode", IBlindModeNodeParams, TBASIC_EXTENSION>;
|
|
14962
15760
|
completeGoal: ICreateChartNodeBasicNodesData<"completeGoal", ICompleteGoalNodeParams, TBASIC_EXTENSION>;
|
|
@@ -14967,6 +15765,7 @@ export interface ICognigyBasicNodes {
|
|
|
14967
15765
|
overwriteAnalytics: ICreateChartNodeBasicNodesData<"overwriteAnalytics", IOverwriteAnalyticsParams, TBASIC_EXTENSION>;
|
|
14968
15766
|
setRating: ICreateChartNodeBasicNodesData<"setRating", ISetRatingParams, TBASIC_EXTENSION>;
|
|
14969
15767
|
requestRating: ICreateChartNodeBasicNodesData<"requestRating", IRequestRatingNodeParams, TBASIC_EXTENSION>;
|
|
15768
|
+
trackMilestone: ICreateChartNodeBasicNodesData<"trackMilestone", ITrackMilestoneNodeParams, TBASIC_EXTENSION>;
|
|
14970
15769
|
executeFlow: ICreateChartNodeBasicNodesData<"executeFlow", IExecuteFlowNodeParams, TBASIC_EXTENSION>;
|
|
14971
15770
|
goTo: ICreateChartNodeBasicNodesData<"goTo", IGoToNodeParams, TBASIC_EXTENSION>;
|
|
14972
15771
|
if: ICreateChartNodeBasicNodesData<"if", IIfNodeParams, TBASIC_EXTENSION>;
|
|
@@ -14985,7 +15784,6 @@ export interface ICognigyBasicNodes {
|
|
|
14985
15784
|
say: ICreateChartNodeBasicNodesData<"say", ISayNodeParams, TBASIC_EXTENSION>;
|
|
14986
15785
|
addLexiconKeyphrase: ICreateChartNodeBasicNodesData<"addLexiconKeyphrase", IAddLexiconKeyphraseNodeParams, TBASIC_EXTENSION>;
|
|
14987
15786
|
executeCognigyNLU: ICreateChartNodeBasicNodesData<"executeCognigyNLU", IExecuteCognigyNLUNodeParams, TBASIC_EXTENSION>;
|
|
14988
|
-
extractAnswer: ICreateChartNodeBasicNodesData<"extractAnswer", IExtractAnswerNodeParams, TBASIC_EXTENSION>;
|
|
14989
15787
|
regexSlotFiller: ICreateChartNodeBasicNodesData<"regexSlotFiller", IRegexSlotFillerParams, TBASIC_EXTENSION>;
|
|
14990
15788
|
matchPattern: ICreateChartNodeBasicNodesData<"matchPattern", IMatchPatternParams, TBASIC_EXTENSION>;
|
|
14991
15789
|
fuzzySearch: ICreateChartNodeBasicNodesData<"fuzzySearch", IFuzzySearchParams, TBASIC_EXTENSION>;
|
|
@@ -15401,10 +16199,18 @@ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<I
|
|
|
15401
16199
|
export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
|
|
15402
16200
|
}
|
|
15403
16201
|
export interface IOpenAIMeta_2_0 {
|
|
15404
|
-
customModel
|
|
16202
|
+
customModel?: string;
|
|
16203
|
+
}
|
|
16204
|
+
export interface IAnthropicMeta_2_0 {
|
|
16205
|
+
customModel?: string;
|
|
16206
|
+
}
|
|
16207
|
+
export interface IAwsBedrockMeta_2_0 {
|
|
16208
|
+
region: string;
|
|
16209
|
+
customModel?: string;
|
|
15405
16210
|
}
|
|
15406
16211
|
export interface IAlephAlphaMeta_2_0 {
|
|
15407
|
-
customModel
|
|
16212
|
+
customModel?: string;
|
|
16213
|
+
baseCustomUrl?: string;
|
|
15408
16214
|
}
|
|
15409
16215
|
export interface IAzureOpenAIMeta_2_0 {
|
|
15410
16216
|
resourceName?: string;
|
|
@@ -15417,6 +16223,16 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15417
16223
|
apiEndPoint: string;
|
|
15418
16224
|
publisher?: string;
|
|
15419
16225
|
}
|
|
16226
|
+
/******************************************************************************/
|
|
16227
|
+
/**
|
|
16228
|
+
* IMPORTANT!
|
|
16229
|
+
* Openapi components from the llm-providers pacakge, if you need to updtate something here
|
|
16230
|
+
* make sure that the actual code in the llm-providers package is updated as well
|
|
16231
|
+
*/
|
|
16232
|
+
/******************************************************************************/
|
|
16233
|
+
export interface IGoogleGeminiMeta_2_0 {
|
|
16234
|
+
location: string;
|
|
16235
|
+
}
|
|
15420
16236
|
/**
|
|
15421
16237
|
* @openapi
|
|
15422
16238
|
*
|
|
@@ -15425,6 +16241,7 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15425
16241
|
* ILargeLanguageModelFields_2_0:
|
|
15426
16242
|
* allOf:
|
|
15427
16243
|
* - type: object
|
|
16244
|
+
* required: ['name', 'modelType', 'provider', 'connectionId']
|
|
15428
16245
|
* properties:
|
|
15429
16246
|
* name:
|
|
15430
16247
|
* type: string
|
|
@@ -15434,7 +16251,12 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15434
16251
|
* example: "LLM meaningful description"
|
|
15435
16252
|
* modelType:
|
|
15436
16253
|
* $ref: '#/components/schemas/TGenerativeAIModels'
|
|
15437
|
-
|
|
16254
|
+
* modelGroup:
|
|
16255
|
+
* $ref: '#/components/schemas/TModelGroups'
|
|
16256
|
+
* isCustomModel:
|
|
16257
|
+
* type: boolean
|
|
16258
|
+
* example: true
|
|
16259
|
+
* provider:
|
|
15438
16260
|
* $ref: '#/components/schemas/TGenerativeAIProviders'
|
|
15439
16261
|
* connectionId:
|
|
15440
16262
|
* type: string
|
|
@@ -15451,6 +16273,15 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15451
16273
|
* customModel:
|
|
15452
16274
|
* type: string
|
|
15453
16275
|
* example: gpt-4-32k-0613
|
|
16276
|
+
* description: The custom model name. This does not work with embedding models
|
|
16277
|
+
* anthropic:
|
|
16278
|
+
* type: object
|
|
16279
|
+
* description: Anthropic specific meta data
|
|
16280
|
+
* properties:
|
|
16281
|
+
* customModel:
|
|
16282
|
+
* type: string
|
|
16283
|
+
* example: claude-3-opus-20240229
|
|
16284
|
+
* description: The custom model name. This does not work with embedding models
|
|
15454
16285
|
* azureOpenAI:
|
|
15455
16286
|
* type: object
|
|
15456
16287
|
* description: Azure OpenAI specific meta data
|
|
@@ -15461,6 +16292,39 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15461
16292
|
* type: string
|
|
15462
16293
|
* apiVersion:
|
|
15463
16294
|
* type: string
|
|
16295
|
+
* baseCustomUrl:
|
|
16296
|
+
* type: string
|
|
16297
|
+
* example:
|
|
16298
|
+
* - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
|
|
16299
|
+
* - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
|
|
16300
|
+
* - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
|
|
16301
|
+
* googleVertexAI:
|
|
16302
|
+
* type: object
|
|
16303
|
+
* description: Google VertexAI specific meta data
|
|
16304
|
+
* properties:
|
|
16305
|
+
* location:
|
|
16306
|
+
* type: string
|
|
16307
|
+
* apiEndpoint:
|
|
16308
|
+
* type: string
|
|
16309
|
+
* publisher:
|
|
16310
|
+
* type: string
|
|
16311
|
+
* googleGemini:
|
|
16312
|
+
* type: object
|
|
16313
|
+
* description: Google Gemini specific meta data
|
|
16314
|
+
* properties:
|
|
16315
|
+
* location:
|
|
16316
|
+
* type: string
|
|
16317
|
+
* alephAlpha:
|
|
16318
|
+
* type: object
|
|
16319
|
+
* description: Aleph Alpha specific meta data
|
|
16320
|
+
* properties:
|
|
16321
|
+
* customModel:
|
|
16322
|
+
* type: string
|
|
16323
|
+
* example: luminous-003
|
|
16324
|
+
* description: The custom model name. This does not work with embedding models
|
|
16325
|
+
* baseCustomUrl:
|
|
16326
|
+
* type: string
|
|
16327
|
+
* example: https://api.aleph-alpha.com
|
|
15464
16328
|
*
|
|
15465
16329
|
* ILargeLanguageModelCreate_2_0:
|
|
15466
16330
|
* allOf:
|
|
@@ -15487,6 +16351,9 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15487
16351
|
name: string;
|
|
15488
16352
|
description: string;
|
|
15489
16353
|
modelType: TGenerativeAIModels;
|
|
16354
|
+
/** model type e.g. chat */
|
|
16355
|
+
modelGroup?: TModeType;
|
|
16356
|
+
isCustomModel?: boolean;
|
|
15490
16357
|
provider: TGenerativeAIProviders;
|
|
15491
16358
|
connectionId: string;
|
|
15492
16359
|
isDefault: boolean;
|
|
@@ -15502,6 +16369,12 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15502
16369
|
alephAlpha?: IAlephAlphaMeta_2_0;
|
|
15503
16370
|
/** Meta data for the GoogleVertexAI connection */
|
|
15504
16371
|
googleVertexAI?: IGoogleVertexAIMeta_2_0;
|
|
16372
|
+
/** Meta data for the GoogleGemini connection */
|
|
16373
|
+
googleGemini?: IGoogleGeminiMeta_2_0;
|
|
16374
|
+
/** Meta data for the Anthropic connection */
|
|
16375
|
+
anthropic?: IAnthropicMeta_2_0;
|
|
16376
|
+
/** Meta data for the AwsBedrock connection */
|
|
16377
|
+
awsBedrock?: IAwsBedrockMeta_2_0;
|
|
15505
16378
|
}
|
|
15506
16379
|
export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
|
|
15507
16380
|
}
|
|
@@ -15553,6 +16426,50 @@ export interface ITestLargeLanguageModelRestReturnValue_2_0 {
|
|
|
15553
16426
|
msg: string;
|
|
15554
16427
|
msgErr?: string;
|
|
15555
16428
|
}
|
|
16429
|
+
/**
|
|
16430
|
+
* @openapi
|
|
16431
|
+
* components:
|
|
16432
|
+
* schemas:
|
|
16433
|
+
* IAvailableModelItem_2_0:
|
|
16434
|
+
* type: object
|
|
16435
|
+
* properties:
|
|
16436
|
+
* modelName:
|
|
16437
|
+
* type: string
|
|
16438
|
+
* modelId:
|
|
16439
|
+
* type: string
|
|
16440
|
+
* providerName:
|
|
16441
|
+
* type: array
|
|
16442
|
+
*
|
|
16443
|
+
*/
|
|
16444
|
+
/**
|
|
16445
|
+
* @openapi
|
|
16446
|
+
* components:
|
|
16447
|
+
* schemas:
|
|
16448
|
+
* IAvailableModelsForLLMProvider_2_0:
|
|
16449
|
+
* allOf:
|
|
16450
|
+
* - type: object
|
|
16451
|
+
* properties:
|
|
16452
|
+
* availableModels:
|
|
16453
|
+
* type: array
|
|
16454
|
+
* items:
|
|
16455
|
+
* $ref: '#/components/schemas/IAvailableModelItem_2_0'
|
|
16456
|
+
*
|
|
16457
|
+
*/
|
|
16458
|
+
export interface IAvailableModelsForLLMProvider_2_0 {
|
|
16459
|
+
availableModels: {
|
|
16460
|
+
modelName: string;
|
|
16461
|
+
modelId: string;
|
|
16462
|
+
providerName: string;
|
|
16463
|
+
}[];
|
|
16464
|
+
}
|
|
16465
|
+
export interface IGetAvailableModelsForLLMRestDataParams_2_0 {
|
|
16466
|
+
largeLanguageModelId: string;
|
|
16467
|
+
}
|
|
16468
|
+
export interface IGetAvailableModelsForLLMRestData_2_0 extends IGetAvailableModelsForLLMRestDataParams_2_0 {
|
|
16469
|
+
connectionRefId: string;
|
|
16470
|
+
}
|
|
16471
|
+
export interface IGetAvailableModelsForLLMRestReturnValue_2_0 extends IAvailableModelsForLLMProvider_2_0 {
|
|
16472
|
+
}
|
|
15556
16473
|
/**
|
|
15557
16474
|
* @openapi
|
|
15558
16475
|
*
|
|
@@ -15664,9 +16581,16 @@ declare const knowledgeSourceType: readonly [
|
|
|
15664
16581
|
"pdf",
|
|
15665
16582
|
"txt",
|
|
15666
16583
|
"docx",
|
|
16584
|
+
"pptx",
|
|
15667
16585
|
"ctxt",
|
|
15668
16586
|
"url",
|
|
15669
|
-
"manual"
|
|
16587
|
+
"manual",
|
|
16588
|
+
"jpeg",
|
|
16589
|
+
"jpg",
|
|
16590
|
+
"png",
|
|
16591
|
+
"bmp",
|
|
16592
|
+
"heif",
|
|
16593
|
+
"tiff"
|
|
15670
16594
|
];
|
|
15671
16595
|
export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
|
|
15672
16596
|
export interface IKnowledgeSourceMetaData {
|
|
@@ -15676,6 +16600,7 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15676
16600
|
url?: string;
|
|
15677
16601
|
failReason?: string;
|
|
15678
16602
|
tags?: string[];
|
|
16603
|
+
extractedChunks?: number;
|
|
15679
16604
|
}
|
|
15680
16605
|
/**
|
|
15681
16606
|
* @openapi
|
|
@@ -15729,7 +16654,15 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15729
16654
|
* - ready
|
|
15730
16655
|
* - ingesting
|
|
15731
16656
|
* - disabled
|
|
15732
|
-
*
|
|
16657
|
+
* metaData:
|
|
16658
|
+
* type: object
|
|
16659
|
+
* properties:
|
|
16660
|
+
* tags:
|
|
16661
|
+
* type: array
|
|
16662
|
+
* description: Array of tags to replace the existing tags
|
|
16663
|
+
* items:
|
|
16664
|
+
* type: string
|
|
16665
|
+
* example: "tag1"
|
|
15733
16666
|
* IKnowledgeSourceDataTypeWebsite_2_0:
|
|
15734
16667
|
* allOf:
|
|
15735
16668
|
* - type: object
|
|
@@ -15822,6 +16755,7 @@ export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSour
|
|
|
15822
16755
|
export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
|
|
15823
16756
|
}
|
|
15824
16757
|
export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
|
|
16758
|
+
metaData?: Partial<Pick<IKnowledgeSourceMetaData, "tags">>;
|
|
15825
16759
|
}
|
|
15826
16760
|
export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
|
|
15827
16761
|
knowledgeStoreId: string;
|
|
@@ -15951,8 +16885,173 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
|
|
|
15951
16885
|
}
|
|
15952
16886
|
export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
|
|
15953
16887
|
}
|
|
16888
|
+
/**
|
|
16889
|
+
* @openapi
|
|
16890
|
+
*
|
|
16891
|
+
* components:
|
|
16892
|
+
* schemas:
|
|
16893
|
+
* IMilestoneIndexItem_2_0:
|
|
16894
|
+
* allOf:
|
|
16895
|
+
* - type: object
|
|
16896
|
+
* properties:
|
|
16897
|
+
* name:
|
|
16898
|
+
* type: string
|
|
16899
|
+
* description: The name of the milestone
|
|
16900
|
+
* example: New Milestone
|
|
16901
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
16902
|
+
*/
|
|
16903
|
+
export interface IMilestoneIndexItem_2_0 {
|
|
16904
|
+
_id: TMongoId;
|
|
16905
|
+
referenceId: string;
|
|
16906
|
+
name: string;
|
|
16907
|
+
description?: string;
|
|
16908
|
+
createdAt: number;
|
|
16909
|
+
lastChanged: number;
|
|
16910
|
+
createdBy: TMongoId;
|
|
16911
|
+
lastChangedBy: TMongoId;
|
|
16912
|
+
}
|
|
16913
|
+
export interface IIndexMilestonesRestData_2_0 extends IRestPagination<IMilestoneIndexItem_2_0>, Partial<IProjectScope> {
|
|
16914
|
+
}
|
|
16915
|
+
export interface IIndexMilestonesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IMilestoneIndexItem_2_0> {
|
|
16916
|
+
}
|
|
16917
|
+
/**
|
|
16918
|
+
* @openapi
|
|
16919
|
+
*
|
|
16920
|
+
* components:
|
|
16921
|
+
* schemas:
|
|
16922
|
+
* IMilestoneStepMetric_2_0:
|
|
16923
|
+
* type: object
|
|
16924
|
+
* properties:
|
|
16925
|
+
* name:
|
|
16926
|
+
* type: string
|
|
16927
|
+
* description: The name of the metric
|
|
16928
|
+
* example: Duration
|
|
16929
|
+
* description:
|
|
16930
|
+
* type: string
|
|
16931
|
+
* description: The description of the metric
|
|
16932
|
+
* example: Time taken to complete the step
|
|
16933
|
+
* type:
|
|
16934
|
+
* type: string
|
|
16935
|
+
* description: Metric type
|
|
16936
|
+
* example: "duration"
|
|
16937
|
+
* value:
|
|
16938
|
+
* type: number
|
|
16939
|
+
* description: Metric value
|
|
16940
|
+
* example: 30
|
|
16941
|
+
*/
|
|
16942
|
+
export interface IMilestoneStepMetric_2_0 {
|
|
16943
|
+
name: string;
|
|
16944
|
+
description: string;
|
|
16945
|
+
type?: "currency" | "duration";
|
|
16946
|
+
value?: number;
|
|
16947
|
+
}
|
|
16948
|
+
/**
|
|
16949
|
+
* @openapi
|
|
16950
|
+
* components:
|
|
16951
|
+
* schemas:
|
|
16952
|
+
* IMilestoneStep_2_0:
|
|
16953
|
+
* type: object
|
|
16954
|
+
* properties:
|
|
16955
|
+
* name:
|
|
16956
|
+
* type: string
|
|
16957
|
+
* description: The name of the milestone step
|
|
16958
|
+
* example: Step 1
|
|
16959
|
+
* description:
|
|
16960
|
+
* type: string
|
|
16961
|
+
* description: The description of the milestone step
|
|
16962
|
+
* example: This is the first step
|
|
16963
|
+
* order:
|
|
16964
|
+
* type: number
|
|
16965
|
+
* description: Step order in the milestone configuration
|
|
16966
|
+
* example: 1
|
|
16967
|
+
* type:
|
|
16968
|
+
* type: string
|
|
16969
|
+
* description: Step type
|
|
16970
|
+
* example: "start"
|
|
16971
|
+
* metrics:
|
|
16972
|
+
* type: array
|
|
16973
|
+
* items:
|
|
16974
|
+
* $ref: '#/components/schemas/IMilestoneStepMetric_2_0'
|
|
16975
|
+
*/
|
|
16976
|
+
export interface IMilestoneStep_2_0 {
|
|
16977
|
+
_id?: TMongoId;
|
|
16978
|
+
name?: string;
|
|
16979
|
+
description?: string;
|
|
16980
|
+
order?: number;
|
|
16981
|
+
type?: "start" | "completion";
|
|
16982
|
+
metrics?: IMilestoneStepMetric_2_0[];
|
|
16983
|
+
}
|
|
16984
|
+
/**
|
|
16985
|
+
* @openapi
|
|
16986
|
+
*
|
|
16987
|
+
* components:
|
|
16988
|
+
* schemas:
|
|
16989
|
+
* IMilestoneData_2_0:
|
|
16990
|
+
* type: object
|
|
16991
|
+
* properties:
|
|
16992
|
+
* name:
|
|
16993
|
+
* type: string
|
|
16994
|
+
* description: The name of the Milestone
|
|
16995
|
+
* example: New Milestone
|
|
16996
|
+
* description:
|
|
16997
|
+
* type: string
|
|
16998
|
+
* description: The description of the milestone
|
|
16999
|
+
* example: "This is a sample milestone"
|
|
17000
|
+
* steps:
|
|
17001
|
+
* type: array
|
|
17002
|
+
* items:
|
|
17003
|
+
* $ref: '#/components/schemas/IMilestoneStep_2_0'
|
|
17004
|
+
*
|
|
17005
|
+
* IMilestone_2_0:
|
|
17006
|
+
* allOf:
|
|
17007
|
+
* - $ref: '#/components/schemas/IMilestoneData_2_0'
|
|
17008
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
17009
|
+
*
|
|
17010
|
+
*/
|
|
17011
|
+
export interface IMilestone_2_0 {
|
|
17012
|
+
_id: TMongoId;
|
|
17013
|
+
referenceId: string;
|
|
17014
|
+
name: string;
|
|
17015
|
+
version: string;
|
|
17016
|
+
createdAt: number;
|
|
17017
|
+
lastChanged: number;
|
|
17018
|
+
createdBy: TMongoId;
|
|
17019
|
+
lastChangedBy: TMongoId;
|
|
17020
|
+
description: string;
|
|
17021
|
+
steps: IMilestoneStep_2_0[];
|
|
17022
|
+
}
|
|
17023
|
+
export interface ICreateMilestoneRestDataBody_2_0 extends IProjectScope, Partial<Omit<IMilestone_2_0, keyof IEntityMeta>> {
|
|
17024
|
+
}
|
|
17025
|
+
export interface ICreateMilestoneRestData_2_0 extends ICreateMilestoneRestDataBody_2_0 {
|
|
17026
|
+
}
|
|
17027
|
+
export interface ICreateMilestoneRestReturnValue_2_0 extends IMilestone_2_0 {
|
|
17028
|
+
}
|
|
17029
|
+
export interface IReadMilestoneRestDataParams_2_0 {
|
|
17030
|
+
milestoneId: string;
|
|
17031
|
+
}
|
|
17032
|
+
export interface IReadMilestoneRestData_2_0 extends IReadMilestoneRestDataParams_2_0 {
|
|
17033
|
+
}
|
|
17034
|
+
export interface IReadMilestoneRestReturnValue_2_0 extends IMilestone_2_0 {
|
|
17035
|
+
}
|
|
17036
|
+
export interface IUpdateMilestoneRestDataParams_2_0 {
|
|
17037
|
+
milestoneId: string;
|
|
17038
|
+
}
|
|
17039
|
+
export interface IUpdateMilestoneRestDataBody_2_0 extends Partial<Omit<IMilestone_2_0, keyof IEntityMeta>> {
|
|
17040
|
+
}
|
|
17041
|
+
export interface IUpdateMilestoneRestData_2_0 extends IUpdateMilestoneRestDataBody_2_0, IUpdateMilestoneRestDataParams_2_0 {
|
|
17042
|
+
}
|
|
17043
|
+
export interface IUpdateMilestoneRestReturnValue_2_0 {
|
|
17044
|
+
}
|
|
17045
|
+
export interface IDeleteMilestoneRestDataParams_2_0 {
|
|
17046
|
+
milestoneId: string;
|
|
17047
|
+
}
|
|
17048
|
+
export interface IDeleteMilestoneRestData_2_0 extends IDeleteMilestoneRestDataParams_2_0 {
|
|
17049
|
+
}
|
|
17050
|
+
export interface IDeleteMilestoneRestReturnValue_2_0 {
|
|
17051
|
+
}
|
|
15954
17052
|
declare const uploadResumableTypes: readonly [
|
|
15955
|
-
"snapshots"
|
|
17053
|
+
"snapshots",
|
|
17054
|
+
"packages"
|
|
15956
17055
|
];
|
|
15957
17056
|
export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
|
|
15958
17057
|
export interface HttpRequest {
|
|
@@ -15971,22 +17070,89 @@ export interface HttpResponse {
|
|
|
15971
17070
|
getBody(): string;
|
|
15972
17071
|
getUnderlyingObject(): any;
|
|
15973
17072
|
}
|
|
15974
|
-
export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
|
|
15975
|
-
file: Buffer | File;
|
|
15976
|
-
onError?: ((error: Error) => void) | null;
|
|
15977
|
-
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
15978
|
-
onSuccess?: (() => void) | null;
|
|
15979
|
-
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
15980
|
-
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
15981
|
-
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
15982
|
-
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
17073
|
+
export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
|
|
17074
|
+
file: Buffer | File;
|
|
17075
|
+
onError?: ((error: Error) => void) | null;
|
|
17076
|
+
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
17077
|
+
onSuccess?: (() => void) | null;
|
|
17078
|
+
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
17079
|
+
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
17080
|
+
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
17081
|
+
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
17082
|
+
}
|
|
17083
|
+
export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
|
|
17084
|
+
uploadType: TUploadResumableTypes;
|
|
17085
|
+
}
|
|
17086
|
+
export interface IUploadResumableRestReturnValue_2_0 {
|
|
17087
|
+
fileName: string;
|
|
17088
|
+
url: string;
|
|
17089
|
+
uploadId: string;
|
|
17090
|
+
}
|
|
17091
|
+
/**
|
|
17092
|
+
* @openapi
|
|
17093
|
+
*
|
|
17094
|
+
* components:
|
|
17095
|
+
* schemas:
|
|
17096
|
+
* IGenerateNluScoreData_2_0:
|
|
17097
|
+
* type: object
|
|
17098
|
+
* required:
|
|
17099
|
+
* - flowReferenceId
|
|
17100
|
+
* - localeReferenceId
|
|
17101
|
+
* - sentence
|
|
17102
|
+
* properties:
|
|
17103
|
+
* flowReferenceId:
|
|
17104
|
+
* type: string
|
|
17105
|
+
* format: uuid
|
|
17106
|
+
* description: UUID of the flow reference.
|
|
17107
|
+
* localeReferenceId:
|
|
17108
|
+
* type: string
|
|
17109
|
+
* format: uuid
|
|
17110
|
+
* description: UUID of the locale reference.
|
|
17111
|
+
* sentence:
|
|
17112
|
+
* type: string
|
|
17113
|
+
* description: Sentence to analyze for NLU scoring.
|
|
17114
|
+
*
|
|
17115
|
+
* IGeneratedNluScore_2_0:
|
|
17116
|
+
* type: object
|
|
17117
|
+
* properties:
|
|
17118
|
+
* id:
|
|
17119
|
+
* type: string
|
|
17120
|
+
* description: Unique identifier of the score.
|
|
17121
|
+
* name:
|
|
17122
|
+
* type: string
|
|
17123
|
+
* description: Name of the score type.
|
|
17124
|
+
* score:
|
|
17125
|
+
* type: number
|
|
17126
|
+
* description: Numerical value of the score.
|
|
17127
|
+
* negated:
|
|
17128
|
+
* type: boolean
|
|
17129
|
+
* description: Indicates if the score is negated.
|
|
17130
|
+
* confirmationSentence:
|
|
17131
|
+
* type: string
|
|
17132
|
+
* description: Sentence used to confirm the score.
|
|
17133
|
+
* confirmationSentences:
|
|
17134
|
+
* type: array
|
|
17135
|
+
* items:
|
|
17136
|
+
* type: string
|
|
17137
|
+
* description: Multiple sentences for confirmation if applicable.
|
|
17138
|
+
* disambiguationSentence:
|
|
17139
|
+
* type: string
|
|
17140
|
+
* description: Sentence used for disambiguation.
|
|
17141
|
+
* flow:
|
|
17142
|
+
* type: string
|
|
17143
|
+
* description: UUID of the flow associated with the score.
|
|
17144
|
+
*/
|
|
17145
|
+
export interface IGenerateNluScoresRestDataParams_2_0 {
|
|
17146
|
+
projectId: string;
|
|
17147
|
+
}
|
|
17148
|
+
export interface IGenerateNluScoresRestDataBody_2_0 {
|
|
17149
|
+
flowReferenceId: string;
|
|
17150
|
+
localeReferenceId: string;
|
|
17151
|
+
sentence: string;
|
|
15983
17152
|
}
|
|
15984
|
-
export interface
|
|
15985
|
-
uploadType: TUploadResumableTypes;
|
|
17153
|
+
export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
|
|
15986
17154
|
}
|
|
15987
|
-
export interface
|
|
15988
|
-
fileName: string;
|
|
15989
|
-
url: string;
|
|
17155
|
+
export interface IGenerateNluScoresRestReturnValue_2_0 {
|
|
15990
17156
|
}
|
|
15991
17157
|
export interface ResourcesAPIGroup_2_0 {
|
|
15992
17158
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
@@ -16054,6 +17220,11 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16054
17220
|
readEndpoint: TRestAPIOperation<IReadEndpointRestData_2_0, IReadEndpointRestReturnValue_2_0>;
|
|
16055
17221
|
updateEndpoint: TRestAPIOperation<IUpdateEndpointRestData_2_0, IUpdateEndpointRestReturnValue_2_0>;
|
|
16056
17222
|
deleteEndpoint: TRestAPIOperation<IDeleteEndpointRestData_2_0, IDeleteEndpointRestReturnValue_2_0>;
|
|
17223
|
+
indexMilestones: TRestAPIOperation<TRestAPIOptionalParameter<IIndexMilestonesRestData_2_0>, IIndexMilestonesRestReturnValue_2_0>;
|
|
17224
|
+
createMilestone: TRestAPIOperation<ICreateMilestoneRestData_2_0, ICreateMilestoneRestReturnValue_2_0>;
|
|
17225
|
+
readMilestone: TRestAPIOperation<IReadMilestoneRestData_2_0, IReadMilestoneRestReturnValue_2_0>;
|
|
17226
|
+
updateMilestone: TRestAPIOperation<IUpdateMilestoneRestData_2_0, IUpdateMilestoneRestReturnValue_2_0>;
|
|
17227
|
+
deleteMilestone: TRestAPIOperation<IDeleteMilestoneRestData_2_0, IDeleteMilestoneRestReturnValue_2_0>;
|
|
16057
17228
|
indexPlaybooks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexPlaybooksRestData_2_0>, IIndexPlaybooksRestReturnValue_2_0>;
|
|
16058
17229
|
batchPlaybooks: TRestAPIOperation<IBatchPlaybooksRestData_2_0, IBatchPlaybooksRestReturnValue_2_0>;
|
|
16059
17230
|
createPlaybook: TRestAPIOperation<ICreatePlaybookRestData_2_0, ICreatePlaybookRestReturnValue_2_0>;
|
|
@@ -16150,11 +17321,6 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16150
17321
|
readLocale: TRestAPIOperation<IReadLocaleRestData_2_0, IReadLocaleRestReturnValue_2_0>;
|
|
16151
17322
|
updateLocale: TRestAPIOperation<IUpdateLocaleRestData_2_0, IUpdateLocaleRestReturnValue_2_0>;
|
|
16152
17323
|
deleteLocale: TRestAPIOperation<IDeleteLocaleRestData_2_0, IDeleteLocaleRestReturnValue_2_0>;
|
|
16153
|
-
indexJourneys: TRestAPIOperation<IIndexJourneysRestData_2_0, IIndexJourneysRestReturnValue_2_0>;
|
|
16154
|
-
readJourney: TRestAPIOperation<IReadJourneyRestData_2_0, IReadJourneyRestReturnValue_2_0>;
|
|
16155
|
-
readJourneyProgress: TRestAPIOperation<IReadJourneyProgressRestData_2_0, IReadJourneyProgressRestReturnValue_2_0>;
|
|
16156
|
-
updateSelectedJourney: TRestAPIOperation<IUpdateSelectedJourneyRestData_2_0, IUpdateSelectedJourneyRestReturnValue_2_0>;
|
|
16157
|
-
trackJourneyEvent: TRestAPIOperation<ITrackJourneyEventRestData_2_0, ITrackJourneyEventRestReturnValue_2_0>;
|
|
16158
17324
|
indexSlotFillers: TRestAPIOperation<IIndexSlotFillersRestData_2_0, IIndexSlotFillersRestReturnValue_2_0>;
|
|
16159
17325
|
batchSlotFillers: TRestAPIOperation<IBatchSlotFillersRestData_2_0, IBatchSlotFillersRestReturnValue_2_0>;
|
|
16160
17326
|
createSlotFiller: TRestAPIOperation<ICreateSlotFillerRestData_2_0, ICreateSlotFillerRestReturnValue_2_0>;
|
|
@@ -16205,6 +17371,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16205
17371
|
deleteLargeLanguageModel: TRestAPIOperation<IDeleteLargeLanguageModelRestData_2_0, IDeleteLargeLanguageModelRestReturnValue_2_0>;
|
|
16206
17372
|
cloneLargeLanguageModel: TRestAPIOperation<ICloneLargeLanguageModelRestData_2_0, ICloneLargeLanguageModelRestReturnValue_2_0>;
|
|
16207
17373
|
testLargeLanguageModel: TRestAPIOperation<ITestLargeLanguageModelRestData_2_0, ITestLargeLanguageModelRestReturnValue_2_0>;
|
|
17374
|
+
getAvailableModelsForLLM: TRestAPIOperation<IGetAvailableModelsForLLMRestData_2_0, IGetAvailableModelsForLLMRestReturnValue_2_0>;
|
|
16208
17375
|
indexKnowledgeStores: TRestAPIOperation<IIndexKnowledgeStoresRestData_2_0, IIndexKnowledgeStoresRestReturnValue_2_0>;
|
|
16209
17376
|
createKnowledgeStore: TRestAPIOperation<ICreateKnowledgeStoreRestData_2_0, ICreateKnowledgeStoreRestReturnValue_2_0>;
|
|
16210
17377
|
readKnowledgeStore: TRestAPIOperation<IReadKnowledgeStoreRestData_2_0, IReadKnowledgeStoreRestReturnValue_2_0>;
|
|
@@ -16222,6 +17389,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16222
17389
|
deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
|
|
16223
17390
|
updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
|
|
16224
17391
|
uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
|
|
17392
|
+
generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
|
|
16225
17393
|
}
|
|
16226
17394
|
declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
|
|
16227
17395
|
/**
|
|
@@ -16685,6 +17853,8 @@ export interface IStep_2_0 {
|
|
|
16685
17853
|
* type: string
|
|
16686
17854
|
* children:
|
|
16687
17855
|
* type: array
|
|
17856
|
+
* items:
|
|
17857
|
+
* type: object
|
|
16688
17858
|
* example:
|
|
16689
17859
|
* step: Collect Email
|
|
16690
17860
|
* type: node
|
|
@@ -16731,9 +17901,7 @@ export interface IStepReport_2_0 {
|
|
|
16731
17901
|
* - done
|
|
16732
17902
|
* - error
|
|
16733
17903
|
* data:
|
|
16734
|
-
*
|
|
16735
|
-
* items:
|
|
16736
|
-
* $ref: '#/components/schemas/IStepReport_2_0'
|
|
17904
|
+
* $ref: '#/components/schemas/IStepReport_2_0'
|
|
16737
17905
|
*/
|
|
16738
17906
|
export interface ILoadStepReportByQueryHashResponse_2_0 {
|
|
16739
17907
|
status: "pending" | "done" | "error";
|
|
@@ -16792,6 +17960,14 @@ export interface InsightsAPIGroup_2_0 {
|
|
|
16792
17960
|
}>;
|
|
16793
17961
|
}
|
|
16794
17962
|
declare function InsightsAPIGroup_2_0(instance: Base): InsightsAPIGroup_2_0;
|
|
17963
|
+
export interface IProfilePrivacyPolicy {
|
|
17964
|
+
accepted: boolean;
|
|
17965
|
+
meta?: {
|
|
17966
|
+
[key: string]: {
|
|
17967
|
+
timestamp: number;
|
|
17968
|
+
};
|
|
17969
|
+
};
|
|
17970
|
+
}
|
|
16795
17971
|
/**
|
|
16796
17972
|
* @openapi
|
|
16797
17973
|
*
|
|
@@ -16838,6 +18014,8 @@ export interface IProfile_2_0 {
|
|
|
16838
18014
|
* type: boolean
|
|
16839
18015
|
* accepted_gdpr:
|
|
16840
18016
|
* type: boolean
|
|
18017
|
+
* privacy_policy:
|
|
18018
|
+
* type: object
|
|
16841
18019
|
* goals:
|
|
16842
18020
|
* type: array
|
|
16843
18021
|
* items:
|
|
@@ -16859,12 +18037,13 @@ export interface IProfile_2_0 {
|
|
|
16859
18037
|
export interface IFlattenedProfile_2_0 {
|
|
16860
18038
|
prevent_data_collection: boolean;
|
|
16861
18039
|
accepted_gdpr: boolean;
|
|
18040
|
+
privacy_policy: IProfilePrivacyPolicy;
|
|
16862
18041
|
goals?: string[];
|
|
16863
18042
|
firstname?: string;
|
|
16864
18043
|
lastname?: string;
|
|
16865
18044
|
email?: string;
|
|
16866
18045
|
profilepic?: string;
|
|
16867
|
-
[key: string]: string | number | boolean | string[];
|
|
18046
|
+
[key: string]: string | number | boolean | string[] | IProfilePrivacyPolicy;
|
|
16868
18047
|
}
|
|
16869
18048
|
/**
|
|
16870
18049
|
* @openapi
|
|
@@ -16963,6 +18142,7 @@ export interface IProfileSchema_2_0 {
|
|
|
16963
18142
|
profilepic: "string";
|
|
16964
18143
|
prevent_data_collection: "boolean";
|
|
16965
18144
|
accepted_gdpr: "boolean";
|
|
18145
|
+
privacy_policy: "object";
|
|
16966
18146
|
goals: "object";
|
|
16967
18147
|
[key: string]: "string" | "boolean" | "number" | "object";
|
|
16968
18148
|
};
|
|
@@ -17606,6 +18786,50 @@ export interface IDeleteConversationRestRestData_2_0 extends IDeleteConversation
|
|
|
17606
18786
|
}
|
|
17607
18787
|
export interface IDeleteConversationRestRestReturnValue_2_0 {
|
|
17608
18788
|
}
|
|
18789
|
+
/**
|
|
18790
|
+
* @openapi
|
|
18791
|
+
*
|
|
18792
|
+
* components:
|
|
18793
|
+
* schemas:
|
|
18794
|
+
* IKnowledgeQueryCounterAggregatedValue_2_0:
|
|
18795
|
+
* type: object
|
|
18796
|
+
* properties:
|
|
18797
|
+
* queries:
|
|
18798
|
+
* type: number
|
|
18799
|
+
* day:
|
|
18800
|
+
* type: number
|
|
18801
|
+
* month:
|
|
18802
|
+
* type: number
|
|
18803
|
+
* year:
|
|
18804
|
+
* type: number
|
|
18805
|
+
*/
|
|
18806
|
+
export interface IKnowledgeQueryCounterAggregatedValue_2_0 {
|
|
18807
|
+
/** The number of queries in the time-span */
|
|
18808
|
+
queries: number;
|
|
18809
|
+
/** The day, e.g. 1 for the first day in the month */
|
|
18810
|
+
day: number;
|
|
18811
|
+
/** The month of the year, e.g. 1 for January */
|
|
18812
|
+
month: number;
|
|
18813
|
+
/** The year, e.g. 2020 */
|
|
18814
|
+
year: number;
|
|
18815
|
+
}
|
|
18816
|
+
export interface IGetKnowledgeQueryCounterRestDataParams_2_0 {
|
|
18817
|
+
projectId: string;
|
|
18818
|
+
}
|
|
18819
|
+
export interface IGetKnowledgeQueryCounterRestData_2_0 extends IGetKnowledgeQueryCounterRestDataParams_2_0 {
|
|
18820
|
+
year: number;
|
|
18821
|
+
month: number;
|
|
18822
|
+
}
|
|
18823
|
+
export interface IGetKnowledgeQueryCounterRestReturnValue_2_0 {
|
|
18824
|
+
items: IKnowledgeQueryCounterAggregatedValue_2_0[];
|
|
18825
|
+
}
|
|
18826
|
+
export interface IGetKnowledgeQueryCounterOrganisationRestData_2_0 {
|
|
18827
|
+
year: number;
|
|
18828
|
+
month: number;
|
|
18829
|
+
}
|
|
18830
|
+
export interface IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0 {
|
|
18831
|
+
items: IKnowledgeQueryCounterAggregatedValue_2_0[];
|
|
18832
|
+
}
|
|
17609
18833
|
export interface MetricsAPIGroup_2_0 {
|
|
17610
18834
|
indexTasks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexTasksRestData_2_0>, IIndexTasksRestReturnValue_2_0>;
|
|
17611
18835
|
readTask: TRestAPIOperation<IReadTaskRestData_2_0, IReadTaskRestReturnValue_2_0>;
|
|
@@ -17632,6 +18856,8 @@ export interface MetricsAPIGroup_2_0 {
|
|
|
17632
18856
|
batchTrainerRecords: TRestAPIOperation<IBatchTrainerRecordsRestData_2_0, IBatchTrainerRecordsRestReturnValue_2_0>;
|
|
17633
18857
|
getConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_2_0, IGetConversationCounterRestReturnValue_2_0>;
|
|
17634
18858
|
getConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_2_0, IGetConversationCounterOrganisationRestReturnValue_2_0>;
|
|
18859
|
+
getKnowledgeQueryCounter: TRestAPIOperation<IGetKnowledgeQueryCounterRestData_2_0, IGetKnowledgeQueryCounterRestReturnValue_2_0>;
|
|
18860
|
+
getKnowledgeQueryCounterOrganisation: TRestAPIOperation<IGetKnowledgeQueryCounterOrganisationRestData_2_0, IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0>;
|
|
17635
18861
|
indexConversations: TRestAPIOperation<IIndexConversationsRestRestData_2_0, IIndexConversationsRestRestReturnValue_2_0>;
|
|
17636
18862
|
readConversation: TRestAPIOperation<IReadConversationRestRestData_2_0, IReadConversationRestRestReturnValue_2_0>;
|
|
17637
18863
|
deleteConversation: TRestAPIOperation<IDeleteConversationRestRestData_2_0, IDeleteConversationRestRestReturnValue_2_0>;
|
|
@@ -17650,6 +18876,7 @@ export declare type IInjectRestReturnValue_2_0 = string;
|
|
|
17650
18876
|
export interface INotifyRestDataBody_2_0 {
|
|
17651
18877
|
text: string;
|
|
17652
18878
|
data: object;
|
|
18879
|
+
attachments?: TAttachments[];
|
|
17653
18880
|
URLToken: string;
|
|
17654
18881
|
userId: string;
|
|
17655
18882
|
sessionId: string;
|
|
@@ -17951,6 +19178,7 @@ declare const actionTypes: readonly [
|
|
|
17951
19178
|
"cancelTask",
|
|
17952
19179
|
"changePlaybookStepOrder",
|
|
17953
19180
|
"cloneFlow",
|
|
19181
|
+
"cloneMilestone",
|
|
17954
19182
|
"cloneLargeLanguageModel",
|
|
17955
19183
|
"configureIdentityProvider",
|
|
17956
19184
|
"createKnowledgeSearchIndex",
|
|
@@ -18065,14 +19293,14 @@ export declare type TActionType = typeof actionTypes[number];
|
|
|
18065
19293
|
*/
|
|
18066
19294
|
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
19295
|
/**
|
|
18068
|
-
* @openapi
|
|
18069
|
-
* components:
|
|
18070
|
-
* schemas:
|
|
18071
|
-
* TAuditEventChainElementType:
|
|
18072
|
-
* allOf:
|
|
18073
|
-
* - $ref: '#/components/schemas/TResourceType'
|
|
18074
|
-
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
18075
|
-
*/
|
|
19296
|
+
* @openapi
|
|
19297
|
+
* components:
|
|
19298
|
+
* schemas:
|
|
19299
|
+
* TAuditEventChainElementType:
|
|
19300
|
+
* allOf:
|
|
19301
|
+
* - $ref: '#/components/schemas/TResourceType'
|
|
19302
|
+
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
19303
|
+
*/
|
|
18076
19304
|
export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional;
|
|
18077
19305
|
/***
|
|
18078
19306
|
* @openapi
|
|
@@ -18097,16 +19325,16 @@ export interface IAuditEventData {
|
|
|
18097
19325
|
type: TAuditEventType;
|
|
18098
19326
|
actionType?: TActionType;
|
|
18099
19327
|
/**
|
|
18100
|
-
|
|
18101
|
-
|
|
18102
|
-
|
|
18103
|
-
|
|
18104
|
-
|
|
18105
|
-
|
|
18106
|
-
|
|
18107
|
-
|
|
18108
|
-
|
|
18109
|
-
|
|
19328
|
+
* Some resources contain sub-resource (and they might have sub-sub-resources)
|
|
19329
|
+
* on which operations get executed. We actually want to track the whole path
|
|
19330
|
+
* in order to understand which resource was modified. Let me give you an example:
|
|
19331
|
+
*
|
|
19332
|
+
* 'A user modified an example sentence within an intent within some flow' - so
|
|
19333
|
+
* in this case we have to track:
|
|
19334
|
+
* - "flow"
|
|
19335
|
+
* - "intent"
|
|
19336
|
+
* - "exampleSentence"
|
|
19337
|
+
*/
|
|
18110
19338
|
chain: IAuditEventModificationChainElement[];
|
|
18111
19339
|
projectId?: TMongoId;
|
|
18112
19340
|
}
|
|
@@ -18888,223 +20116,62 @@ export interface IReadProjectInboxRestReturnValue_2_0 extends ICognigyLiveAgentM
|
|
|
18888
20116
|
liveAgentDefaultInbox: Number;
|
|
18889
20117
|
}
|
|
18890
20118
|
export interface IReadLiveAgentAccountRestReturnValue_2_0 extends ICognigyLiveAgentMiddleware_2_0 {
|
|
18891
|
-
liveAgentAccount: Number;
|
|
18892
|
-
}
|
|
18893
|
-
export interface ICognigyLiveAgentMiddleware_2_0 {
|
|
18894
|
-
error?: string;
|
|
18895
|
-
}
|
|
18896
|
-
declare enum EOrganisationDeletionStatus {
|
|
18897
|
-
TOKEN_REQUESTED = "TOKEN_REQUESTED",
|
|
18898
|
-
IN_PROGRESS = "IN_PROGRESS",
|
|
18899
|
-
COMPLETED = "COMPLETED"
|
|
18900
|
-
}
|
|
18901
|
-
export declare type TDataToBeDeleted = {
|
|
18902
|
-
service: string;
|
|
18903
|
-
collectionName: string;
|
|
18904
|
-
isDeleted: boolean;
|
|
18905
|
-
lastUpdatedAt: string | null;
|
|
18906
|
-
};
|
|
18907
|
-
export interface IOrganisationDeletion {
|
|
18908
|
-
organisationId: string;
|
|
18909
|
-
organisationName: string;
|
|
18910
|
-
verificationTokenChachedKey: string;
|
|
18911
|
-
createdAt: Date;
|
|
18912
|
-
updatedAt: Date;
|
|
18913
|
-
status: EOrganisationDeletionStatus;
|
|
18914
|
-
dataToBeDeleted: TDataToBeDeleted[];
|
|
18915
|
-
}
|
|
18916
|
-
export interface IRequestOrganisationDeletionRestReturnValue_2_0 extends Omit<IOrganisationDeletion, "verificationTokenChachedKey"> {
|
|
18917
|
-
}
|
|
18918
|
-
declare const servicesNames: readonly [
|
|
18919
|
-
"service-api",
|
|
18920
|
-
"service-resources",
|
|
18921
|
-
"service-journeys",
|
|
18922
|
-
"service-logs",
|
|
18923
|
-
"service-profiles",
|
|
18924
|
-
"service-security",
|
|
18925
|
-
"service-trainer",
|
|
18926
|
-
"service-handover",
|
|
18927
|
-
"service-task-manager",
|
|
18928
|
-
"service-app-session-manager",
|
|
18929
|
-
"service-session-state-manager",
|
|
18930
|
-
"service-function-scheduler",
|
|
18931
|
-
"service-alexa-management",
|
|
18932
|
-
"service-runtime-file-manager"
|
|
18933
|
-
];
|
|
18934
|
-
export declare type TServicesNames = typeof servicesNames[number];
|
|
18935
|
-
export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
|
|
18936
|
-
[key in keyof TServicesNames]: string[];
|
|
18937
|
-
};
|
|
18938
|
-
export interface IReadVoiceGatewayAccountRestReturnValue_2_0 {
|
|
18939
|
-
voiceGatewayAccount: string;
|
|
18940
|
-
}
|
|
18941
|
-
export interface ISetupVoiceGatewayRestDataBody_2_0 {
|
|
18942
|
-
accountSid: string;
|
|
18943
|
-
}
|
|
18944
|
-
export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
|
|
18945
|
-
}
|
|
18946
|
-
export interface AdministrationAPIGroup_2_0 {
|
|
18947
|
-
requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
|
|
18948
|
-
validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
|
|
18949
|
-
resetPassword: TRestAPIOperation<IResetPasswordRestData_2_0, IResetPasswordRestReturnValue_2_0>;
|
|
18950
|
-
changePassword: TRestAPIOperation<IChangePasswordRestData_2_0, IChangePasswordRestReturnValue_2_0>;
|
|
18951
|
-
setSystemLicense: TRestAPIOperation<ISetSystemLicenseRestData_2_0, ISetSystemLicenseRestReturnValue_2_0>;
|
|
18952
|
-
getSystemLicenseState: TRestAPIOperation<void, IGetSystemLicenseStateRestReturnValue_2_0>;
|
|
18953
|
-
getSystemMessage: TRestAPIOperation<void, IGetSystemMessageRestReturnValue_2_0>;
|
|
18954
|
-
indexAuditEvents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAuditEventsRestData_2_0>, IIndexAuditEventsRestReturnValue_2_0>;
|
|
18955
|
-
readAuditEvent: TRestAPIOperation<IReadAuditEventRestData_2_0, IReadAuditEventRestReturnValue_2_0>;
|
|
18956
|
-
logoutUser: TRestAPIOperation<ILogoutUserRestData_2_0, ILogoutUserRestReturnValue_2_0>;
|
|
18957
|
-
resetFailedLoginAttempts: TRestAPIOperation<IResetFailedLoginAttemptsRestData_2_0, IResetFailedLoginAttemptsRestReturnValue_2_0>;
|
|
18958
|
-
readLastLoginAttemptMe: TRestAPIOperation<void, IReadLastLoginAttemptRestReturnValue_2_0>;
|
|
18959
|
-
indexLoginAttemptsMe: TRestAPIOperation<IIndexLoginAttemptsRestData_2_0, IIndexLoginAttemptsRestReturnValue_2_0>;
|
|
18960
|
-
deprecatePassword: TRestAPIOperation<IDeprecatePasswordRestData_2_0, IDeprecatePasswordRestReturnValue_2_0>;
|
|
18961
|
-
indexUsers: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestData_2_0>, IIndexUsersRestReturnValue_2_0>;
|
|
18962
|
-
createUser: TRestAPIOperation<ICreateUserRestData_2_0, ICreateUserRestReturnValue_2_0>;
|
|
18963
|
-
readUserMe: TRestAPIOperation<void, IReadUserMeRestReturnValue_2_0>;
|
|
18964
|
-
readUser: TRestAPIOperation<IReadUserRestData_2_0, IReadUserRestReturnValue_2_0>;
|
|
18965
|
-
updateUser: TRestAPIOperation<IUpdateUserRestData_2_0, IUpdateUserRestReturnValue_2_0>;
|
|
18966
|
-
updateUserMe: TRestAPIOperation<IUpdateUserMeRestData_2_0, IUpdateUserMeRestReturnValue_2_0>;
|
|
18967
|
-
deleteUser: TRestAPIOperation<IDeleteUserRestData_2_0, IDeleteUserRestReturnValue_2_0>;
|
|
18968
|
-
deleteUserMe: TRestAPIOperation<void, void>;
|
|
18969
|
-
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_0, ICreateApiKeyMeRestReturnValue_2_0>;
|
|
18970
|
-
deleteApiKeyMe: TRestAPIOperation<IDeleteApiKeyMeRestData_2_0, IDeleteApiKeyMeRestReturnValue_2_0>;
|
|
18971
|
-
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_0, IIndexApiKeysMeRestReturnValue_2_0>;
|
|
18972
|
-
addRoleToUser: TRestAPIOperation<IAddRoleToUserRestData_2_0, IAddRoleToUserRestReturnValue_2_0>;
|
|
18973
|
-
removeRoleFromUser: TRestAPIOperation<IRemoveRoleFromUserRestData_2_0, IRemoveRoleFromUserRestReturnValue_2_0>;
|
|
18974
|
-
readUserAclMe: TRestAPIOperation<void, IReadUserAclMeRestReturnValue_2_0>;
|
|
18975
|
-
acceptTermsOfService: TRestAPIOperation;
|
|
18976
|
-
indexProjectMembers: TRestAPIOperation<IIndexProjectMembersRestData_2_0, IIndexProjectMembersRestReturnValue_2_0>;
|
|
18977
|
-
readProjectMember: TRestAPIOperation<IReadProjectMemberRestData_2_0, IReadProjectMemberRestReturnValue_2_0>;
|
|
18978
|
-
addProjectMember: TRestAPIOperation<IAddProjectMemberRestData_2_0, IAddProjectMemberRestReturnValue_2_0>;
|
|
18979
|
-
updateProjectMember: TRestAPIOperation<IUpdateProjectMemberRestData_2_0, IUpdateProjectMemberRestReturnValue_2_0>;
|
|
18980
|
-
removeProjectMember: TRestAPIOperation<IRemoveProjectMemberRestData_2_0, IRemoveProjectMemberRestReturnValue_2_0>;
|
|
18981
|
-
addRoleToMember: TRestAPIOperation<IAddRoleToMemberRestData_2_0, IAddRoleToMemberRestReturnValue_2_0>;
|
|
18982
|
-
removeRoleFromMember: TRestAPIOperation<IRemoveRoleFromMemberRestData_2_0, IRemoveRoleFromMemberRestReturnValue_2_0>;
|
|
18983
|
-
addProjectToUser: TRestAPIOperation<IAddProjectToUserRestData_2_0, IAddProjectToUserRestReturnValue_2_0>;
|
|
18984
|
-
removeProjectFromUser: TRestAPIOperation<IRemoveProjectFromUserRestData_2_0, IRemoveProjectFromUserRestReturnValue_2_0>;
|
|
18985
|
-
configureIdentityProvider: TRestAPIOperation<IConfigureIdentityProviderRestData_2_0, IConfigureIdentityProviderRestReturnValue_2_0>;
|
|
18986
|
-
resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
|
|
18987
|
-
setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
|
|
18988
|
-
setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
18989
|
-
updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
18990
|
-
readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
|
|
18991
|
-
readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
|
|
18992
|
-
requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
|
|
18993
|
-
readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
|
|
18994
|
-
setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
|
|
18995
|
-
readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
|
|
18996
|
-
}
|
|
18997
|
-
declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
|
|
18998
|
-
/**
|
|
18999
|
-
* @openapi
|
|
19000
|
-
*
|
|
19001
|
-
* components:
|
|
19002
|
-
* schemas:
|
|
19003
|
-
* IApiKeyIndexItem_2_1:
|
|
19004
|
-
* type: object
|
|
19005
|
-
* properties:
|
|
19006
|
-
* _id:
|
|
19007
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
19008
|
-
* name:
|
|
19009
|
-
* type: string
|
|
19010
|
-
* createdAt:
|
|
19011
|
-
* type: number
|
|
19012
|
-
*/
|
|
19013
|
-
export interface IApiKeyIndexItem_2_1 {
|
|
19014
|
-
/** The object id of the api-key */
|
|
19015
|
-
_id: TMongoId;
|
|
19016
|
-
/** The name of the api-key, e.g. 'my demo' */
|
|
19017
|
-
name: string;
|
|
19018
|
-
createdAt: number;
|
|
19019
|
-
schemaVersion: number;
|
|
19020
|
-
}
|
|
19021
|
-
export interface IIndexApiKeysMeRestData_2_1 extends IRestPagination<IApiKeyIndexItem_2_1> {
|
|
19022
|
-
}
|
|
19023
|
-
export interface IIndexApiKeysMeRestReturnValue_2_1 extends ICursorBasedPaginationReturnValue<IApiKeyIndexItem_2_1> {
|
|
19024
|
-
}
|
|
19025
|
-
/**
|
|
19026
|
-
* @openapi
|
|
19027
|
-
*
|
|
19028
|
-
* components:
|
|
19029
|
-
* schemas:
|
|
19030
|
-
* IApiKeyData_2_1:
|
|
19031
|
-
* type: object
|
|
19032
|
-
* properties:
|
|
19033
|
-
* name:
|
|
19034
|
-
* type: string
|
|
19035
|
-
*
|
|
19036
|
-
* IApiKey_2_1:
|
|
19037
|
-
* allOf:
|
|
19038
|
-
* - $ref: '#/components/schemas/IApiKeyData_2_1'
|
|
19039
|
-
* - type: object
|
|
19040
|
-
* properties:
|
|
19041
|
-
* _id:
|
|
19042
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
19043
|
-
* createdAt:
|
|
19044
|
-
* type: integer
|
|
19045
|
-
* minimum: 0
|
|
19046
|
-
* maximum: 2147483647
|
|
19047
|
-
* example: 1527621049
|
|
19048
|
-
* apiKey:
|
|
19049
|
-
* type: string
|
|
19050
|
-
*/
|
|
19051
|
-
export interface IApiKey_2_1 {
|
|
19052
|
-
/** The object id of the api-key */
|
|
19053
|
-
_id: TMongoId;
|
|
19054
|
-
/** The name of the api-key, e.g. 'my demo' */
|
|
19055
|
-
name: string;
|
|
19056
|
-
/** The actual api-key */
|
|
19057
|
-
apiKey: string;
|
|
19058
|
-
createdAt: number;
|
|
19059
|
-
schemaVersion: number;
|
|
20119
|
+
liveAgentAccount: Number;
|
|
19060
20120
|
}
|
|
19061
|
-
export interface
|
|
20121
|
+
export interface ICognigyLiveAgentMiddleware_2_0 {
|
|
20122
|
+
error?: string;
|
|
19062
20123
|
}
|
|
19063
|
-
|
|
20124
|
+
declare enum EOrganisationDeletionStatus {
|
|
20125
|
+
TOKEN_REQUESTED = "TOKEN_REQUESTED",
|
|
20126
|
+
IN_PROGRESS = "IN_PROGRESS",
|
|
20127
|
+
COMPLETED = "COMPLETED"
|
|
19064
20128
|
}
|
|
19065
|
-
export
|
|
20129
|
+
export declare type TDataToBeDeleted = {
|
|
20130
|
+
service: string;
|
|
20131
|
+
collectionName: string;
|
|
20132
|
+
isDeleted: boolean;
|
|
20133
|
+
lastUpdatedAt: string | null;
|
|
20134
|
+
};
|
|
20135
|
+
export interface IOrganisationDeletion {
|
|
20136
|
+
organisationId: string;
|
|
20137
|
+
organisationName: string;
|
|
20138
|
+
verificationTokenChachedKey: string;
|
|
20139
|
+
createdAt: Date;
|
|
20140
|
+
updatedAt: Date;
|
|
20141
|
+
status: EOrganisationDeletionStatus;
|
|
20142
|
+
dataToBeDeleted: TDataToBeDeleted[];
|
|
19066
20143
|
}
|
|
19067
|
-
export interface
|
|
19068
|
-
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_1, ICreateApiKeyMeRestReturnValue_2_1>;
|
|
19069
|
-
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_1, IIndexApiKeysMeRestReturnValue_2_1>;
|
|
20144
|
+
export interface IRequestOrganisationDeletionRestReturnValue_2_0 extends Omit<IOrganisationDeletion, "verificationTokenChachedKey"> {
|
|
19070
20145
|
}
|
|
19071
|
-
declare
|
|
19072
|
-
|
|
19073
|
-
|
|
19074
|
-
|
|
19075
|
-
|
|
19076
|
-
|
|
19077
|
-
|
|
19078
|
-
|
|
19079
|
-
|
|
19080
|
-
|
|
19081
|
-
|
|
19082
|
-
|
|
19083
|
-
|
|
19084
|
-
|
|
19085
|
-
|
|
19086
|
-
|
|
19087
|
-
|
|
19088
|
-
|
|
19089
|
-
|
|
19090
|
-
|
|
19091
|
-
|
|
19092
|
-
* type: number
|
|
19093
|
-
* maxSessionStateTTL:
|
|
19094
|
-
* type: number
|
|
19095
|
-
*/
|
|
19096
|
-
export interface IVendor_2_0 {
|
|
19097
|
-
/** The COGNIGY.AI version we are running */
|
|
19098
|
-
version: string;
|
|
19099
|
-
/** Base URL to the frontend UI */
|
|
19100
|
-
frontendBaseUrl: string;
|
|
19101
|
-
/** Flag whether users need to agree the license agreement within this env */
|
|
19102
|
-
hasLicenseAgreement: boolean;
|
|
19103
|
-
maxContactProfileTTL: number;
|
|
19104
|
-
maxConversationTTL: number;
|
|
19105
|
-
maxSessionStateTTL: number;
|
|
20146
|
+
declare const servicesNames: readonly [
|
|
20147
|
+
"service-api",
|
|
20148
|
+
"service-resources",
|
|
20149
|
+
"service-logs",
|
|
20150
|
+
"service-profiles",
|
|
20151
|
+
"service-security",
|
|
20152
|
+
"service-trainer",
|
|
20153
|
+
"service-handover",
|
|
20154
|
+
"service-task-manager",
|
|
20155
|
+
"service-app-session-manager",
|
|
20156
|
+
"service-session-state-manager",
|
|
20157
|
+
"service-function-scheduler",
|
|
20158
|
+
"service-alexa-management",
|
|
20159
|
+
"service-runtime-file-manager"
|
|
20160
|
+
];
|
|
20161
|
+
export declare type TServicesNames = typeof servicesNames[number];
|
|
20162
|
+
export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
|
|
20163
|
+
[key in keyof TServicesNames]: string[];
|
|
20164
|
+
};
|
|
20165
|
+
export interface IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0 {
|
|
20166
|
+
chunkCount: number;
|
|
19106
20167
|
}
|
|
19107
|
-
export interface
|
|
20168
|
+
export interface IReadVoiceGatewayAccountRestReturnValue_2_0 {
|
|
20169
|
+
voiceGatewayAccount: string;
|
|
20170
|
+
}
|
|
20171
|
+
export interface ISetupVoiceGatewayRestDataBody_2_0 {
|
|
20172
|
+
accountSid: string;
|
|
20173
|
+
}
|
|
20174
|
+
export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
|
|
19108
20175
|
}
|
|
19109
20176
|
/**
|
|
19110
20177
|
* @openapi
|
|
@@ -19125,6 +20192,8 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
|
|
|
19125
20192
|
* type: number
|
|
19126
20193
|
* quotaMaxMessagesPerDay:
|
|
19127
20194
|
* type: number
|
|
20195
|
+
* quotaMaxKnowledgeChunks:
|
|
20196
|
+
* type: number
|
|
19128
20197
|
* passwordPolicy:
|
|
19129
20198
|
* $ref: '#/components/schemas/IOrganisationPasswordPolicy_2_0'
|
|
19130
20199
|
* sessionStateTTLInMinutes:
|
|
@@ -19268,6 +20337,8 @@ export interface IOrganisationDataPrivacySettings_2_0 {
|
|
|
19268
20337
|
* type: number
|
|
19269
20338
|
* quotaMaxMessagesPerDay:
|
|
19270
20339
|
* type: number
|
|
20340
|
+
* quotaMaxKnowledgeChunks:
|
|
20341
|
+
* type: number
|
|
19271
20342
|
* passwordPolicy:
|
|
19272
20343
|
* $ref: '#/components/schemas/IOrganisationPasswordPolicy_2_0'
|
|
19273
20344
|
* sessionStateTTLInMinutes:
|
|
@@ -19295,6 +20366,7 @@ export interface IOrganisationIndexItem_2_0 {
|
|
|
19295
20366
|
quotaMaxUsers: number;
|
|
19296
20367
|
quotaMaxChannelsPerProject: number;
|
|
19297
20368
|
quotaMaxMessagesPerDay: number;
|
|
20369
|
+
quotaMaxKnowledgeChunks: number;
|
|
19298
20370
|
passwordPolicy: IOrganisationPasswordPolicy_2_0;
|
|
19299
20371
|
billingTimezone: string;
|
|
19300
20372
|
sessionStateTTLInMinutes: number;
|
|
@@ -19364,6 +20436,171 @@ export interface IDeleteOrganisationRestData_2_0 extends IDeleteOrganisationRest
|
|
|
19364
20436
|
}
|
|
19365
20437
|
export interface IDeleteOrganisationRestReturnValue_2_0 {
|
|
19366
20438
|
}
|
|
20439
|
+
export interface AdministrationAPIGroup_2_0 {
|
|
20440
|
+
requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
|
|
20441
|
+
validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
|
|
20442
|
+
resetPassword: TRestAPIOperation<IResetPasswordRestData_2_0, IResetPasswordRestReturnValue_2_0>;
|
|
20443
|
+
changePassword: TRestAPIOperation<IChangePasswordRestData_2_0, IChangePasswordRestReturnValue_2_0>;
|
|
20444
|
+
setSystemLicense: TRestAPIOperation<ISetSystemLicenseRestData_2_0, ISetSystemLicenseRestReturnValue_2_0>;
|
|
20445
|
+
getSystemLicenseState: TRestAPIOperation<void, IGetSystemLicenseStateRestReturnValue_2_0>;
|
|
20446
|
+
getSystemMessage: TRestAPIOperation<void, IGetSystemMessageRestReturnValue_2_0>;
|
|
20447
|
+
indexAuditEvents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAuditEventsRestData_2_0>, IIndexAuditEventsRestReturnValue_2_0>;
|
|
20448
|
+
readAuditEvent: TRestAPIOperation<IReadAuditEventRestData_2_0, IReadAuditEventRestReturnValue_2_0>;
|
|
20449
|
+
logoutUser: TRestAPIOperation<ILogoutUserRestData_2_0, ILogoutUserRestReturnValue_2_0>;
|
|
20450
|
+
resetFailedLoginAttempts: TRestAPIOperation<IResetFailedLoginAttemptsRestData_2_0, IResetFailedLoginAttemptsRestReturnValue_2_0>;
|
|
20451
|
+
readLastLoginAttemptMe: TRestAPIOperation<void, IReadLastLoginAttemptRestReturnValue_2_0>;
|
|
20452
|
+
indexLoginAttemptsMe: TRestAPIOperation<IIndexLoginAttemptsRestData_2_0, IIndexLoginAttemptsRestReturnValue_2_0>;
|
|
20453
|
+
deprecatePassword: TRestAPIOperation<IDeprecatePasswordRestData_2_0, IDeprecatePasswordRestReturnValue_2_0>;
|
|
20454
|
+
indexUsers: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestData_2_0>, IIndexUsersRestReturnValue_2_0>;
|
|
20455
|
+
createUser: TRestAPIOperation<ICreateUserRestData_2_0, ICreateUserRestReturnValue_2_0>;
|
|
20456
|
+
readUserMe: TRestAPIOperation<void, IReadUserMeRestReturnValue_2_0>;
|
|
20457
|
+
readUser: TRestAPIOperation<IReadUserRestData_2_0, IReadUserRestReturnValue_2_0>;
|
|
20458
|
+
updateUser: TRestAPIOperation<IUpdateUserRestData_2_0, IUpdateUserRestReturnValue_2_0>;
|
|
20459
|
+
updateUserMe: TRestAPIOperation<IUpdateUserMeRestData_2_0, IUpdateUserMeRestReturnValue_2_0>;
|
|
20460
|
+
deleteUser: TRestAPIOperation<IDeleteUserRestData_2_0, IDeleteUserRestReturnValue_2_0>;
|
|
20461
|
+
deleteUserMe: TRestAPIOperation<void, void>;
|
|
20462
|
+
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_0, ICreateApiKeyMeRestReturnValue_2_0>;
|
|
20463
|
+
deleteApiKeyMe: TRestAPIOperation<IDeleteApiKeyMeRestData_2_0, IDeleteApiKeyMeRestReturnValue_2_0>;
|
|
20464
|
+
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_0, IIndexApiKeysMeRestReturnValue_2_0>;
|
|
20465
|
+
addRoleToUser: TRestAPIOperation<IAddRoleToUserRestData_2_0, IAddRoleToUserRestReturnValue_2_0>;
|
|
20466
|
+
removeRoleFromUser: TRestAPIOperation<IRemoveRoleFromUserRestData_2_0, IRemoveRoleFromUserRestReturnValue_2_0>;
|
|
20467
|
+
readUserAclMe: TRestAPIOperation<void, IReadUserAclMeRestReturnValue_2_0>;
|
|
20468
|
+
acceptTermsOfService: TRestAPIOperation;
|
|
20469
|
+
indexProjectMembers: TRestAPIOperation<IIndexProjectMembersRestData_2_0, IIndexProjectMembersRestReturnValue_2_0>;
|
|
20470
|
+
readProjectMember: TRestAPIOperation<IReadProjectMemberRestData_2_0, IReadProjectMemberRestReturnValue_2_0>;
|
|
20471
|
+
addProjectMember: TRestAPIOperation<IAddProjectMemberRestData_2_0, IAddProjectMemberRestReturnValue_2_0>;
|
|
20472
|
+
updateProjectMember: TRestAPIOperation<IUpdateProjectMemberRestData_2_0, IUpdateProjectMemberRestReturnValue_2_0>;
|
|
20473
|
+
removeProjectMember: TRestAPIOperation<IRemoveProjectMemberRestData_2_0, IRemoveProjectMemberRestReturnValue_2_0>;
|
|
20474
|
+
addRoleToMember: TRestAPIOperation<IAddRoleToMemberRestData_2_0, IAddRoleToMemberRestReturnValue_2_0>;
|
|
20475
|
+
removeRoleFromMember: TRestAPIOperation<IRemoveRoleFromMemberRestData_2_0, IRemoveRoleFromMemberRestReturnValue_2_0>;
|
|
20476
|
+
addProjectToUser: TRestAPIOperation<IAddProjectToUserRestData_2_0, IAddProjectToUserRestReturnValue_2_0>;
|
|
20477
|
+
removeProjectFromUser: TRestAPIOperation<IRemoveProjectFromUserRestData_2_0, IRemoveProjectFromUserRestReturnValue_2_0>;
|
|
20478
|
+
configureIdentityProvider: TRestAPIOperation<IConfigureIdentityProviderRestData_2_0, IConfigureIdentityProviderRestReturnValue_2_0>;
|
|
20479
|
+
resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
|
|
20480
|
+
setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
|
|
20481
|
+
setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
20482
|
+
updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
20483
|
+
readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
|
|
20484
|
+
readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
|
|
20485
|
+
requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
|
|
20486
|
+
readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
|
|
20487
|
+
setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
|
|
20488
|
+
readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
|
|
20489
|
+
readOrganisationPolicies: TRestAPIOperation<void, IReadOrganisationRestReturnValue_2_0>;
|
|
20490
|
+
readOrganisationKnowledgeChunksCount: TRestAPIOperation<void, IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0>;
|
|
20491
|
+
}
|
|
20492
|
+
declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
|
|
20493
|
+
/**
|
|
20494
|
+
* @openapi
|
|
20495
|
+
*
|
|
20496
|
+
* components:
|
|
20497
|
+
* schemas:
|
|
20498
|
+
* IApiKeyIndexItem_2_1:
|
|
20499
|
+
* type: object
|
|
20500
|
+
* properties:
|
|
20501
|
+
* _id:
|
|
20502
|
+
* $ref: '#/components/schemas/TMongoId'
|
|
20503
|
+
* name:
|
|
20504
|
+
* type: string
|
|
20505
|
+
* createdAt:
|
|
20506
|
+
* type: number
|
|
20507
|
+
*/
|
|
20508
|
+
export interface IApiKeyIndexItem_2_1 {
|
|
20509
|
+
/** The object id of the api-key */
|
|
20510
|
+
_id: TMongoId;
|
|
20511
|
+
/** The name of the api-key, e.g. 'my demo' */
|
|
20512
|
+
name: string;
|
|
20513
|
+
createdAt: number;
|
|
20514
|
+
schemaVersion: number;
|
|
20515
|
+
}
|
|
20516
|
+
export interface IIndexApiKeysMeRestData_2_1 extends IRestPagination<IApiKeyIndexItem_2_1> {
|
|
20517
|
+
}
|
|
20518
|
+
export interface IIndexApiKeysMeRestReturnValue_2_1 extends ICursorBasedPaginationReturnValue<IApiKeyIndexItem_2_1> {
|
|
20519
|
+
}
|
|
20520
|
+
/**
|
|
20521
|
+
* @openapi
|
|
20522
|
+
*
|
|
20523
|
+
* components:
|
|
20524
|
+
* schemas:
|
|
20525
|
+
* IApiKeyData_2_1:
|
|
20526
|
+
* type: object
|
|
20527
|
+
* properties:
|
|
20528
|
+
* name:
|
|
20529
|
+
* type: string
|
|
20530
|
+
*
|
|
20531
|
+
* IApiKey_2_1:
|
|
20532
|
+
* allOf:
|
|
20533
|
+
* - $ref: '#/components/schemas/IApiKeyData_2_1'
|
|
20534
|
+
* - type: object
|
|
20535
|
+
* properties:
|
|
20536
|
+
* _id:
|
|
20537
|
+
* $ref: '#/components/schemas/TMongoId'
|
|
20538
|
+
* createdAt:
|
|
20539
|
+
* type: integer
|
|
20540
|
+
* minimum: 0
|
|
20541
|
+
* maximum: 2147483647
|
|
20542
|
+
* example: 1527621049
|
|
20543
|
+
* apiKey:
|
|
20544
|
+
* type: string
|
|
20545
|
+
*/
|
|
20546
|
+
export interface IApiKey_2_1 {
|
|
20547
|
+
/** The object id of the api-key */
|
|
20548
|
+
_id: TMongoId;
|
|
20549
|
+
/** The name of the api-key, e.g. 'my demo' */
|
|
20550
|
+
name: string;
|
|
20551
|
+
/** The actual api-key */
|
|
20552
|
+
apiKey: string;
|
|
20553
|
+
createdAt: number;
|
|
20554
|
+
schemaVersion: number;
|
|
20555
|
+
}
|
|
20556
|
+
export interface ICreateApiKeyMeRestDataBody_2_1 extends Partial<Omit<IApiKey_2_1, keyof IEntityMeta | "apiKey">> {
|
|
20557
|
+
}
|
|
20558
|
+
export interface ICreateApiKeyMeRestData_2_1 extends ICreateApiKeyMeRestDataBody_2_1 {
|
|
20559
|
+
}
|
|
20560
|
+
export interface ICreateApiKeyMeRestReturnValue_2_1 extends IApiKey_2_1 {
|
|
20561
|
+
}
|
|
20562
|
+
export interface AdministrationAPIGroup_2_1 extends Omit<AdministrationAPIGroup_2_0, "createApiKeyMe" | "indexApiKeysMe"> {
|
|
20563
|
+
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_1, ICreateApiKeyMeRestReturnValue_2_1>;
|
|
20564
|
+
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_1, IIndexApiKeysMeRestReturnValue_2_1>;
|
|
20565
|
+
}
|
|
20566
|
+
declare function AdministrationAPIGroup_2_1(instance: Base): AdministrationAPIGroup_2_1;
|
|
20567
|
+
/**
|
|
20568
|
+
* @openapi
|
|
20569
|
+
*
|
|
20570
|
+
* components:
|
|
20571
|
+
* schemas:
|
|
20572
|
+
* IVendor_2_0:
|
|
20573
|
+
* type: object
|
|
20574
|
+
* properties:
|
|
20575
|
+
* version:
|
|
20576
|
+
* type: string
|
|
20577
|
+
* description: The product version we are running
|
|
20578
|
+
* frontendBaseUrl:
|
|
20579
|
+
* type: string
|
|
20580
|
+
* description: Base URL to the frontend UI
|
|
20581
|
+
* hasLicenseAgreement:
|
|
20582
|
+
* type: string
|
|
20583
|
+
* description: Flag whether users need to agree the license agreement within this env
|
|
20584
|
+
* maxContactProfileTTL:
|
|
20585
|
+
* type: number
|
|
20586
|
+
* maxConversationTTL:
|
|
20587
|
+
* type: number
|
|
20588
|
+
* maxSessionStateTTL:
|
|
20589
|
+
* type: number
|
|
20590
|
+
*/
|
|
20591
|
+
export interface IVendor_2_0 {
|
|
20592
|
+
/** The COGNIGY.AI version we are running */
|
|
20593
|
+
version: string;
|
|
20594
|
+
/** Base URL to the frontend UI */
|
|
20595
|
+
frontendBaseUrl: string;
|
|
20596
|
+
/** Flag whether users need to agree the license agreement within this env */
|
|
20597
|
+
hasLicenseAgreement: boolean;
|
|
20598
|
+
maxContactProfileTTL: number;
|
|
20599
|
+
maxConversationTTL: number;
|
|
20600
|
+
maxSessionStateTTL: number;
|
|
20601
|
+
}
|
|
20602
|
+
export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
|
|
20603
|
+
}
|
|
19367
20604
|
export interface IGetBillingInformationRestData_2_0 extends IRestPagination<{
|
|
19368
20605
|
name: string;
|
|
19369
20606
|
isDisabled: boolean;
|