@cognigy/rest-api-client 0.18.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/build/RestAPIClient.js +7 -0
- package/build/apigroups/AdministrationAPIGroup_2_0.js +8 -1
- package/build/apigroups/JWTAuthAPIGroup_2_0.js +12 -0
- package/build/apigroups/MetricsAPIGroup_2_0.js +5 -0
- package/build/apigroups/ResourcesAPIGroup_2_0.js +28 -14
- package/build/apigroups/index.js +3 -1
- package/build/shared/charts/descriptors/agentAssist/helpers/determineMetadata.js +15 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/answerExtraction.helper.js +1 -1
- package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/followUpDetection.helper.js +2 -2
- package/build/shared/charts/descriptors/agentAssist/identityAssist.js +1 -1
- package/build/shared/charts/descriptors/agentAssist/index.js +3 -1
- package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +1 -1
- package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +4 -5
- package/build/shared/charts/descriptors/agentAssist/sendData.js +74 -0
- package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +1 -1
- 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 +2 -1
- package/build/shared/charts/descriptors/analytics/activateProfile.js +1 -0
- package/build/shared/charts/descriptors/analytics/addMemory.js +51 -0
- package/build/shared/charts/descriptors/analytics/blindMode.js +2 -0
- package/build/shared/charts/descriptors/analytics/completeGoal.js +4 -2
- 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/helper.js +20 -0
- package/build/shared/charts/descriptors/analytics/index.js +5 -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/setRating.js +4 -2
- package/build/shared/charts/descriptors/analytics/trackGoal.js +102 -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 +4 -1
- 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 +19 -1
- package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearchV2.js +1 -1
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +55 -20
- package/build/shared/charts/descriptors/logic/disableSlotFillers.js +1 -1
- package/build/shared/charts/descriptors/logic/enableSlotFillers.js +1 -1
- 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 +113 -4
- package/build/shared/charts/descriptors/message/question/question.js +50 -5
- package/build/shared/charts/descriptors/message/question/utils/validateQuestionAnswer.js +4 -2
- package/build/shared/charts/descriptors/nlu/cleanText.js +2 -1
- package/build/shared/charts/descriptors/nlu/executeCognigyNLU.js +1 -1
- package/build/shared/charts/descriptors/nlu/fuzzySearch.js +24 -2
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFiller.js +1 -1
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFillerFallback.js +1 -1
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFillerSuccess.js +1 -1
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +18 -9
- package/build/shared/charts/descriptors/nlu/matchPattern.js +1 -1
- package/build/shared/charts/descriptors/nlu/regexSlotFiller.js +1 -1
- package/build/shared/charts/descriptors/service/GPTConversation.js +1 -1
- package/build/shared/charts/descriptors/service/GPTPrompt.js +70 -41
- package/build/shared/charts/descriptors/service/LLMEntityExtract.js +12 -3
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentHandover.js +92 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +1146 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobDefault.js +31 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +139 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentToolAnswer.js +120 -0
- package/build/shared/charts/descriptors/service/aiAgent/helper.js +222 -0
- package/build/shared/charts/descriptors/service/handoverV2.js +140 -2
- package/build/shared/charts/descriptors/service/httpRequest.js +35 -2
- package/build/shared/charts/descriptors/service/index.js +11 -1
- package/build/shared/charts/descriptors/transcripts/addTranscriptStep.js +413 -0
- package/build/shared/charts/descriptors/transcripts/getTranscript.js +104 -0
- package/build/shared/charts/descriptors/transcripts/index.js +8 -0
- package/build/shared/charts/descriptors/voice/mappers/base.mapper.js +20 -0
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +227 -72
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +6 -9
- package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +2 -0
- package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +5 -4
- 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/sessionSpeechParameters.js +2 -0
- package/build/shared/charts/descriptors/voice/nodes/transfer.js +2 -0
- package/build/shared/charts/descriptors/voicegateway/nodes/callRecording.js +8 -1
- package/build/shared/charts/descriptors/voicegateway/nodes/handover.js +4 -2
- package/build/shared/charts/descriptors/voicegateway/nodes/hangup.js +4 -2
- package/build/shared/charts/descriptors/voicegateway/nodes/helper/utils.js +14 -0
- package/build/shared/charts/descriptors/voicegateway/nodes/playURL.js +4 -5
- package/build/shared/charts/descriptors/voicegateway/nodes/sendMessage.js +8 -1
- package/build/shared/charts/descriptors/voicegateway/nodes/sendMetaData.js +7 -3
- package/build/shared/charts/descriptors/voicegateway/nodes/setSessionParams.js +8 -1
- 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 -0
- 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 +311 -10
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +25 -9
- package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +2 -2
- package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +4 -2
- package/build/shared/constants.js +16 -1
- package/build/shared/handoverClients/interfaces/THandoverEventType.js +2 -0
- package/build/shared/helper/logFullConfigToDebugMode.js +30 -0
- package/build/shared/helper/nlu/textCleaner.js +4 -2
- package/build/shared/interfaces/IEndpointSettings.js +3 -0
- package/build/shared/interfaces/IOrganisation.js +1 -0
- package/build/shared/interfaces/IProfile.js +2 -0
- package/build/shared/interfaces/IProfileSchema.js +4 -0
- package/build/shared/interfaces/analytics/IAnalyticsSourceData.js +22 -20
- package/build/shared/interfaces/{restAPI/resources/milestone/v2.0/IMilestone_2_0.js → analytics/IGoalAnalytics.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/generativeAI/IGenerativeAIModels.js +51 -70
- package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourney_2_0.js → generativeAI/tools.js} +1 -1
- package/build/shared/interfaces/handover.js +45 -2
- package/build/shared/interfaces/license.js +3 -2
- package/build/shared/interfaces/messageAPI/endpoints.js +8 -1
- package/build/shared/interfaces/messageAPI/handover.js +22 -1
- package/build/shared/interfaces/resources/IAiAgent.js +52 -0
- package/build/shared/interfaces/resources/IAuditEvent.js +2 -1
- package/build/shared/interfaces/resources/IConnection.js +1 -0
- package/build/shared/interfaces/resources/IEndpoint.js +2 -2
- package/build/shared/interfaces/resources/{IMilestone.js → IGoal.js} +15 -15
- package/build/shared/interfaces/resources/ILargeLanguageModel.js +52 -4
- package/build/shared/interfaces/resources/INodeDescriptorSet.js +15 -0
- package/build/shared/interfaces/resources/TResourceType.js +16 -8
- 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 +9 -1
- 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/administration/user/v2.0/IGetPinnedResources_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/{resources/journey/v2.0/IReadJourneyRest_2_0.js → administration/user/v2.0/IPinResourceRest_2_0.js} +1 -1
- package/build/shared/interfaces/restAPI/operations/nlu/v2.0/IGenerateNluScoresRest_2_0.js +57 -0
- package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgentHiringTemplate_2_0.js +32 -0
- package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgent_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IIndexJourneysRest_2_0.js → aiAgent/v2.0/ICreateAiAgentRest_2_0.js} +1 -1
- package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IDeleteAiAgentRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IGetAiAgentHiringTemplates_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyStep_2_0.js → aiAgent/v2.0/IHireAiAgent_2_0.js} +1 -1
- package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyIndexItem_2_0.js → aiAgent/v2.0/IIndexAiAgentRest_2_0.js} +1 -1
- package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyProgress_2_0.js → aiAgent/v2.0/IReadAiAgentRest_2_0.js} +1 -1
- package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IUpdateAiAgentRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IValidateAiAgentNameRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/ICloneGoalRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/ICreateGoalRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IDeleteGoalRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalIndexItem_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalStepMetric_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalStep_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoal_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IIndexGoalsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IReadGoalRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/v2.0/IUpdateGoalRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/goal/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/security/IPermission.js +6 -2
- package/build/shared/interfaces/security/IPinnedResource.js +3 -0
- 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/transcripts/transcripts.js +33 -0
- package/build/shared/interfaces/user.js +1 -1
- package/package.json +2 -2
- package/types/index.d.ts +2332 -1041
- 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/license.js.map +0 -1
- 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/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/knowledgeSearchIndex/v2.0/ICreateKnowledgeSearchIndexRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/knowledgeSearchIndex/v2.0/IDeleteKnowledgeSearchIndexRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/ICloneMilestoneRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/ICreateMilestoneRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IDeleteMilestoneRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IIndexMilestonesRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneIndexItem_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStepMetric_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStep_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IReadMilestoneRest_2_0.js +0 -3
- package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IUpdateMilestoneRest_2_0.js +0 -3
- package/build/test.js +0 -27
- /package/build/shared/interfaces/restAPI/{resources/journey/v2.0 → operations}/index.js +0 -0
- /package/build/shared/interfaces/restAPI/{resources/knowledgeSearchIndex → operations/nlu}/v2.0/index.js +0 -0
- /package/build/shared/interfaces/restAPI/resources/{milestone → aiAgent}/v2.0/index.js +0 -0
package/types/index.d.ts
CHANGED
|
@@ -414,6 +414,7 @@ export interface IGetAuthorizationCodeParameters {
|
|
|
414
414
|
declare const organisationWidePermissions: readonly [
|
|
415
415
|
"analyticsOdata",
|
|
416
416
|
"apiKeys",
|
|
417
|
+
"auditEvents",
|
|
417
418
|
"assignProject",
|
|
418
419
|
"liveAgentAccount",
|
|
419
420
|
"projects",
|
|
@@ -424,6 +425,7 @@ declare const organisationWidePermissions: readonly [
|
|
|
424
425
|
export declare type TOrganisationWidePermissions = typeof organisationWidePermissions[number];
|
|
425
426
|
declare const projectWidePermissions: readonly [
|
|
426
427
|
"agentAssistConfigs",
|
|
428
|
+
"aiAgents",
|
|
427
429
|
"analytics",
|
|
428
430
|
"connections",
|
|
429
431
|
"contactProfiles",
|
|
@@ -446,7 +448,7 @@ declare const projectWidePermissions: readonly [
|
|
|
446
448
|
"logs",
|
|
447
449
|
"memberDetails",
|
|
448
450
|
"members",
|
|
449
|
-
"
|
|
451
|
+
"goals",
|
|
450
452
|
"nluConnectors",
|
|
451
453
|
"packages",
|
|
452
454
|
"playbooks",
|
|
@@ -912,6 +914,80 @@ declare const referenceKeys: readonly [
|
|
|
912
914
|
export declare type TReferenceKeys = (typeof referenceKeys)[number];
|
|
913
915
|
export declare type TReferenceAndEntityMetaKeys = TReferenceKeys | TEntityMetaKeys | "referenceId";
|
|
914
916
|
export declare type TNonQueriableKeys<T> = TReferenceKeys;
|
|
917
|
+
declare const arrayTResourceType: readonly [
|
|
918
|
+
"agentassistconfig",
|
|
919
|
+
"agentSettings",
|
|
920
|
+
"chart",
|
|
921
|
+
"connection",
|
|
922
|
+
"connectionSchema",
|
|
923
|
+
"endpoint",
|
|
924
|
+
"extension",
|
|
925
|
+
"file",
|
|
926
|
+
"flow",
|
|
927
|
+
"flowSettings",
|
|
928
|
+
"flowState",
|
|
929
|
+
"function",
|
|
930
|
+
"intent",
|
|
931
|
+
"intentDefaultReply",
|
|
932
|
+
"intentLearningSentence",
|
|
933
|
+
"intentRelation",
|
|
934
|
+
"intentSentence",
|
|
935
|
+
"intentTrainGroup",
|
|
936
|
+
"largeLanguageModel",
|
|
937
|
+
"knowledgeStore",
|
|
938
|
+
"knowledgeSource",
|
|
939
|
+
"knowledgeChunk",
|
|
940
|
+
"lexicon",
|
|
941
|
+
"lexiconEntry",
|
|
942
|
+
"lexiconKeyphrase",
|
|
943
|
+
"lexiconSlot",
|
|
944
|
+
"locale",
|
|
945
|
+
"goal",
|
|
946
|
+
"nluconnector",
|
|
947
|
+
"nodeData",
|
|
948
|
+
"nodeDescriptorSet",
|
|
949
|
+
"package",
|
|
950
|
+
"playbook",
|
|
951
|
+
"playbookRun",
|
|
952
|
+
"slotFiller",
|
|
953
|
+
"snapshot",
|
|
954
|
+
"snippet",
|
|
955
|
+
"aiAgent"
|
|
956
|
+
];
|
|
957
|
+
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
958
|
+
declare const arrayTChartableResourceType: readonly [
|
|
959
|
+
"flow"
|
|
960
|
+
];
|
|
961
|
+
export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
|
|
962
|
+
declare const searchableResourceTypes: readonly [
|
|
963
|
+
"endpoint",
|
|
964
|
+
"extension",
|
|
965
|
+
"flow",
|
|
966
|
+
"function",
|
|
967
|
+
"largeLanguageModel",
|
|
968
|
+
"lexicon",
|
|
969
|
+
"goal",
|
|
970
|
+
"nluconnector",
|
|
971
|
+
"playbook",
|
|
972
|
+
"project",
|
|
973
|
+
"snapshot"
|
|
974
|
+
];
|
|
975
|
+
export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
|
|
976
|
+
declare const pinnableResourceTypes: readonly [
|
|
977
|
+
"project"
|
|
978
|
+
];
|
|
979
|
+
/**
|
|
980
|
+
* @openapi
|
|
981
|
+
* components:
|
|
982
|
+
* schemas:
|
|
983
|
+
* TPinnableResourceType:
|
|
984
|
+
* type: string
|
|
985
|
+
* description: The type of a pinnable resource
|
|
986
|
+
* example: project
|
|
987
|
+
* enum:
|
|
988
|
+
* - project
|
|
989
|
+
*/
|
|
990
|
+
export declare type TPinnableResourceType = (typeof pinnableResourceTypes)[number];
|
|
915
991
|
declare const organisationWideRoles: readonly [
|
|
916
992
|
"admin",
|
|
917
993
|
"apiKeys",
|
|
@@ -952,6 +1028,7 @@ declare const projectWideRoles: readonly [
|
|
|
952
1028
|
"function_admin",
|
|
953
1029
|
"function_editor",
|
|
954
1030
|
"intents",
|
|
1031
|
+
"knowledgeAdmin",
|
|
955
1032
|
"large_language_model_admin",
|
|
956
1033
|
"lexicon_admin",
|
|
957
1034
|
"lexicon_editor",
|
|
@@ -1009,6 +1086,8 @@ export interface ICrudPermissions {
|
|
|
1009
1086
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1010
1087
|
* apiKeys:
|
|
1011
1088
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1089
|
+
* auditEvents:
|
|
1090
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1012
1091
|
* liveAgentAccount:
|
|
1013
1092
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1014
1093
|
* projects:
|
|
@@ -1051,7 +1130,7 @@ export interface ICrudPermissions {
|
|
|
1051
1130
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1052
1131
|
* members:
|
|
1053
1132
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1054
|
-
*
|
|
1133
|
+
* goals:
|
|
1055
1134
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1056
1135
|
* nluConnectors:
|
|
1057
1136
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
@@ -1136,7 +1215,7 @@ export interface IOrganisationWideAcl {
|
|
|
1136
1215
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1137
1216
|
* members:
|
|
1138
1217
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1139
|
-
*
|
|
1218
|
+
* goals:
|
|
1140
1219
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1141
1220
|
* nluConnectors:
|
|
1142
1221
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
@@ -1347,7 +1426,7 @@ export declare type TIdpIdTokenSignedResponseAlg = typeof idpIdTokenSignedRespon
|
|
|
1347
1426
|
* sets of information be made available as Claim Values.
|
|
1348
1427
|
* The scopes openid, profile, email and offline_access are always
|
|
1349
1428
|
* requested.
|
|
1350
|
-
*
|
|
1429
|
+
* idpFrontChannelLogoutUrl:
|
|
1351
1430
|
* type: string
|
|
1352
1431
|
* format: url
|
|
1353
1432
|
* idpIdTokenSignedResponseAlg:
|
|
@@ -1493,6 +1572,7 @@ export interface IRestAPIClientVersionConfiguration {
|
|
|
1493
1572
|
management: "2.0";
|
|
1494
1573
|
insights: "2.0";
|
|
1495
1574
|
analytics: "2.0";
|
|
1575
|
+
jwt: "2.0";
|
|
1496
1576
|
}
|
|
1497
1577
|
export declare type THttpLib = "axios";
|
|
1498
1578
|
/**
|
|
@@ -1548,64 +1628,6 @@ export interface IHttpAdapter {
|
|
|
1548
1628
|
setConfig(config: IRestAPIClientConfig): void;
|
|
1549
1629
|
}
|
|
1550
1630
|
export declare type TTusAPIOperation<Data = void, ReturnValue = void> = (args: Data) => ReturnValue;
|
|
1551
|
-
declare const arrayTResourceType: readonly [
|
|
1552
|
-
"agentassistconfig",
|
|
1553
|
-
"agentSettings",
|
|
1554
|
-
"chart",
|
|
1555
|
-
"connection",
|
|
1556
|
-
"connectionSchema",
|
|
1557
|
-
"endpoint",
|
|
1558
|
-
"extension",
|
|
1559
|
-
"file",
|
|
1560
|
-
"flow",
|
|
1561
|
-
"flowSettings",
|
|
1562
|
-
"flowState",
|
|
1563
|
-
"function",
|
|
1564
|
-
"intent",
|
|
1565
|
-
"intentDefaultReply",
|
|
1566
|
-
"intentLearningSentence",
|
|
1567
|
-
"intentRelation",
|
|
1568
|
-
"intentSentence",
|
|
1569
|
-
"intentTrainGroup",
|
|
1570
|
-
"largeLanguageModel",
|
|
1571
|
-
"knowledgeStore",
|
|
1572
|
-
"knowledgeSource",
|
|
1573
|
-
"knowledgeChunk",
|
|
1574
|
-
"lexicon",
|
|
1575
|
-
"lexiconEntry",
|
|
1576
|
-
"lexiconKeyphrase",
|
|
1577
|
-
"lexiconSlot",
|
|
1578
|
-
"locale",
|
|
1579
|
-
"milestone",
|
|
1580
|
-
"nluconnector",
|
|
1581
|
-
"nodeData",
|
|
1582
|
-
"nodeDescriptorSet",
|
|
1583
|
-
"package",
|
|
1584
|
-
"playbook",
|
|
1585
|
-
"playbookRun",
|
|
1586
|
-
"slotFiller",
|
|
1587
|
-
"snapshot",
|
|
1588
|
-
"snippet"
|
|
1589
|
-
];
|
|
1590
|
-
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
1591
|
-
declare const arrayTChartableResourceType: readonly [
|
|
1592
|
-
"flow"
|
|
1593
|
-
];
|
|
1594
|
-
export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
|
|
1595
|
-
declare const searchableResourceTypes: readonly [
|
|
1596
|
-
"endpoint",
|
|
1597
|
-
"extension",
|
|
1598
|
-
"flow",
|
|
1599
|
-
"function",
|
|
1600
|
-
"largeLanguageModel",
|
|
1601
|
-
"lexicon",
|
|
1602
|
-
"milestone",
|
|
1603
|
-
"nluconnector",
|
|
1604
|
-
"playbook",
|
|
1605
|
-
"project",
|
|
1606
|
-
"snapshot"
|
|
1607
|
-
];
|
|
1608
|
-
export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
|
|
1609
1631
|
declare const arrayNLUConnectorType: readonly [
|
|
1610
1632
|
"alexa",
|
|
1611
1633
|
"dialogflow",
|
|
@@ -1966,7 +1988,7 @@ export interface IAnalyticsSnapshotMeta {
|
|
|
1966
1988
|
snapshotName: string;
|
|
1967
1989
|
snapshotId: TMongoId | any;
|
|
1968
1990
|
}
|
|
1969
|
-
export interface
|
|
1991
|
+
export interface IAnalyticsEndpointMeta {
|
|
1970
1992
|
endpointUrlToken: string;
|
|
1971
1993
|
endpointName: string;
|
|
1972
1994
|
endpointType: TEndpointType;
|
|
@@ -1977,7 +1999,7 @@ export interface IAnalyticsLocaleMeta {
|
|
|
1977
1999
|
localeName: string;
|
|
1978
2000
|
localeReferenceId: string;
|
|
1979
2001
|
}
|
|
1980
|
-
export interface IStepEvent extends IAnalyticsFlowMeta,
|
|
2002
|
+
export interface IStepEvent extends IAnalyticsFlowMeta, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, Partial<IAnalyticsSnapshotMeta> {
|
|
1981
2003
|
_id: TMongoId;
|
|
1982
2004
|
userId: string;
|
|
1983
2005
|
sessionId: string;
|
|
@@ -2015,6 +2037,7 @@ export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyti
|
|
|
2015
2037
|
handoverEscalations: number;
|
|
2016
2038
|
snapshotName?: string;
|
|
2017
2039
|
flowHistory?: IAnalyticsFlowHistoryData[];
|
|
2040
|
+
allowDataOnly: boolean;
|
|
2018
2041
|
custom1?: string;
|
|
2019
2042
|
custom2?: string;
|
|
2020
2043
|
custom3?: string;
|
|
@@ -2062,6 +2085,12 @@ declare const whisperAssistConfigurations: readonly [
|
|
|
2062
2085
|
"template"
|
|
2063
2086
|
];
|
|
2064
2087
|
export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
|
|
2088
|
+
declare const copilotType: readonly [
|
|
2089
|
+
"none",
|
|
2090
|
+
"workspace",
|
|
2091
|
+
"whisper"
|
|
2092
|
+
];
|
|
2093
|
+
export declare type TCopilotType = typeof copilotType[number];
|
|
2065
2094
|
export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
|
|
2066
2095
|
export interface IRCEHandoverSettings {
|
|
2067
2096
|
/**
|
|
@@ -2195,6 +2224,7 @@ export interface ISalesForceHandoverSettings {
|
|
|
2195
2224
|
forwardUnknownEventsToFlow: boolean;
|
|
2196
2225
|
}
|
|
2197
2226
|
export interface IAgentAssistSettings {
|
|
2227
|
+
copilotType: TCopilotType;
|
|
2198
2228
|
agentAssistFlowId: string;
|
|
2199
2229
|
agentAssistConfigId: string;
|
|
2200
2230
|
enableTranscriptTile?: boolean;
|
|
@@ -2237,7 +2267,7 @@ export interface IGenesysCloudOMHandoverSettings {
|
|
|
2237
2267
|
}
|
|
2238
2268
|
export interface IHandoverStatusInputObject {
|
|
2239
2269
|
status: THandoverStatus;
|
|
2240
|
-
eventType?: "queueUpdate" | "handoverInactivity";
|
|
2270
|
+
eventType?: "queueUpdate" | "handoverInactivity" | "genericHandoverUpdate" | "handoverAlreadyInProgress";
|
|
2241
2271
|
inactivityCount?: number;
|
|
2242
2272
|
error?: {
|
|
2243
2273
|
reason: "unsupported" | "error";
|
|
@@ -2245,7 +2275,7 @@ export interface IHandoverStatusInputObject {
|
|
|
2245
2275
|
};
|
|
2246
2276
|
data?: any;
|
|
2247
2277
|
}
|
|
2248
|
-
export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject";
|
|
2278
|
+
export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject" | "handoverAlreadyInProgress" | "genericHandoverUpdate";
|
|
2249
2279
|
export interface IEndpointTranslationSettings {
|
|
2250
2280
|
translationEnabled: boolean;
|
|
2251
2281
|
flowLanguage: string;
|
|
@@ -2301,10 +2331,6 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2301
2331
|
useAnalytics: boolean;
|
|
2302
2332
|
/** Whether we should store data payloads into analytics for this endpoint */
|
|
2303
2333
|
storeDataPayload: boolean;
|
|
2304
|
-
/** Whether we should use Chatbase to collect analytics */
|
|
2305
|
-
useChatbaseAnalytics: boolean;
|
|
2306
|
-
/** The apikey for the Chatbase bot */
|
|
2307
|
-
chatbaseApikey: string;
|
|
2308
2334
|
/** Whether we should use Dashbot to collect analytics */
|
|
2309
2335
|
useDashbotAnalytics: boolean;
|
|
2310
2336
|
/** The apikey for the dashbot bot */
|
|
@@ -2316,6 +2342,14 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2316
2342
|
* is true.
|
|
2317
2343
|
*/
|
|
2318
2344
|
dashbotPlatform: TDashbotPlatform;
|
|
2345
|
+
/**
|
|
2346
|
+
* If set to `true`, disables input sanitization
|
|
2347
|
+
*/
|
|
2348
|
+
disableInputSanitization: boolean;
|
|
2349
|
+
/**
|
|
2350
|
+
* If set to `true`, disables skipping of html tags with uri prop
|
|
2351
|
+
*/
|
|
2352
|
+
disableSkipUriTags: boolean;
|
|
2319
2353
|
/**
|
|
2320
2354
|
* Optional endpoint specific settings e.g. Facebook Page token
|
|
2321
2355
|
*/
|
|
@@ -2470,6 +2504,7 @@ export interface ICallEventSettings {
|
|
|
2470
2504
|
}
|
|
2471
2505
|
export interface ICallEventFailoverSettings {
|
|
2472
2506
|
enabled?: boolean;
|
|
2507
|
+
enabledForSpeech?: boolean;
|
|
2473
2508
|
type?: TTransferType;
|
|
2474
2509
|
headers?: string;
|
|
2475
2510
|
to?: string;
|
|
@@ -2490,12 +2525,14 @@ export interface ICallEventFailoverSettings {
|
|
|
2490
2525
|
deepgramEndpointing?: boolean;
|
|
2491
2526
|
deepgramEndpointingValue?: number;
|
|
2492
2527
|
dialTranscribeDeepgramTier?: string;
|
|
2528
|
+
anchorMedia?: boolean;
|
|
2493
2529
|
}
|
|
2494
2530
|
export interface ICallEvents {
|
|
2495
2531
|
amd?: ICallEventSettings;
|
|
2496
2532
|
callCreated?: ICallEventSettings;
|
|
2497
2533
|
callCompleted?: ICallEventSettings;
|
|
2498
2534
|
callFailed?: ICallEventSettings;
|
|
2535
|
+
callInProgress?: ICallEventSettings;
|
|
2499
2536
|
callReconnected?: ICallEventSettings;
|
|
2500
2537
|
userInputTimeout?: ICallEventSettings;
|
|
2501
2538
|
recognizedSpeech?: ICallEventSettings;
|
|
@@ -2515,11 +2552,13 @@ export interface IVGProsodySettings {
|
|
|
2515
2552
|
export interface IVGGenericSettings {
|
|
2516
2553
|
prosodySettings?: IVGProsodySettings;
|
|
2517
2554
|
showBestTranscriptOnly?: boolean;
|
|
2555
|
+
enableCallInProgress?: boolean;
|
|
2518
2556
|
}
|
|
2519
2557
|
export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
|
|
2520
2558
|
callEvents: ICallEvents;
|
|
2521
2559
|
failover?: ICallEventFailoverSettings;
|
|
2522
2560
|
genericSettings?: IVGGenericSettings;
|
|
2561
|
+
isFeatureAccmEnabled?: boolean;
|
|
2523
2562
|
}
|
|
2524
2563
|
export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
|
|
2525
2564
|
export declare type TAvayaVoice = "man" | "woman" | string;
|
|
@@ -3213,10 +3252,29 @@ export interface IWebchat3EndpointColorsSettings {
|
|
|
3213
3252
|
textLinkColor: string;
|
|
3214
3253
|
}
|
|
3215
3254
|
export interface IWebchat3EndpointBehaviorSettings {
|
|
3255
|
+
/**
|
|
3256
|
+
* If enabled, shows 'You are now talking to an AI
|
|
3257
|
+
* agent.' notification in the chat.
|
|
3258
|
+
*
|
|
3259
|
+
* Default: true
|
|
3260
|
+
*/
|
|
3261
|
+
enableAIAgentNotice: boolean;
|
|
3262
|
+
/**
|
|
3263
|
+
* Text shown as a notice regarding non-human agent
|
|
3264
|
+
* in the chat.
|
|
3265
|
+
*
|
|
3266
|
+
* Default: `You're now chatting with an AI Agent.`
|
|
3267
|
+
*/
|
|
3268
|
+
AIAgentNoticeText: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* Whether to enable collecting
|
|
3271
|
+
* addtional meatadata from customers
|
|
3272
|
+
*/
|
|
3273
|
+
enableCollectMetadata: boolean;
|
|
3216
3274
|
/**
|
|
3217
3275
|
* Whether to enable typing indicators
|
|
3218
3276
|
* when the bot is replying
|
|
3219
|
-
|
|
3277
|
+
*/
|
|
3220
3278
|
enableTypingIndicator: boolean;
|
|
3221
3279
|
/**
|
|
3222
3280
|
* The amount of ms per letter
|
|
@@ -3226,28 +3284,28 @@ export interface IWebchat3EndpointBehaviorSettings {
|
|
|
3226
3284
|
/**
|
|
3227
3285
|
* The placeholder text
|
|
3228
3286
|
* we display in the input field
|
|
3229
|
-
|
|
3287
|
+
*/
|
|
3230
3288
|
inputPlaceholder: string;
|
|
3231
3289
|
/**
|
|
3232
3290
|
* Whether the webchat should use STT.
|
|
3233
|
-
|
|
3291
|
+
*/
|
|
3234
3292
|
enableSTT: boolean;
|
|
3235
3293
|
/**
|
|
3236
3294
|
* Whether the webchat should use
|
|
3237
3295
|
* TTS and thereby display
|
|
3238
3296
|
* a record button.
|
|
3239
|
-
|
|
3297
|
+
*/
|
|
3240
3298
|
enableTTS: boolean;
|
|
3241
3299
|
/**
|
|
3242
3300
|
* This setting is used to decide whether
|
|
3243
3301
|
* the input should be focused right
|
|
3244
3302
|
* after a postback button is pressed
|
|
3245
|
-
|
|
3303
|
+
*/
|
|
3246
3304
|
focusInputAfterPostback: boolean;
|
|
3247
3305
|
/**
|
|
3248
3306
|
* This setting is used to decide whether
|
|
3249
3307
|
* a connectivity indicator should be displayed
|
|
3250
|
-
|
|
3308
|
+
*/
|
|
3251
3309
|
enableConnectionStatusIndicator: boolean;
|
|
3252
3310
|
}
|
|
3253
3311
|
export interface IWebchat3EndpointStartBehaviorSettings {
|
|
@@ -3737,27 +3795,208 @@ export interface IFileStorageSettings {
|
|
|
3737
3795
|
azureConnection?: string;
|
|
3738
3796
|
googleCloudConnection?: string;
|
|
3739
3797
|
}
|
|
3798
|
+
/**
|
|
3799
|
+
* @openapi
|
|
3800
|
+
*
|
|
3801
|
+
* components:
|
|
3802
|
+
* schemas:
|
|
3803
|
+
* IMediaAttachment:
|
|
3804
|
+
* type: object
|
|
3805
|
+
* properties:
|
|
3806
|
+
* name:
|
|
3807
|
+
* type: string
|
|
3808
|
+
* caption:
|
|
3809
|
+
* type: string
|
|
3810
|
+
* url:
|
|
3811
|
+
* type: string
|
|
3812
|
+
* type:
|
|
3813
|
+
* type: string
|
|
3814
|
+
* required:
|
|
3815
|
+
* - name
|
|
3816
|
+
* - url
|
|
3817
|
+
* - type
|
|
3818
|
+
*/
|
|
3740
3819
|
export interface IMediaAttachment {
|
|
3741
3820
|
name: string;
|
|
3742
3821
|
caption?: string;
|
|
3743
3822
|
url: string;
|
|
3744
3823
|
type: string;
|
|
3745
3824
|
}
|
|
3825
|
+
/**
|
|
3826
|
+
* @openapi
|
|
3827
|
+
*
|
|
3828
|
+
* components:
|
|
3829
|
+
* schemas:
|
|
3830
|
+
* IFileAttachment:
|
|
3831
|
+
* allOf:
|
|
3832
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3833
|
+
* - type: object
|
|
3834
|
+
* properties:
|
|
3835
|
+
* type:
|
|
3836
|
+
* type: string
|
|
3837
|
+
* enum: [file, document]
|
|
3838
|
+
* required:
|
|
3839
|
+
* - type
|
|
3840
|
+
*/
|
|
3746
3841
|
export interface IFileAttachment extends IMediaAttachment {
|
|
3747
3842
|
type: "file" | "document";
|
|
3748
3843
|
}
|
|
3844
|
+
/**
|
|
3845
|
+
* @openapi
|
|
3846
|
+
*
|
|
3847
|
+
* components:
|
|
3848
|
+
* schemas:
|
|
3849
|
+
* IImageAttachment:
|
|
3850
|
+
* allOf:
|
|
3851
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3852
|
+
* - type: object
|
|
3853
|
+
* properties:
|
|
3854
|
+
* type:
|
|
3855
|
+
* type: string
|
|
3856
|
+
* enum: [image]
|
|
3857
|
+
* required:
|
|
3858
|
+
* - type
|
|
3859
|
+
*/
|
|
3749
3860
|
export interface IImageAttachment extends IMediaAttachment {
|
|
3750
3861
|
type: "image";
|
|
3751
3862
|
}
|
|
3863
|
+
/**
|
|
3864
|
+
* @openapi
|
|
3865
|
+
*
|
|
3866
|
+
* components:
|
|
3867
|
+
* schemas:
|
|
3868
|
+
* IStickerAttachment:
|
|
3869
|
+
* allOf:
|
|
3870
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3871
|
+
* - type: object
|
|
3872
|
+
* properties:
|
|
3873
|
+
* type:
|
|
3874
|
+
* type: string
|
|
3875
|
+
* enum: [sticker]
|
|
3876
|
+
* required:
|
|
3877
|
+
* - type
|
|
3878
|
+
*/
|
|
3752
3879
|
export interface IStickerAttachment extends IMediaAttachment {
|
|
3753
3880
|
type: "sticker";
|
|
3754
3881
|
}
|
|
3882
|
+
/**
|
|
3883
|
+
* @openapi
|
|
3884
|
+
*
|
|
3885
|
+
* components:
|
|
3886
|
+
* schemas:
|
|
3887
|
+
* IVideoAttachment:
|
|
3888
|
+
* allOf:
|
|
3889
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3890
|
+
* - type: object
|
|
3891
|
+
* properties:
|
|
3892
|
+
* type:
|
|
3893
|
+
* type: string
|
|
3894
|
+
* enum: [video]
|
|
3895
|
+
* required:
|
|
3896
|
+
* - type
|
|
3897
|
+
*/
|
|
3755
3898
|
export interface IVideoAttachment extends IMediaAttachment {
|
|
3756
3899
|
type: "video";
|
|
3757
3900
|
}
|
|
3901
|
+
/**
|
|
3902
|
+
* @openapi
|
|
3903
|
+
*
|
|
3904
|
+
* components:
|
|
3905
|
+
* schemas:
|
|
3906
|
+
* IAudioAttachment:
|
|
3907
|
+
* allOf:
|
|
3908
|
+
* - $ref: '#/components/schemas/IMediaAttachment'
|
|
3909
|
+
* - type: object
|
|
3910
|
+
* properties:
|
|
3911
|
+
* type:
|
|
3912
|
+
* type: string
|
|
3913
|
+
* enum: [audio]
|
|
3914
|
+
* required:
|
|
3915
|
+
* - type
|
|
3916
|
+
*/
|
|
3758
3917
|
export interface IAudioAttachment extends IMediaAttachment {
|
|
3759
3918
|
type: "audio";
|
|
3760
3919
|
}
|
|
3920
|
+
/**
|
|
3921
|
+
* @openapi
|
|
3922
|
+
*
|
|
3923
|
+
* components:
|
|
3924
|
+
* schemas:
|
|
3925
|
+
* IContactAttachment:
|
|
3926
|
+
* type: object
|
|
3927
|
+
* properties:
|
|
3928
|
+
* type:
|
|
3929
|
+
* type: string
|
|
3930
|
+
* enum: [contact]
|
|
3931
|
+
* addresses:
|
|
3932
|
+
* type: array
|
|
3933
|
+
* items:
|
|
3934
|
+
* type: object
|
|
3935
|
+
* properties:
|
|
3936
|
+
* city:
|
|
3937
|
+
* type: string
|
|
3938
|
+
* country:
|
|
3939
|
+
* type: string
|
|
3940
|
+
* countryCode:
|
|
3941
|
+
* type: string
|
|
3942
|
+
* state:
|
|
3943
|
+
* type: string
|
|
3944
|
+
* street:
|
|
3945
|
+
* type: string
|
|
3946
|
+
* type:
|
|
3947
|
+
* type: string
|
|
3948
|
+
* enum: [HOME, WORK]
|
|
3949
|
+
* zip:
|
|
3950
|
+
* type: string
|
|
3951
|
+
* postOfficeBox:
|
|
3952
|
+
* type: string
|
|
3953
|
+
* extendedAddress:
|
|
3954
|
+
* type: string
|
|
3955
|
+
* latitude:
|
|
3956
|
+
* type: number
|
|
3957
|
+
* longitude:
|
|
3958
|
+
* type: number
|
|
3959
|
+
* birthday:
|
|
3960
|
+
* type: string
|
|
3961
|
+
* emails:
|
|
3962
|
+
* type: array
|
|
3963
|
+
* items:
|
|
3964
|
+
* type: object
|
|
3965
|
+
* properties:
|
|
3966
|
+
* email:
|
|
3967
|
+
* type: string
|
|
3968
|
+
* type:
|
|
3969
|
+
* type: string
|
|
3970
|
+
* enum: [HOME, WORK]
|
|
3971
|
+
* urls:
|
|
3972
|
+
* type: array
|
|
3973
|
+
* items:
|
|
3974
|
+
* type: object
|
|
3975
|
+
* properties:
|
|
3976
|
+
* url:
|
|
3977
|
+
* type: string
|
|
3978
|
+
* type:
|
|
3979
|
+
* type: string
|
|
3980
|
+
* enum: [HOME, WORK]
|
|
3981
|
+
* photos:
|
|
3982
|
+
* type: array
|
|
3983
|
+
* items:
|
|
3984
|
+
* type: string
|
|
3985
|
+
* gender:
|
|
3986
|
+
* type: string
|
|
3987
|
+
* languages:
|
|
3988
|
+
* type: array
|
|
3989
|
+
* items:
|
|
3990
|
+
* type: string
|
|
3991
|
+
* timeZone:
|
|
3992
|
+
* type: string
|
|
3993
|
+
* notes:
|
|
3994
|
+
* type: array
|
|
3995
|
+
* items:
|
|
3996
|
+
* type: string
|
|
3997
|
+
* required:
|
|
3998
|
+
* - type
|
|
3999
|
+
*/
|
|
3761
4000
|
export interface IContactAttachment {
|
|
3762
4001
|
type: "contact";
|
|
3763
4002
|
addresses?: {
|
|
@@ -3808,16 +4047,57 @@ export interface IContactAttachment {
|
|
|
3808
4047
|
timeZone?: string;
|
|
3809
4048
|
notes?: string[];
|
|
3810
4049
|
}
|
|
3811
|
-
|
|
3812
|
-
|
|
3813
|
-
|
|
4050
|
+
/**
|
|
4051
|
+
* @openapi
|
|
4052
|
+
*
|
|
4053
|
+
* components:
|
|
4054
|
+
* schemas:
|
|
4055
|
+
* ILocationAttachment:
|
|
4056
|
+
* type: object
|
|
4057
|
+
* properties:
|
|
4058
|
+
* type:
|
|
4059
|
+
* type: string
|
|
4060
|
+
* enum: [location]
|
|
4061
|
+
* latitude:
|
|
4062
|
+
* type: number
|
|
4063
|
+
* longitude:
|
|
4064
|
+
* type: number
|
|
4065
|
+
* name:
|
|
4066
|
+
* type: string
|
|
4067
|
+
* title:
|
|
4068
|
+
* type: string
|
|
4069
|
+
* address:
|
|
4070
|
+
* type: string
|
|
4071
|
+
* required:
|
|
4072
|
+
* - type
|
|
4073
|
+
* - latitude
|
|
4074
|
+
* - longitude
|
|
4075
|
+
*/
|
|
4076
|
+
export interface ILocationAttachment {
|
|
4077
|
+
type: "location";
|
|
4078
|
+
latitude: number;
|
|
3814
4079
|
longitude: number;
|
|
3815
4080
|
name?: string;
|
|
3816
4081
|
title?: string;
|
|
3817
4082
|
address?: string;
|
|
3818
4083
|
}
|
|
3819
|
-
export declare type
|
|
3820
|
-
|
|
4084
|
+
export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
|
|
4085
|
+
/**
|
|
4086
|
+
* @openapi
|
|
4087
|
+
*
|
|
4088
|
+
* components:
|
|
4089
|
+
* schemas:
|
|
4090
|
+
* TAttachments:
|
|
4091
|
+
* oneOf:
|
|
4092
|
+
* - $ref: '#/components/schemas/IFileAttachment'
|
|
4093
|
+
* - $ref: '#/components/schemas/IImageAttachment'
|
|
4094
|
+
* - $ref: '#/components/schemas/IVideoAttachment'
|
|
4095
|
+
* - $ref: '#/components/schemas/IAudioAttachment'
|
|
4096
|
+
* - $ref: '#/components/schemas/IStickerAttachment'
|
|
4097
|
+
* - $ref: '#/components/schemas/IContactAttachment'
|
|
4098
|
+
* - $ref: '#/components/schemas/ILocationAttachment'
|
|
4099
|
+
*/
|
|
4100
|
+
export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
|
|
3821
4101
|
export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
|
|
3822
4102
|
/** The base 8x8 server url */
|
|
3823
4103
|
baseUrl: string;
|
|
@@ -3860,46 +4140,102 @@ declare const generativeAIModels: readonly [
|
|
|
3860
4140
|
"gpt-3.5-turbo",
|
|
3861
4141
|
"gpt-3.5-turbo-instruct",
|
|
3862
4142
|
"gpt-4",
|
|
3863
|
-
"
|
|
4143
|
+
"gpt-4o",
|
|
4144
|
+
"gpt-4o-mini",
|
|
3864
4145
|
"luminous-extended-control",
|
|
3865
4146
|
"claude-v1-100k",
|
|
3866
4147
|
"claude-instant-v1",
|
|
3867
4148
|
"claude-3-opus-20240229",
|
|
3868
4149
|
"claude-3-haiku-20240307",
|
|
3869
4150
|
"claude-3-sonnet-20240229",
|
|
4151
|
+
"claude-3-5-sonnet-20241022",
|
|
3870
4152
|
"text-bison@001",
|
|
3871
4153
|
"custom-model",
|
|
4154
|
+
"gemini-1.0-pro",
|
|
4155
|
+
"gemini-1.5-pro",
|
|
4156
|
+
"gemini-1.5-flash",
|
|
4157
|
+
"amazon.nova-lite-v1:0",
|
|
4158
|
+
"amazon.nova-pro-v1:0",
|
|
4159
|
+
"amazon.nova-micro-v1:0",
|
|
4160
|
+
"anthropic.claude-3-5-sonnet-20240620-v1:0",
|
|
4161
|
+
"text-embedding-3-small",
|
|
3872
4162
|
"text-embedding-3-large",
|
|
3873
4163
|
"text-embedding-ada-002",
|
|
3874
4164
|
"luminous-embedding-128"
|
|
3875
4165
|
];
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
4166
|
+
/**
|
|
4167
|
+
* @openapi
|
|
4168
|
+
*
|
|
4169
|
+
* components:
|
|
4170
|
+
* schemas:
|
|
4171
|
+
* TGenerativeAIModels:
|
|
4172
|
+
* type: string
|
|
4173
|
+
* enum:
|
|
4174
|
+
* - gpt-3.5-turbo
|
|
4175
|
+
* - gpt-3.5-turbo-instruct
|
|
4176
|
+
* - gpt-4
|
|
4177
|
+
* - gpt-4o
|
|
4178
|
+
* - gpt-4o-mini
|
|
4179
|
+
* - text-embedding-ada-002
|
|
4180
|
+
* - luminous-extended-control
|
|
4181
|
+
* - luminous-embedding-128
|
|
4182
|
+
* - claude-v1-100k
|
|
4183
|
+
* - claude-instant-v1
|
|
4184
|
+
* - claude-3-opus-20240229
|
|
4185
|
+
* - text-bison@001
|
|
4186
|
+
* - custom-model
|
|
4187
|
+
* - gemini-1.0-pro
|
|
4188
|
+
* - gemini-1.5-pro
|
|
4189
|
+
* - gemini-1.5-flash
|
|
4190
|
+
*/
|
|
4191
|
+
export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
|
|
3882
4192
|
declare const generativeAIProviders: readonly [
|
|
3883
4193
|
"azureOpenAI",
|
|
3884
4194
|
"openAI",
|
|
3885
4195
|
"alephAlpha",
|
|
3886
4196
|
"anthropic",
|
|
3887
|
-
"googleVertexAI"
|
|
4197
|
+
"googleVertexAI",
|
|
4198
|
+
"googleGemini",
|
|
4199
|
+
"awsBedrock"
|
|
3888
4200
|
];
|
|
3889
|
-
|
|
4201
|
+
/**
|
|
4202
|
+
* @openapi
|
|
4203
|
+
*
|
|
4204
|
+
* components:
|
|
4205
|
+
* schemas:
|
|
4206
|
+
* TGenerativeAIProviders:
|
|
4207
|
+
* type: string
|
|
4208
|
+
* enum:
|
|
4209
|
+
* - azureOpenAI
|
|
4210
|
+
* - openAI
|
|
4211
|
+
* - anthropic
|
|
4212
|
+
* - googleVertexAI
|
|
4213
|
+
* - googleGemini
|
|
4214
|
+
* - alephAlpha
|
|
4215
|
+
* - awsBedrock
|
|
4216
|
+
*/
|
|
4217
|
+
export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
|
|
3890
4218
|
declare const generativeAIUseCases: readonly [
|
|
3891
4219
|
"nlu",
|
|
3892
4220
|
"knowledgeSearch",
|
|
4221
|
+
"aiAgent",
|
|
3893
4222
|
"gptPromptNode",
|
|
3894
|
-
"gptConversation",
|
|
3895
4223
|
"aiEnhancedOutputs",
|
|
3896
4224
|
"sentimentAnalysis",
|
|
3897
4225
|
"intentSentenceGeneration",
|
|
3898
4226
|
"flowGeneration",
|
|
3899
4227
|
"generateNodeOutput",
|
|
3900
|
-
"lexiconGeneration"
|
|
4228
|
+
"lexiconGeneration",
|
|
4229
|
+
"answerExtraction",
|
|
4230
|
+
"gptConversation"
|
|
3901
4231
|
];
|
|
3902
4232
|
export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
|
|
4233
|
+
declare const modeType: readonly [
|
|
4234
|
+
"chat",
|
|
4235
|
+
"completion",
|
|
4236
|
+
"embedding"
|
|
4237
|
+
];
|
|
4238
|
+
export declare type TModeType = typeof modeType[number];
|
|
3903
4239
|
export interface IGenerativeAIUseCaseSettings {
|
|
3904
4240
|
largeLanguageModelId: string | null;
|
|
3905
4241
|
temperature: number;
|
|
@@ -4553,6 +4889,14 @@ export interface ISharedSettings_2_0 {
|
|
|
4553
4889
|
* $ref: '#/components/schemas/IAudioPreviewSettings_2_0'
|
|
4554
4890
|
* generativeAISettings:
|
|
4555
4891
|
* $ref: '#/components/schemas/IGenerativeAIModelSettings_2_0'
|
|
4892
|
+
* currencySettings:
|
|
4893
|
+
* type: object
|
|
4894
|
+
* properties:
|
|
4895
|
+
* currency:
|
|
4896
|
+
* type: string
|
|
4897
|
+
* example: "USD"
|
|
4898
|
+
* knowledgeAISettings:
|
|
4899
|
+
* $ref: '#/components/schemas/IKnowledgeAISettings_2_0'
|
|
4556
4900
|
*
|
|
4557
4901
|
* IAgentSettings_2_0:
|
|
4558
4902
|
* allOf:
|
|
@@ -4577,6 +4921,10 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
|
|
|
4577
4921
|
translationSettings: IAgentTranslationSettings_2_0;
|
|
4578
4922
|
audioPreviewSettings: IAudioPreviewSettings_2_0;
|
|
4579
4923
|
generativeAISettings: IGenerativeAISettings_2_0;
|
|
4924
|
+
currencySettings: {
|
|
4925
|
+
currency: string;
|
|
4926
|
+
};
|
|
4927
|
+
knowledgeAISettings: IKnowledgeAISettings_2_0;
|
|
4580
4928
|
}
|
|
4581
4929
|
/**
|
|
4582
4930
|
* @openapi
|
|
@@ -4723,7 +5071,9 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
4723
5071
|
* - azureOpenAI
|
|
4724
5072
|
* - anthropic
|
|
4725
5073
|
* - googleVertexAI
|
|
5074
|
+
* - googleGemini
|
|
4726
5075
|
* - alephAlpha
|
|
5076
|
+
* - awsBedrock
|
|
4727
5077
|
*/
|
|
4728
5078
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
4729
5079
|
/**
|
|
@@ -4762,6 +5112,40 @@ export interface IGenerativeAISettings_2_0 {
|
|
|
4762
5112
|
[key in TGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
|
|
4763
5113
|
};
|
|
4764
5114
|
}
|
|
5115
|
+
/**
|
|
5116
|
+
* @openapi
|
|
5117
|
+
*
|
|
5118
|
+
* components:
|
|
5119
|
+
* schemas:
|
|
5120
|
+
* TFileExtractorOptions_2_0:
|
|
5121
|
+
* type: string
|
|
5122
|
+
* description: Options for the Knowledge AI File Extractor
|
|
5123
|
+
* enum:
|
|
5124
|
+
* - default
|
|
5125
|
+
* - legacy
|
|
5126
|
+
* - azure
|
|
5127
|
+
*/
|
|
5128
|
+
export declare type TFileExtractorOptions_2_0 = "default" | "legacy" | "azure";
|
|
5129
|
+
/**
|
|
5130
|
+
* @openapi
|
|
5131
|
+
*
|
|
5132
|
+
* components:
|
|
5133
|
+
* schemas:
|
|
5134
|
+
* IKnowledgeAISettings_2_0:
|
|
5135
|
+
* type: object
|
|
5136
|
+
* properties:
|
|
5137
|
+
* fileExtractor:
|
|
5138
|
+
* $ref: '#/components/schemas/TFileExtractorOptions_2_0'
|
|
5139
|
+
* azureDIConnectionId:
|
|
5140
|
+
* type: string
|
|
5141
|
+
* description: ReferenceId of the Azure AI Document Intelligence Connection
|
|
5142
|
+
* example: "f66e99eb-db8f-433c-977f-69160d9a6bdb"
|
|
5143
|
+
*
|
|
5144
|
+
*/
|
|
5145
|
+
export interface IKnowledgeAISettings_2_0 {
|
|
5146
|
+
fileExtractor: TFileExtractorOptions_2_0;
|
|
5147
|
+
azureDIConnectionId?: string;
|
|
5148
|
+
}
|
|
4765
5149
|
/**
|
|
4766
5150
|
* @openapi
|
|
4767
5151
|
*
|
|
@@ -6045,6 +6429,10 @@ export interface ILexiconSlotIndexItem_2_0 {
|
|
|
6045
6429
|
/** The MongoDB ObjectId */
|
|
6046
6430
|
_id: TMongoId;
|
|
6047
6431
|
name: string;
|
|
6432
|
+
createdAt: number;
|
|
6433
|
+
lastChanged: number;
|
|
6434
|
+
createdBy: TMongoId;
|
|
6435
|
+
lastChangedBy: TMongoId;
|
|
6048
6436
|
}
|
|
6049
6437
|
export interface IIndexLexiconSlotsRestDataParams_2_0 {
|
|
6050
6438
|
lexiconId: TMongoId;
|
|
@@ -6222,7 +6610,9 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6222
6610
|
* description: The name of the endpoint
|
|
6223
6611
|
* example: New Endpoint
|
|
6224
6612
|
* entrypoint:
|
|
6225
|
-
*
|
|
6613
|
+
* type: string
|
|
6614
|
+
* description: The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.
|
|
6615
|
+
* example: 667ed4ae16d66f47dc2a9400
|
|
6226
6616
|
* active:
|
|
6227
6617
|
* type: boolean
|
|
6228
6618
|
* description: Toggle whether the endpoint is active or not
|
|
@@ -6248,12 +6638,6 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6248
6638
|
* useAnalytics:
|
|
6249
6639
|
* type: boolean
|
|
6250
6640
|
* description: Whether we should store analytics for this endpoint
|
|
6251
|
-
* useChatbaseAnalytics:
|
|
6252
|
-
* type: boolean
|
|
6253
|
-
* description: Whether we should use Chatbase to collect analytics
|
|
6254
|
-
* chatbaseApikey:
|
|
6255
|
-
* type: string
|
|
6256
|
-
* description: The apikey for the Chatbase bot
|
|
6257
6641
|
* useDashbotAnalytics:
|
|
6258
6642
|
* type: boolean
|
|
6259
6643
|
* description: Whether we should use Dashbot to collect analytics
|
|
@@ -6262,6 +6646,12 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6262
6646
|
* description: The apikey for the dashbot bot
|
|
6263
6647
|
* dashbotPlatform:
|
|
6264
6648
|
* type: string
|
|
6649
|
+
* disableInputSanitization:
|
|
6650
|
+
* type: string
|
|
6651
|
+
* description: If true, disables input text sanitization after Input Transformer
|
|
6652
|
+
* disableSkipUriTags:
|
|
6653
|
+
* type: string
|
|
6654
|
+
* description: If true, disables skipping of uri tags
|
|
6265
6655
|
* overrideSnapshotConnections:
|
|
6266
6656
|
* type: boolean
|
|
6267
6657
|
* settings:
|
|
@@ -6333,6 +6723,8 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6333
6723
|
* type: boolean
|
|
6334
6724
|
* dynamicImageAspectRatio:
|
|
6335
6725
|
* type: boolean
|
|
6726
|
+
* enableCollectMetadata:
|
|
6727
|
+
* type: boolean
|
|
6336
6728
|
* enableConnectionStatusIndicator:
|
|
6337
6729
|
* type: boolean
|
|
6338
6730
|
* enableDemoWebchat:
|
|
@@ -6448,7 +6840,7 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6448
6840
|
* type: object
|
|
6449
6841
|
* persistentMenu:
|
|
6450
6842
|
* type: object
|
|
6451
|
-
*
|
|
6843
|
+
* transformer:
|
|
6452
6844
|
* type: object
|
|
6453
6845
|
* properties:
|
|
6454
6846
|
* abortOnError:
|
|
@@ -6540,6 +6932,13 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
6540
6932
|
* agentAssistSettings:
|
|
6541
6933
|
* type: object
|
|
6542
6934
|
* properties:
|
|
6935
|
+
* copilotType:
|
|
6936
|
+
* type: string
|
|
6937
|
+
* enum:
|
|
6938
|
+
* - none
|
|
6939
|
+
* - workspace
|
|
6940
|
+
* - whisper
|
|
6941
|
+
* description: Copilot Type
|
|
6543
6942
|
* agentAssistFlowId:
|
|
6544
6943
|
* type: string
|
|
6545
6944
|
* description: Copilot flow ID
|
|
@@ -6599,10 +6998,6 @@ export interface IEndpoint_2_0 {
|
|
|
6599
6998
|
useContactProfiles: boolean;
|
|
6600
6999
|
/** Whether we should store analytics for this endpoint */
|
|
6601
7000
|
useAnalytics: boolean;
|
|
6602
|
-
/** Whether we should use Chatbase to collect analytics */
|
|
6603
|
-
useChatbaseAnalytics: boolean;
|
|
6604
|
-
/** The apikey for the Chatbase bot */
|
|
6605
|
-
chatbaseApikey: string;
|
|
6606
7001
|
/** Whether we should use Dashbot to collect analytics */
|
|
6607
7002
|
useDashbotAnalytics: boolean;
|
|
6608
7003
|
/** The apikey for the dashbot bot */
|
|
@@ -6614,6 +7009,14 @@ export interface IEndpoint_2_0 {
|
|
|
6614
7009
|
* is true.
|
|
6615
7010
|
*/
|
|
6616
7011
|
dashbotPlatform: TDashbotPlatform;
|
|
7012
|
+
/**
|
|
7013
|
+
* If set to `true`, disables input sanitization
|
|
7014
|
+
*/
|
|
7015
|
+
disableInputSanitization: boolean;
|
|
7016
|
+
/**
|
|
7017
|
+
* If set to `true`, disables skipping of uri tags
|
|
7018
|
+
*/
|
|
7019
|
+
disableSkipUriTags: boolean;
|
|
6617
7020
|
/**
|
|
6618
7021
|
* Optional endpoint specific settings e.g. Facebook Page token
|
|
6619
7022
|
*/
|
|
@@ -7995,6 +8398,7 @@ export interface IConnection extends IEntityMeta {
|
|
|
7995
8398
|
type: string;
|
|
7996
8399
|
projectReference: TMongoId;
|
|
7997
8400
|
organisationReference: TMongoId;
|
|
8401
|
+
isDeprecated: boolean;
|
|
7998
8402
|
}
|
|
7999
8403
|
export interface IGraphConnection {
|
|
8000
8404
|
type: "connection";
|
|
@@ -8013,6 +8417,10 @@ export interface IAlephAlphaMeta {
|
|
|
8013
8417
|
export interface IAnthropicMeta {
|
|
8014
8418
|
customModel?: string;
|
|
8015
8419
|
}
|
|
8420
|
+
export interface IAwsBedrockMeta {
|
|
8421
|
+
region: string;
|
|
8422
|
+
customModel?: string;
|
|
8423
|
+
}
|
|
8016
8424
|
export interface IAzureOpenAIMeta {
|
|
8017
8425
|
resourceName?: string;
|
|
8018
8426
|
deploymentName?: string;
|
|
@@ -8026,14 +8434,29 @@ export interface IGoogleVertexAIMeta {
|
|
|
8026
8434
|
publisher?: string;
|
|
8027
8435
|
customModel?: string;
|
|
8028
8436
|
}
|
|
8437
|
+
export interface IGoogleGeminiMeta {
|
|
8438
|
+
location: string;
|
|
8439
|
+
customModel?: string;
|
|
8440
|
+
}
|
|
8441
|
+
export declare type TLLMFallback = {
|
|
8442
|
+
order: number;
|
|
8443
|
+
isFallbackEnabled: boolean;
|
|
8444
|
+
fallbackLLMReferenceId: string;
|
|
8445
|
+
immediateFallBack: {
|
|
8446
|
+
failedRequests: number;
|
|
8447
|
+
durationInMinutes: number;
|
|
8448
|
+
emailNotificationList: string[];
|
|
8449
|
+
};
|
|
8450
|
+
};
|
|
8029
8451
|
export interface ILargeLanguageModel extends IEntityMeta {
|
|
8030
8452
|
_id: TMongoId;
|
|
8031
8453
|
referenceId: string;
|
|
8032
8454
|
name: string;
|
|
8033
8455
|
description: string;
|
|
8034
8456
|
modelType: TGenerativeAIModels;
|
|
8035
|
-
modelGroup?:
|
|
8457
|
+
modelGroup?: TModeType;
|
|
8036
8458
|
isCustomModel?: boolean;
|
|
8459
|
+
areFallbacksEnabled?: boolean;
|
|
8037
8460
|
provider: TGenerativeAIProviders;
|
|
8038
8461
|
connectionId: string;
|
|
8039
8462
|
isDefault: boolean;
|
|
@@ -8041,9 +8464,12 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
8041
8464
|
organisationReference: TMongoId;
|
|
8042
8465
|
azureOpenAI?: IAzureOpenAIMeta;
|
|
8043
8466
|
googleVertexAI?: IGoogleVertexAIMeta;
|
|
8467
|
+
googleGemini?: IGoogleGeminiMeta;
|
|
8044
8468
|
openAI?: IOpenAIMeta;
|
|
8045
8469
|
alephAlpha?: IAlephAlphaMeta;
|
|
8046
8470
|
anthropic?: IAnthropicMeta;
|
|
8471
|
+
awsBedrock?: IAwsBedrockMeta;
|
|
8472
|
+
fallbacks?: TLLMFallback[];
|
|
8047
8473
|
}
|
|
8048
8474
|
export interface IGraphLargeLanguageModelDependencyAttachment {
|
|
8049
8475
|
_id: string;
|
|
@@ -8210,6 +8636,7 @@ export interface IHttpRequestNodeSharedConfig {
|
|
|
8210
8636
|
allowSelfSigned: boolean;
|
|
8211
8637
|
abortOnError: boolean;
|
|
8212
8638
|
errorLogging: "none" | "basic" | "full";
|
|
8639
|
+
debugLogging: "none" | "request" | "response" | "full";
|
|
8213
8640
|
logWarning: string;
|
|
8214
8641
|
}
|
|
8215
8642
|
export interface IHttpRequestNodeOAuthConfig extends IHttpRequestNodeSharedConfig {
|
|
@@ -8262,7 +8689,9 @@ declare const arrayTDebugEventTypes: readonly [
|
|
|
8262
8689
|
"input",
|
|
8263
8690
|
"output",
|
|
8264
8691
|
"switchedFlow",
|
|
8265
|
-
"nluWarning"
|
|
8692
|
+
"nluWarning",
|
|
8693
|
+
"debugMessage",
|
|
8694
|
+
"debugError"
|
|
8266
8695
|
];
|
|
8267
8696
|
export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
|
|
8268
8697
|
export interface IInputChangedEventPayload {
|
|
@@ -8345,7 +8774,21 @@ export interface INluWarningEventPayload {
|
|
|
8345
8774
|
errorMessage: string;
|
|
8346
8775
|
sessionId?: string;
|
|
8347
8776
|
}
|
|
8348
|
-
export
|
|
8777
|
+
export interface IDebugEventMessagePayloadBase {
|
|
8778
|
+
sessionId?: string;
|
|
8779
|
+
header?: string;
|
|
8780
|
+
metadata?: IOutputEventMetadata;
|
|
8781
|
+
}
|
|
8782
|
+
export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
|
|
8783
|
+
type: "text";
|
|
8784
|
+
message: string;
|
|
8785
|
+
}
|
|
8786
|
+
export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
|
|
8787
|
+
type: "json";
|
|
8788
|
+
message: object;
|
|
8789
|
+
}
|
|
8790
|
+
export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
|
|
8791
|
+
export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload;
|
|
8349
8792
|
declare const audioPreviewProviders: readonly [
|
|
8350
8793
|
"microsoft",
|
|
8351
8794
|
"google",
|
|
@@ -8383,6 +8826,20 @@ export interface INluEmbeddingCredentials {
|
|
|
8383
8826
|
apiDeploymentName?: string;
|
|
8384
8827
|
apiVersion?: string;
|
|
8385
8828
|
}
|
|
8829
|
+
export interface ISetAppStateOverlaySettings {
|
|
8830
|
+
autoOpen: boolean;
|
|
8831
|
+
closeOnSubmit: boolean;
|
|
8832
|
+
feedbackMessage: string;
|
|
8833
|
+
screenTitle: string;
|
|
8834
|
+
sendEventOnCloseIconClick: boolean;
|
|
8835
|
+
showCloseIcon: boolean;
|
|
8836
|
+
}
|
|
8837
|
+
export interface ISetAppStateOverlaySettingsMetaData {
|
|
8838
|
+
overlaySettings: ISetAppStateOverlaySettings;
|
|
8839
|
+
endpointType: TEndpointType;
|
|
8840
|
+
url: string;
|
|
8841
|
+
URLToken: string;
|
|
8842
|
+
}
|
|
8386
8843
|
export interface IVoiceGateway2VadParams {
|
|
8387
8844
|
enable?: boolean;
|
|
8388
8845
|
voiceMs?: number;
|
|
@@ -8559,6 +9016,7 @@ export declare type TVoiceGatewayNuanceFormatting = {
|
|
|
8559
9016
|
};
|
|
8560
9017
|
export declare type TVoiceGateway2InputType = "digits" | "speech";
|
|
8561
9018
|
export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
|
|
9019
|
+
export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
|
|
8562
9020
|
export interface IVoiceGateway2BargeInParams {
|
|
8563
9021
|
enable?: boolean;
|
|
8564
9022
|
sticky?: boolean;
|
|
@@ -8579,7 +9037,15 @@ export interface IVoiceGateway2ActivityParams {
|
|
|
8579
9037
|
user?: IVoiceGateway2CognigyUserInputConfigParams;
|
|
8580
9038
|
dtmf?: boolean;
|
|
8581
9039
|
sessionParams?: IVoiceGateway2ActivityParams;
|
|
9040
|
+
fillerNoise?: IVoiceGateway2FillerNoiseParams;
|
|
9041
|
+
flow?: IVoiceGateway2CognigyFlowInputConfigParams;
|
|
8582
9042
|
}
|
|
9043
|
+
export interface IVoiceGateway2FillerNoiseParams {
|
|
9044
|
+
enable: boolean;
|
|
9045
|
+
url?: string;
|
|
9046
|
+
startDelaySecs?: number;
|
|
9047
|
+
}
|
|
9048
|
+
export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
|
|
8583
9049
|
export interface IVoiceGateway2CognigyUserInputConfigParams {
|
|
8584
9050
|
noInputMode?: TVoiceGateway2UserNoInputMode;
|
|
8585
9051
|
noInputTimeout?: number;
|
|
@@ -8588,6 +9054,15 @@ export interface IVoiceGateway2CognigyUserInputConfigParams {
|
|
|
8588
9054
|
noInputUrl?: string;
|
|
8589
9055
|
userNoInputAutoHangup?: boolean;
|
|
8590
9056
|
}
|
|
9057
|
+
export interface IVoiceGateway2CognigyFlowInputConfigParams {
|
|
9058
|
+
flowNoInputEnable?: boolean;
|
|
9059
|
+
flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
|
|
9060
|
+
flowNoInputTimeout?: number;
|
|
9061
|
+
flowNoInputRetries?: number;
|
|
9062
|
+
flowNoInputSpeech?: string;
|
|
9063
|
+
flowNoInputUrl?: string;
|
|
9064
|
+
flowNoInputFail?: boolean;
|
|
9065
|
+
}
|
|
8591
9066
|
export interface IGetNluPipelineParams {
|
|
8592
9067
|
parseIntents?: boolean;
|
|
8593
9068
|
parseSlots?: boolean;
|
|
@@ -8623,6 +9098,10 @@ export interface IHandoverRequestStatus {
|
|
|
8623
9098
|
nodeType: "question" | "handoverToAgent";
|
|
8624
9099
|
agentAssistInitMessage: string;
|
|
8625
9100
|
processedInitMessage?: boolean;
|
|
9101
|
+
/**
|
|
9102
|
+
* Indicates whether an "Assist / Copilot Flow"
|
|
9103
|
+
* should be used during the Handover Request
|
|
9104
|
+
*/
|
|
8626
9105
|
agentAssistConfigured: boolean;
|
|
8627
9106
|
providerResponse: TAnyProviderResponse;
|
|
8628
9107
|
sendOnQueueEvent?: boolean;
|
|
@@ -8660,6 +9139,20 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
|
|
|
8660
9139
|
agentAssistInitMessage: string;
|
|
8661
9140
|
sendOnQueueEvent: boolean;
|
|
8662
9141
|
sendOnActiveEvent: boolean;
|
|
9142
|
+
getQueuePosition: boolean;
|
|
9143
|
+
getEstimatedWaitTime: boolean;
|
|
9144
|
+
alternativeUpdate: boolean;
|
|
9145
|
+
updateIntervalQueuePosition: number;
|
|
9146
|
+
updateIntervalEstimatedWaitTime: number;
|
|
9147
|
+
maximumQueuePosition: number;
|
|
9148
|
+
maximumEstimatedWaitTime: number;
|
|
9149
|
+
alternativeText: string;
|
|
9150
|
+
enableHandoverDisconnectMessageLiveAgent: boolean;
|
|
9151
|
+
enableHandoverConnectMessageLiveAgent: boolean;
|
|
9152
|
+
enableHandoverDisconnectMessageGenesys: boolean;
|
|
9153
|
+
enableHandoverConnectMessageGenesys: boolean;
|
|
9154
|
+
enableHandoverDisconnectMessageRingCentralEngage: boolean;
|
|
9155
|
+
enableHandoverConnectMessageRingCentralEngage: boolean;
|
|
8663
9156
|
};
|
|
8664
9157
|
nodeType?: "question" | "handoverToAgent";
|
|
8665
9158
|
}
|
|
@@ -8692,6 +9185,51 @@ export interface IScheduledNodeParams extends INodeFunctionBaseParams {
|
|
|
8692
9185
|
}
|
|
8693
9186
|
export interface ISchedulingErrorNodeParams extends INodeFunctionBaseParams {
|
|
8694
9187
|
}
|
|
9188
|
+
export interface ISpeakingStyle {
|
|
9189
|
+
completeness: string;
|
|
9190
|
+
formality: string;
|
|
9191
|
+
[key: string]: string;
|
|
9192
|
+
}
|
|
9193
|
+
declare const contactProfileOptions: readonly [
|
|
9194
|
+
"none",
|
|
9195
|
+
"selectedProfileFields",
|
|
9196
|
+
"completeProfile",
|
|
9197
|
+
"profileMemoriesOnly"
|
|
9198
|
+
];
|
|
9199
|
+
export declare type TContactProfileOptions = typeof contactProfileOptions[number];
|
|
9200
|
+
export interface ISafetySettings {
|
|
9201
|
+
avoidHarmfulContent: boolean;
|
|
9202
|
+
avoidUngroundedContent: boolean;
|
|
9203
|
+
avoidCopyrightInfringements: boolean;
|
|
9204
|
+
preventJailbreakAndManipulation: boolean;
|
|
9205
|
+
}
|
|
9206
|
+
export interface IAiAgent extends IEntityMeta {
|
|
9207
|
+
name: string;
|
|
9208
|
+
referenceId: string;
|
|
9209
|
+
image: string;
|
|
9210
|
+
imageOptimizedFormat: boolean;
|
|
9211
|
+
knowledgeReferenceId: string;
|
|
9212
|
+
description: string;
|
|
9213
|
+
speakingStyle: ISpeakingStyle;
|
|
9214
|
+
safetySettings: ISafetySettings;
|
|
9215
|
+
instructions: string;
|
|
9216
|
+
contactProfilesOption: TContactProfileOptions;
|
|
9217
|
+
contactProfilesSelected: string[];
|
|
9218
|
+
projectReference: TMongoId;
|
|
9219
|
+
organisationReference: TMongoId;
|
|
9220
|
+
}
|
|
9221
|
+
export interface IAiAgentDependencies {
|
|
9222
|
+
type: "attachedKnowledgeStore";
|
|
9223
|
+
_id: TMongoId;
|
|
9224
|
+
}
|
|
9225
|
+
export interface IGraphAiAgent {
|
|
9226
|
+
type: "aiAgent";
|
|
9227
|
+
_id: TMongoId;
|
|
9228
|
+
name: string;
|
|
9229
|
+
referenceId: string;
|
|
9230
|
+
properties: Pick<IAiAgent, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy" | "knowledgeReferenceId">;
|
|
9231
|
+
dependencies?: IAiAgentDependencies[];
|
|
9232
|
+
}
|
|
8695
9233
|
export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
|
|
8696
9234
|
tile: any;
|
|
8697
9235
|
}
|
|
@@ -8775,6 +9313,8 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
|
8775
9313
|
repromptLLMProvider: string;
|
|
8776
9314
|
repromptLLMPrompt: string;
|
|
8777
9315
|
repromptLLMTurns: number;
|
|
9316
|
+
repromptLLMStream: boolean;
|
|
9317
|
+
repromptLLMStreamStopTokens: string[];
|
|
8778
9318
|
repromptType: "text" | "say" | "llm" | "execute";
|
|
8779
9319
|
repromptSay: ISayParams["config"]["say"];
|
|
8780
9320
|
repromptFlowNode: {
|
|
@@ -8953,172 +9493,635 @@ export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
|
|
|
8953
9493
|
type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom" | "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber" | "llm_entity";
|
|
8954
9494
|
}
|
|
8955
9495
|
export declare type TRephraseWithAIQuestionType = IActiveQuestion["type"] | IOptionalQuestionNodeOtherConfig["type"];
|
|
8956
|
-
export interface
|
|
8957
|
-
|
|
8958
|
-
|
|
8959
|
-
|
|
8960
|
-
|
|
8961
|
-
|
|
8962
|
-
|
|
8963
|
-
|
|
8964
|
-
|
|
8965
|
-
|
|
8966
|
-
|
|
8967
|
-
|
|
8968
|
-
|
|
8969
|
-
|
|
8970
|
-
type: string;
|
|
8971
|
-
value: string;
|
|
8972
|
-
invalidReason: string;
|
|
9496
|
+
export interface INodeToExecute {
|
|
9497
|
+
nodeId: string;
|
|
9498
|
+
flowExecutionCallerId?: string;
|
|
9499
|
+
flowId: string;
|
|
9500
|
+
cognigyScriptInput?: IExecutionObjects["input"];
|
|
9501
|
+
inputObjectToRestore?: IExecutionObjects["input"];
|
|
9502
|
+
nextMainFlowNodeInputObject?: IExecutionObjects["input"];
|
|
9503
|
+
ignoreSlotScope?: boolean;
|
|
9504
|
+
trackAnalyticsStepOptions?: {
|
|
9505
|
+
entityReferenceId: string;
|
|
9506
|
+
flowName: string;
|
|
9507
|
+
flowReferenceId: string;
|
|
9508
|
+
type: "intent" | "node";
|
|
9509
|
+
stepLabel: string;
|
|
8973
9510
|
};
|
|
8974
|
-
|
|
9511
|
+
type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
|
|
8975
9512
|
}
|
|
8976
9513
|
export declare type TCompletionPrompt = {
|
|
8977
9514
|
prompt: string;
|
|
8978
9515
|
};
|
|
9516
|
+
export declare type TChatMessage = {
|
|
9517
|
+
role: "user" | "system" | "assistant" | "tool";
|
|
9518
|
+
content: string;
|
|
9519
|
+
toolCallId?: string;
|
|
9520
|
+
};
|
|
8979
9521
|
export declare type TChatPrompt = {
|
|
8980
|
-
messages: Array<
|
|
8981
|
-
role: "user" | "system" | "assistant";
|
|
8982
|
-
content: string;
|
|
8983
|
-
}>;
|
|
9522
|
+
messages: Array<TChatMessage>;
|
|
8984
9523
|
};
|
|
8985
|
-
export
|
|
8986
|
-
|
|
8987
|
-
|
|
8988
|
-
|
|
8989
|
-
|
|
8990
|
-
|
|
8991
|
-
|
|
8992
|
-
|
|
8993
|
-
|
|
8994
|
-
|
|
8995
|
-
|
|
8996
|
-
|
|
8997
|
-
|
|
8998
|
-
|
|
8999
|
-
|
|
9000
|
-
|
|
9001
|
-
|
|
9002
|
-
|
|
9003
|
-
|
|
9004
|
-
|
|
9005
|
-
|
|
9006
|
-
|
|
9007
|
-
|
|
9008
|
-
|
|
9009
|
-
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
9010
|
-
* So 0.1 means only the tokens comprising the top 10% probability mass are considered.
|
|
9011
|
-
* It is recommended altering this or temperature but not both.
|
|
9012
|
-
*/
|
|
9013
|
-
topP?: number;
|
|
9014
|
-
/**
|
|
9015
|
-
* Top-k changes how the model selects tokens for output. A top-k of 1 means
|
|
9016
|
-
* the selected token is the most probable among all tokens in the model's
|
|
9017
|
-
* vocabulary (also called greedy decoding), while a top-k of 3 means that
|
|
9018
|
-
* the next token is selected from among the 3 most probable tokens
|
|
9019
|
-
* (using temperature).
|
|
9020
|
-
* values: [1–40]
|
|
9021
|
-
* Default: 40
|
|
9022
|
-
*/
|
|
9023
|
-
topK?: number;
|
|
9524
|
+
export declare type TSessionUsageInformation = {
|
|
9525
|
+
[key: string]: {
|
|
9526
|
+
llmDisplayName: string;
|
|
9527
|
+
providerType: string;
|
|
9528
|
+
modelType: string;
|
|
9529
|
+
usage: {
|
|
9530
|
+
inputTokens: number;
|
|
9531
|
+
outputTokens: number;
|
|
9532
|
+
};
|
|
9533
|
+
};
|
|
9534
|
+
};
|
|
9535
|
+
export interface IToolCall {
|
|
9536
|
+
id: string;
|
|
9537
|
+
type: string;
|
|
9538
|
+
index: number;
|
|
9539
|
+
function: IToolFunction;
|
|
9540
|
+
}
|
|
9541
|
+
export interface IToolFunction {
|
|
9542
|
+
name: string;
|
|
9543
|
+
arguments: {
|
|
9544
|
+
[key: string]: unknown;
|
|
9545
|
+
};
|
|
9546
|
+
}
|
|
9547
|
+
export interface ISessionState extends ISessionStateWithoutMeta {
|
|
9024
9548
|
/**
|
|
9025
|
-
*
|
|
9026
|
-
*
|
|
9549
|
+
* The Mongo ObjectId. Typed as any due
|
|
9550
|
+
* to extending the mongoose document below.
|
|
9027
9551
|
*/
|
|
9028
|
-
|
|
9552
|
+
_id: any;
|
|
9029
9553
|
/**
|
|
9030
|
-
*
|
|
9031
|
-
* increasing the model's likelihood to talk about new topics.
|
|
9554
|
+
* The id of the user.
|
|
9032
9555
|
*/
|
|
9033
|
-
|
|
9556
|
+
userId: string;
|
|
9034
9557
|
/**
|
|
9035
|
-
*
|
|
9558
|
+
* The unique identifier of the
|
|
9559
|
+
* current session (conversation) the
|
|
9560
|
+
* user is having.
|
|
9036
9561
|
*/
|
|
9037
|
-
|
|
9562
|
+
sessionId: string;
|
|
9038
9563
|
/**
|
|
9039
|
-
* The
|
|
9564
|
+
* The 'epoch' is a value which we will increase whenever
|
|
9565
|
+
* we dispatch a change for the session state. We use it
|
|
9566
|
+
* to avoid that we apply outdated updates to the session state
|
|
9040
9567
|
*/
|
|
9041
|
-
|
|
9568
|
+
epoch: number;
|
|
9042
9569
|
/**
|
|
9043
|
-
*
|
|
9570
|
+
* Date when this object will expire in the database. We utilize a
|
|
9571
|
+
* time-based index in MongoDB.
|
|
9044
9572
|
*/
|
|
9045
|
-
|
|
9573
|
+
expiresAt: Date;
|
|
9574
|
+
}
|
|
9575
|
+
export interface ISessionStateWithoutMeta {
|
|
9046
9576
|
/**
|
|
9047
|
-
*
|
|
9577
|
+
* The context object that the user
|
|
9578
|
+
* can manipulate in the Flow.
|
|
9579
|
+
* Moves from string at storage to object in memory
|
|
9048
9580
|
*/
|
|
9049
|
-
|
|
9581
|
+
context: {
|
|
9582
|
+
[key: string]: any;
|
|
9583
|
+
} | string;
|
|
9050
9584
|
/**
|
|
9051
|
-
*
|
|
9052
|
-
*
|
|
9585
|
+
* The system context stores information
|
|
9586
|
+
* like execution number and Flow paths.
|
|
9053
9587
|
*/
|
|
9054
|
-
|
|
9588
|
+
systemContext: {
|
|
9589
|
+
[key: string]: any;
|
|
9590
|
+
};
|
|
9055
9591
|
/**
|
|
9056
|
-
*
|
|
9592
|
+
* The current Flow state.
|
|
9057
9593
|
*/
|
|
9058
|
-
|
|
9594
|
+
state: string;
|
|
9595
|
+
flowId: string;
|
|
9596
|
+
thinkFlowReferenceIdMarker: string;
|
|
9597
|
+
localeReferenceId: string;
|
|
9059
9598
|
/**
|
|
9060
|
-
*
|
|
9599
|
+
* The snapshot / project
|
|
9600
|
+
* the user is using
|
|
9061
9601
|
*/
|
|
9062
|
-
|
|
9602
|
+
entrypoint: string;
|
|
9603
|
+
entrypointType: "project" | "snapshot";
|
|
9604
|
+
projectId: string;
|
|
9605
|
+
timezoneOffset: number | string;
|
|
9063
9606
|
/**
|
|
9064
|
-
|
|
9065
|
-
|
|
9066
|
-
|
|
9607
|
+
* Forms/Processes need the any slots of the calling flow to map injected any slots
|
|
9608
|
+
*/
|
|
9609
|
+
injectedAnySlots: {
|
|
9610
|
+
[key: string]: string;
|
|
9611
|
+
};
|
|
9612
|
+
reconfirmedSentences: {
|
|
9613
|
+
[key: string]: string[];
|
|
9614
|
+
};
|
|
9615
|
+
endpointClientInstanceId?: string;
|
|
9616
|
+
endpointId?: string;
|
|
9617
|
+
previousInputId: string | null;
|
|
9618
|
+
previousInputMessageAmount: number;
|
|
9619
|
+
sensitiveLoggingSettings: ISensitiveLoggingSettings;
|
|
9620
|
+
sentWelcomeMessage?: boolean;
|
|
9621
|
+
nodesToExecuteStack?: INodeToExecute[];
|
|
9622
|
+
trackedSteps?: IAnalyticsStepData["trackedSteps"];
|
|
9623
|
+
trackedGoals?: IAnalyticsSourceData["trackedGoals"];
|
|
9624
|
+
handoverEscalations?: IAnalyticsSourceData["handoverEscalations"];
|
|
9625
|
+
previousInputText?: IAnalyticsSourceData["previousInputText"];
|
|
9626
|
+
previousInputData?: IAnalyticsSourceData["previousInputData"];
|
|
9627
|
+
previousInputAttachments?: IAnalyticsSourceData["previousInputAttachments"] | any;
|
|
9628
|
+
previousSource?: IAnalyticsSourceData["previousSource"];
|
|
9629
|
+
handoverRequest?: IHandoverRequestStatus;
|
|
9630
|
+
frustration?: number;
|
|
9067
9631
|
/**
|
|
9068
|
-
*
|
|
9632
|
+
* The list of nodes that were visited in the last
|
|
9633
|
+
* Flow execution
|
|
9069
9634
|
*/
|
|
9070
|
-
|
|
9635
|
+
lastFlowPath?: string;
|
|
9636
|
+
apps?: IAppsSessionState;
|
|
9071
9637
|
/**
|
|
9072
|
-
*
|
|
9638
|
+
* The last user input and bot output strings.
|
|
9639
|
+
* Only filled & used if Generative AI feature is enabled.
|
|
9073
9640
|
*/
|
|
9074
|
-
|
|
9075
|
-
|
|
9076
|
-
|
|
9641
|
+
lastConversationEntries?: ILastConversationEntry[];
|
|
9642
|
+
analytics: ISessionStateAnalytics;
|
|
9643
|
+
lastToolCall?: {
|
|
9644
|
+
llmProvider: TGenerativeAIProviders;
|
|
9645
|
+
toolCall: IToolCall;
|
|
9646
|
+
aiAgentJobNode: {
|
|
9647
|
+
flow: string;
|
|
9648
|
+
node: string;
|
|
9649
|
+
};
|
|
9650
|
+
};
|
|
9651
|
+
tokenUsage?: TSessionUsageInformation;
|
|
9652
|
+
}
|
|
9653
|
+
export interface ISessionStateAnalytics {
|
|
9654
|
+
goalCycleIds: {
|
|
9655
|
+
[goalId: string]: string;
|
|
9656
|
+
};
|
|
9657
|
+
}
|
|
9658
|
+
export interface ILastConversationEntry {
|
|
9659
|
+
source: "user" | "bot";
|
|
9660
|
+
text: string;
|
|
9661
|
+
}
|
|
9662
|
+
export interface IAppsSessionState {
|
|
9663
|
+
session: {
|
|
9664
|
+
token: string;
|
|
9665
|
+
};
|
|
9666
|
+
customization: {};
|
|
9667
|
+
}
|
|
9668
|
+
export declare type ValueOf<T> = T[keyof T];
|
|
9669
|
+
/**
|
|
9670
|
+
* Options for reading the transcript
|
|
9671
|
+
* @param limit: the maximum number of entries to read
|
|
9672
|
+
* @param rolesWhiteList: (optional) the roles for which the entries should be included, if not provided or empty all entries will be read
|
|
9673
|
+
* @param excludeDataOnlyMessagesFilter: (optional) the roles for which data only messages (emtpy text field) will be excluded if type is input/output
|
|
9674
|
+
*/
|
|
9675
|
+
export declare type TReadTranscriptOptions = {
|
|
9676
|
+
limit: number;
|
|
9677
|
+
rolesWhiteList?: TTranscriptRoles[];
|
|
9678
|
+
excludeDataOnlyMessagesFilter?: (TranscriptRole.USER | TranscriptRole.AGENT | TranscriptRole.ASSISTANT)[];
|
|
9679
|
+
};
|
|
9680
|
+
declare enum TranscriptRole {
|
|
9681
|
+
ASSISTANT = "assistant",
|
|
9682
|
+
USER = "user",
|
|
9683
|
+
AGENT = "agent",
|
|
9684
|
+
SYSTEM = "system",
|
|
9685
|
+
TOOL = "tool"
|
|
9686
|
+
}
|
|
9687
|
+
export declare type TTranscriptRoles = ValueOf<typeof TranscriptRole>;
|
|
9688
|
+
declare enum TranscriptEntryType {
|
|
9689
|
+
INPUT = "input",
|
|
9690
|
+
OUTPUT = "output",
|
|
9691
|
+
TOOL_CALL = "toolCall",
|
|
9692
|
+
TOOL_ANSWER = "toolAnswer",
|
|
9693
|
+
DEBUG_LOG = "debugLog"
|
|
9694
|
+
}
|
|
9695
|
+
export declare type TTranscriptEntryContent = TTranscriptUserInput | TTranscriptAssistantOutput | TTranscriptAgentOutput | TTranscriptAssistantToolCall | TTranscriptToolAnswer | TTranscriptDebugLog;
|
|
9696
|
+
export declare type TTranscriptEntry = TTranscriptEntryContent & {
|
|
9697
|
+
timestamp: number;
|
|
9698
|
+
traceId: string;
|
|
9699
|
+
};
|
|
9700
|
+
export declare type TTranscriptUserInput = {
|
|
9701
|
+
role: TranscriptRole.USER;
|
|
9702
|
+
type: TranscriptEntryType.INPUT;
|
|
9703
|
+
source: "user" | "system";
|
|
9704
|
+
payload: {
|
|
9705
|
+
text: string;
|
|
9706
|
+
data: any;
|
|
9707
|
+
};
|
|
9708
|
+
};
|
|
9709
|
+
export declare type TTranscriptAgentOutput = {
|
|
9710
|
+
role: TranscriptRole.AGENT;
|
|
9711
|
+
type: TranscriptEntryType.OUTPUT;
|
|
9712
|
+
source: "agent" | "system";
|
|
9713
|
+
payload: {
|
|
9714
|
+
text: string;
|
|
9715
|
+
data: any;
|
|
9716
|
+
};
|
|
9717
|
+
};
|
|
9718
|
+
export declare type TTranscriptAssistantOutput = {
|
|
9719
|
+
role: TranscriptRole.ASSISTANT;
|
|
9720
|
+
type: TranscriptEntryType.OUTPUT;
|
|
9721
|
+
source: "assistant" | "system";
|
|
9722
|
+
payload: {
|
|
9723
|
+
text: string;
|
|
9724
|
+
data: any;
|
|
9725
|
+
};
|
|
9726
|
+
};
|
|
9727
|
+
export declare type TTranscriptAssistantToolCall = {
|
|
9728
|
+
role: TranscriptRole.ASSISTANT;
|
|
9729
|
+
type: TranscriptEntryType.TOOL_CALL;
|
|
9730
|
+
source: "system";
|
|
9731
|
+
payload: {
|
|
9732
|
+
name: string;
|
|
9733
|
+
id: string;
|
|
9734
|
+
input: Object;
|
|
9735
|
+
};
|
|
9736
|
+
};
|
|
9737
|
+
export declare type TTranscriptToolAnswer = {
|
|
9738
|
+
role: TranscriptRole.TOOL;
|
|
9739
|
+
type: TranscriptEntryType.TOOL_ANSWER;
|
|
9740
|
+
source: "system";
|
|
9741
|
+
payload: {
|
|
9742
|
+
toolCallId: string;
|
|
9743
|
+
name?: string;
|
|
9744
|
+
content: string;
|
|
9745
|
+
};
|
|
9746
|
+
};
|
|
9747
|
+
export declare type TTranscriptDebugLog = {
|
|
9748
|
+
role: TranscriptRole.SYSTEM;
|
|
9749
|
+
type: TranscriptEntryType.DEBUG_LOG;
|
|
9750
|
+
source: "system";
|
|
9751
|
+
payload: {
|
|
9752
|
+
header?: string;
|
|
9753
|
+
message: string;
|
|
9754
|
+
metadata?: any;
|
|
9755
|
+
};
|
|
9756
|
+
};
|
|
9757
|
+
export interface IToolFunction {
|
|
9758
|
+
/**
|
|
9759
|
+
* The name of the function to be called.
|
|
9760
|
+
*/
|
|
9761
|
+
name: string;
|
|
9762
|
+
/**
|
|
9763
|
+
* A description of what the function does, used by the model to choose when and
|
|
9764
|
+
* how to call the function.
|
|
9765
|
+
*/
|
|
9766
|
+
description: string;
|
|
9767
|
+
/**
|
|
9768
|
+
* strict: true enables structured outputs.
|
|
9769
|
+
*/
|
|
9770
|
+
strict?: boolean;
|
|
9771
|
+
/**
|
|
9772
|
+
* The parameters the functions accepts, ideally described as a JSON Schema object.
|
|
9773
|
+
*/
|
|
9774
|
+
parameters?: IToolParameters;
|
|
9775
|
+
}
|
|
9776
|
+
export interface ITool {
|
|
9777
|
+
function: IToolFunction;
|
|
9778
|
+
/**
|
|
9779
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
9780
|
+
*/
|
|
9781
|
+
type: "function";
|
|
9782
|
+
}
|
|
9783
|
+
export interface IToolParameters {
|
|
9784
|
+
[key: string]: any;
|
|
9785
|
+
}
|
|
9786
|
+
export interface OpenAIChatMessage {
|
|
9787
|
+
role: "system" | "user" | "assistant";
|
|
9788
|
+
content: string;
|
|
9789
|
+
}
|
|
9790
|
+
export interface IGenerativeSlot {
|
|
9791
|
+
tag: string;
|
|
9792
|
+
description: string;
|
|
9793
|
+
value: string;
|
|
9794
|
+
optional?: boolean;
|
|
9795
|
+
validation?: {
|
|
9796
|
+
type: string;
|
|
9797
|
+
value: string;
|
|
9798
|
+
invalidReason: string;
|
|
9799
|
+
};
|
|
9800
|
+
invalid?: boolean;
|
|
9801
|
+
}
|
|
9802
|
+
export interface IRunGenerativeAIPromptOptions {
|
|
9803
|
+
/**
|
|
9804
|
+
* @deprecated should not inject the prompt anymore, use getPrompt() instead
|
|
9805
|
+
*/
|
|
9806
|
+
prompt?: string;
|
|
9807
|
+
/** Text to calculate the embedding vector */
|
|
9808
|
+
embeddingText?: string;
|
|
9809
|
+
/**
|
|
9810
|
+
* Instead of a prompt, we can also provide messages in OpenAI's chat format
|
|
9811
|
+
*/
|
|
9812
|
+
chat?: OpenAIChatMessage[];
|
|
9813
|
+
/**
|
|
9814
|
+
* transcript - The transcript to use for the prompt.
|
|
9815
|
+
* If provided, the transcript will be converted to in the prompt runner.
|
|
9816
|
+
* Also, the system message will be expected in the `chat` property.
|
|
9817
|
+
*/
|
|
9818
|
+
transcript?: TTranscriptEntry[];
|
|
9819
|
+
/**
|
|
9820
|
+
* tools - Function tools to provide to the llm.
|
|
9821
|
+
*/
|
|
9822
|
+
tools?: ITool[];
|
|
9823
|
+
/**
|
|
9824
|
+
* toolChoice - Determine choice of tool usage.
|
|
9825
|
+
*/
|
|
9826
|
+
toolChoice?: "auto" | "required" | "none";
|
|
9827
|
+
/** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
|
|
9828
|
+
promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
|
|
9829
|
+
/** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
|
|
9830
|
+
temperature?: number;
|
|
9831
|
+
/** model - (Optional) The OpenAI model to use. Defaults to 'gpt-4o' */
|
|
9832
|
+
model?: TGenerativeAIModels;
|
|
9833
|
+
/** timeoutInMs - (Optional) The timeout for the request in ms. Defaults to 10000 */
|
|
9834
|
+
timeoutInMs?: number;
|
|
9835
|
+
/** maxTokens - (Optional) Upper bound on how many tokens the API will return.
|
|
9836
|
+
* The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length.
|
|
9837
|
+
* If not provided, we calculate the maximum: model_max_tokens - prompt_tokens */
|
|
9838
|
+
maxTokens?: number;
|
|
9839
|
+
/**
|
|
9840
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
9841
|
+
* So 0.1 means only the tokens comprising the top 10% probability mass are considered.
|
|
9842
|
+
* It is recommended altering this or temperature but not both.
|
|
9843
|
+
*/
|
|
9844
|
+
topP?: number;
|
|
9845
|
+
/**
|
|
9846
|
+
* Top-k changes how the model selects tokens for output. A top-k of 1 means
|
|
9847
|
+
* the selected token is the most probable among all tokens in the model's
|
|
9848
|
+
* vocabulary (also called greedy decoding), while a top-k of 3 means that
|
|
9849
|
+
* the next token is selected from among the 3 most probable tokens
|
|
9850
|
+
* (using temperature).
|
|
9851
|
+
* values: [1–40]
|
|
9852
|
+
* Default: 40
|
|
9853
|
+
*/
|
|
9854
|
+
topK?: number;
|
|
9855
|
+
/**
|
|
9856
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far,
|
|
9857
|
+
* decreasing the model's likelihood to repeat the same line verbatim.
|
|
9858
|
+
*/
|
|
9859
|
+
frequencyPenalty?: number;
|
|
9860
|
+
/**
|
|
9861
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
|
|
9862
|
+
* increasing the model's likelihood to talk about new topics.
|
|
9863
|
+
*/
|
|
9864
|
+
presencePenalty?: number;
|
|
9865
|
+
/**
|
|
9866
|
+
* Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
|
|
9867
|
+
*/
|
|
9868
|
+
stop?: string[];
|
|
9869
|
+
/**
|
|
9870
|
+
* The useCase of the prompt.
|
|
9871
|
+
*/
|
|
9872
|
+
useCase?: string;
|
|
9873
|
+
/**
|
|
9874
|
+
* Whether to stream the response or not.
|
|
9875
|
+
*/
|
|
9876
|
+
stream?: boolean;
|
|
9877
|
+
/**
|
|
9878
|
+
* Callback function for stream data
|
|
9879
|
+
*/
|
|
9880
|
+
streamOnDataHandler?: Function;
|
|
9881
|
+
/**
|
|
9882
|
+
* Array of tokens which signal the end of a sentence and trigger
|
|
9883
|
+
* flushing of token buffer to the provided handler
|
|
9884
|
+
*/
|
|
9885
|
+
streamStopTokens?: string[];
|
|
9886
|
+
/**
|
|
9887
|
+
* Array of regular expressions which prevent the stream buffer to be flushed
|
|
9888
|
+
*/
|
|
9889
|
+
streamStopTokenOverrides?: string[];
|
|
9890
|
+
/**
|
|
9891
|
+
* A string denoting the reference ID of the chosen LLM provider
|
|
9892
|
+
*/
|
|
9893
|
+
llmProviderReferenceId?: string;
|
|
9894
|
+
/**
|
|
9895
|
+
* Response Format (can be json for some providers), text and default means none
|
|
9896
|
+
*/
|
|
9897
|
+
responseFormat?: "json_object" | "text" | "default";
|
|
9898
|
+
/**
|
|
9899
|
+
* Option to output detailed results, including finish_reason, etc
|
|
9900
|
+
*/
|
|
9901
|
+
detailedResults?: boolean;
|
|
9902
|
+
/**
|
|
9903
|
+
* Developers can now specify seed parameter in the OpenAI Chat Completion request to receive (mostly) consistent outputs
|
|
9904
|
+
*/
|
|
9905
|
+
seed?: number;
|
|
9906
|
+
/**
|
|
9907
|
+
* JSON object with options to pass to the LLM Model
|
|
9908
|
+
*/
|
|
9909
|
+
customModelOptions?: any;
|
|
9910
|
+
/**
|
|
9911
|
+
* JSON object with options to pass to the LLM Request
|
|
9077
9912
|
*/
|
|
9078
9913
|
customRequestOptions?: any;
|
|
9914
|
+
/**
|
|
9915
|
+
* The user can supply specific instructions for image processing
|
|
9916
|
+
*/
|
|
9917
|
+
imageOptions?: {
|
|
9918
|
+
/**
|
|
9919
|
+
* Whether to process images at all
|
|
9920
|
+
*/
|
|
9921
|
+
processImages?: boolean;
|
|
9922
|
+
/**
|
|
9923
|
+
* Configure how images older than the last turn are handled
|
|
9924
|
+
*/
|
|
9925
|
+
transcriptImageHandling?: "minify" | "drop" | "keep";
|
|
9926
|
+
/**
|
|
9927
|
+
* Options for resizing images
|
|
9928
|
+
*/
|
|
9929
|
+
resizingOptions?: {
|
|
9930
|
+
/**
|
|
9931
|
+
* Maximum Width for images to be sent to the provider
|
|
9932
|
+
*/
|
|
9933
|
+
maxImageWidth?: number;
|
|
9934
|
+
/**
|
|
9935
|
+
* Maximum Height for images to be sent to the provider
|
|
9936
|
+
*/
|
|
9937
|
+
maxImageHeight?: number;
|
|
9938
|
+
/**
|
|
9939
|
+
* Maximum File Size for images to be sent to the provider
|
|
9940
|
+
*/
|
|
9941
|
+
maxImageFileSizeInBytes?: number;
|
|
9942
|
+
};
|
|
9943
|
+
};
|
|
9944
|
+
}
|
|
9945
|
+
export interface IAzureOpenAIProviderFieldsV2 {
|
|
9946
|
+
apiKey: string;
|
|
9947
|
+
}
|
|
9948
|
+
export interface IAzureOpenAIProviderOauth2Fields {
|
|
9949
|
+
clientId: string;
|
|
9950
|
+
clientSecret: string;
|
|
9951
|
+
oauthUrl: string;
|
|
9952
|
+
scope: string;
|
|
9953
|
+
}
|
|
9954
|
+
export interface IParams {
|
|
9955
|
+
[key: string]: any;
|
|
9956
|
+
}
|
|
9957
|
+
export interface IConnectionSchemaField {
|
|
9958
|
+
_id?: TMongoId;
|
|
9959
|
+
/** The field name, e.g. 'client_id' */
|
|
9960
|
+
fieldName: string;
|
|
9961
|
+
required?: boolean;
|
|
9962
|
+
label?: string;
|
|
9963
|
+
description?: string;
|
|
9964
|
+
params?: IParams;
|
|
9965
|
+
}
|
|
9966
|
+
export interface IConnectionSchema extends IEntityMeta {
|
|
9967
|
+
_id: TMongoId;
|
|
9968
|
+
extension: string;
|
|
9969
|
+
isCognigy: boolean;
|
|
9970
|
+
/** The type of the connection, e.g. 'oauth' */
|
|
9971
|
+
type: string;
|
|
9972
|
+
/** An additional label for the connection schema - by default we will pick the 'type' */
|
|
9973
|
+
label: string;
|
|
9974
|
+
/** The actual fields */
|
|
9975
|
+
fields: IConnectionSchemaField[];
|
|
9976
|
+
projectReference: TMongoId;
|
|
9977
|
+
organisationReference: TMongoId;
|
|
9978
|
+
}
|
|
9979
|
+
/** Logical operators that can be used when filtering tags for search */
|
|
9980
|
+
export declare type ISearchTagsFilterOps = "and" | "or";
|
|
9981
|
+
export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields {
|
|
9982
|
+
tokenCacheKey: string;
|
|
9983
|
+
}
|
|
9984
|
+
export interface ISearchLLMCredentials {
|
|
9985
|
+
provider: TGenerativeAIProviders;
|
|
9986
|
+
connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields;
|
|
9987
|
+
providerMetaData: IAzureOpenAIMeta;
|
|
9988
|
+
}
|
|
9989
|
+
export interface ISearchTagsData {
|
|
9990
|
+
tags: string[];
|
|
9991
|
+
op: ISearchTagsFilterOps;
|
|
9992
|
+
}
|
|
9993
|
+
export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
|
|
9994
|
+
query: string;
|
|
9995
|
+
projectId?: string;
|
|
9996
|
+
organisationId?: string | undefined;
|
|
9997
|
+
topK: number;
|
|
9998
|
+
language: string;
|
|
9999
|
+
knowledgeStoreIds?: string[];
|
|
10000
|
+
llmCredentials?: ISearchLLMCredentials;
|
|
10001
|
+
sessionId?: string;
|
|
10002
|
+
tagsData?: ISearchTagsData;
|
|
10003
|
+
}
|
|
10004
|
+
export interface IKnowledgeSearchReturnValue {
|
|
10005
|
+
status: "success" | "error";
|
|
10006
|
+
error?: string;
|
|
10007
|
+
data?: {
|
|
10008
|
+
topK: [
|
|
10009
|
+
{
|
|
10010
|
+
text: string;
|
|
10011
|
+
distance: number;
|
|
10012
|
+
storeReferenceId: string;
|
|
10013
|
+
sourceReferenceId: string;
|
|
10014
|
+
sourceMetaData: {
|
|
10015
|
+
sourceName: string;
|
|
10016
|
+
sourceType: string;
|
|
10017
|
+
title: string;
|
|
10018
|
+
url: string;
|
|
10019
|
+
[key: string]: any;
|
|
10020
|
+
};
|
|
10021
|
+
chunkMetaData?: {
|
|
10022
|
+
[key: string]: any;
|
|
10023
|
+
};
|
|
10024
|
+
order: number;
|
|
10025
|
+
}
|
|
10026
|
+
];
|
|
10027
|
+
tokenUsage: {
|
|
10028
|
+
inputTokens: number;
|
|
10029
|
+
outputTokens: number;
|
|
10030
|
+
totalTokens: number;
|
|
10031
|
+
};
|
|
10032
|
+
};
|
|
10033
|
+
}
|
|
10034
|
+
export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
|
|
10035
|
+
config: {
|
|
10036
|
+
lexiconId: string;
|
|
10037
|
+
keyphrase: string;
|
|
10038
|
+
slots: string[];
|
|
10039
|
+
synonyms: string[];
|
|
10040
|
+
};
|
|
10041
|
+
}
|
|
10042
|
+
export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
|
|
10043
|
+
config: {
|
|
10044
|
+
text: string;
|
|
10045
|
+
data: any;
|
|
10046
|
+
mode: string;
|
|
10047
|
+
contextKey: string;
|
|
10048
|
+
inputKey: string;
|
|
10049
|
+
parseIntents: boolean;
|
|
10050
|
+
parseSlots: boolean;
|
|
10051
|
+
parseSystemSlots: boolean;
|
|
10052
|
+
findType: boolean;
|
|
10053
|
+
processDefaultReply: boolean;
|
|
10054
|
+
};
|
|
10055
|
+
}
|
|
10056
|
+
export interface IRegexSlotFillerConfig {
|
|
10057
|
+
regex: string;
|
|
10058
|
+
flags: string;
|
|
10059
|
+
slot: string;
|
|
10060
|
+
}
|
|
10061
|
+
export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
|
|
10062
|
+
config: IRegexSlotFillerConfig;
|
|
10063
|
+
}
|
|
10064
|
+
export interface IMatchPatternParams extends INodeFunctionBaseParams {
|
|
10065
|
+
config: {
|
|
10066
|
+
patterns: string[];
|
|
10067
|
+
patternGroupName: string;
|
|
10068
|
+
alternateInput: string;
|
|
10069
|
+
detailedCompoundSlots: boolean;
|
|
10070
|
+
createNewSlots: boolean;
|
|
10071
|
+
tagExistingSlots: boolean;
|
|
10072
|
+
useFullSystemslotText: boolean;
|
|
10073
|
+
};
|
|
10074
|
+
}
|
|
10075
|
+
export interface IFuzzySearchParams extends INodeFunctionBaseParams {
|
|
10076
|
+
config: {
|
|
10077
|
+
searchPattern: string;
|
|
10078
|
+
items: any;
|
|
10079
|
+
isCaseSensitive: boolean;
|
|
10080
|
+
includeScore: boolean;
|
|
10081
|
+
includeMatches: boolean;
|
|
10082
|
+
minMatchCharLength: number;
|
|
10083
|
+
shouldSort: boolean;
|
|
10084
|
+
findAllMatches: boolean;
|
|
10085
|
+
location: number;
|
|
10086
|
+
threshold: number;
|
|
10087
|
+
distance: number;
|
|
10088
|
+
ignoreLocation: boolean;
|
|
10089
|
+
storeLocation: string;
|
|
10090
|
+
inputKey: string;
|
|
10091
|
+
contextKey: string;
|
|
10092
|
+
};
|
|
10093
|
+
}
|
|
10094
|
+
export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
10095
|
+
config: {
|
|
10096
|
+
slotsConfig: IGenerativeSlot[];
|
|
10097
|
+
amountOfLastUserInputs: number;
|
|
10098
|
+
maxQuestions: number;
|
|
10099
|
+
temperature: number;
|
|
10100
|
+
storeLocation: string;
|
|
10101
|
+
contextKey: string;
|
|
10102
|
+
inputKey: string;
|
|
10103
|
+
timeout: number;
|
|
10104
|
+
};
|
|
10105
|
+
}
|
|
10106
|
+
export interface IGoalAnalyticsPayload {
|
|
10107
|
+
analyticsdata: IGoalEscalations;
|
|
10108
|
+
data: IPayloadBaseMetaData;
|
|
9079
10109
|
}
|
|
9080
|
-
export interface
|
|
9081
|
-
|
|
9082
|
-
|
|
9083
|
-
|
|
9084
|
-
|
|
9085
|
-
|
|
9086
|
-
|
|
10110
|
+
export interface IGoalAnalyticsData {
|
|
10111
|
+
projectId: string;
|
|
10112
|
+
organisationId: string;
|
|
10113
|
+
sessionId: string;
|
|
10114
|
+
version: string;
|
|
10115
|
+
timestamp: Date;
|
|
10116
|
+
goalCycleId: string;
|
|
10117
|
+
stepId: string;
|
|
10118
|
+
goalId: string;
|
|
10119
|
+
contactId: string;
|
|
9087
10120
|
}
|
|
9088
|
-
export interface
|
|
9089
|
-
query: string;
|
|
9090
|
-
projectId?: string;
|
|
9091
|
-
organisationId?: string | undefined;
|
|
9092
|
-
topK: number;
|
|
9093
|
-
language: string;
|
|
9094
|
-
knowledgeStoreIds?: string[];
|
|
9095
|
-
openAiCredentials?: IOpenAiCredentials;
|
|
9096
|
-
sessionId?: string;
|
|
9097
|
-
tags?: string[];
|
|
10121
|
+
export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
|
|
9098
10122
|
}
|
|
9099
|
-
export interface
|
|
9100
|
-
|
|
9101
|
-
error?: string;
|
|
9102
|
-
data?: {
|
|
9103
|
-
topK: [
|
|
9104
|
-
{
|
|
9105
|
-
text: string;
|
|
9106
|
-
distance: number;
|
|
9107
|
-
sourceReferenceId: string;
|
|
9108
|
-
sourceMetaData: {
|
|
9109
|
-
sourceName: string;
|
|
9110
|
-
sourceType: string;
|
|
9111
|
-
title: string;
|
|
9112
|
-
url: string;
|
|
9113
|
-
[key: string]: any;
|
|
9114
|
-
};
|
|
9115
|
-
chunkMetaData?: {
|
|
9116
|
-
[key: string]: any;
|
|
9117
|
-
};
|
|
9118
|
-
order: number;
|
|
9119
|
-
}
|
|
9120
|
-
];
|
|
9121
|
-
};
|
|
10123
|
+
export interface IEndpointSettings {
|
|
10124
|
+
isFeatureAccmEnabled?: boolean;
|
|
9122
10125
|
}
|
|
9123
10126
|
export interface IGetConversationTranscriptParams {
|
|
9124
10127
|
turnLimit: number;
|
|
@@ -9161,6 +10164,7 @@ export interface IRephraseSentenceWithAIOptions {
|
|
|
9161
10164
|
question?: string;
|
|
9162
10165
|
answer?: string;
|
|
9163
10166
|
}
|
|
10167
|
+
export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics" | "lastToolCall" | "tokenUsage">>;
|
|
9164
10168
|
export interface IActions {
|
|
9165
10169
|
addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
|
|
9166
10170
|
addHandoverInactivityTimer?: (params: {
|
|
@@ -9168,12 +10172,14 @@ export interface IActions {
|
|
|
9168
10172
|
}) => Promise<void>;
|
|
9169
10173
|
activateProfile?: () => Promise<any>;
|
|
9170
10174
|
addLexiconKeyphrase?: (lexicon: string, keyphrase: string, slots: Array<string>, synonyms: Array<string>, data?: Object) => void;
|
|
9171
|
-
|
|
10175
|
+
addContactMemory?: (memoryText: string) => void;
|
|
10176
|
+
addToContext?: (key: string, value: any, mode: "simple" | "array") => void;
|
|
9172
10177
|
cancelHandoverRequest?: (cancelHandoverInProvider?: boolean) => Promise<void>;
|
|
9173
10178
|
checkAgentAvailability?: (params: ICheckAgentAvailabilityNodeParams) => void;
|
|
9174
10179
|
checkFrustration?: (nodeId: string, input: any) => void;
|
|
9175
10180
|
checkThink?: (id: string) => boolean;
|
|
9176
10181
|
completeGoal?: (goalData: IAnalyticsDataGoals) => void;
|
|
10182
|
+
countGPTTokens: (prompt: string) => number;
|
|
9177
10183
|
deactivateProfile?: (deleteData: boolean) => Promise<any>;
|
|
9178
10184
|
deleteContext?: (key: string) => void;
|
|
9179
10185
|
deleteProfile?: () => Promise<any>;
|
|
@@ -9188,8 +10194,18 @@ export interface IActions {
|
|
|
9188
10194
|
executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
|
|
9189
10195
|
executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
|
|
9190
10196
|
handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
|
|
9191
|
-
|
|
9192
|
-
|
|
10197
|
+
/**
|
|
10198
|
+
* returns the analytics data object - mutable
|
|
10199
|
+
* @deprecated
|
|
10200
|
+
*/
|
|
10201
|
+
getAnalyticsData: () => IAnalyticsSourceData;
|
|
10202
|
+
/** returns a copy of the analytics data object - immutable */
|
|
10203
|
+
getAnalyticsDataCopy: (key: string, value: any) => void;
|
|
10204
|
+
setAnalyticsData?: (key: keyof IAnalyticsSourceData, value: any) => void;
|
|
10205
|
+
/** returns a copy of the analytics data object - immutable */
|
|
10206
|
+
getSessionStateCopy: () => ISessionState;
|
|
10207
|
+
/** sets a key value pair in the session state in the brain */
|
|
10208
|
+
setSessionState: (key: keyof TBrainSessionState, value: any) => void;
|
|
9193
10209
|
getInjectedAnySlots?: () => {
|
|
9194
10210
|
[key: string]: string;
|
|
9195
10211
|
};
|
|
@@ -9207,6 +10223,10 @@ export interface IActions {
|
|
|
9207
10223
|
targetRuntimeVersion: number;
|
|
9208
10224
|
}) => boolean;
|
|
9209
10225
|
log?: (level: string, text: string) => void;
|
|
10226
|
+
logDebugMessage?: (message: string | object, header?: string) => void;
|
|
10227
|
+
logDebugError?: (message: string | object, header?: string) => void;
|
|
10228
|
+
logDebugMessageWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
|
|
10229
|
+
logDebugErrorWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
|
|
9210
10230
|
mergeProfile?: (contactId: string) => Promise<any>;
|
|
9211
10231
|
parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
|
|
9212
10232
|
parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
|
|
@@ -9239,6 +10259,7 @@ export interface IActions {
|
|
|
9239
10259
|
}) => void;
|
|
9240
10260
|
setLastTopic?: (text: string, type: any, age: number) => void;
|
|
9241
10261
|
setLocaleReferenceId?: (localeReferenceID: string) => void;
|
|
10262
|
+
setRegexSlot: (regexSlotFillerParams: IRegexSlotFillerParams) => void;
|
|
9242
10263
|
setSensitiveLoggingSettings?: (settings: ISensitiveLoggingSettings, traceId: string) => void;
|
|
9243
10264
|
setState?: (state: string) => void;
|
|
9244
10265
|
setSystemContext?: (key: string, value: any) => void;
|
|
@@ -9255,6 +10276,27 @@ export interface IActions {
|
|
|
9255
10276
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
9256
10277
|
getAgentAssistConfigId: () => string;
|
|
9257
10278
|
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
10279
|
+
getMetadata: () => IGetMetaDataActionValue;
|
|
10280
|
+
sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
|
|
10281
|
+
getEndpointSettings: () => IEndpointSettings;
|
|
10282
|
+
getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
|
|
10283
|
+
addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
|
|
10284
|
+
}
|
|
10285
|
+
export interface IGetMetaDataActionValue {
|
|
10286
|
+
sessionId: string;
|
|
10287
|
+
projectId: string;
|
|
10288
|
+
organisationId: string;
|
|
10289
|
+
traceId: string;
|
|
10290
|
+
endpointUrlToken: string;
|
|
10291
|
+
endpointName: string;
|
|
10292
|
+
channel: string;
|
|
10293
|
+
localeReferenceId: string;
|
|
10294
|
+
localeName: string;
|
|
10295
|
+
endpointType: TEndpointType;
|
|
10296
|
+
snapshotId: string;
|
|
10297
|
+
snapshotName: string;
|
|
10298
|
+
isFollowSessionActive: boolean;
|
|
10299
|
+
contactId: string;
|
|
9258
10300
|
}
|
|
9259
10301
|
export interface ICognigyNLPProperties {
|
|
9260
10302
|
/** The original text of the user */
|
|
@@ -9654,14 +10696,6 @@ export interface IMongoAggregateNodeParams extends INodeFunctionBaseParams {
|
|
|
9654
10696
|
stopOnError: boolean;
|
|
9655
10697
|
};
|
|
9656
10698
|
}
|
|
9657
|
-
export interface IRegexSlotFillerConfig {
|
|
9658
|
-
regex: string;
|
|
9659
|
-
flags: string;
|
|
9660
|
-
slot: string;
|
|
9661
|
-
}
|
|
9662
|
-
export interface IRegexSlotFillerParams extends INodeFunctionBaseParams {
|
|
9663
|
-
config: IRegexSlotFillerConfig;
|
|
9664
|
-
}
|
|
9665
10699
|
declare const ruleOperands: readonly [
|
|
9666
10700
|
"lt",
|
|
9667
10701
|
"lte",
|
|
@@ -9780,7 +10814,6 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
|
|
|
9780
10814
|
};
|
|
9781
10815
|
}
|
|
9782
10816
|
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal" | "getConversationTranscript"> {
|
|
9783
|
-
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
9784
10817
|
setNextNode: (nodeId: string, newFlowId?: string) => void;
|
|
9785
10818
|
resetNextNodes: () => void;
|
|
9786
10819
|
stopExecution: () => void;
|
|
@@ -9850,7 +10883,6 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
9850
10883
|
traceId: string;
|
|
9851
10884
|
}) => Promise<any>;
|
|
9852
10885
|
fuseSearch?: (list: any, options: any, pattern: string) => any;
|
|
9853
|
-
setRegexSlot: (regexSlotFillerParams: IRegexSlotFillerParams) => void;
|
|
9854
10886
|
addToInput: (key: string, value: any) => void;
|
|
9855
10887
|
resetCognigyScriptInput?: () => void;
|
|
9856
10888
|
setForwardDatesOnly?: () => void;
|
|
@@ -9862,15 +10894,23 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
9862
10894
|
appInterimScreenOverride?: string;
|
|
9863
10895
|
appConnectScreenOverride?: string;
|
|
9864
10896
|
}) => Promise<string>;
|
|
9865
|
-
setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown
|
|
10897
|
+
setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown>, options?: {
|
|
10898
|
+
webchat3?: {
|
|
10899
|
+
overlaySettingsMetaData?: ISetAppStateOverlaySettingsMetaData;
|
|
10900
|
+
};
|
|
10901
|
+
}) => void;
|
|
9866
10902
|
getAppSessionPin: () => Promise<string>;
|
|
9867
10903
|
validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
|
|
9868
10904
|
completeGoal: (goal: string) => void;
|
|
9869
10905
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
9870
10906
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
9871
10907
|
getAgentAssistConfigId: () => string;
|
|
9872
|
-
countGPTTokens
|
|
10908
|
+
countGPTTokens: (prompt: string) => number;
|
|
9873
10909
|
getConversationTranscript?: (mode: string, options?: any) => any;
|
|
10910
|
+
getEndpointSettings: () => IEndpointSettings;
|
|
10911
|
+
updateSessionStateValues(values: Partial<ISessionState>): void;
|
|
10912
|
+
getLLMTokenUsageForSession(): TSessionUsageInformation | null;
|
|
10913
|
+
loadSessionState: () => Promise<Partial<ISessionStateWithoutMeta>>;
|
|
9874
10914
|
}
|
|
9875
10915
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
9876
10916
|
api: INodeExecutionAPI;
|
|
@@ -9994,7 +11034,8 @@ declare const nodePreviewTypes: readonly [
|
|
|
9994
11034
|
"sayNode",
|
|
9995
11035
|
"custom",
|
|
9996
11036
|
"resource",
|
|
9997
|
-
"image"
|
|
11037
|
+
"image",
|
|
11038
|
+
"aiAgent"
|
|
9998
11039
|
];
|
|
9999
11040
|
export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
|
|
10000
11041
|
export interface INodePreview {
|
|
@@ -10057,10 +11098,13 @@ declare const nodeFieldTypes: readonly [
|
|
|
10057
11098
|
"function",
|
|
10058
11099
|
"json",
|
|
10059
11100
|
"keyValuePairs",
|
|
11101
|
+
"toolParameters",
|
|
10060
11102
|
"knowledgeStore",
|
|
10061
11103
|
"knowledgeStoreSelect",
|
|
10062
11104
|
"knowledgeSourceTags",
|
|
10063
11105
|
"llmSelect",
|
|
11106
|
+
"aiAgentSelect",
|
|
11107
|
+
"goalAndStepsSelect",
|
|
10064
11108
|
"lexicon",
|
|
10065
11109
|
"localeField",
|
|
10066
11110
|
"node",
|
|
@@ -10137,6 +11181,11 @@ export interface INodeField<K extends string | number | symbol = string> {
|
|
|
10137
11181
|
[key: string]: any;
|
|
10138
11182
|
};
|
|
10139
11183
|
optionsResolver?: INodeOptionsResolver;
|
|
11184
|
+
resetOption?: IResetOption;
|
|
11185
|
+
}
|
|
11186
|
+
export interface IResetOption {
|
|
11187
|
+
lookupValue: string;
|
|
11188
|
+
fieldsToReset: string[];
|
|
10140
11189
|
}
|
|
10141
11190
|
export interface INodeSection {
|
|
10142
11191
|
/** Unique identifier for this section within all sections of a descriptor, e.g. 'authentication' */
|
|
@@ -10196,31 +11245,6 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
10196
11245
|
/** The form defines how fields and sections should be render in order */
|
|
10197
11246
|
form?: INodeFieldAndSectionFormElement[];
|
|
10198
11247
|
}
|
|
10199
|
-
export interface IParams {
|
|
10200
|
-
[key: string]: any;
|
|
10201
|
-
}
|
|
10202
|
-
export interface IConnectionSchemaField {
|
|
10203
|
-
_id?: TMongoId;
|
|
10204
|
-
/** The field name, e.g. 'client_id' */
|
|
10205
|
-
fieldName: string;
|
|
10206
|
-
required?: boolean;
|
|
10207
|
-
label?: string;
|
|
10208
|
-
description?: string;
|
|
10209
|
-
params?: IParams;
|
|
10210
|
-
}
|
|
10211
|
-
export interface IConnectionSchema extends IEntityMeta {
|
|
10212
|
-
_id: TMongoId;
|
|
10213
|
-
extension: string;
|
|
10214
|
-
isCognigy: boolean;
|
|
10215
|
-
/** The type of the connection, e.g. 'oauth' */
|
|
10216
|
-
type: string;
|
|
10217
|
-
/** An additional label for the connection schema - by default we will pick the 'type' */
|
|
10218
|
-
label: string;
|
|
10219
|
-
/** The actual fields */
|
|
10220
|
-
fields: IConnectionSchemaField[];
|
|
10221
|
-
projectReference: TMongoId;
|
|
10222
|
-
organisationReference: TMongoId;
|
|
10223
|
-
}
|
|
10224
11248
|
export interface IAppTemplate extends IEntityMeta {
|
|
10225
11249
|
/** The object id of this app template */
|
|
10226
11250
|
_id: TMongoId;
|
|
@@ -10487,39 +11511,39 @@ export interface IGraphPlaybook {
|
|
|
10487
11511
|
name: string;
|
|
10488
11512
|
properties: Pick<IPlaybook, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10489
11513
|
}
|
|
10490
|
-
export interface
|
|
11514
|
+
export interface IGoal extends IEntityMeta {
|
|
10491
11515
|
_id: TMongoId;
|
|
10492
11516
|
name: string;
|
|
10493
|
-
version:
|
|
10494
|
-
steps:
|
|
11517
|
+
version: string;
|
|
11518
|
+
steps: IGoalStep[];
|
|
10495
11519
|
description: string;
|
|
10496
11520
|
referenceId: string;
|
|
10497
11521
|
projectReference: TMongoId;
|
|
10498
11522
|
organisationReference: TMongoId;
|
|
10499
11523
|
}
|
|
10500
|
-
export interface
|
|
11524
|
+
export interface IGoalStep {
|
|
10501
11525
|
_id?: string;
|
|
10502
11526
|
name?: string;
|
|
10503
11527
|
description?: string;
|
|
10504
11528
|
order?: number;
|
|
10505
11529
|
type?: "start" | "completion";
|
|
10506
|
-
metrics?:
|
|
11530
|
+
metrics?: IGoalStepMetric[];
|
|
10507
11531
|
}
|
|
10508
|
-
export interface
|
|
11532
|
+
export interface IGoalStepMetric {
|
|
10509
11533
|
_id?: string;
|
|
10510
11534
|
name: string;
|
|
10511
11535
|
description: string;
|
|
10512
|
-
type?: "currency" | "duration";
|
|
11536
|
+
type?: "currency" | "duration" | "revenue";
|
|
10513
11537
|
value?: number;
|
|
10514
11538
|
}
|
|
10515
|
-
export interface
|
|
10516
|
-
type: "
|
|
11539
|
+
export interface IGraphGoal {
|
|
11540
|
+
type: "goal";
|
|
10517
11541
|
_id: TMongoId;
|
|
10518
11542
|
referenceId: string;
|
|
10519
11543
|
name: string;
|
|
10520
|
-
properties: Pick<
|
|
11544
|
+
properties: Pick<IGoal, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10521
11545
|
}
|
|
10522
|
-
export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore |
|
|
11546
|
+
export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphAiAgent;
|
|
10523
11547
|
export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
|
|
10524
11548
|
export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
|
|
10525
11549
|
/**
|
|
@@ -13412,6 +14436,9 @@ export interface IComposeSnapshotDownloadLinkRestReturnValue_2_0 {
|
|
|
13412
14436
|
* type: string
|
|
13413
14437
|
* description: The name of the Connection
|
|
13414
14438
|
* example: azure
|
|
14439
|
+
* isDeprecated:
|
|
14440
|
+
* type: boolean
|
|
14441
|
+
* description: Marked 'true' if the connection type is deprecated
|
|
13415
14442
|
* connectionSchema:
|
|
13416
14443
|
* type: object
|
|
13417
14444
|
* properties:
|
|
@@ -13427,6 +14454,7 @@ export interface IConnectionIndexItem_2_0 {
|
|
|
13427
14454
|
_id: TMongoId;
|
|
13428
14455
|
referenceId: string;
|
|
13429
14456
|
name: string;
|
|
14457
|
+
isDeprecated: boolean;
|
|
13430
14458
|
extension: string;
|
|
13431
14459
|
type: string;
|
|
13432
14460
|
createdAt: number;
|
|
@@ -13460,6 +14488,9 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
|
|
|
13460
14488
|
* name:
|
|
13461
14489
|
* type: string
|
|
13462
14490
|
* example: "some name"
|
|
14491
|
+
* isDeprecated:
|
|
14492
|
+
* type: boolean
|
|
14493
|
+
* description: Marked 'true' if the connection type is deprecated
|
|
13463
14494
|
* type:
|
|
13464
14495
|
* type: string
|
|
13465
14496
|
* example: "http_basic"
|
|
@@ -13480,6 +14511,9 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
|
|
|
13480
14511
|
* type: string
|
|
13481
14512
|
* description: The name of the Connection
|
|
13482
14513
|
* example: Azure API
|
|
14514
|
+
* isDeprecated:
|
|
14515
|
+
* type: boolean
|
|
14516
|
+
* description: Marked 'true' if the connection type is deprecated
|
|
13483
14517
|
* connectionSchema:
|
|
13484
14518
|
* type: object
|
|
13485
14519
|
* description: Identifies the schema which should be used to validate the connection fields.
|
|
@@ -13503,378 +14537,91 @@ export interface IConnection_2_0 {
|
|
|
13503
14537
|
referenceId: string;
|
|
13504
14538
|
_id: TMongoId;
|
|
13505
14539
|
name: string;
|
|
14540
|
+
isDeprecated: boolean;
|
|
13506
14541
|
fields: IConnectionFields;
|
|
13507
|
-
extension: string;
|
|
13508
|
-
type: string;
|
|
13509
|
-
createdAt: number;
|
|
13510
|
-
lastChanged: number;
|
|
13511
|
-
createdBy: TMongoId;
|
|
13512
|
-
lastChangedBy: TMongoId;
|
|
13513
|
-
}
|
|
13514
|
-
export declare type IBatchConnectionsRestOperationSet = (IBatchActionOperation<"create", Omit<IConnection_2_0, keyof IEntityMeta>> | IBatchActionOperation<"update", Omit<IConnection_2_0, keyof IEntityMeta>> | IBatchActionOperation<"delete">)[];
|
|
13515
|
-
export interface IBatchConnectionsRestDataBody_2_0 {
|
|
13516
|
-
operations: IBatchConnectionsRestOperationSet;
|
|
13517
|
-
}
|
|
13518
|
-
export interface IBatchConnectionsRestDataQuery_2_0 extends IProjectScope {
|
|
13519
|
-
}
|
|
13520
|
-
export interface IBatchConnectionsRestData_2_0 extends IBatchConnectionsRestDataBody_2_0, IBatchConnectionsRestDataQuery_2_0 {
|
|
13521
|
-
}
|
|
13522
|
-
export interface IBatchConnectionsRestReturnValue_2_0 {
|
|
13523
|
-
}
|
|
13524
|
-
export interface ICreateConnectionRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnection_2_0, keyof IEntityMeta>> {
|
|
13525
|
-
}
|
|
13526
|
-
export interface ICreateConnectionRestData_2_0 extends ICreateConnectionRestDataBody_2_0 {
|
|
13527
|
-
}
|
|
13528
|
-
export interface ICreateConnectionRestReturnValue_2_0 extends IConnection_2_0 {
|
|
13529
|
-
}
|
|
13530
|
-
export interface IReadConnectionRestDataParams_2_0 {
|
|
13531
|
-
connectionId: string;
|
|
13532
|
-
}
|
|
13533
|
-
export interface IReadConnectionRestData_2_0 extends IReadConnectionRestDataParams_2_0 {
|
|
13534
|
-
}
|
|
13535
|
-
export interface IReadConnectionRestReturnValue_2_0 extends IConnection_2_0 {
|
|
13536
|
-
}
|
|
13537
|
-
export interface IUpdateConnectionRestDataBody_2_0 extends Partial<Pick<IConnection_2_0, "fields">> {
|
|
13538
|
-
}
|
|
13539
|
-
export interface IUpdateConnectionRestDataParams_2_0 {
|
|
13540
|
-
connectionId: string;
|
|
13541
|
-
}
|
|
13542
|
-
export interface IUpdateConnectionRestData_2_0 extends IUpdateConnectionRestDataBody_2_0, IUpdateConnectionRestDataParams_2_0 {
|
|
13543
|
-
}
|
|
13544
|
-
export interface IUpdateConnectionRestReturnValue_2_0 {
|
|
13545
|
-
}
|
|
13546
|
-
export interface IDeleteConnectionRestDataParams_2_0 {
|
|
13547
|
-
connectionId: string;
|
|
13548
|
-
}
|
|
13549
|
-
export interface IDeleteConnectionRestData_2_0 extends IDeleteConnectionRestDataParams_2_0 {
|
|
13550
|
-
}
|
|
13551
|
-
export interface IDeleteConnectionRestReturnValue_2_0 {
|
|
13552
|
-
}
|
|
13553
|
-
/**
|
|
13554
|
-
* @openapi
|
|
13555
|
-
*
|
|
13556
|
-
* components:
|
|
13557
|
-
* schemas:
|
|
13558
|
-
* IConnectionData_2_0:
|
|
13559
|
-
* type: object
|
|
13560
|
-
* properties:
|
|
13561
|
-
* key:
|
|
13562
|
-
* type: string
|
|
13563
|
-
* description: The key of the connection field. The key should match the connection schema of the specific connection type.
|
|
13564
|
-
* example: some-key-from-connection-schema
|
|
13565
|
-
* value:
|
|
13566
|
-
* type: string
|
|
13567
|
-
* description: The value of the connection field
|
|
13568
|
-
* example: x123w123
|
|
13569
|
-
*/
|
|
13570
|
-
export interface IConnectionField_2_0 {
|
|
13571
|
-
key: string;
|
|
13572
|
-
value: string;
|
|
13573
|
-
}
|
|
13574
|
-
export interface ICreateConnectionFieldRestDataParams_2_0 {
|
|
13575
|
-
connectionId: string;
|
|
13576
|
-
}
|
|
13577
|
-
export interface ICreateConnectionFieldRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnectionField_2_0, keyof IEntityMeta>> {
|
|
13578
|
-
}
|
|
13579
|
-
export interface ICreateConnectionFieldRestData_2_0 extends ICreateConnectionFieldRestDataParams_2_0, ICreateConnectionFieldRestDataBody_2_0 {
|
|
13580
|
-
}
|
|
13581
|
-
export interface ICreateConnectionFieldRestReturnValue_2_0 {
|
|
13582
|
-
}
|
|
13583
|
-
export interface IDeleteConnectionFieldRestDataParams_2_0 {
|
|
13584
|
-
connectionId: string;
|
|
13585
|
-
fieldName: string;
|
|
13586
|
-
}
|
|
13587
|
-
export interface IDeleteConnectionFieldRestData_2_0 extends IDeleteConnectionFieldRestDataParams_2_0 {
|
|
13588
|
-
}
|
|
13589
|
-
export interface IDeleteConnectionFieldRestReturnValue_2_0 {
|
|
13590
|
-
}
|
|
13591
|
-
declare const journeyStepGoals: readonly [
|
|
13592
|
-
"createAgent",
|
|
13593
|
-
"createFlow",
|
|
13594
|
-
"createEndpoint",
|
|
13595
|
-
"createLexicon",
|
|
13596
|
-
"createSnapshot",
|
|
13597
|
-
"createKnowledgeStore",
|
|
13598
|
-
"createKnowledgeSource",
|
|
13599
|
-
"openWebchat",
|
|
13600
|
-
"createCodeNode",
|
|
13601
|
-
"createHttpRequestNode",
|
|
13602
|
-
"createIfNode",
|
|
13603
|
-
"createQuestionNode",
|
|
13604
|
-
"createSayNode",
|
|
13605
|
-
"createLookupNode",
|
|
13606
|
-
"createKnowledgeSearchNode",
|
|
13607
|
-
"createSearchExtractOutputNode",
|
|
13608
|
-
"createGptConversationNode",
|
|
13609
|
-
"createLlmPromptNode",
|
|
13610
|
-
"updateCaseNode",
|
|
13611
|
-
"updateHttpRequestNode",
|
|
13612
|
-
"updateIfNode",
|
|
13613
|
-
"updateQuestionNode",
|
|
13614
|
-
"updateSayNode",
|
|
13615
|
-
"createIntent",
|
|
13616
|
-
"trainIntents",
|
|
13617
|
-
"activateLexicon",
|
|
13618
|
-
"useToken",
|
|
13619
|
-
"addKeyphrase",
|
|
13620
|
-
"expertModeOn",
|
|
13621
|
-
"openContextTab",
|
|
13622
|
-
"openInfoTab",
|
|
13623
|
-
"openIP",
|
|
13624
|
-
"sendMessage",
|
|
13625
|
-
"prepareSnapshotDownload",
|
|
13626
|
-
"restoreSnapshot"
|
|
13627
|
-
];
|
|
13628
|
-
export declare type TJourneyStepGoals = typeof journeyStepGoals[number];
|
|
13629
|
-
/**
|
|
13630
|
-
* @openapi
|
|
13631
|
-
*
|
|
13632
|
-
* components:
|
|
13633
|
-
* schemas:
|
|
13634
|
-
* IJourneyStep_2_0:
|
|
13635
|
-
* allOf:
|
|
13636
|
-
* - type: object
|
|
13637
|
-
* properties:
|
|
13638
|
-
* referenceId:
|
|
13639
|
-
* type: string
|
|
13640
|
-
* name:
|
|
13641
|
-
* type: string
|
|
13642
|
-
* description: The name of this journey step, e.g. 'Create a Virtual Agent'
|
|
13643
|
-
* link:
|
|
13644
|
-
* type: string
|
|
13645
|
-
* description: A hyperlink to our helpdesk for this journey step.
|
|
13646
|
-
* summary:
|
|
13647
|
-
* type: string
|
|
13648
|
-
* description: A quick summary what this journey step is about.
|
|
13649
|
-
* description:
|
|
13650
|
-
* type: string
|
|
13651
|
-
* description: The full-blown description for this journey step containing rich media.
|
|
13652
|
-
* goals:
|
|
13653
|
-
* type: array
|
|
13654
|
-
* items:
|
|
13655
|
-
* type: string
|
|
13656
|
-
* description: Internal name of the goal.
|
|
13657
|
-
*/
|
|
13658
|
-
export interface IJourneyStep_2_0 {
|
|
13659
|
-
/** The reference id of the journey step */
|
|
13660
|
-
referenceId: string;
|
|
13661
|
-
/** The name of this journey step */
|
|
13662
|
-
name: string;
|
|
13663
|
-
/** Hyperlink to our helpdesk */
|
|
13664
|
-
link: string;
|
|
13665
|
-
/** Summary of this journey step */
|
|
13666
|
-
summary: string;
|
|
13667
|
-
/** Full description */
|
|
13668
|
-
description: string;
|
|
13669
|
-
/** The goals which need to be completed in order to complete this step */
|
|
13670
|
-
goals: TJourneyStepGoals[];
|
|
13671
|
-
}
|
|
13672
|
-
/**
|
|
13673
|
-
* @openapi
|
|
13674
|
-
*
|
|
13675
|
-
* components:
|
|
13676
|
-
* schemas:
|
|
13677
|
-
* IJourney_2_0:
|
|
13678
|
-
* allOf:
|
|
13679
|
-
* - type: object
|
|
13680
|
-
* properties:
|
|
13681
|
-
* name:
|
|
13682
|
-
* type: string
|
|
13683
|
-
* description: The name of the journey.
|
|
13684
|
-
* link:
|
|
13685
|
-
* type: string
|
|
13686
|
-
* description: A hyperlink to the help-center for this journey.
|
|
13687
|
-
* summary:
|
|
13688
|
-
* type: string
|
|
13689
|
-
* description: A quick summary for what the journey is about.
|
|
13690
|
-
* steps:
|
|
13691
|
-
* $ref: '#/components/schemas/IJourneyStep_2_0'
|
|
13692
|
-
* - $ref: '#/components/schemas/IEntityMeta'
|
|
13693
|
-
*/
|
|
13694
|
-
export interface IJourney_2_0 {
|
|
13695
|
-
/** The object id of the journey */
|
|
13696
|
-
_id: TMongoId;
|
|
13697
|
-
/** The reference id of the journey */
|
|
13698
|
-
referenceId: string;
|
|
13699
|
-
/** The name of the journey */
|
|
13700
|
-
name: string;
|
|
13701
|
-
/** The hyperlink to the helpdesk for this journey */
|
|
13702
|
-
link: string;
|
|
13703
|
-
/** Summary of the journey */
|
|
13704
|
-
summary: string;
|
|
13705
|
-
/** The list of journey steps in this journey */
|
|
13706
|
-
steps: IJourneyStep_2_0[];
|
|
13707
|
-
createdAt: number;
|
|
13708
|
-
lastChanged: number;
|
|
13709
|
-
createdBy: TMongoId;
|
|
13710
|
-
lastChangedBy: TMongoId;
|
|
13711
|
-
}
|
|
13712
|
-
/**
|
|
13713
|
-
* @openapi
|
|
13714
|
-
*
|
|
13715
|
-
* components:
|
|
13716
|
-
* schemas:
|
|
13717
|
-
* IJourneyIndexItem_2_0:
|
|
13718
|
-
* allOf:
|
|
13719
|
-
* - type: object
|
|
13720
|
-
* properties:
|
|
13721
|
-
* referenceId:
|
|
13722
|
-
* type: string
|
|
13723
|
-
* name:
|
|
13724
|
-
* type: string
|
|
13725
|
-
* description: The name of the journey.
|
|
13726
|
-
* link:
|
|
13727
|
-
* type: string
|
|
13728
|
-
* description: A hyperlink to the help-center for this journey.
|
|
13729
|
-
* summary:
|
|
13730
|
-
* type: string
|
|
13731
|
-
* description: A quick summary for what the journey is about.
|
|
13732
|
-
* - $ref: '#/components/schemas/IEntityMeta'
|
|
13733
|
-
*/
|
|
13734
|
-
export interface IJourneyIndexItem_2_0 {
|
|
13735
|
-
/** The object id of the journey */
|
|
13736
|
-
_id: TMongoId;
|
|
13737
|
-
/** The reference id of the journey */
|
|
13738
|
-
referenceId: string;
|
|
13739
|
-
/** The name of the journey */
|
|
13740
|
-
name: string;
|
|
13741
|
-
/** The hyperlink to the helpdesk for this journey */
|
|
13742
|
-
link: string;
|
|
13743
|
-
/** Summary of the journey */
|
|
13744
|
-
summary: string;
|
|
13745
|
-
/** Unix-timestamp when the entity was created initially */
|
|
14542
|
+
extension: string;
|
|
14543
|
+
type: string;
|
|
13746
14544
|
createdAt: number;
|
|
13747
|
-
/** Unix-timestamp when the entity was changed last time */
|
|
13748
14545
|
lastChanged: number;
|
|
13749
|
-
/** Id of the user who created the entity initially */
|
|
13750
14546
|
createdBy: TMongoId;
|
|
13751
|
-
/** Id of the user who did the last modification */
|
|
13752
14547
|
lastChangedBy: TMongoId;
|
|
13753
14548
|
}
|
|
13754
|
-
|
|
13755
|
-
|
|
13756
|
-
|
|
13757
|
-
* components:
|
|
13758
|
-
* schemas:
|
|
13759
|
-
* IJourneyProgress_2_0:
|
|
13760
|
-
* allOf:
|
|
13761
|
-
* - type: object
|
|
13762
|
-
* properties:
|
|
13763
|
-
* userReference:
|
|
13764
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
13765
|
-
* organisationReference:
|
|
13766
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
13767
|
-
* isCurrent:
|
|
13768
|
-
* type: boolean
|
|
13769
|
-
* description: Information whether this progress object keeps track of the currently selected journey.
|
|
13770
|
-
* isComplete:
|
|
13771
|
-
* type: boolean
|
|
13772
|
-
* description: Information whether the currently selected journey is complete.
|
|
13773
|
-
* journeyReferenceId:
|
|
13774
|
-
* type: string
|
|
13775
|
-
* journeySteps:
|
|
13776
|
-
* $ref: '#/components/schemas/IJourneyStepProgress_2_0'
|
|
13777
|
-
*/
|
|
13778
|
-
export interface IJourneyProgress_2_0 {
|
|
13779
|
-
/** The user who owns this journey progress object */
|
|
13780
|
-
userReference: TMongoId;
|
|
13781
|
-
/** The organisation id the user belongs to who owns the progress object */
|
|
13782
|
-
organisationReference: TMongoId;
|
|
13783
|
-
/** Whether this is the current journey */
|
|
13784
|
-
isCurrent: boolean;
|
|
13785
|
-
/** Whether this journey was completed already */
|
|
13786
|
-
isComplete: boolean;
|
|
13787
|
-
/** A reference to the journey this progress object is for */
|
|
13788
|
-
journeyReferenceId: TMongoId;
|
|
13789
|
-
/** Stores information about the steps and their progress */
|
|
13790
|
-
journeySteps: IJourneyStepProgress_2_0[];
|
|
14549
|
+
export declare type IBatchConnectionsRestOperationSet = (IBatchActionOperation<"create", Omit<IConnection_2_0, keyof IEntityMeta>> | IBatchActionOperation<"update", Omit<IConnection_2_0, keyof IEntityMeta>> | IBatchActionOperation<"delete">)[];
|
|
14550
|
+
export interface IBatchConnectionsRestDataBody_2_0 {
|
|
14551
|
+
operations: IBatchConnectionsRestOperationSet;
|
|
13791
14552
|
}
|
|
13792
|
-
|
|
13793
|
-
* @openapi
|
|
13794
|
-
*
|
|
13795
|
-
* components:
|
|
13796
|
-
* schemas:
|
|
13797
|
-
* IJourneyStepProgress_2_0:
|
|
13798
|
-
* allOf:
|
|
13799
|
-
* - type: object
|
|
13800
|
-
* properties:
|
|
13801
|
-
* journeyStepReferenceId:
|
|
13802
|
-
* type: string
|
|
13803
|
-
* isComplete:
|
|
13804
|
-
* type: boolean
|
|
13805
|
-
* completedGoals:
|
|
13806
|
-
* type: array
|
|
13807
|
-
* items:
|
|
13808
|
-
* type: string
|
|
13809
|
-
*/
|
|
13810
|
-
export interface IJourneyStepProgress_2_0 {
|
|
13811
|
-
/** The id of this journey progress step */
|
|
13812
|
-
journeyStepReferenceId: TMongoId;
|
|
13813
|
-
/** Whether this step is complete */
|
|
13814
|
-
isComplete: boolean;
|
|
13815
|
-
/** The already completed goals */
|
|
13816
|
-
completedGoals: string[];
|
|
14553
|
+
export interface IBatchConnectionsRestDataQuery_2_0 extends IProjectScope {
|
|
13817
14554
|
}
|
|
13818
|
-
export interface
|
|
14555
|
+
export interface IBatchConnectionsRestData_2_0 extends IBatchConnectionsRestDataBody_2_0, IBatchConnectionsRestDataQuery_2_0 {
|
|
13819
14556
|
}
|
|
13820
|
-
export interface
|
|
14557
|
+
export interface IBatchConnectionsRestReturnValue_2_0 {
|
|
13821
14558
|
}
|
|
13822
|
-
export interface
|
|
13823
|
-
journeyReferenceId: string;
|
|
14559
|
+
export interface ICreateConnectionRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnection_2_0, keyof IEntityMeta>> {
|
|
13824
14560
|
}
|
|
13825
|
-
export interface
|
|
14561
|
+
export interface ICreateConnectionRestData_2_0 extends ICreateConnectionRestDataBody_2_0 {
|
|
13826
14562
|
}
|
|
13827
|
-
export interface
|
|
14563
|
+
export interface ICreateConnectionRestReturnValue_2_0 extends IConnection_2_0 {
|
|
13828
14564
|
}
|
|
13829
|
-
export interface
|
|
14565
|
+
export interface IReadConnectionRestDataParams_2_0 {
|
|
14566
|
+
connectionId: string;
|
|
13830
14567
|
}
|
|
13831
|
-
export interface
|
|
14568
|
+
export interface IReadConnectionRestData_2_0 extends IReadConnectionRestDataParams_2_0 {
|
|
13832
14569
|
}
|
|
13833
|
-
|
|
13834
|
-
|
|
13835
|
-
|
|
13836
|
-
|
|
13837
|
-
|
|
13838
|
-
|
|
13839
|
-
|
|
13840
|
-
|
|
13841
|
-
|
|
13842
|
-
|
|
13843
|
-
* type: string
|
|
13844
|
-
* description: The name of the event to track.
|
|
13845
|
-
* example: createFlow
|
|
13846
|
-
* payload:
|
|
13847
|
-
* type: object
|
|
13848
|
-
*/
|
|
13849
|
-
export interface IJourneyTrackEventBase_2_0 {
|
|
13850
|
-
event: string;
|
|
13851
|
-
payload: {
|
|
13852
|
-
[key: string]: any;
|
|
13853
|
-
};
|
|
14570
|
+
export interface IReadConnectionRestReturnValue_2_0 extends IConnection_2_0 {
|
|
14571
|
+
}
|
|
14572
|
+
export interface IUpdateConnectionRestDataBody_2_0 extends Partial<Pick<IConnection_2_0, "fields">> {
|
|
14573
|
+
}
|
|
14574
|
+
export interface IUpdateConnectionRestDataParams_2_0 {
|
|
14575
|
+
connectionId: string;
|
|
14576
|
+
}
|
|
14577
|
+
export interface IUpdateConnectionRestData_2_0 extends IUpdateConnectionRestDataBody_2_0, IUpdateConnectionRestDataParams_2_0 {
|
|
14578
|
+
}
|
|
14579
|
+
export interface IUpdateConnectionRestReturnValue_2_0 {
|
|
13854
14580
|
}
|
|
13855
|
-
export interface
|
|
14581
|
+
export interface IDeleteConnectionRestDataParams_2_0 {
|
|
14582
|
+
connectionId: string;
|
|
13856
14583
|
}
|
|
13857
|
-
export interface
|
|
14584
|
+
export interface IDeleteConnectionRestData_2_0 extends IDeleteConnectionRestDataParams_2_0 {
|
|
13858
14585
|
}
|
|
13859
|
-
export interface
|
|
14586
|
+
export interface IDeleteConnectionRestReturnValue_2_0 {
|
|
13860
14587
|
}
|
|
13861
14588
|
/**
|
|
13862
14589
|
* @openapi
|
|
13863
14590
|
*
|
|
13864
14591
|
* components:
|
|
13865
14592
|
* schemas:
|
|
13866
|
-
*
|
|
14593
|
+
* IConnectionData_2_0:
|
|
13867
14594
|
* type: object
|
|
13868
14595
|
* properties:
|
|
13869
|
-
*
|
|
14596
|
+
* key:
|
|
14597
|
+
* type: string
|
|
14598
|
+
* description: The key of the connection field. The key should match the connection schema of the specific connection type.
|
|
14599
|
+
* example: some-key-from-connection-schema
|
|
14600
|
+
* value:
|
|
13870
14601
|
* type: string
|
|
14602
|
+
* description: The value of the connection field
|
|
14603
|
+
* example: x123w123
|
|
13871
14604
|
*/
|
|
13872
|
-
export interface
|
|
13873
|
-
|
|
14605
|
+
export interface IConnectionField_2_0 {
|
|
14606
|
+
key: string;
|
|
14607
|
+
value: string;
|
|
14608
|
+
}
|
|
14609
|
+
export interface ICreateConnectionFieldRestDataParams_2_0 {
|
|
14610
|
+
connectionId: string;
|
|
14611
|
+
}
|
|
14612
|
+
export interface ICreateConnectionFieldRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnectionField_2_0, keyof IEntityMeta>> {
|
|
14613
|
+
}
|
|
14614
|
+
export interface ICreateConnectionFieldRestData_2_0 extends ICreateConnectionFieldRestDataParams_2_0, ICreateConnectionFieldRestDataBody_2_0 {
|
|
14615
|
+
}
|
|
14616
|
+
export interface ICreateConnectionFieldRestReturnValue_2_0 {
|
|
13874
14617
|
}
|
|
13875
|
-
export interface
|
|
14618
|
+
export interface IDeleteConnectionFieldRestDataParams_2_0 {
|
|
14619
|
+
connectionId: string;
|
|
14620
|
+
fieldName: string;
|
|
14621
|
+
}
|
|
14622
|
+
export interface IDeleteConnectionFieldRestData_2_0 extends IDeleteConnectionFieldRestDataParams_2_0 {
|
|
13876
14623
|
}
|
|
13877
|
-
export interface
|
|
14624
|
+
export interface IDeleteConnectionFieldRestReturnValue_2_0 {
|
|
13878
14625
|
}
|
|
13879
14626
|
declare const slotFillerTypesGeneric: readonly [
|
|
13880
14627
|
"age",
|
|
@@ -14654,6 +15401,13 @@ export interface ILogNodeParams extends INodeFunctionBaseParams {
|
|
|
14654
15401
|
message: string;
|
|
14655
15402
|
};
|
|
14656
15403
|
}
|
|
15404
|
+
export interface IDebugMessageNodeParams extends INodeFunctionBaseParams {
|
|
15405
|
+
config: {
|
|
15406
|
+
level: "info" | "error";
|
|
15407
|
+
message: string;
|
|
15408
|
+
header: string;
|
|
15409
|
+
};
|
|
15410
|
+
}
|
|
14657
15411
|
export interface IDatePickerConfig {
|
|
14658
15412
|
datepicker_eventName: string;
|
|
14659
15413
|
datepicker_locale: string;
|
|
@@ -14686,70 +15440,6 @@ export interface IDatePickerNodeParams extends INodeFunctionBaseParams {
|
|
|
14686
15440
|
config: IDatePickerConfig;
|
|
14687
15441
|
}
|
|
14688
15442
|
export declare type ISayNodeParams = ISayParams;
|
|
14689
|
-
export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
|
|
14690
|
-
config: {
|
|
14691
|
-
lexiconId: string;
|
|
14692
|
-
keyphrase: string;
|
|
14693
|
-
slots: string[];
|
|
14694
|
-
synonyms: string[];
|
|
14695
|
-
};
|
|
14696
|
-
}
|
|
14697
|
-
export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
|
|
14698
|
-
config: {
|
|
14699
|
-
text: string;
|
|
14700
|
-
data: any;
|
|
14701
|
-
mode: string;
|
|
14702
|
-
contextKey: string;
|
|
14703
|
-
inputKey: string;
|
|
14704
|
-
parseIntents: boolean;
|
|
14705
|
-
parseSlots: boolean;
|
|
14706
|
-
parseSystemSlots: boolean;
|
|
14707
|
-
findType: boolean;
|
|
14708
|
-
processDefaultReply: boolean;
|
|
14709
|
-
};
|
|
14710
|
-
}
|
|
14711
|
-
export interface IMatchPatternParams extends INodeFunctionBaseParams {
|
|
14712
|
-
config: {
|
|
14713
|
-
patterns: string[];
|
|
14714
|
-
patternGroupName: string;
|
|
14715
|
-
alternateInput: string;
|
|
14716
|
-
detailedCompoundSlots: boolean;
|
|
14717
|
-
createNewSlots: boolean;
|
|
14718
|
-
tagExistingSlots: boolean;
|
|
14719
|
-
useFullSystemslotText: boolean;
|
|
14720
|
-
};
|
|
14721
|
-
}
|
|
14722
|
-
export interface IFuzzySearchParams extends INodeFunctionBaseParams {
|
|
14723
|
-
config: {
|
|
14724
|
-
searchPattern: string;
|
|
14725
|
-
items: any;
|
|
14726
|
-
isCaseSensitive: boolean;
|
|
14727
|
-
includeScore: boolean;
|
|
14728
|
-
includeMatches: boolean;
|
|
14729
|
-
minMatchCharLength: number;
|
|
14730
|
-
shouldSort: boolean;
|
|
14731
|
-
findAllMatches: boolean;
|
|
14732
|
-
location: number;
|
|
14733
|
-
threshold: number;
|
|
14734
|
-
distance: number;
|
|
14735
|
-
ignoreLocation: boolean;
|
|
14736
|
-
storeLocation: string;
|
|
14737
|
-
inputKey: string;
|
|
14738
|
-
contextKey: string;
|
|
14739
|
-
};
|
|
14740
|
-
}
|
|
14741
|
-
export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
14742
|
-
config: {
|
|
14743
|
-
slotsConfig: IGenerativeSlot[];
|
|
14744
|
-
amountOfLastUserInputs: number;
|
|
14745
|
-
maxQuestions: number;
|
|
14746
|
-
temperature: number;
|
|
14747
|
-
storeLocation: string;
|
|
14748
|
-
contextKey: string;
|
|
14749
|
-
inputKey: string;
|
|
14750
|
-
timeout: number;
|
|
14751
|
-
};
|
|
14752
|
-
}
|
|
14753
15443
|
export interface IContinuousASRParams extends INodeFunctionBaseParams {
|
|
14754
15444
|
config: {
|
|
14755
15445
|
asrEnabled: boolean;
|
|
@@ -14810,15 +15500,17 @@ export interface IVoiceConfigParams {
|
|
|
14810
15500
|
googleModel: TVoiceGateway2GoogleModel;
|
|
14811
15501
|
userNoInputMode: TVoiceGateway2UserNoInputMode;
|
|
14812
15502
|
userNoInputTimeout: number;
|
|
15503
|
+
userNoInputTimeoutEnable: boolean;
|
|
14813
15504
|
userNoInputRetries: number;
|
|
14814
15505
|
userNoInputSpeech: string;
|
|
14815
15506
|
userNoInputUrl: string;
|
|
14816
|
-
|
|
14817
|
-
|
|
14818
|
-
|
|
14819
|
-
|
|
14820
|
-
|
|
14821
|
-
|
|
15507
|
+
flowNoInputTimeoutEnable: boolean;
|
|
15508
|
+
flowNoInputTimeout: number;
|
|
15509
|
+
flowNoInputMode: TVoiceGateway2FlowNoInputMode;
|
|
15510
|
+
flowNoInputRetries: number;
|
|
15511
|
+
flowNoInputSpeech: string;
|
|
15512
|
+
flowNoInputUrl: string;
|
|
15513
|
+
flowNoInputFail: boolean;
|
|
14822
15514
|
dtmfEnable: boolean;
|
|
14823
15515
|
dtmfInterDigitTimeout: number;
|
|
14824
15516
|
dtmfMaxDigits: number;
|
|
@@ -14842,6 +15534,13 @@ export interface IVoiceConfigParams {
|
|
|
14842
15534
|
deepgramEndpointing: boolean;
|
|
14843
15535
|
deepgramEndpointingValue: number;
|
|
14844
15536
|
deepgramSmartFormatting: boolean;
|
|
15537
|
+
atmosphereAction: TVoiceGateway2DubActionType;
|
|
15538
|
+
atmosphereUrl: string;
|
|
15539
|
+
atmosphereLoop: boolean;
|
|
15540
|
+
atmosphereVolume: number;
|
|
15541
|
+
silenceOverlayAction: boolean | string;
|
|
15542
|
+
silenceOverlayURL: string;
|
|
15543
|
+
silenceOverlayDelay: number;
|
|
14845
15544
|
}
|
|
14846
15545
|
export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
|
|
14847
15546
|
config: IVoiceConfigParams;
|
|
@@ -14942,6 +15641,11 @@ export interface IUpdateProfileNodeParams extends INodeFunctionBaseParams {
|
|
|
14942
15641
|
value: string;
|
|
14943
15642
|
};
|
|
14944
15643
|
}
|
|
15644
|
+
export interface IAddMemoryNodeParams extends INodeFunctionBaseParams {
|
|
15645
|
+
config: {
|
|
15646
|
+
memory: string;
|
|
15647
|
+
};
|
|
15648
|
+
}
|
|
14945
15649
|
export interface IBlindModeNodeParams extends INodeFunctionBaseParams {
|
|
14946
15650
|
config: {
|
|
14947
15651
|
maskLogging: boolean;
|
|
@@ -14991,6 +15695,20 @@ export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
|
|
|
14991
15695
|
ratingChatStatusMessage: string;
|
|
14992
15696
|
};
|
|
14993
15697
|
}
|
|
15698
|
+
export interface ITrackGoalNodeParams extends INodeFunctionBaseParams {
|
|
15699
|
+
config: {
|
|
15700
|
+
goal: {
|
|
15701
|
+
goalId: string;
|
|
15702
|
+
name: string;
|
|
15703
|
+
version: string;
|
|
15704
|
+
selectedSteps: {
|
|
15705
|
+
stepId: string;
|
|
15706
|
+
name: string;
|
|
15707
|
+
type: string;
|
|
15708
|
+
}[];
|
|
15709
|
+
};
|
|
15710
|
+
};
|
|
15711
|
+
}
|
|
14994
15712
|
export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
|
|
14995
15713
|
appInterimScreenOverride?: string;
|
|
14996
15714
|
appConnectScreenOverride?: string;
|
|
@@ -15142,6 +15860,12 @@ export interface ISetSessionParamsParams extends INodeFunctionBaseParams {
|
|
|
15142
15860
|
sttContextId: string;
|
|
15143
15861
|
sttContextPhrases: string[];
|
|
15144
15862
|
sttContextBoost: number;
|
|
15863
|
+
sttSpeechContexts: [
|
|
15864
|
+
{
|
|
15865
|
+
phrases: string[];
|
|
15866
|
+
boost: number;
|
|
15867
|
+
}
|
|
15868
|
+
];
|
|
15145
15869
|
sttDisablePunctuation: boolean;
|
|
15146
15870
|
azureEnableAudioLogging: boolean;
|
|
15147
15871
|
voiceName: string;
|
|
@@ -15279,6 +16003,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
|
15279
16003
|
transferReason: string;
|
|
15280
16004
|
transferTarget: string;
|
|
15281
16005
|
referredBy: string;
|
|
16006
|
+
anchorMedia: boolean;
|
|
15282
16007
|
useTransferSipHeaders: boolean;
|
|
15283
16008
|
transferSipHeaders: {
|
|
15284
16009
|
[key: string]: string | object;
|
|
@@ -15349,6 +16074,7 @@ export interface ISearchExtractOutputNodeParams extends INodeFunctionBaseParams
|
|
|
15349
16074
|
searchStoreLocationContextKey: string;
|
|
15350
16075
|
searchStoreLocationInputKey: string;
|
|
15351
16076
|
searchSourceTags: string[];
|
|
16077
|
+
searchSourceTagsFilterOp: ISearchTagsFilterOps;
|
|
15352
16078
|
knowledgeStoreId?: string;
|
|
15353
16079
|
prompt: string;
|
|
15354
16080
|
temperature: number;
|
|
@@ -15387,6 +16113,7 @@ export interface ICognigyBasicNodes {
|
|
|
15387
16113
|
resetContext: ICreateChartNodeBasicNodesData<"resetContext", IResetContextNodeParams, TBASIC_EXTENSION>;
|
|
15388
16114
|
code: ICreateChartNodeBasicNodesData<"code", ICodeNodeBasicParams, TBASIC_EXTENSION>;
|
|
15389
16115
|
log: ICreateChartNodeBasicNodesData<"log", ILogNodeParams, TBASIC_EXTENSION>;
|
|
16116
|
+
debugMessage: ICreateChartNodeBasicNodesData<"debugMessage", IDebugMessageNodeParams, TBASIC_EXTENSION>;
|
|
15390
16117
|
activateProfile: ICreateChartNodeBasicNodesData<"activateProfile", IActivateProfileNodeParams, TBASIC_EXTENSION>;
|
|
15391
16118
|
blindMode: ICreateChartNodeBasicNodesData<"blindMode", IBlindModeNodeParams, TBASIC_EXTENSION>;
|
|
15392
16119
|
completeGoal: ICreateChartNodeBasicNodesData<"completeGoal", ICompleteGoalNodeParams, TBASIC_EXTENSION>;
|
|
@@ -15394,9 +16121,11 @@ export interface ICognigyBasicNodes {
|
|
|
15394
16121
|
deleteProfile: ICreateChartNodeBasicNodesData<"deleteProfile", IDeleteProfileNodeParams, TBASIC_EXTENSION>;
|
|
15395
16122
|
mergeProfile: ICreateChartNodeBasicNodesData<"mergeProfile", IMergeProfileNodeParams, TBASIC_EXTENSION>;
|
|
15396
16123
|
updateProfile: ICreateChartNodeBasicNodesData<"updateProfile", IUpdateProfileNodeParams, TBASIC_EXTENSION>;
|
|
16124
|
+
addMemory: ICreateChartNodeBasicNodesData<"addMemory", IAddMemoryNodeParams, TBASIC_EXTENSION>;
|
|
15397
16125
|
overwriteAnalytics: ICreateChartNodeBasicNodesData<"overwriteAnalytics", IOverwriteAnalyticsParams, TBASIC_EXTENSION>;
|
|
15398
16126
|
setRating: ICreateChartNodeBasicNodesData<"setRating", ISetRatingParams, TBASIC_EXTENSION>;
|
|
15399
16127
|
requestRating: ICreateChartNodeBasicNodesData<"requestRating", IRequestRatingNodeParams, TBASIC_EXTENSION>;
|
|
16128
|
+
trackGoal: ICreateChartNodeBasicNodesData<"trackGoal", ITrackGoalNodeParams, TBASIC_EXTENSION>;
|
|
15400
16129
|
executeFlow: ICreateChartNodeBasicNodesData<"executeFlow", IExecuteFlowNodeParams, TBASIC_EXTENSION>;
|
|
15401
16130
|
goTo: ICreateChartNodeBasicNodesData<"goTo", IGoToNodeParams, TBASIC_EXTENSION>;
|
|
15402
16131
|
if: ICreateChartNodeBasicNodesData<"if", IIfNodeParams, TBASIC_EXTENSION>;
|
|
@@ -15778,63 +16507,16 @@ export interface IIndexAgentAssistConfigsRestData_2_0 extends IRestPagination<IA
|
|
|
15778
16507
|
}
|
|
15779
16508
|
export interface IIndexAgentAssistConfigsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAgentAssistConfig_2_0> {
|
|
15780
16509
|
}
|
|
15781
|
-
/**
|
|
15782
|
-
* @openapi
|
|
15783
|
-
*
|
|
15784
|
-
* components:
|
|
15785
|
-
* schemas:
|
|
15786
|
-
* ILargeLanguageModelIndexItem_2_0:
|
|
15787
|
-
* allOf:
|
|
15788
|
-
* - type: object
|
|
15789
|
-
* properties:
|
|
15790
|
-
* referenceId:
|
|
15791
|
-
* type: string
|
|
15792
|
-
* description: The reference id of the LargeLanguageModel
|
|
15793
|
-
* format: uuid
|
|
15794
|
-
* name:
|
|
15795
|
-
* type: string
|
|
15796
|
-
* example: "LLM Name"
|
|
15797
|
-
* description:
|
|
15798
|
-
* type: string
|
|
15799
|
-
* example: "LLM Name"
|
|
15800
|
-
* modeltype:
|
|
15801
|
-
* $ref: '#/components/schemas/TGenerativeAIModels'
|
|
15802
|
-
* provider:
|
|
15803
|
-
* $ref: '#/components/schemas/TGenerativeAIProviders'
|
|
15804
|
-
* connectionId:
|
|
15805
|
-
* type: string
|
|
15806
|
-
* description: The reference id of the GenerativeAI Provider Connection
|
|
15807
|
-
* format: uuid
|
|
15808
|
-
* isDefault:
|
|
15809
|
-
* type: boolean
|
|
15810
|
-
* description: Sets the LLM to default (fallback) if no other LLM is set
|
|
15811
|
-
* example: false
|
|
15812
|
-
* - $ref: '#/components/schemas/IEntityMeta'
|
|
15813
|
-
*/
|
|
15814
|
-
export interface ILargeLanguageModelIndexItem_2_0 {
|
|
15815
|
-
referenceId: string;
|
|
15816
|
-
_id: TMongoId;
|
|
15817
|
-
name: string;
|
|
15818
|
-
description: string;
|
|
15819
|
-
modelType: TGenerativeAIModels;
|
|
15820
|
-
provider: TGenerativeAIProviders;
|
|
15821
|
-
connectionId: string;
|
|
15822
|
-
isDefault: boolean;
|
|
15823
|
-
createdAt: number;
|
|
15824
|
-
lastChanged: number;
|
|
15825
|
-
createdBy: TMongoId;
|
|
15826
|
-
lastChangedBy: TMongoId;
|
|
15827
|
-
}
|
|
15828
|
-
export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
|
|
15829
|
-
}
|
|
15830
|
-
export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
|
|
15831
|
-
}
|
|
15832
16510
|
export interface IOpenAIMeta_2_0 {
|
|
15833
16511
|
customModel?: string;
|
|
15834
16512
|
}
|
|
15835
16513
|
export interface IAnthropicMeta_2_0 {
|
|
15836
16514
|
customModel?: string;
|
|
15837
16515
|
}
|
|
16516
|
+
export interface IAwsBedrockMeta_2_0 {
|
|
16517
|
+
region: string;
|
|
16518
|
+
customModel?: string;
|
|
16519
|
+
}
|
|
15838
16520
|
export interface IAlephAlphaMeta_2_0 {
|
|
15839
16521
|
customModel?: string;
|
|
15840
16522
|
baseCustomUrl?: string;
|
|
@@ -15845,10 +16527,60 @@ export interface IAzureOpenAIMeta_2_0 {
|
|
|
15845
16527
|
baseCustomUrl?: string | null;
|
|
15846
16528
|
apiVersion?: string;
|
|
15847
16529
|
}
|
|
15848
|
-
export interface IGoogleVertexAIMeta_2_0 {
|
|
16530
|
+
export interface IGoogleVertexAIMeta_2_0 {
|
|
16531
|
+
location: string;
|
|
16532
|
+
apiEndPoint: string;
|
|
16533
|
+
publisher?: string;
|
|
16534
|
+
}
|
|
16535
|
+
/**
|
|
16536
|
+
* @openapi
|
|
16537
|
+
*
|
|
16538
|
+
* components:
|
|
16539
|
+
* schemas:
|
|
16540
|
+
* ILLMFallback_2_0:
|
|
16541
|
+
* type: object
|
|
16542
|
+
* properties:
|
|
16543
|
+
* isFallbackEnabled:
|
|
16544
|
+
* type: boolean
|
|
16545
|
+
* description: A flag that indicates whether the fallback configuration should be considered at all
|
|
16546
|
+
* fallbackLLMReferenceId:
|
|
16547
|
+
* type: string
|
|
16548
|
+
* description: The reference id of an existing largeLanguageModel
|
|
16549
|
+
* immediateFallBack:
|
|
16550
|
+
* type: object
|
|
16551
|
+
* properties:
|
|
16552
|
+
* failedRequests:
|
|
16553
|
+
* type: number
|
|
16554
|
+
* description: Number of failed requests to trigger the fallback LLM as 1st choice
|
|
16555
|
+
* durationInMinutes:
|
|
16556
|
+
* type: number
|
|
16557
|
+
* description: Duration in minutes for which the fallback LLM should be used as 1st choice
|
|
16558
|
+
* emailNotificationList:
|
|
16559
|
+
* type: array
|
|
16560
|
+
* items:
|
|
16561
|
+
* type: string
|
|
16562
|
+
* description: List of email addresses to notify when fallback is triggered
|
|
16563
|
+
* description: Configuration for LLM fallback
|
|
16564
|
+
*/
|
|
16565
|
+
export interface ILLMFallback_2_0 {
|
|
16566
|
+
order: number;
|
|
16567
|
+
isFallbackEnabled: boolean;
|
|
16568
|
+
fallbackLLMReferenceId: string;
|
|
16569
|
+
immediateFallBack: {
|
|
16570
|
+
failedRequests: number;
|
|
16571
|
+
durationInMinutes: number;
|
|
16572
|
+
emailNotificationList: string[];
|
|
16573
|
+
};
|
|
16574
|
+
}
|
|
16575
|
+
/******************************************************************************/
|
|
16576
|
+
/**
|
|
16577
|
+
* IMPORTANT!
|
|
16578
|
+
* Openapi components from the llm-providers pacakge, if you need to updtate something here
|
|
16579
|
+
* make sure that the actual code in the llm-providers package is updated as well
|
|
16580
|
+
*/
|
|
16581
|
+
/******************************************************************************/
|
|
16582
|
+
export interface IGoogleGeminiMeta_2_0 {
|
|
15849
16583
|
location: string;
|
|
15850
|
-
apiEndPoint: string;
|
|
15851
|
-
publisher?: string;
|
|
15852
16584
|
}
|
|
15853
16585
|
/**
|
|
15854
16586
|
* @openapi
|
|
@@ -15925,6 +16657,12 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15925
16657
|
* type: string
|
|
15926
16658
|
* publisher:
|
|
15927
16659
|
* type: string
|
|
16660
|
+
* googleGemini:
|
|
16661
|
+
* type: object
|
|
16662
|
+
* description: Google Gemini specific meta data
|
|
16663
|
+
* properties:
|
|
16664
|
+
* location:
|
|
16665
|
+
* type: string
|
|
15928
16666
|
* alephAlpha:
|
|
15929
16667
|
* type: object
|
|
15930
16668
|
* description: Aleph Alpha specific meta data
|
|
@@ -15936,6 +16674,11 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
15936
16674
|
* baseCustomUrl:
|
|
15937
16675
|
* type: string
|
|
15938
16676
|
* example: https://api.aleph-alpha.com
|
|
16677
|
+
* fallbacks:
|
|
16678
|
+
* type: array
|
|
16679
|
+
* description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
|
|
16680
|
+
* items:
|
|
16681
|
+
* $ref: '#/components/schemas/ILLMFallback_2_0'
|
|
15939
16682
|
*
|
|
15940
16683
|
* ILargeLanguageModelCreate_2_0:
|
|
15941
16684
|
* allOf:
|
|
@@ -15963,7 +16706,7 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15963
16706
|
description: string;
|
|
15964
16707
|
modelType: TGenerativeAIModels;
|
|
15965
16708
|
/** model type e.g. chat */
|
|
15966
|
-
modelGroup?:
|
|
16709
|
+
modelGroup?: TModeType;
|
|
15967
16710
|
isCustomModel?: boolean;
|
|
15968
16711
|
provider: TGenerativeAIProviders;
|
|
15969
16712
|
connectionId: string;
|
|
@@ -15980,8 +16723,67 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
15980
16723
|
alephAlpha?: IAlephAlphaMeta_2_0;
|
|
15981
16724
|
/** Meta data for the GoogleVertexAI connection */
|
|
15982
16725
|
googleVertexAI?: IGoogleVertexAIMeta_2_0;
|
|
16726
|
+
/** Meta data for the GoogleGemini connection */
|
|
16727
|
+
googleGemini?: IGoogleGeminiMeta_2_0;
|
|
15983
16728
|
/** Meta data for the Anthropic connection */
|
|
15984
16729
|
anthropic?: IAnthropicMeta_2_0;
|
|
16730
|
+
/** Meta data for the AwsBedrock connection */
|
|
16731
|
+
awsBedrock?: IAwsBedrockMeta_2_0;
|
|
16732
|
+
/** Fallback LLM configuration */
|
|
16733
|
+
fallbacks?: ILLMFallback_2_0[];
|
|
16734
|
+
}
|
|
16735
|
+
/**
|
|
16736
|
+
* @openapi
|
|
16737
|
+
*
|
|
16738
|
+
* components:
|
|
16739
|
+
* schemas:
|
|
16740
|
+
* ILargeLanguageModelIndexItem_2_0:
|
|
16741
|
+
* allOf:
|
|
16742
|
+
* - type: object
|
|
16743
|
+
* properties:
|
|
16744
|
+
* referenceId:
|
|
16745
|
+
* type: string
|
|
16746
|
+
* description: The reference id of the LargeLanguageModel
|
|
16747
|
+
* format: uuid
|
|
16748
|
+
* name:
|
|
16749
|
+
* type: string
|
|
16750
|
+
* example: "LLM Name"
|
|
16751
|
+
* description:
|
|
16752
|
+
* type: string
|
|
16753
|
+
* example: "LLM Name"
|
|
16754
|
+
* modeltype:
|
|
16755
|
+
* $ref: '#/components/schemas/TGenerativeAIModels'
|
|
16756
|
+
* provider:
|
|
16757
|
+
* $ref: '#/components/schemas/TGenerativeAIProviders'
|
|
16758
|
+
* connectionId:
|
|
16759
|
+
* type: string
|
|
16760
|
+
* description: The reference id of the GenerativeAI Provider Connection
|
|
16761
|
+
* format: uuid
|
|
16762
|
+
* isDefault:
|
|
16763
|
+
* type: boolean
|
|
16764
|
+
* description: Sets the LLM to default (fallback) if no other LLM is set
|
|
16765
|
+
* example: false
|
|
16766
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
16767
|
+
*/
|
|
16768
|
+
export interface ILargeLanguageModelIndexItem_2_0 {
|
|
16769
|
+
referenceId: string;
|
|
16770
|
+
_id: TMongoId;
|
|
16771
|
+
name: string;
|
|
16772
|
+
description: string;
|
|
16773
|
+
modelType: TGenerativeAIModels;
|
|
16774
|
+
provider: TGenerativeAIProviders;
|
|
16775
|
+
connectionId: string;
|
|
16776
|
+
/** Fallback LLM configuration */
|
|
16777
|
+
fallbacks?: ILLMFallback_2_0[];
|
|
16778
|
+
isDefault: boolean;
|
|
16779
|
+
createdAt: number;
|
|
16780
|
+
lastChanged: number;
|
|
16781
|
+
createdBy: TMongoId;
|
|
16782
|
+
lastChangedBy: TMongoId;
|
|
16783
|
+
}
|
|
16784
|
+
export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
|
|
16785
|
+
}
|
|
16786
|
+
export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
|
|
15985
16787
|
}
|
|
15986
16788
|
export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
|
|
15987
16789
|
}
|
|
@@ -16033,6 +16835,50 @@ export interface ITestLargeLanguageModelRestReturnValue_2_0 {
|
|
|
16033
16835
|
msg: string;
|
|
16034
16836
|
msgErr?: string;
|
|
16035
16837
|
}
|
|
16838
|
+
/**
|
|
16839
|
+
* @openapi
|
|
16840
|
+
* components:
|
|
16841
|
+
* schemas:
|
|
16842
|
+
* IAvailableModelItem_2_0:
|
|
16843
|
+
* type: object
|
|
16844
|
+
* properties:
|
|
16845
|
+
* modelName:
|
|
16846
|
+
* type: string
|
|
16847
|
+
* modelId:
|
|
16848
|
+
* type: string
|
|
16849
|
+
* providerName:
|
|
16850
|
+
* type: array
|
|
16851
|
+
*
|
|
16852
|
+
*/
|
|
16853
|
+
/**
|
|
16854
|
+
* @openapi
|
|
16855
|
+
* components:
|
|
16856
|
+
* schemas:
|
|
16857
|
+
* IAvailableModelsForLLMProvider_2_0:
|
|
16858
|
+
* allOf:
|
|
16859
|
+
* - type: object
|
|
16860
|
+
* properties:
|
|
16861
|
+
* availableModels:
|
|
16862
|
+
* type: array
|
|
16863
|
+
* items:
|
|
16864
|
+
* $ref: '#/components/schemas/IAvailableModelItem_2_0'
|
|
16865
|
+
*
|
|
16866
|
+
*/
|
|
16867
|
+
export interface IAvailableModelsForLLMProvider_2_0 {
|
|
16868
|
+
availableModels: {
|
|
16869
|
+
modelName: string;
|
|
16870
|
+
modelId: string;
|
|
16871
|
+
providerName: string;
|
|
16872
|
+
}[];
|
|
16873
|
+
}
|
|
16874
|
+
export interface IGetAvailableModelsForLLMRestDataParams_2_0 {
|
|
16875
|
+
largeLanguageModelId: string;
|
|
16876
|
+
}
|
|
16877
|
+
export interface IGetAvailableModelsForLLMRestData_2_0 extends IGetAvailableModelsForLLMRestDataParams_2_0 {
|
|
16878
|
+
connectionRefId: string;
|
|
16879
|
+
}
|
|
16880
|
+
export interface IGetAvailableModelsForLLMRestReturnValue_2_0 extends IAvailableModelsForLLMProvider_2_0 {
|
|
16881
|
+
}
|
|
16036
16882
|
/**
|
|
16037
16883
|
* @openapi
|
|
16038
16884
|
*
|
|
@@ -16144,9 +16990,16 @@ declare const knowledgeSourceType: readonly [
|
|
|
16144
16990
|
"pdf",
|
|
16145
16991
|
"txt",
|
|
16146
16992
|
"docx",
|
|
16993
|
+
"pptx",
|
|
16147
16994
|
"ctxt",
|
|
16148
16995
|
"url",
|
|
16149
|
-
"manual"
|
|
16996
|
+
"manual",
|
|
16997
|
+
"jpeg",
|
|
16998
|
+
"jpg",
|
|
16999
|
+
"png",
|
|
17000
|
+
"bmp",
|
|
17001
|
+
"heif",
|
|
17002
|
+
"tiff"
|
|
16150
17003
|
];
|
|
16151
17004
|
export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
|
|
16152
17005
|
export interface IKnowledgeSourceMetaData {
|
|
@@ -16210,7 +17063,15 @@ export interface IKnowledgeSourceMetaData {
|
|
|
16210
17063
|
* - ready
|
|
16211
17064
|
* - ingesting
|
|
16212
17065
|
* - disabled
|
|
16213
|
-
*
|
|
17066
|
+
* metaData:
|
|
17067
|
+
* type: object
|
|
17068
|
+
* properties:
|
|
17069
|
+
* tags:
|
|
17070
|
+
* type: array
|
|
17071
|
+
* description: Array of tags to replace the existing tags
|
|
17072
|
+
* items:
|
|
17073
|
+
* type: string
|
|
17074
|
+
* example: "tag1"
|
|
16214
17075
|
* IKnowledgeSourceDataTypeWebsite_2_0:
|
|
16215
17076
|
* allOf:
|
|
16216
17077
|
* - type: object
|
|
@@ -16303,6 +17164,7 @@ export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSour
|
|
|
16303
17164
|
export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
|
|
16304
17165
|
}
|
|
16305
17166
|
export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
|
|
17167
|
+
metaData?: Partial<Pick<IKnowledgeSourceMetaData, "tags">>;
|
|
16306
17168
|
}
|
|
16307
17169
|
export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
|
|
16308
17170
|
knowledgeStoreId: string;
|
|
@@ -16437,34 +17299,36 @@ export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
|
|
|
16437
17299
|
*
|
|
16438
17300
|
* components:
|
|
16439
17301
|
* schemas:
|
|
16440
|
-
*
|
|
17302
|
+
* IGoalIndexItem_2_0:
|
|
16441
17303
|
* allOf:
|
|
16442
17304
|
* - type: object
|
|
16443
17305
|
* properties:
|
|
16444
17306
|
* name:
|
|
16445
17307
|
* type: string
|
|
16446
|
-
* description: The name of the
|
|
16447
|
-
* example: New
|
|
17308
|
+
* description: The name of the goal
|
|
17309
|
+
* example: New Goal
|
|
16448
17310
|
* - $ref: '#/components/schemas/IEntityMeta'
|
|
16449
17311
|
*/
|
|
16450
|
-
export interface
|
|
17312
|
+
export interface IGoalIndexItem_2_0 {
|
|
16451
17313
|
_id: TMongoId;
|
|
17314
|
+
referenceId: string;
|
|
16452
17315
|
name: string;
|
|
17316
|
+
description?: string;
|
|
16453
17317
|
createdAt: number;
|
|
16454
17318
|
lastChanged: number;
|
|
16455
17319
|
createdBy: TMongoId;
|
|
16456
17320
|
lastChangedBy: TMongoId;
|
|
16457
17321
|
}
|
|
16458
|
-
export interface
|
|
17322
|
+
export interface IIndexGoalsRestData_2_0 extends IRestPagination<IGoalIndexItem_2_0>, Partial<IProjectScope> {
|
|
16459
17323
|
}
|
|
16460
|
-
export interface
|
|
17324
|
+
export interface IIndexGoalsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IGoalIndexItem_2_0> {
|
|
16461
17325
|
}
|
|
16462
17326
|
/**
|
|
16463
17327
|
* @openapi
|
|
16464
17328
|
*
|
|
16465
17329
|
* components:
|
|
16466
17330
|
* schemas:
|
|
16467
|
-
*
|
|
17331
|
+
* IGoalStepMetric_2_0:
|
|
16468
17332
|
* type: object
|
|
16469
17333
|
* properties:
|
|
16470
17334
|
* name:
|
|
@@ -16477,37 +17341,37 @@ export interface IIndexMilestonesRestReturnValue_2_0 extends ICursorBasedPaginat
|
|
|
16477
17341
|
* example: Time taken to complete the step
|
|
16478
17342
|
* type:
|
|
16479
17343
|
* type: string
|
|
16480
|
-
* description: Metric type
|
|
17344
|
+
* description: Metric type. Available values "currency", "duration", "revenue"
|
|
16481
17345
|
* example: "duration"
|
|
16482
17346
|
* value:
|
|
16483
17347
|
* type: number
|
|
16484
17348
|
* description: Metric value
|
|
16485
17349
|
* example: 30
|
|
16486
17350
|
*/
|
|
16487
|
-
export interface
|
|
17351
|
+
export interface IGoalStepMetric_2_0 {
|
|
16488
17352
|
name: string;
|
|
16489
17353
|
description: string;
|
|
16490
|
-
type?: "currency" | "duration";
|
|
17354
|
+
type?: "currency" | "duration" | "revenue";
|
|
16491
17355
|
value?: number;
|
|
16492
17356
|
}
|
|
16493
17357
|
/**
|
|
16494
17358
|
* @openapi
|
|
16495
17359
|
* components:
|
|
16496
17360
|
* schemas:
|
|
16497
|
-
*
|
|
17361
|
+
* IGoalStep_2_0:
|
|
16498
17362
|
* type: object
|
|
16499
17363
|
* properties:
|
|
16500
17364
|
* name:
|
|
16501
17365
|
* type: string
|
|
16502
|
-
* description: The name of the
|
|
17366
|
+
* description: The name of the goal step
|
|
16503
17367
|
* example: Step 1
|
|
16504
17368
|
* description:
|
|
16505
17369
|
* type: string
|
|
16506
|
-
* description: The description of the
|
|
17370
|
+
* description: The description of the goal step
|
|
16507
17371
|
* example: This is the first step
|
|
16508
17372
|
* order:
|
|
16509
17373
|
* type: number
|
|
16510
|
-
* description: Step order in the
|
|
17374
|
+
* description: Step order in the goal configuration
|
|
16511
17375
|
* example: 1
|
|
16512
17376
|
* type:
|
|
16513
17377
|
* type: string
|
|
@@ -16516,124 +17380,386 @@ export interface IMilestoneStepMetric_2_0 {
|
|
|
16516
17380
|
* metrics:
|
|
16517
17381
|
* type: array
|
|
16518
17382
|
* items:
|
|
16519
|
-
* $ref: '#/components/schemas/
|
|
17383
|
+
* $ref: '#/components/schemas/IGoalStepMetric_2_0'
|
|
16520
17384
|
*/
|
|
16521
|
-
export interface
|
|
17385
|
+
export interface IGoalStep_2_0 {
|
|
17386
|
+
_id?: TMongoId;
|
|
16522
17387
|
name?: string;
|
|
16523
17388
|
description?: string;
|
|
16524
17389
|
order?: number;
|
|
16525
17390
|
type?: "start" | "completion";
|
|
16526
|
-
metrics?:
|
|
17391
|
+
metrics?: IGoalStepMetric_2_0[];
|
|
16527
17392
|
}
|
|
16528
17393
|
/**
|
|
16529
17394
|
* @openapi
|
|
16530
17395
|
*
|
|
16531
17396
|
* components:
|
|
16532
17397
|
* schemas:
|
|
16533
|
-
*
|
|
17398
|
+
* IGoalData_2_0:
|
|
16534
17399
|
* type: object
|
|
16535
17400
|
* properties:
|
|
16536
17401
|
* name:
|
|
16537
17402
|
* type: string
|
|
16538
|
-
* description: The name of the
|
|
16539
|
-
* example: New
|
|
16540
|
-
* version:
|
|
16541
|
-
* type: number
|
|
16542
|
-
* description: Current version of the milestone.
|
|
16543
|
-
* example: 1
|
|
17403
|
+
* description: The name of the Goal
|
|
17404
|
+
* example: New Goal
|
|
16544
17405
|
* description:
|
|
16545
17406
|
* type: string
|
|
16546
|
-
* description: The description of the
|
|
16547
|
-
* example: "This is a sample
|
|
17407
|
+
* description: The description of the goal
|
|
17408
|
+
* example: "This is a sample goal"
|
|
16548
17409
|
* steps:
|
|
16549
17410
|
* type: array
|
|
16550
17411
|
* items:
|
|
16551
|
-
* $ref: '#/components/schemas/
|
|
17412
|
+
* $ref: '#/components/schemas/IGoalStep_2_0'
|
|
16552
17413
|
*
|
|
16553
|
-
*
|
|
17414
|
+
* IGoal_2_0:
|
|
16554
17415
|
* allOf:
|
|
16555
|
-
* - $ref: '#/components/schemas/
|
|
17416
|
+
* - $ref: '#/components/schemas/IGoalData_2_0'
|
|
16556
17417
|
* - $ref: '#/components/schemas/IEntityMeta'
|
|
16557
17418
|
*
|
|
16558
17419
|
*/
|
|
16559
|
-
export interface
|
|
17420
|
+
export interface IGoal_2_0 {
|
|
16560
17421
|
_id: TMongoId;
|
|
17422
|
+
referenceId: string;
|
|
16561
17423
|
name: string;
|
|
16562
|
-
version:
|
|
17424
|
+
version: string;
|
|
16563
17425
|
createdAt: number;
|
|
16564
17426
|
lastChanged: number;
|
|
16565
17427
|
createdBy: TMongoId;
|
|
16566
17428
|
lastChangedBy: TMongoId;
|
|
16567
17429
|
description: string;
|
|
16568
|
-
steps:
|
|
17430
|
+
steps: IGoalStep_2_0[];
|
|
17431
|
+
}
|
|
17432
|
+
export interface ICreateGoalRestDataBody_2_0 extends IProjectScope, Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
|
|
17433
|
+
}
|
|
17434
|
+
export interface ICreateGoalRestData_2_0 extends ICreateGoalRestDataBody_2_0 {
|
|
17435
|
+
}
|
|
17436
|
+
export interface ICreateGoalRestReturnValue_2_0 extends IGoal_2_0 {
|
|
17437
|
+
}
|
|
17438
|
+
export interface IReadGoalRestDataParams_2_0 {
|
|
17439
|
+
goalId: string;
|
|
17440
|
+
}
|
|
17441
|
+
export interface IReadGoalRestData_2_0 extends IReadGoalRestDataParams_2_0 {
|
|
17442
|
+
}
|
|
17443
|
+
export interface IReadGoalRestReturnValue_2_0 extends IGoal_2_0 {
|
|
17444
|
+
}
|
|
17445
|
+
export interface IUpdateGoalRestDataParams_2_0 {
|
|
17446
|
+
goalId: string;
|
|
17447
|
+
}
|
|
17448
|
+
export interface IUpdateGoalRestDataBody_2_0 extends Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
|
|
17449
|
+
}
|
|
17450
|
+
export interface IUpdateGoalRestData_2_0 extends IUpdateGoalRestDataBody_2_0, IUpdateGoalRestDataParams_2_0 {
|
|
17451
|
+
}
|
|
17452
|
+
export interface IUpdateGoalRestReturnValue_2_0 {
|
|
17453
|
+
}
|
|
17454
|
+
export interface IDeleteGoalRestDataParams_2_0 {
|
|
17455
|
+
goalId: string;
|
|
17456
|
+
}
|
|
17457
|
+
export interface IDeleteGoalRestData_2_0 extends IDeleteGoalRestDataParams_2_0 {
|
|
17458
|
+
}
|
|
17459
|
+
export interface IDeleteGoalRestReturnValue_2_0 {
|
|
17460
|
+
}
|
|
17461
|
+
declare const uploadResumableTypes: readonly [
|
|
17462
|
+
"snapshots",
|
|
17463
|
+
"packages"
|
|
17464
|
+
];
|
|
17465
|
+
export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
|
|
17466
|
+
export interface HttpRequest {
|
|
17467
|
+
getMethod(): string;
|
|
17468
|
+
getURL(): string;
|
|
17469
|
+
setHeader(header: string, value: string): void;
|
|
17470
|
+
getHeader(header: string): string;
|
|
17471
|
+
setProgressHandler(handler: (bytesSent: number) => void): void;
|
|
17472
|
+
send(body: any): Promise<HttpResponse>;
|
|
17473
|
+
abort(): Promise<void>;
|
|
17474
|
+
getUnderlyingObject(): any;
|
|
17475
|
+
}
|
|
17476
|
+
export interface HttpResponse {
|
|
17477
|
+
getStatus(): number;
|
|
17478
|
+
getHeader(header: string): string;
|
|
17479
|
+
getBody(): string;
|
|
17480
|
+
getUnderlyingObject(): any;
|
|
17481
|
+
}
|
|
17482
|
+
export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
|
|
17483
|
+
file: Buffer | File;
|
|
17484
|
+
onError?: ((error: Error) => void) | null;
|
|
17485
|
+
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
17486
|
+
onSuccess?: (() => void) | null;
|
|
17487
|
+
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
17488
|
+
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
17489
|
+
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
17490
|
+
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
17491
|
+
}
|
|
17492
|
+
export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
|
|
17493
|
+
uploadType: TUploadResumableTypes;
|
|
17494
|
+
}
|
|
17495
|
+
export interface IUploadResumableRestReturnValue_2_0 {
|
|
17496
|
+
fileName: string;
|
|
17497
|
+
url: string;
|
|
17498
|
+
uploadId: string;
|
|
17499
|
+
}
|
|
17500
|
+
/**
|
|
17501
|
+
* @openapi
|
|
17502
|
+
*
|
|
17503
|
+
* components:
|
|
17504
|
+
* schemas:
|
|
17505
|
+
* IGenerateNluScoreData_2_0:
|
|
17506
|
+
* type: object
|
|
17507
|
+
* required:
|
|
17508
|
+
* - flowReferenceId
|
|
17509
|
+
* - localeReferenceId
|
|
17510
|
+
* - sentence
|
|
17511
|
+
* properties:
|
|
17512
|
+
* flowReferenceId:
|
|
17513
|
+
* type: string
|
|
17514
|
+
* format: uuid
|
|
17515
|
+
* description: UUID of the flow reference.
|
|
17516
|
+
* localeReferenceId:
|
|
17517
|
+
* type: string
|
|
17518
|
+
* format: uuid
|
|
17519
|
+
* description: UUID of the locale reference.
|
|
17520
|
+
* sentence:
|
|
17521
|
+
* type: string
|
|
17522
|
+
* description: Sentence to analyze for NLU scoring.
|
|
17523
|
+
*
|
|
17524
|
+
* IGeneratedNluScore_2_0:
|
|
17525
|
+
* type: object
|
|
17526
|
+
* properties:
|
|
17527
|
+
* id:
|
|
17528
|
+
* type: string
|
|
17529
|
+
* description: Unique identifier of the score.
|
|
17530
|
+
* name:
|
|
17531
|
+
* type: string
|
|
17532
|
+
* description: Name of the score type.
|
|
17533
|
+
* score:
|
|
17534
|
+
* type: number
|
|
17535
|
+
* description: Numerical value of the score.
|
|
17536
|
+
* negated:
|
|
17537
|
+
* type: boolean
|
|
17538
|
+
* description: Indicates if the score is negated.
|
|
17539
|
+
* confirmationSentence:
|
|
17540
|
+
* type: string
|
|
17541
|
+
* description: Sentence used to confirm the score.
|
|
17542
|
+
* confirmationSentences:
|
|
17543
|
+
* type: array
|
|
17544
|
+
* items:
|
|
17545
|
+
* type: string
|
|
17546
|
+
* description: Multiple sentences for confirmation if applicable.
|
|
17547
|
+
* disambiguationSentence:
|
|
17548
|
+
* type: string
|
|
17549
|
+
* description: Sentence used for disambiguation.
|
|
17550
|
+
* flow:
|
|
17551
|
+
* type: string
|
|
17552
|
+
* description: UUID of the flow associated with the score.
|
|
17553
|
+
*/
|
|
17554
|
+
export interface IGenerateNluScoresRestDataParams_2_0 {
|
|
17555
|
+
projectId: string;
|
|
17556
|
+
}
|
|
17557
|
+
export interface IGenerateNluScoresRestDataBody_2_0 {
|
|
17558
|
+
flowReferenceId: string;
|
|
17559
|
+
localeReferenceId: string;
|
|
17560
|
+
sentence: string;
|
|
17561
|
+
}
|
|
17562
|
+
export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
|
|
17563
|
+
}
|
|
17564
|
+
export interface IGenerateNluScoresRestReturnValue_2_0 {
|
|
17565
|
+
}
|
|
17566
|
+
/**
|
|
17567
|
+
* @openapi
|
|
17568
|
+
*
|
|
17569
|
+
* components:
|
|
17570
|
+
* schemas:
|
|
17571
|
+
* IAiAgentData_2_0:
|
|
17572
|
+
* type: object
|
|
17573
|
+
* properties:
|
|
17574
|
+
* name:
|
|
17575
|
+
* type: string
|
|
17576
|
+
* example: "Cognigy AI Agent"
|
|
17577
|
+
* image:
|
|
17578
|
+
* type: string
|
|
17579
|
+
* description: Avatar of the AI Agent.
|
|
17580
|
+
* example: "https://cognigy.com/ai-agent.png"
|
|
17581
|
+
* imageOptimizedFormat:
|
|
17582
|
+
* type: boolean
|
|
17583
|
+
* description: Whether the optimized image format defined by Cognigy is used.
|
|
17584
|
+
* example: true
|
|
17585
|
+
* knowledgeReferenceId:
|
|
17586
|
+
* type: string
|
|
17587
|
+
* format: uuid
|
|
17588
|
+
* description: A referenceId of a Knowledge Store this Agent will use as base knowledge.
|
|
17589
|
+
* example: "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
|
|
17590
|
+
* description:
|
|
17591
|
+
* type: string
|
|
17592
|
+
* maxLength: 1000
|
|
17593
|
+
* description: A short description of the AI Agent, up to 1000 characters.
|
|
17594
|
+
* example: "I am a virtual assistant that can help you with your questions."
|
|
17595
|
+
* speakingStyle:
|
|
17596
|
+
* type: object
|
|
17597
|
+
* properties:
|
|
17598
|
+
* completeness:
|
|
17599
|
+
* type: string
|
|
17600
|
+
* formality:
|
|
17601
|
+
* type: string
|
|
17602
|
+
* example: { "completeness": "concise", "formality": "formal" }
|
|
17603
|
+
* safetySettings:
|
|
17604
|
+
* type: object
|
|
17605
|
+
* properties:
|
|
17606
|
+
* avoidHarmfulContent:
|
|
17607
|
+
* type: boolean
|
|
17608
|
+
* avoidUngroundedContent:
|
|
17609
|
+
* type: boolean
|
|
17610
|
+
* avoidCopyrightInfringements:
|
|
17611
|
+
* type: boolean
|
|
17612
|
+
* preventJailbreakAndManipulation:
|
|
17613
|
+
* type: boolean
|
|
17614
|
+
* contactProfilesOption:
|
|
17615
|
+
* type: string
|
|
17616
|
+
* enum:
|
|
17617
|
+
* - "none"
|
|
17618
|
+
* - "selectedProfileFields"
|
|
17619
|
+
* - "completeProfile"
|
|
17620
|
+
* - "profileMemoriesOnly"
|
|
17621
|
+
* description: Option to enable or customize Contact profiles selection for the AI Agent.
|
|
17622
|
+
* example: "selectedProfileFields"
|
|
17623
|
+
* contactProfilesSelected:
|
|
17624
|
+
* type: array
|
|
17625
|
+
* items:
|
|
17626
|
+
* type: string
|
|
17627
|
+
* description: Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
|
|
17628
|
+
* example: ["name", "email"]
|
|
17629
|
+
* instructions:
|
|
17630
|
+
* type: string
|
|
17631
|
+
* description: Instructions for the AI Agent.
|
|
17632
|
+
* example: "I can help you with your questions, provide information and much more."
|
|
17633
|
+
* maxLength: 1000
|
|
17634
|
+
* IAiAgent_2_0:
|
|
17635
|
+
* allOf:
|
|
17636
|
+
* - $ref: '#/components/schemas/IAiAgentData_2_0'
|
|
17637
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
17638
|
+
*/
|
|
17639
|
+
export interface IAiAgent_2_0 {
|
|
17640
|
+
_id: TMongoId;
|
|
17641
|
+
name: string;
|
|
17642
|
+
referenceId: string;
|
|
17643
|
+
image: string;
|
|
17644
|
+
imageOptimizedFormat: boolean;
|
|
17645
|
+
instructions: string;
|
|
17646
|
+
knowledgeReferenceId: string;
|
|
17647
|
+
description: string;
|
|
17648
|
+
speakingStyle: ISpeakingStyle;
|
|
17649
|
+
safetySettings: ISafetySettings;
|
|
17650
|
+
contactProfilesOption: TContactProfileOptions;
|
|
17651
|
+
contactProfilesSelected: string[];
|
|
17652
|
+
projectReference: TMongoId;
|
|
17653
|
+
organisationReference: TMongoId;
|
|
17654
|
+
createdAt: number;
|
|
17655
|
+
lastChanged: number;
|
|
17656
|
+
createdBy: TMongoId;
|
|
17657
|
+
lastChangedBy: TMongoId;
|
|
16569
17658
|
}
|
|
16570
|
-
export interface
|
|
17659
|
+
export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
|
|
16571
17660
|
}
|
|
16572
|
-
export interface
|
|
17661
|
+
export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
|
|
16573
17662
|
}
|
|
16574
|
-
export interface
|
|
17663
|
+
export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
|
|
16575
17664
|
}
|
|
16576
|
-
export interface
|
|
16577
|
-
milestoneId: string;
|
|
17665
|
+
export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
|
|
16578
17666
|
}
|
|
16579
|
-
export interface
|
|
17667
|
+
export interface IUpdateAiAgentRestDataParams_2_0 {
|
|
17668
|
+
aiAgentId: string;
|
|
16580
17669
|
}
|
|
16581
|
-
export interface
|
|
17670
|
+
export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
|
|
16582
17671
|
}
|
|
16583
|
-
export interface
|
|
16584
|
-
milestoneId: string;
|
|
17672
|
+
export interface IUpdateAiAgentRestReturnValue_2_0 {
|
|
16585
17673
|
}
|
|
16586
|
-
export interface
|
|
17674
|
+
export interface IReadAiAgentRestDataParams_2_0 {
|
|
17675
|
+
aiAgentId: string;
|
|
16587
17676
|
}
|
|
16588
|
-
export interface
|
|
17677
|
+
export interface IReadAiAgentRestData_2_0 extends IReadAiAgentRestDataParams_2_0 {
|
|
16589
17678
|
}
|
|
16590
|
-
export interface
|
|
17679
|
+
export interface IReadAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
|
|
17680
|
+
}
|
|
17681
|
+
export interface IIndexAiAgentsRestData_2_0 extends IRestPagination<IAiAgent_2_0>, IProjectScope {
|
|
17682
|
+
}
|
|
17683
|
+
export interface IIndexAiAgentsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAiAgent_2_0> {
|
|
17684
|
+
}
|
|
17685
|
+
export interface IDeleteAiAgentRestDataParams_2_0 {
|
|
17686
|
+
aiAgentId: string;
|
|
17687
|
+
}
|
|
17688
|
+
export interface IDeleteAiAgentRestData_2_0 extends IDeleteAiAgentRestDataParams_2_0 {
|
|
17689
|
+
}
|
|
17690
|
+
export interface IDeleteAiAgentRestReturnValue_2_0 {
|
|
17691
|
+
}
|
|
17692
|
+
/**
|
|
17693
|
+
* @openapi
|
|
17694
|
+
* components:
|
|
17695
|
+
* schemas:
|
|
17696
|
+
* IAiAgentHiringTemplate_2_0:
|
|
17697
|
+
* type: object
|
|
17698
|
+
* properties:
|
|
17699
|
+
* templateId:
|
|
17700
|
+
* type: string
|
|
17701
|
+
* description: The ID of the AI Agent template to hire.
|
|
17702
|
+
* example: RetailAssistant-Rita
|
|
17703
|
+
* aiAgentName:
|
|
17704
|
+
* type: string
|
|
17705
|
+
* description: The name of the AI Agent.
|
|
17706
|
+
* example: Rita
|
|
17707
|
+
* aiAgentFileName:
|
|
17708
|
+
* type: string
|
|
17709
|
+
* description: The file name of the AI Agent.
|
|
17710
|
+
* example: Rita.tar
|
|
17711
|
+
* aiAgentImage:
|
|
17712
|
+
* type: string
|
|
17713
|
+
* description: The image of the AI Agent.
|
|
17714
|
+
* example: https://cognigy.com/rita.png
|
|
17715
|
+
* aiAgentDescription:
|
|
17716
|
+
* type: string
|
|
17717
|
+
* description: A short description of the AI Agent, up to 1000 characters.
|
|
17718
|
+
* example: "I am a virtual assistant that can help you with your questions."
|
|
17719
|
+
*
|
|
17720
|
+
*/
|
|
17721
|
+
export interface IAiAgentHiringTemplate_2_0 {
|
|
17722
|
+
templateId: string;
|
|
17723
|
+
aiAgentName: string;
|
|
17724
|
+
aiAgentFileName: string;
|
|
17725
|
+
aiAgentImage: string;
|
|
17726
|
+
aiAgentDescription: string;
|
|
16591
17727
|
}
|
|
16592
|
-
export interface
|
|
16593
|
-
milestoneId: string;
|
|
17728
|
+
export interface IGetAiAgentHiringTemplatesRestData_2_0 {
|
|
16594
17729
|
}
|
|
16595
|
-
export interface
|
|
17730
|
+
export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
|
|
17731
|
+
templates: IAiAgentHiringTemplate_2_0[];
|
|
16596
17732
|
}
|
|
16597
|
-
|
|
17733
|
+
/**
|
|
17734
|
+
* @openapi
|
|
17735
|
+
* components:
|
|
17736
|
+
* schemas:
|
|
17737
|
+
* IAiAgentTemplateId_2_0:
|
|
17738
|
+
* type: object
|
|
17739
|
+
* properties:
|
|
17740
|
+
* templateId:
|
|
17741
|
+
* type: string
|
|
17742
|
+
* description: The ID of the AI Agent template to hire.
|
|
17743
|
+
* example: insurance-agent-olivia
|
|
17744
|
+
* overrideAiAgentReferenceId:
|
|
17745
|
+
* type: string
|
|
17746
|
+
* description: The reference ID of the AI Agent to override the AI Agent from the hired package.
|
|
17747
|
+
* example: 5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b
|
|
17748
|
+
*/
|
|
17749
|
+
export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
|
|
17750
|
+
templateId: string;
|
|
17751
|
+
overrideAiAgentReferenceId?: string;
|
|
16598
17752
|
}
|
|
16599
|
-
|
|
16600
|
-
"snapshots",
|
|
16601
|
-
"packages"
|
|
16602
|
-
];
|
|
16603
|
-
export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
|
|
16604
|
-
export interface HttpRequest {
|
|
16605
|
-
getMethod(): string;
|
|
16606
|
-
getURL(): string;
|
|
16607
|
-
setHeader(header: string, value: string): void;
|
|
16608
|
-
getHeader(header: string): string;
|
|
16609
|
-
setProgressHandler(handler: (bytesSent: number) => void): void;
|
|
16610
|
-
send(body: any): Promise<HttpResponse>;
|
|
16611
|
-
abort(): Promise<void>;
|
|
16612
|
-
getUnderlyingObject(): any;
|
|
17753
|
+
export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
|
|
16613
17754
|
}
|
|
16614
|
-
export interface
|
|
16615
|
-
getStatus(): number;
|
|
16616
|
-
getHeader(header: string): string;
|
|
16617
|
-
getBody(): string;
|
|
16618
|
-
getUnderlyingObject(): any;
|
|
17755
|
+
export interface IHireAiAgentRestReturnValue_2_0 {
|
|
16619
17756
|
}
|
|
16620
|
-
export interface
|
|
16621
|
-
|
|
16622
|
-
onError?: ((error: Error) => void) | null;
|
|
16623
|
-
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
16624
|
-
onSuccess?: (() => void) | null;
|
|
16625
|
-
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
16626
|
-
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
16627
|
-
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
16628
|
-
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
17757
|
+
export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
|
|
17758
|
+
name: string;
|
|
16629
17759
|
}
|
|
16630
|
-
export interface
|
|
16631
|
-
uploadType: TUploadResumableTypes;
|
|
17760
|
+
export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
|
|
16632
17761
|
}
|
|
16633
|
-
export interface
|
|
16634
|
-
fileName: string;
|
|
16635
|
-
url: string;
|
|
16636
|
-
uploadId: string;
|
|
17762
|
+
export interface IValidateAiAgentNameRestReturnValue_2_0 {
|
|
16637
17763
|
}
|
|
16638
17764
|
export interface ResourcesAPIGroup_2_0 {
|
|
16639
17765
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
@@ -16701,11 +17827,11 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16701
17827
|
readEndpoint: TRestAPIOperation<IReadEndpointRestData_2_0, IReadEndpointRestReturnValue_2_0>;
|
|
16702
17828
|
updateEndpoint: TRestAPIOperation<IUpdateEndpointRestData_2_0, IUpdateEndpointRestReturnValue_2_0>;
|
|
16703
17829
|
deleteEndpoint: TRestAPIOperation<IDeleteEndpointRestData_2_0, IDeleteEndpointRestReturnValue_2_0>;
|
|
16704
|
-
|
|
16705
|
-
|
|
16706
|
-
|
|
16707
|
-
|
|
16708
|
-
|
|
17830
|
+
indexGoals: TRestAPIOperation<TRestAPIOptionalParameter<IIndexGoalsRestData_2_0>, IIndexGoalsRestReturnValue_2_0>;
|
|
17831
|
+
createGoal: TRestAPIOperation<ICreateGoalRestData_2_0, ICreateGoalRestReturnValue_2_0>;
|
|
17832
|
+
readGoal: TRestAPIOperation<IReadGoalRestData_2_0, IReadGoalRestReturnValue_2_0>;
|
|
17833
|
+
updateGoal: TRestAPIOperation<IUpdateGoalRestData_2_0, IUpdateGoalRestReturnValue_2_0>;
|
|
17834
|
+
deleteGoal: TRestAPIOperation<IDeleteGoalRestData_2_0, IDeleteGoalRestReturnValue_2_0>;
|
|
16709
17835
|
indexPlaybooks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexPlaybooksRestData_2_0>, IIndexPlaybooksRestReturnValue_2_0>;
|
|
16710
17836
|
batchPlaybooks: TRestAPIOperation<IBatchPlaybooksRestData_2_0, IBatchPlaybooksRestReturnValue_2_0>;
|
|
16711
17837
|
createPlaybook: TRestAPIOperation<ICreatePlaybookRestData_2_0, ICreatePlaybookRestReturnValue_2_0>;
|
|
@@ -16802,11 +17928,6 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16802
17928
|
readLocale: TRestAPIOperation<IReadLocaleRestData_2_0, IReadLocaleRestReturnValue_2_0>;
|
|
16803
17929
|
updateLocale: TRestAPIOperation<IUpdateLocaleRestData_2_0, IUpdateLocaleRestReturnValue_2_0>;
|
|
16804
17930
|
deleteLocale: TRestAPIOperation<IDeleteLocaleRestData_2_0, IDeleteLocaleRestReturnValue_2_0>;
|
|
16805
|
-
indexJourneys: TRestAPIOperation<IIndexJourneysRestData_2_0, IIndexJourneysRestReturnValue_2_0>;
|
|
16806
|
-
readJourney: TRestAPIOperation<IReadJourneyRestData_2_0, IReadJourneyRestReturnValue_2_0>;
|
|
16807
|
-
readJourneyProgress: TRestAPIOperation<IReadJourneyProgressRestData_2_0, IReadJourneyProgressRestReturnValue_2_0>;
|
|
16808
|
-
updateSelectedJourney: TRestAPIOperation<IUpdateSelectedJourneyRestData_2_0, IUpdateSelectedJourneyRestReturnValue_2_0>;
|
|
16809
|
-
trackJourneyEvent: TRestAPIOperation<ITrackJourneyEventRestData_2_0, ITrackJourneyEventRestReturnValue_2_0>;
|
|
16810
17931
|
indexSlotFillers: TRestAPIOperation<IIndexSlotFillersRestData_2_0, IIndexSlotFillersRestReturnValue_2_0>;
|
|
16811
17932
|
batchSlotFillers: TRestAPIOperation<IBatchSlotFillersRestData_2_0, IBatchSlotFillersRestReturnValue_2_0>;
|
|
16812
17933
|
createSlotFiller: TRestAPIOperation<ICreateSlotFillerRestData_2_0, ICreateSlotFillerRestReturnValue_2_0>;
|
|
@@ -16849,6 +17970,14 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16849
17970
|
readAgentAssistConfig: TRestAPIOperation<IReadAgentAssistConfigRestData_2_0, IReadAgentAssistConfigRestReturnValue_2_0>;
|
|
16850
17971
|
updateAgentAssistConfig: TRestAPIOperation<IUpdateAgentAssistConfigRestData_2_0, IUpdateAgentAssistConfigRestReturnValue_2_0>;
|
|
16851
17972
|
deleteAgentAssistConfig: TRestAPIOperation<IDeleteAgentAssistConfigRestData_2_0, IDeleteAgentAssistConfigRestReturnValue_2_0>;
|
|
17973
|
+
createAiAgent: TRestAPIOperation<ICreateAiAgentRestData_2_0, ICreateAiAgentRestReturnValue_2_0>;
|
|
17974
|
+
updateAiAgent: TRestAPIOperation<IUpdateAiAgentRestData_2_0, IUpdateAiAgentRestReturnValue_2_0>;
|
|
17975
|
+
readAiAgent: TRestAPIOperation<IReadAiAgentRestData_2_0, IReadAiAgentRestReturnValue_2_0>;
|
|
17976
|
+
indexAiAgents: TRestAPIOperation<IIndexAiAgentsRestData_2_0, IIndexAiAgentsRestReturnValue_2_0>;
|
|
17977
|
+
deleteAiAgent: TRestAPIOperation<IDeleteAiAgentRestData_2_0, IDeleteAiAgentRestReturnValue_2_0>;
|
|
17978
|
+
validateAiAgentName: TRestAPIOperation<IValidateAiAgentNameRestData_2_0, IValidateAiAgentNameRestReturnValue_2_0>;
|
|
17979
|
+
getAiAgentHiringTemplates: TRestAPIOperation<IGetAiAgentHiringTemplatesRestData_2_0, IGetAiAgentHiringTemplatesRestReturnValue_2_0>;
|
|
17980
|
+
hireAiAgent: TRestAPIOperation<IHireAiAgentRestData_2_0, IHireAiAgentRestReturnValue_2_0>;
|
|
16852
17981
|
generateNodeOutput: TRestAPIOperation<IGenerateNodeOutputRestData_2_0, IGenerateNodeOutputRestReturnValue_2_0>;
|
|
16853
17982
|
indexLargeLanguageModels: TRestAPIOperation<IIndexLargeLanguageModelsRestData_2_0, IIndexLargeLanguageModelsRestReturnValue_2_0>;
|
|
16854
17983
|
createLargeLanguageModel: TRestAPIOperation<ICreateLargeLanguageModelRestData_2_0, ICreateLargeLanguageModelRestReturnValue_2_0>;
|
|
@@ -16857,6 +17986,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16857
17986
|
deleteLargeLanguageModel: TRestAPIOperation<IDeleteLargeLanguageModelRestData_2_0, IDeleteLargeLanguageModelRestReturnValue_2_0>;
|
|
16858
17987
|
cloneLargeLanguageModel: TRestAPIOperation<ICloneLargeLanguageModelRestData_2_0, ICloneLargeLanguageModelRestReturnValue_2_0>;
|
|
16859
17988
|
testLargeLanguageModel: TRestAPIOperation<ITestLargeLanguageModelRestData_2_0, ITestLargeLanguageModelRestReturnValue_2_0>;
|
|
17989
|
+
getAvailableModelsForLLM: TRestAPIOperation<IGetAvailableModelsForLLMRestData_2_0, IGetAvailableModelsForLLMRestReturnValue_2_0>;
|
|
16860
17990
|
indexKnowledgeStores: TRestAPIOperation<IIndexKnowledgeStoresRestData_2_0, IIndexKnowledgeStoresRestReturnValue_2_0>;
|
|
16861
17991
|
createKnowledgeStore: TRestAPIOperation<ICreateKnowledgeStoreRestData_2_0, ICreateKnowledgeStoreRestReturnValue_2_0>;
|
|
16862
17992
|
readKnowledgeStore: TRestAPIOperation<IReadKnowledgeStoreRestData_2_0, IReadKnowledgeStoreRestReturnValue_2_0>;
|
|
@@ -16874,6 +18004,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
16874
18004
|
deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
|
|
16875
18005
|
updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
|
|
16876
18006
|
uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
|
|
18007
|
+
generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
|
|
16877
18008
|
}
|
|
16878
18009
|
declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
|
|
16879
18010
|
/**
|
|
@@ -17337,6 +18468,8 @@ export interface IStep_2_0 {
|
|
|
17337
18468
|
* type: string
|
|
17338
18469
|
* children:
|
|
17339
18470
|
* type: array
|
|
18471
|
+
* items:
|
|
18472
|
+
* type: object
|
|
17340
18473
|
* example:
|
|
17341
18474
|
* step: Collect Email
|
|
17342
18475
|
* type: node
|
|
@@ -17383,9 +18516,7 @@ export interface IStepReport_2_0 {
|
|
|
17383
18516
|
* - done
|
|
17384
18517
|
* - error
|
|
17385
18518
|
* data:
|
|
17386
|
-
*
|
|
17387
|
-
* items:
|
|
17388
|
-
* $ref: '#/components/schemas/IStepReport_2_0'
|
|
18519
|
+
* $ref: '#/components/schemas/IStepReport_2_0'
|
|
17389
18520
|
*/
|
|
17390
18521
|
export interface ILoadStepReportByQueryHashResponse_2_0 {
|
|
17391
18522
|
status: "pending" | "done" | "error";
|
|
@@ -17444,6 +18575,25 @@ export interface InsightsAPIGroup_2_0 {
|
|
|
17444
18575
|
}>;
|
|
17445
18576
|
}
|
|
17446
18577
|
declare function InsightsAPIGroup_2_0(instance: Base): InsightsAPIGroup_2_0;
|
|
18578
|
+
export interface JWTAuthAPIGroup_2_0 {
|
|
18579
|
+
collaborationJWT: TRestAPIOperation<void, {
|
|
18580
|
+
token: string;
|
|
18581
|
+
}>;
|
|
18582
|
+
}
|
|
18583
|
+
declare function JWTAuthAPIGroup_2_0(instance: Base): JWTAuthAPIGroup_2_0;
|
|
18584
|
+
export interface IProfilePrivacyPolicy {
|
|
18585
|
+
accepted: boolean;
|
|
18586
|
+
meta?: {
|
|
18587
|
+
[key: string]: {
|
|
18588
|
+
timestamp: number;
|
|
18589
|
+
};
|
|
18590
|
+
};
|
|
18591
|
+
}
|
|
18592
|
+
export interface IMemory {
|
|
18593
|
+
id: string;
|
|
18594
|
+
timestamp: string;
|
|
18595
|
+
text: string;
|
|
18596
|
+
}
|
|
17447
18597
|
/**
|
|
17448
18598
|
* @openapi
|
|
17449
18599
|
*
|
|
@@ -17483,6 +18633,22 @@ export interface IProfile_2_0 {
|
|
|
17483
18633
|
*
|
|
17484
18634
|
* components:
|
|
17485
18635
|
* schemas:
|
|
18636
|
+
* IMemory:
|
|
18637
|
+
* type: object
|
|
18638
|
+
* properties:
|
|
18639
|
+
* id:
|
|
18640
|
+
* type: string
|
|
18641
|
+
* description: Unique identifier for the memory
|
|
18642
|
+
* example: "123456"
|
|
18643
|
+
* timestamp:
|
|
18644
|
+
* type: string
|
|
18645
|
+
* format: date-time
|
|
18646
|
+
* description: The timestamp of when the memory was created
|
|
18647
|
+
* example: "2024-09-23T08:37:00Z"
|
|
18648
|
+
* text:
|
|
18649
|
+
* type: string
|
|
18650
|
+
* description: The text content of the memory
|
|
18651
|
+
* example: "This is a memory."
|
|
17486
18652
|
* IFlattenedProfile_2_0:
|
|
17487
18653
|
* type: object
|
|
17488
18654
|
* properties:
|
|
@@ -17490,11 +18656,18 @@ export interface IProfile_2_0 {
|
|
|
17490
18656
|
* type: boolean
|
|
17491
18657
|
* accepted_gdpr:
|
|
17492
18658
|
* type: boolean
|
|
18659
|
+
* privacy_policy:
|
|
18660
|
+
* type: object
|
|
17493
18661
|
* goals:
|
|
17494
18662
|
* type: array
|
|
17495
18663
|
* items:
|
|
17496
18664
|
* type: string
|
|
17497
18665
|
* example: buyer
|
|
18666
|
+
* memories:
|
|
18667
|
+
* type: array
|
|
18668
|
+
* items:
|
|
18669
|
+
* $ref: '#/components/schemas/IMemory'
|
|
18670
|
+
* description: Array of memories associated with the profile.
|
|
17498
18671
|
* firstname:
|
|
17499
18672
|
* type: string
|
|
17500
18673
|
* example: Max
|
|
@@ -17511,12 +18684,14 @@ export interface IProfile_2_0 {
|
|
|
17511
18684
|
export interface IFlattenedProfile_2_0 {
|
|
17512
18685
|
prevent_data_collection: boolean;
|
|
17513
18686
|
accepted_gdpr: boolean;
|
|
18687
|
+
privacy_policy: IProfilePrivacyPolicy;
|
|
17514
18688
|
goals?: string[];
|
|
18689
|
+
memories?: IMemory[];
|
|
17515
18690
|
firstname?: string;
|
|
17516
18691
|
lastname?: string;
|
|
17517
18692
|
email?: string;
|
|
17518
18693
|
profilepic?: string;
|
|
17519
|
-
[key: string]: string | number | boolean | string[];
|
|
18694
|
+
[key: string]: string | number | boolean | string[] | IMemory[] | IProfilePrivacyPolicy | object;
|
|
17520
18695
|
}
|
|
17521
18696
|
/**
|
|
17522
18697
|
* @openapi
|
|
@@ -17615,7 +18790,9 @@ export interface IProfileSchema_2_0 {
|
|
|
17615
18790
|
profilepic: "string";
|
|
17616
18791
|
prevent_data_collection: "boolean";
|
|
17617
18792
|
accepted_gdpr: "boolean";
|
|
18793
|
+
privacy_policy: "object";
|
|
17618
18794
|
goals: "object";
|
|
18795
|
+
memories: "object";
|
|
17619
18796
|
[key: string]: "string" | "boolean" | "number" | "object";
|
|
17620
18797
|
};
|
|
17621
18798
|
details: IProfileSchemaEntry_2_0[];
|
|
@@ -18258,6 +19435,50 @@ export interface IDeleteConversationRestRestData_2_0 extends IDeleteConversation
|
|
|
18258
19435
|
}
|
|
18259
19436
|
export interface IDeleteConversationRestRestReturnValue_2_0 {
|
|
18260
19437
|
}
|
|
19438
|
+
/**
|
|
19439
|
+
* @openapi
|
|
19440
|
+
*
|
|
19441
|
+
* components:
|
|
19442
|
+
* schemas:
|
|
19443
|
+
* IKnowledgeQueryCounterAggregatedValue_2_0:
|
|
19444
|
+
* type: object
|
|
19445
|
+
* properties:
|
|
19446
|
+
* queries:
|
|
19447
|
+
* type: number
|
|
19448
|
+
* day:
|
|
19449
|
+
* type: number
|
|
19450
|
+
* month:
|
|
19451
|
+
* type: number
|
|
19452
|
+
* year:
|
|
19453
|
+
* type: number
|
|
19454
|
+
*/
|
|
19455
|
+
export interface IKnowledgeQueryCounterAggregatedValue_2_0 {
|
|
19456
|
+
/** The number of queries in the time-span */
|
|
19457
|
+
queries: number;
|
|
19458
|
+
/** The day, e.g. 1 for the first day in the month */
|
|
19459
|
+
day: number;
|
|
19460
|
+
/** The month of the year, e.g. 1 for January */
|
|
19461
|
+
month: number;
|
|
19462
|
+
/** The year, e.g. 2020 */
|
|
19463
|
+
year: number;
|
|
19464
|
+
}
|
|
19465
|
+
export interface IGetKnowledgeQueryCounterRestDataParams_2_0 {
|
|
19466
|
+
projectId: string;
|
|
19467
|
+
}
|
|
19468
|
+
export interface IGetKnowledgeQueryCounterRestData_2_0 extends IGetKnowledgeQueryCounterRestDataParams_2_0 {
|
|
19469
|
+
year: number;
|
|
19470
|
+
month: number;
|
|
19471
|
+
}
|
|
19472
|
+
export interface IGetKnowledgeQueryCounterRestReturnValue_2_0 {
|
|
19473
|
+
items: IKnowledgeQueryCounterAggregatedValue_2_0[];
|
|
19474
|
+
}
|
|
19475
|
+
export interface IGetKnowledgeQueryCounterOrganisationRestData_2_0 {
|
|
19476
|
+
year: number;
|
|
19477
|
+
month: number;
|
|
19478
|
+
}
|
|
19479
|
+
export interface IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0 {
|
|
19480
|
+
items: IKnowledgeQueryCounterAggregatedValue_2_0[];
|
|
19481
|
+
}
|
|
18261
19482
|
export interface MetricsAPIGroup_2_0 {
|
|
18262
19483
|
indexTasks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexTasksRestData_2_0>, IIndexTasksRestReturnValue_2_0>;
|
|
18263
19484
|
readTask: TRestAPIOperation<IReadTaskRestData_2_0, IReadTaskRestReturnValue_2_0>;
|
|
@@ -18284,6 +19505,8 @@ export interface MetricsAPIGroup_2_0 {
|
|
|
18284
19505
|
batchTrainerRecords: TRestAPIOperation<IBatchTrainerRecordsRestData_2_0, IBatchTrainerRecordsRestReturnValue_2_0>;
|
|
18285
19506
|
getConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_2_0, IGetConversationCounterRestReturnValue_2_0>;
|
|
18286
19507
|
getConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_2_0, IGetConversationCounterOrganisationRestReturnValue_2_0>;
|
|
19508
|
+
getKnowledgeQueryCounter: TRestAPIOperation<IGetKnowledgeQueryCounterRestData_2_0, IGetKnowledgeQueryCounterRestReturnValue_2_0>;
|
|
19509
|
+
getKnowledgeQueryCounterOrganisation: TRestAPIOperation<IGetKnowledgeQueryCounterOrganisationRestData_2_0, IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0>;
|
|
18287
19510
|
indexConversations: TRestAPIOperation<IIndexConversationsRestRestData_2_0, IIndexConversationsRestRestReturnValue_2_0>;
|
|
18288
19511
|
readConversation: TRestAPIOperation<IReadConversationRestRestData_2_0, IReadConversationRestRestReturnValue_2_0>;
|
|
18289
19512
|
deleteConversation: TRestAPIOperation<IDeleteConversationRestRestData_2_0, IDeleteConversationRestRestReturnValue_2_0>;
|
|
@@ -18302,6 +19525,7 @@ export declare type IInjectRestReturnValue_2_0 = string;
|
|
|
18302
19525
|
export interface INotifyRestDataBody_2_0 {
|
|
18303
19526
|
text: string;
|
|
18304
19527
|
data: object;
|
|
19528
|
+
attachments?: TAttachments[];
|
|
18305
19529
|
URLToken: string;
|
|
18306
19530
|
userId: string;
|
|
18307
19531
|
sessionId: string;
|
|
@@ -18603,7 +19827,7 @@ declare const actionTypes: readonly [
|
|
|
18603
19827
|
"cancelTask",
|
|
18604
19828
|
"changePlaybookStepOrder",
|
|
18605
19829
|
"cloneFlow",
|
|
18606
|
-
"
|
|
19830
|
+
"cloneGoal",
|
|
18607
19831
|
"cloneLargeLanguageModel",
|
|
18608
19832
|
"configureIdentityProvider",
|
|
18609
19833
|
"createKnowledgeSearchIndex",
|
|
@@ -18614,6 +19838,7 @@ declare const actionTypes: readonly [
|
|
|
18614
19838
|
"deprecatePassword",
|
|
18615
19839
|
"exportLexicons",
|
|
18616
19840
|
"followSession",
|
|
19841
|
+
"hireAiAgent",
|
|
18617
19842
|
"importIntents",
|
|
18618
19843
|
"importIntoLexicon",
|
|
18619
19844
|
"ingestKnowledgeStore",
|
|
@@ -18715,8 +19940,9 @@ export declare type TActionType = typeof actionTypes[number];
|
|
|
18715
19940
|
* - trainerRecord
|
|
18716
19941
|
* - user
|
|
18717
19942
|
* - yesNoIntent
|
|
19943
|
+
* - aiAgent
|
|
18718
19944
|
*/
|
|
18719
|
-
export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
|
|
19945
|
+
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" | "aiAgent";
|
|
18720
19946
|
/**
|
|
18721
19947
|
* @openapi
|
|
18722
19948
|
* components:
|
|
@@ -19571,193 +20797,32 @@ export interface IRequestOrganisationDeletionRestReturnValue_2_0 extends Omit<IO
|
|
|
19571
20797
|
declare const servicesNames: readonly [
|
|
19572
20798
|
"service-api",
|
|
19573
20799
|
"service-resources",
|
|
19574
|
-
"service-journeys",
|
|
19575
20800
|
"service-logs",
|
|
19576
|
-
"service-profiles",
|
|
19577
|
-
"service-security",
|
|
19578
|
-
"service-trainer",
|
|
19579
|
-
"service-handover",
|
|
19580
|
-
"service-task-manager",
|
|
19581
|
-
"service-app-session-manager",
|
|
19582
|
-
"service-session-state-manager",
|
|
19583
|
-
"service-function-scheduler",
|
|
19584
|
-
"service-alexa-management",
|
|
19585
|
-
"service-runtime-file-manager"
|
|
19586
|
-
];
|
|
19587
|
-
export declare type TServicesNames = typeof servicesNames[number];
|
|
19588
|
-
export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
|
|
19589
|
-
[key in keyof TServicesNames]: string[];
|
|
19590
|
-
};
|
|
19591
|
-
export interface
|
|
19592
|
-
|
|
19593
|
-
}
|
|
19594
|
-
export interface ISetupVoiceGatewayRestDataBody_2_0 {
|
|
19595
|
-
accountSid: string;
|
|
19596
|
-
}
|
|
19597
|
-
export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
|
|
19598
|
-
}
|
|
19599
|
-
export interface AdministrationAPIGroup_2_0 {
|
|
19600
|
-
requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
|
|
19601
|
-
validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
|
|
19602
|
-
resetPassword: TRestAPIOperation<IResetPasswordRestData_2_0, IResetPasswordRestReturnValue_2_0>;
|
|
19603
|
-
changePassword: TRestAPIOperation<IChangePasswordRestData_2_0, IChangePasswordRestReturnValue_2_0>;
|
|
19604
|
-
setSystemLicense: TRestAPIOperation<ISetSystemLicenseRestData_2_0, ISetSystemLicenseRestReturnValue_2_0>;
|
|
19605
|
-
getSystemLicenseState: TRestAPIOperation<void, IGetSystemLicenseStateRestReturnValue_2_0>;
|
|
19606
|
-
getSystemMessage: TRestAPIOperation<void, IGetSystemMessageRestReturnValue_2_0>;
|
|
19607
|
-
indexAuditEvents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAuditEventsRestData_2_0>, IIndexAuditEventsRestReturnValue_2_0>;
|
|
19608
|
-
readAuditEvent: TRestAPIOperation<IReadAuditEventRestData_2_0, IReadAuditEventRestReturnValue_2_0>;
|
|
19609
|
-
logoutUser: TRestAPIOperation<ILogoutUserRestData_2_0, ILogoutUserRestReturnValue_2_0>;
|
|
19610
|
-
resetFailedLoginAttempts: TRestAPIOperation<IResetFailedLoginAttemptsRestData_2_0, IResetFailedLoginAttemptsRestReturnValue_2_0>;
|
|
19611
|
-
readLastLoginAttemptMe: TRestAPIOperation<void, IReadLastLoginAttemptRestReturnValue_2_0>;
|
|
19612
|
-
indexLoginAttemptsMe: TRestAPIOperation<IIndexLoginAttemptsRestData_2_0, IIndexLoginAttemptsRestReturnValue_2_0>;
|
|
19613
|
-
deprecatePassword: TRestAPIOperation<IDeprecatePasswordRestData_2_0, IDeprecatePasswordRestReturnValue_2_0>;
|
|
19614
|
-
indexUsers: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestData_2_0>, IIndexUsersRestReturnValue_2_0>;
|
|
19615
|
-
createUser: TRestAPIOperation<ICreateUserRestData_2_0, ICreateUserRestReturnValue_2_0>;
|
|
19616
|
-
readUserMe: TRestAPIOperation<void, IReadUserMeRestReturnValue_2_0>;
|
|
19617
|
-
readUser: TRestAPIOperation<IReadUserRestData_2_0, IReadUserRestReturnValue_2_0>;
|
|
19618
|
-
updateUser: TRestAPIOperation<IUpdateUserRestData_2_0, IUpdateUserRestReturnValue_2_0>;
|
|
19619
|
-
updateUserMe: TRestAPIOperation<IUpdateUserMeRestData_2_0, IUpdateUserMeRestReturnValue_2_0>;
|
|
19620
|
-
deleteUser: TRestAPIOperation<IDeleteUserRestData_2_0, IDeleteUserRestReturnValue_2_0>;
|
|
19621
|
-
deleteUserMe: TRestAPIOperation<void, void>;
|
|
19622
|
-
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_0, ICreateApiKeyMeRestReturnValue_2_0>;
|
|
19623
|
-
deleteApiKeyMe: TRestAPIOperation<IDeleteApiKeyMeRestData_2_0, IDeleteApiKeyMeRestReturnValue_2_0>;
|
|
19624
|
-
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_0, IIndexApiKeysMeRestReturnValue_2_0>;
|
|
19625
|
-
addRoleToUser: TRestAPIOperation<IAddRoleToUserRestData_2_0, IAddRoleToUserRestReturnValue_2_0>;
|
|
19626
|
-
removeRoleFromUser: TRestAPIOperation<IRemoveRoleFromUserRestData_2_0, IRemoveRoleFromUserRestReturnValue_2_0>;
|
|
19627
|
-
readUserAclMe: TRestAPIOperation<void, IReadUserAclMeRestReturnValue_2_0>;
|
|
19628
|
-
acceptTermsOfService: TRestAPIOperation;
|
|
19629
|
-
indexProjectMembers: TRestAPIOperation<IIndexProjectMembersRestData_2_0, IIndexProjectMembersRestReturnValue_2_0>;
|
|
19630
|
-
readProjectMember: TRestAPIOperation<IReadProjectMemberRestData_2_0, IReadProjectMemberRestReturnValue_2_0>;
|
|
19631
|
-
addProjectMember: TRestAPIOperation<IAddProjectMemberRestData_2_0, IAddProjectMemberRestReturnValue_2_0>;
|
|
19632
|
-
updateProjectMember: TRestAPIOperation<IUpdateProjectMemberRestData_2_0, IUpdateProjectMemberRestReturnValue_2_0>;
|
|
19633
|
-
removeProjectMember: TRestAPIOperation<IRemoveProjectMemberRestData_2_0, IRemoveProjectMemberRestReturnValue_2_0>;
|
|
19634
|
-
addRoleToMember: TRestAPIOperation<IAddRoleToMemberRestData_2_0, IAddRoleToMemberRestReturnValue_2_0>;
|
|
19635
|
-
removeRoleFromMember: TRestAPIOperation<IRemoveRoleFromMemberRestData_2_0, IRemoveRoleFromMemberRestReturnValue_2_0>;
|
|
19636
|
-
addProjectToUser: TRestAPIOperation<IAddProjectToUserRestData_2_0, IAddProjectToUserRestReturnValue_2_0>;
|
|
19637
|
-
removeProjectFromUser: TRestAPIOperation<IRemoveProjectFromUserRestData_2_0, IRemoveProjectFromUserRestReturnValue_2_0>;
|
|
19638
|
-
configureIdentityProvider: TRestAPIOperation<IConfigureIdentityProviderRestData_2_0, IConfigureIdentityProviderRestReturnValue_2_0>;
|
|
19639
|
-
resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
|
|
19640
|
-
setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
|
|
19641
|
-
setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
19642
|
-
updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
19643
|
-
readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
|
|
19644
|
-
readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
|
|
19645
|
-
requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
|
|
19646
|
-
readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
|
|
19647
|
-
setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
|
|
19648
|
-
readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
|
|
19649
|
-
}
|
|
19650
|
-
declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
|
|
19651
|
-
/**
|
|
19652
|
-
* @openapi
|
|
19653
|
-
*
|
|
19654
|
-
* components:
|
|
19655
|
-
* schemas:
|
|
19656
|
-
* IApiKeyIndexItem_2_1:
|
|
19657
|
-
* type: object
|
|
19658
|
-
* properties:
|
|
19659
|
-
* _id:
|
|
19660
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
19661
|
-
* name:
|
|
19662
|
-
* type: string
|
|
19663
|
-
* createdAt:
|
|
19664
|
-
* type: number
|
|
19665
|
-
*/
|
|
19666
|
-
export interface IApiKeyIndexItem_2_1 {
|
|
19667
|
-
/** The object id of the api-key */
|
|
19668
|
-
_id: TMongoId;
|
|
19669
|
-
/** The name of the api-key, e.g. 'my demo' */
|
|
19670
|
-
name: string;
|
|
19671
|
-
createdAt: number;
|
|
19672
|
-
schemaVersion: number;
|
|
19673
|
-
}
|
|
19674
|
-
export interface IIndexApiKeysMeRestData_2_1 extends IRestPagination<IApiKeyIndexItem_2_1> {
|
|
19675
|
-
}
|
|
19676
|
-
export interface IIndexApiKeysMeRestReturnValue_2_1 extends ICursorBasedPaginationReturnValue<IApiKeyIndexItem_2_1> {
|
|
19677
|
-
}
|
|
19678
|
-
/**
|
|
19679
|
-
* @openapi
|
|
19680
|
-
*
|
|
19681
|
-
* components:
|
|
19682
|
-
* schemas:
|
|
19683
|
-
* IApiKeyData_2_1:
|
|
19684
|
-
* type: object
|
|
19685
|
-
* properties:
|
|
19686
|
-
* name:
|
|
19687
|
-
* type: string
|
|
19688
|
-
*
|
|
19689
|
-
* IApiKey_2_1:
|
|
19690
|
-
* allOf:
|
|
19691
|
-
* - $ref: '#/components/schemas/IApiKeyData_2_1'
|
|
19692
|
-
* - type: object
|
|
19693
|
-
* properties:
|
|
19694
|
-
* _id:
|
|
19695
|
-
* $ref: '#/components/schemas/TMongoId'
|
|
19696
|
-
* createdAt:
|
|
19697
|
-
* type: integer
|
|
19698
|
-
* minimum: 0
|
|
19699
|
-
* maximum: 2147483647
|
|
19700
|
-
* example: 1527621049
|
|
19701
|
-
* apiKey:
|
|
19702
|
-
* type: string
|
|
19703
|
-
*/
|
|
19704
|
-
export interface IApiKey_2_1 {
|
|
19705
|
-
/** The object id of the api-key */
|
|
19706
|
-
_id: TMongoId;
|
|
19707
|
-
/** The name of the api-key, e.g. 'my demo' */
|
|
19708
|
-
name: string;
|
|
19709
|
-
/** The actual api-key */
|
|
19710
|
-
apiKey: string;
|
|
19711
|
-
createdAt: number;
|
|
19712
|
-
schemaVersion: number;
|
|
19713
|
-
}
|
|
19714
|
-
export interface ICreateApiKeyMeRestDataBody_2_1 extends Partial<Omit<IApiKey_2_1, keyof IEntityMeta | "apiKey">> {
|
|
19715
|
-
}
|
|
19716
|
-
export interface ICreateApiKeyMeRestData_2_1 extends ICreateApiKeyMeRestDataBody_2_1 {
|
|
19717
|
-
}
|
|
19718
|
-
export interface ICreateApiKeyMeRestReturnValue_2_1 extends IApiKey_2_1 {
|
|
20801
|
+
"service-profiles",
|
|
20802
|
+
"service-security",
|
|
20803
|
+
"service-trainer",
|
|
20804
|
+
"service-handover",
|
|
20805
|
+
"service-task-manager",
|
|
20806
|
+
"service-app-session-manager",
|
|
20807
|
+
"service-session-state-manager",
|
|
20808
|
+
"service-function-scheduler",
|
|
20809
|
+
"service-alexa-management",
|
|
20810
|
+
"service-runtime-file-manager"
|
|
20811
|
+
];
|
|
20812
|
+
export declare type TServicesNames = typeof servicesNames[number];
|
|
20813
|
+
export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
|
|
20814
|
+
[key in keyof TServicesNames]: string[];
|
|
20815
|
+
};
|
|
20816
|
+
export interface IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0 {
|
|
20817
|
+
chunkCount: number;
|
|
19719
20818
|
}
|
|
19720
|
-
export interface
|
|
19721
|
-
|
|
19722
|
-
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_1, IIndexApiKeysMeRestReturnValue_2_1>;
|
|
20819
|
+
export interface IReadVoiceGatewayAccountRestReturnValue_2_0 {
|
|
20820
|
+
voiceGatewayAccount: string;
|
|
19723
20821
|
}
|
|
19724
|
-
|
|
19725
|
-
|
|
19726
|
-
* @openapi
|
|
19727
|
-
*
|
|
19728
|
-
* components:
|
|
19729
|
-
* schemas:
|
|
19730
|
-
* IVendor_2_0:
|
|
19731
|
-
* type: object
|
|
19732
|
-
* properties:
|
|
19733
|
-
* version:
|
|
19734
|
-
* type: string
|
|
19735
|
-
* description: The product version we are running
|
|
19736
|
-
* frontendBaseUrl:
|
|
19737
|
-
* type: string
|
|
19738
|
-
* description: Base URL to the frontend UI
|
|
19739
|
-
* hasLicenseAgreement:
|
|
19740
|
-
* type: string
|
|
19741
|
-
* description: Flag whether users need to agree the license agreement within this env
|
|
19742
|
-
* maxContactProfileTTL:
|
|
19743
|
-
* type: number
|
|
19744
|
-
* maxConversationTTL:
|
|
19745
|
-
* type: number
|
|
19746
|
-
* maxSessionStateTTL:
|
|
19747
|
-
* type: number
|
|
19748
|
-
*/
|
|
19749
|
-
export interface IVendor_2_0 {
|
|
19750
|
-
/** The COGNIGY.AI version we are running */
|
|
19751
|
-
version: string;
|
|
19752
|
-
/** Base URL to the frontend UI */
|
|
19753
|
-
frontendBaseUrl: string;
|
|
19754
|
-
/** Flag whether users need to agree the license agreement within this env */
|
|
19755
|
-
hasLicenseAgreement: boolean;
|
|
19756
|
-
maxContactProfileTTL: number;
|
|
19757
|
-
maxConversationTTL: number;
|
|
19758
|
-
maxSessionStateTTL: number;
|
|
20822
|
+
export interface ISetupVoiceGatewayRestDataBody_2_0 {
|
|
20823
|
+
accountSid: string;
|
|
19759
20824
|
}
|
|
19760
|
-
export interface
|
|
20825
|
+
export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
|
|
19761
20826
|
}
|
|
19762
20827
|
/**
|
|
19763
20828
|
* @openapi
|
|
@@ -19778,6 +20843,8 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
|
|
|
19778
20843
|
* type: number
|
|
19779
20844
|
* quotaMaxMessagesPerDay:
|
|
19780
20845
|
* type: number
|
|
20846
|
+
* quotaMaxKnowledgeChunks:
|
|
20847
|
+
* type: number
|
|
19781
20848
|
* passwordPolicy:
|
|
19782
20849
|
* $ref: '#/components/schemas/IOrganisationPasswordPolicy_2_0'
|
|
19783
20850
|
* sessionStateTTLInMinutes:
|
|
@@ -19921,6 +20988,8 @@ export interface IOrganisationDataPrivacySettings_2_0 {
|
|
|
19921
20988
|
* type: number
|
|
19922
20989
|
* quotaMaxMessagesPerDay:
|
|
19923
20990
|
* type: number
|
|
20991
|
+
* quotaMaxKnowledgeChunks:
|
|
20992
|
+
* type: number
|
|
19924
20993
|
* passwordPolicy:
|
|
19925
20994
|
* $ref: '#/components/schemas/IOrganisationPasswordPolicy_2_0'
|
|
19926
20995
|
* sessionStateTTLInMinutes:
|
|
@@ -19948,6 +21017,7 @@ export interface IOrganisationIndexItem_2_0 {
|
|
|
19948
21017
|
quotaMaxUsers: number;
|
|
19949
21018
|
quotaMaxChannelsPerProject: number;
|
|
19950
21019
|
quotaMaxMessagesPerDay: number;
|
|
21020
|
+
quotaMaxKnowledgeChunks: number;
|
|
19951
21021
|
passwordPolicy: IOrganisationPasswordPolicy_2_0;
|
|
19952
21022
|
billingTimezone: string;
|
|
19953
21023
|
sessionStateTTLInMinutes: number;
|
|
@@ -20017,6 +21087,221 @@ export interface IDeleteOrganisationRestData_2_0 extends IDeleteOrganisationRest
|
|
|
20017
21087
|
}
|
|
20018
21088
|
export interface IDeleteOrganisationRestReturnValue_2_0 {
|
|
20019
21089
|
}
|
|
21090
|
+
/**
|
|
21091
|
+
* @openapi
|
|
21092
|
+
*
|
|
21093
|
+
* components:
|
|
21094
|
+
* schemas:
|
|
21095
|
+
* IPinResourceRestDataBody_2_0:
|
|
21096
|
+
* type: object
|
|
21097
|
+
* properties:
|
|
21098
|
+
* resourceType:
|
|
21099
|
+
* $ref: '#/components/schemas/TPinnableResourceType'
|
|
21100
|
+
* resourceId:
|
|
21101
|
+
* $ref: '#/components/schemas/TMongoId'
|
|
21102
|
+
* pin:
|
|
21103
|
+
* type: boolean
|
|
21104
|
+
* */
|
|
21105
|
+
export interface IPinResourceRestDataBody_2_0 {
|
|
21106
|
+
resourceType: TPinnableResourceType;
|
|
21107
|
+
resourceId: TMongoId;
|
|
21108
|
+
pin: boolean;
|
|
21109
|
+
}
|
|
21110
|
+
export interface IPinResourceRestData_2_0 extends IPinResourceRestDataBody_2_0 {
|
|
21111
|
+
}
|
|
21112
|
+
export interface IPinResourceRestReturnValue_2_0 {
|
|
21113
|
+
}
|
|
21114
|
+
export interface IGetPinnedResourcesRestDataQuery_2_0 {
|
|
21115
|
+
resourceType: TPinnableResourceType;
|
|
21116
|
+
}
|
|
21117
|
+
export interface IGetPinnedResourcesRestData_2_0 extends IGetPinnedResourcesRestDataQuery_2_0 {
|
|
21118
|
+
}
|
|
21119
|
+
/**
|
|
21120
|
+
* @openapi
|
|
21121
|
+
*
|
|
21122
|
+
* components:
|
|
21123
|
+
* schemas:
|
|
21124
|
+
* IGetPinnedResourcesRestReturnValue_2_0:
|
|
21125
|
+
* type: object
|
|
21126
|
+
* properties:
|
|
21127
|
+
* type:
|
|
21128
|
+
* $ref: '#/components/schemas/TPinnableResourceType'
|
|
21129
|
+
* pinnedIds:
|
|
21130
|
+
* type: array
|
|
21131
|
+
* items:
|
|
21132
|
+
* $ref: '#/components/schemas/TMongoId'
|
|
21133
|
+
*/
|
|
21134
|
+
export interface IGetPinnedResourcesRestReturnValue_2_0 {
|
|
21135
|
+
type: TPinnableResourceType;
|
|
21136
|
+
pinnedIds: TMongoId[];
|
|
21137
|
+
}
|
|
21138
|
+
export interface AdministrationAPIGroup_2_0 {
|
|
21139
|
+
requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
|
|
21140
|
+
validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
|
|
21141
|
+
resetPassword: TRestAPIOperation<IResetPasswordRestData_2_0, IResetPasswordRestReturnValue_2_0>;
|
|
21142
|
+
changePassword: TRestAPIOperation<IChangePasswordRestData_2_0, IChangePasswordRestReturnValue_2_0>;
|
|
21143
|
+
setSystemLicense: TRestAPIOperation<ISetSystemLicenseRestData_2_0, ISetSystemLicenseRestReturnValue_2_0>;
|
|
21144
|
+
getSystemLicenseState: TRestAPIOperation<void, IGetSystemLicenseStateRestReturnValue_2_0>;
|
|
21145
|
+
getSystemMessage: TRestAPIOperation<void, IGetSystemMessageRestReturnValue_2_0>;
|
|
21146
|
+
indexAuditEvents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAuditEventsRestData_2_0>, IIndexAuditEventsRestReturnValue_2_0>;
|
|
21147
|
+
readAuditEvent: TRestAPIOperation<IReadAuditEventRestData_2_0, IReadAuditEventRestReturnValue_2_0>;
|
|
21148
|
+
logoutUser: TRestAPIOperation<ILogoutUserRestData_2_0, ILogoutUserRestReturnValue_2_0>;
|
|
21149
|
+
resetFailedLoginAttempts: TRestAPIOperation<IResetFailedLoginAttemptsRestData_2_0, IResetFailedLoginAttemptsRestReturnValue_2_0>;
|
|
21150
|
+
readLastLoginAttemptMe: TRestAPIOperation<void, IReadLastLoginAttemptRestReturnValue_2_0>;
|
|
21151
|
+
indexLoginAttemptsMe: TRestAPIOperation<IIndexLoginAttemptsRestData_2_0, IIndexLoginAttemptsRestReturnValue_2_0>;
|
|
21152
|
+
deprecatePassword: TRestAPIOperation<IDeprecatePasswordRestData_2_0, IDeprecatePasswordRestReturnValue_2_0>;
|
|
21153
|
+
indexUsers: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestData_2_0>, IIndexUsersRestReturnValue_2_0>;
|
|
21154
|
+
createUser: TRestAPIOperation<ICreateUserRestData_2_0, ICreateUserRestReturnValue_2_0>;
|
|
21155
|
+
readUserMe: TRestAPIOperation<void, IReadUserMeRestReturnValue_2_0>;
|
|
21156
|
+
readUser: TRestAPIOperation<IReadUserRestData_2_0, IReadUserRestReturnValue_2_0>;
|
|
21157
|
+
updateUser: TRestAPIOperation<IUpdateUserRestData_2_0, IUpdateUserRestReturnValue_2_0>;
|
|
21158
|
+
updateUserMe: TRestAPIOperation<IUpdateUserMeRestData_2_0, IUpdateUserMeRestReturnValue_2_0>;
|
|
21159
|
+
deleteUser: TRestAPIOperation<IDeleteUserRestData_2_0, IDeleteUserRestReturnValue_2_0>;
|
|
21160
|
+
deleteUserMe: TRestAPIOperation<void, void>;
|
|
21161
|
+
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_0, ICreateApiKeyMeRestReturnValue_2_0>;
|
|
21162
|
+
deleteApiKeyMe: TRestAPIOperation<IDeleteApiKeyMeRestData_2_0, IDeleteApiKeyMeRestReturnValue_2_0>;
|
|
21163
|
+
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_0, IIndexApiKeysMeRestReturnValue_2_0>;
|
|
21164
|
+
addRoleToUser: TRestAPIOperation<IAddRoleToUserRestData_2_0, IAddRoleToUserRestReturnValue_2_0>;
|
|
21165
|
+
removeRoleFromUser: TRestAPIOperation<IRemoveRoleFromUserRestData_2_0, IRemoveRoleFromUserRestReturnValue_2_0>;
|
|
21166
|
+
readUserAclMe: TRestAPIOperation<void, IReadUserAclMeRestReturnValue_2_0>;
|
|
21167
|
+
acceptTermsOfService: TRestAPIOperation;
|
|
21168
|
+
indexProjectMembers: TRestAPIOperation<IIndexProjectMembersRestData_2_0, IIndexProjectMembersRestReturnValue_2_0>;
|
|
21169
|
+
readProjectMember: TRestAPIOperation<IReadProjectMemberRestData_2_0, IReadProjectMemberRestReturnValue_2_0>;
|
|
21170
|
+
addProjectMember: TRestAPIOperation<IAddProjectMemberRestData_2_0, IAddProjectMemberRestReturnValue_2_0>;
|
|
21171
|
+
updateProjectMember: TRestAPIOperation<IUpdateProjectMemberRestData_2_0, IUpdateProjectMemberRestReturnValue_2_0>;
|
|
21172
|
+
removeProjectMember: TRestAPIOperation<IRemoveProjectMemberRestData_2_0, IRemoveProjectMemberRestReturnValue_2_0>;
|
|
21173
|
+
addRoleToMember: TRestAPIOperation<IAddRoleToMemberRestData_2_0, IAddRoleToMemberRestReturnValue_2_0>;
|
|
21174
|
+
removeRoleFromMember: TRestAPIOperation<IRemoveRoleFromMemberRestData_2_0, IRemoveRoleFromMemberRestReturnValue_2_0>;
|
|
21175
|
+
addProjectToUser: TRestAPIOperation<IAddProjectToUserRestData_2_0, IAddProjectToUserRestReturnValue_2_0>;
|
|
21176
|
+
removeProjectFromUser: TRestAPIOperation<IRemoveProjectFromUserRestData_2_0, IRemoveProjectFromUserRestReturnValue_2_0>;
|
|
21177
|
+
configureIdentityProvider: TRestAPIOperation<IConfigureIdentityProviderRestData_2_0, IConfigureIdentityProviderRestReturnValue_2_0>;
|
|
21178
|
+
resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
|
|
21179
|
+
setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
|
|
21180
|
+
setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
21181
|
+
updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
|
|
21182
|
+
readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
|
|
21183
|
+
readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
|
|
21184
|
+
requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
|
|
21185
|
+
readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
|
|
21186
|
+
setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
|
|
21187
|
+
readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
|
|
21188
|
+
readOrganisationPolicies: TRestAPIOperation<void, IReadOrganisationRestReturnValue_2_0>;
|
|
21189
|
+
readOrganisationKnowledgeChunksCount: TRestAPIOperation<void, IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0>;
|
|
21190
|
+
pinResourceMe: TRestAPIOperation<IPinResourceRestData_2_0, IPinResourceRestReturnValue_2_0>;
|
|
21191
|
+
getPinnedResourcesMe: TRestAPIOperation<IGetPinnedResourcesRestData_2_0, IGetPinnedResourcesRestReturnValue_2_0>;
|
|
21192
|
+
}
|
|
21193
|
+
declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
|
|
21194
|
+
/**
|
|
21195
|
+
* @openapi
|
|
21196
|
+
*
|
|
21197
|
+
* components:
|
|
21198
|
+
* schemas:
|
|
21199
|
+
* IApiKeyIndexItem_2_1:
|
|
21200
|
+
* type: object
|
|
21201
|
+
* properties:
|
|
21202
|
+
* _id:
|
|
21203
|
+
* $ref: '#/components/schemas/TMongoId'
|
|
21204
|
+
* name:
|
|
21205
|
+
* type: string
|
|
21206
|
+
* createdAt:
|
|
21207
|
+
* type: number
|
|
21208
|
+
*/
|
|
21209
|
+
export interface IApiKeyIndexItem_2_1 {
|
|
21210
|
+
/** The object id of the api-key */
|
|
21211
|
+
_id: TMongoId;
|
|
21212
|
+
/** The name of the api-key, e.g. 'my demo' */
|
|
21213
|
+
name: string;
|
|
21214
|
+
createdAt: number;
|
|
21215
|
+
schemaVersion: number;
|
|
21216
|
+
}
|
|
21217
|
+
export interface IIndexApiKeysMeRestData_2_1 extends IRestPagination<IApiKeyIndexItem_2_1> {
|
|
21218
|
+
}
|
|
21219
|
+
export interface IIndexApiKeysMeRestReturnValue_2_1 extends ICursorBasedPaginationReturnValue<IApiKeyIndexItem_2_1> {
|
|
21220
|
+
}
|
|
21221
|
+
/**
|
|
21222
|
+
* @openapi
|
|
21223
|
+
*
|
|
21224
|
+
* components:
|
|
21225
|
+
* schemas:
|
|
21226
|
+
* IApiKeyData_2_1:
|
|
21227
|
+
* type: object
|
|
21228
|
+
* properties:
|
|
21229
|
+
* name:
|
|
21230
|
+
* type: string
|
|
21231
|
+
*
|
|
21232
|
+
* IApiKey_2_1:
|
|
21233
|
+
* allOf:
|
|
21234
|
+
* - $ref: '#/components/schemas/IApiKeyData_2_1'
|
|
21235
|
+
* - type: object
|
|
21236
|
+
* properties:
|
|
21237
|
+
* _id:
|
|
21238
|
+
* $ref: '#/components/schemas/TMongoId'
|
|
21239
|
+
* createdAt:
|
|
21240
|
+
* type: integer
|
|
21241
|
+
* minimum: 0
|
|
21242
|
+
* maximum: 2147483647
|
|
21243
|
+
* example: 1527621049
|
|
21244
|
+
* apiKey:
|
|
21245
|
+
* type: string
|
|
21246
|
+
*/
|
|
21247
|
+
export interface IApiKey_2_1 {
|
|
21248
|
+
/** The object id of the api-key */
|
|
21249
|
+
_id: TMongoId;
|
|
21250
|
+
/** The name of the api-key, e.g. 'my demo' */
|
|
21251
|
+
name: string;
|
|
21252
|
+
/** The actual api-key */
|
|
21253
|
+
apiKey: string;
|
|
21254
|
+
createdAt: number;
|
|
21255
|
+
schemaVersion: number;
|
|
21256
|
+
}
|
|
21257
|
+
export interface ICreateApiKeyMeRestDataBody_2_1 extends Partial<Omit<IApiKey_2_1, keyof IEntityMeta | "apiKey">> {
|
|
21258
|
+
}
|
|
21259
|
+
export interface ICreateApiKeyMeRestData_2_1 extends ICreateApiKeyMeRestDataBody_2_1 {
|
|
21260
|
+
}
|
|
21261
|
+
export interface ICreateApiKeyMeRestReturnValue_2_1 extends IApiKey_2_1 {
|
|
21262
|
+
}
|
|
21263
|
+
export interface AdministrationAPIGroup_2_1 extends Omit<AdministrationAPIGroup_2_0, "createApiKeyMe" | "indexApiKeysMe"> {
|
|
21264
|
+
createApiKeyMe: TRestAPIOperation<ICreateApiKeyMeRestData_2_1, ICreateApiKeyMeRestReturnValue_2_1>;
|
|
21265
|
+
indexApiKeysMe: TRestAPIOperation<IIndexApiKeysMeRestData_2_1, IIndexApiKeysMeRestReturnValue_2_1>;
|
|
21266
|
+
}
|
|
21267
|
+
declare function AdministrationAPIGroup_2_1(instance: Base): AdministrationAPIGroup_2_1;
|
|
21268
|
+
/**
|
|
21269
|
+
* @openapi
|
|
21270
|
+
*
|
|
21271
|
+
* components:
|
|
21272
|
+
* schemas:
|
|
21273
|
+
* IVendor_2_0:
|
|
21274
|
+
* type: object
|
|
21275
|
+
* properties:
|
|
21276
|
+
* version:
|
|
21277
|
+
* type: string
|
|
21278
|
+
* description: The product version we are running
|
|
21279
|
+
* frontendBaseUrl:
|
|
21280
|
+
* type: string
|
|
21281
|
+
* description: Base URL to the frontend UI
|
|
21282
|
+
* hasLicenseAgreement:
|
|
21283
|
+
* type: string
|
|
21284
|
+
* description: Flag whether users need to agree the license agreement within this env
|
|
21285
|
+
* maxContactProfileTTL:
|
|
21286
|
+
* type: number
|
|
21287
|
+
* maxConversationTTL:
|
|
21288
|
+
* type: number
|
|
21289
|
+
* maxSessionStateTTL:
|
|
21290
|
+
* type: number
|
|
21291
|
+
*/
|
|
21292
|
+
export interface IVendor_2_0 {
|
|
21293
|
+
/** The COGNIGY.AI version we are running */
|
|
21294
|
+
version: string;
|
|
21295
|
+
/** Base URL to the frontend UI */
|
|
21296
|
+
frontendBaseUrl: string;
|
|
21297
|
+
/** Flag whether users need to agree the license agreement within this env */
|
|
21298
|
+
hasLicenseAgreement: boolean;
|
|
21299
|
+
maxContactProfileTTL: number;
|
|
21300
|
+
maxConversationTTL: number;
|
|
21301
|
+
maxSessionStateTTL: number;
|
|
21302
|
+
}
|
|
21303
|
+
export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
|
|
21304
|
+
}
|
|
20020
21305
|
export interface IGetBillingInformationRestData_2_0 extends IRestPagination<{
|
|
20021
21306
|
name: string;
|
|
20022
21307
|
isDisabled: boolean;
|
|
@@ -20143,6 +21428,7 @@ export interface IUserManagementIndexItem_2_0 {
|
|
|
20143
21428
|
lastChanged: number;
|
|
20144
21429
|
createdBy: TMongoId;
|
|
20145
21430
|
lastChangedBy: TMongoId;
|
|
21431
|
+
lastActive: number;
|
|
20146
21432
|
}
|
|
20147
21433
|
export interface IIndexUsersRestManagementData_2_0 extends IRestPagination<IUserManagementIndexItem_2_0>, IOrganisationScope {
|
|
20148
21434
|
}
|
|
@@ -20297,7 +21583,7 @@ export interface AnalyticsAPIGroup_2_0 {
|
|
|
20297
21583
|
updateAnalyticsRecords: TRestAPIOperation<IUpdateAnalyticsRecordsRestData_2_0, IUpdateAnalyticsRecordsRestReturnValue_2_0>;
|
|
20298
21584
|
}
|
|
20299
21585
|
declare function AnalyticsAPIGroup_2_0(instance: Base): AnalyticsAPIGroup_2_0;
|
|
20300
|
-
export declare type TRestAPIGroupsTypeByConfiguration<T extends IRestAPIClientConfig> = TResourceAPIVersionType<T> & TInsightsAPIVersionType<T> & TMetricsAPIVersionType<T> & TSessionAPIVersionType<T> & TExternalAPIVersionType<T> & TAdministrationAPIVersionType<T> & TManagementAPIVersionType<T> & TAnalyticsAPIVersionType<T>;
|
|
21586
|
+
export declare type TRestAPIGroupsTypeByConfiguration<T extends IRestAPIClientConfig> = TResourceAPIVersionType<T> & TJWTAuthAPIVersionType<T> & TInsightsAPIVersionType<T> & TMetricsAPIVersionType<T> & TSessionAPIVersionType<T> & TExternalAPIVersionType<T> & TAdministrationAPIVersionType<T> & TManagementAPIVersionType<T> & TAnalyticsAPIVersionType<T>;
|
|
20301
21587
|
export declare type TResourceAPIVersionType<T> = T extends {
|
|
20302
21588
|
versions: {
|
|
20303
21589
|
resources: "2.0";
|
|
@@ -20308,6 +21594,11 @@ export declare type TInsightsAPIVersionType<T> = T extends {
|
|
|
20308
21594
|
insights: "2.0";
|
|
20309
21595
|
};
|
|
20310
21596
|
} ? InsightsAPIGroup_2_0 : InsightsAPIGroup_2_0;
|
|
21597
|
+
export declare type TJWTAuthAPIVersionType<T> = T extends {
|
|
21598
|
+
versions: {
|
|
21599
|
+
jwt: "2.0";
|
|
21600
|
+
};
|
|
21601
|
+
} ? JWTAuthAPIGroup_2_0 : JWTAuthAPIGroup_2_0;
|
|
20311
21602
|
export declare type TMetricsAPIVersionType<T> = T extends {
|
|
20312
21603
|
versions: {
|
|
20313
21604
|
metrics: "1.0";
|