@cognigy/rest-api-client 0.15.0 → 0.17.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 +17 -0
- package/build/GenericTusFn.js +64 -0
- package/build/RestAPIClient.js +3 -0
- package/build/apigroups/AdministrationAPIGroup_2_0.js +7 -2
- package/build/apigroups/ResourcesAPIGroup_2_0.js +28 -23
- package/build/{shared/interfaces/agentAssist/ISendTileUpdateReferenceParams.js → apigroups/TTusAPIOperation.js} +1 -1
- package/build/apigroups/index.js +2 -0
- package/build/connector/AxiosAdapter.js +5 -4
- package/build/shared/charts/descriptors/agentAssist/constants/constants.js +7 -0
- package/build/shared/charts/descriptors/agentAssist/helpers/sentiment.helper.js +41 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/identityAssistTemplate.js +54 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +203 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/nextActionWidgetTemplate.js +93 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage0.js +81 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage1.js +84 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage2.js +97 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stageError.js +85 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/sentimentAnalysisTemplate.js +41 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/stylesPartial.js +15 -0
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/transcriptAssistTemplate.js +53 -0
- package/build/shared/charts/descriptors/agentAssist/identityAssist.js +135 -0
- package/build/shared/charts/descriptors/agentAssist/index.js +15 -1
- package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +625 -0
- package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +77 -0
- package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +86 -0
- package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js +2 -2
- package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +120 -0
- package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js +2 -2
- package/build/shared/charts/descriptors/agentAssist/setIframeTile.js +2 -2
- package/build/shared/charts/descriptors/agentAssist/setSecureFormsTile.js +171 -0
- package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +72 -0
- package/build/shared/charts/descriptors/allFields.js +12 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/TGenerativeAIConnectionFields.js +3 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/alephAlphaProviderConnection.js +11 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/anthropicProviderConnection.js +1 -1
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnectionV2.js +1 -1
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +6 -2
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +1 -1
- package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +4 -4
- package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/azureBlobStorageProviderConnection.js +3 -3
- package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/googleCloudStorageProviderConnection.js +3 -3
- package/build/shared/charts/descriptors/connectionNodes/mongoDB/mongoDBConnection.js +1 -1
- package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2Connection.js +8 -8
- package/build/shared/charts/descriptors/connectionNodes/smtp/serviceConnection.js +2 -2
- package/build/shared/charts/descriptors/connectionNodes/smtp/smtpConnection.js +5 -5
- package/build/shared/charts/descriptors/connectionNodes/speechProviders/awsSpeechProviderConnection.js +4 -4
- package/build/shared/charts/descriptors/connectionNodes/speechProviders/microsoftSpeechProviderConnection.js +2 -2
- package/build/shared/charts/descriptors/connectionNodes/sql/sqlConnection.js +5 -5
- package/build/shared/charts/descriptors/connectionNodes/translationProviders/deeplTranslationProviderConnection.js +15 -0
- package/build/shared/charts/descriptors/connectionNodes/translationProviders/googleTranslationProviderConnection.js +15 -0
- package/build/shared/charts/descriptors/connectionNodes/translationProviders/index.js +23 -0
- package/build/shared/charts/descriptors/connectionNodes/translationProviders/microsoftTranslationProviderConnection.js +21 -0
- package/build/shared/charts/descriptors/index.js +13 -2
- package/build/shared/charts/descriptors/knowledgeSearch/constants/constants.js +6 -0
- package/build/shared/charts/descriptors/knowledgeSearch/index.js +5 -1
- package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearch.js +7 -2
- package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearchV2.js +151 -0
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +985 -0
- package/build/shared/charts/descriptors/logic/goTo.js +2 -0
- package/build/shared/charts/descriptors/message/question/optionalQuestion.js +2 -2
- package/build/shared/charts/descriptors/message/question/question.js +215 -8
- package/build/shared/charts/descriptors/nlu/cleanText.js +1 -0
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +107 -5
- package/build/shared/charts/descriptors/service/GPTConversation.js +125 -23
- package/build/shared/charts/descriptors/service/GPTPrompt.js +148 -12
- package/build/shared/charts/descriptors/service/checkAgentAvailability.js +15 -1
- package/build/shared/charts/descriptors/service/handoverV2.js +45 -0
- package/build/shared/{interfaces/twilioInterface.js → charts/descriptors/voice/interface/IBandwidth.js} +1 -1
- package/build/shared/charts/descriptors/voice/mappers/base.mapper.js +14 -0
- package/build/shared/charts/descriptors/voice/mappers/hangup.mapper.js +26 -0
- package/build/shared/charts/descriptors/voice/mappers/muteSpeechInput.mapper.js +17 -2
- package/build/shared/charts/descriptors/voice/mappers/play.mapper.js +54 -0
- package/build/shared/charts/descriptors/voice/mappers/record.mapper.js +7 -0
- package/build/shared/charts/descriptors/voice/mappers/sendMetadata.mapper.js +15 -0
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +56 -20
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +39 -13
- package/build/shared/charts/descriptors/voice/nodes/muteSpeechInput.js +1 -1
- package/build/shared/charts/descriptors/voice/nodes/play.js +1 -1
- package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +120 -29
- package/build/shared/charts/descriptors/voice/nodes/transfer.js +11 -3
- package/build/shared/charts/descriptors/voice/utils/vgConstants.js +14 -0
- package/build/shared/charts/descriptors/voicegateway/index.js +14 -11
- package/build/shared/charts/descriptors/voicegateway/utils/paramUtils.js +1 -5
- package/build/shared/charts/descriptors/voicegateway2/nodes/muteSpeechInput.js +12 -1
- package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +6 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +159 -36
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +296 -43
- package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +30 -4
- package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +1 -1
- package/build/shared/constants.js +5 -1
- package/build/shared/handoverClients/interfaces/THandoverEventType.js +3 -1
- package/build/shared/helper/BaseContext.js +33 -15
- package/build/shared/helper/nlu/textCleaner.js +25 -3
- package/build/shared/interfaces/IEndpointTranslationSettings.js +9 -0
- package/build/shared/interfaces/IOrganisation.js +2 -1
- package/build/shared/interfaces/agentAssist/ISendConfigUpdateParams.js +3 -0
- package/build/shared/interfaces/agentAssist/ISendUpdateReferenceParams.js +3 -0
- package/build/shared/interfaces/amqpInterface.js +18 -22
- package/build/shared/interfaces/channels/genesysBotConnector.js +21 -0
- package/build/shared/interfaces/channels/niceCXOne.js +8 -0
- package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +17 -7
- package/build/shared/interfaces/handover.js +57 -3
- package/build/shared/interfaces/journeys/IJourney.js +6 -0
- package/build/shared/interfaces/journeys/IJourneyTrackEvent.js +2 -0
- package/build/shared/interfaces/messageAPI/endpoints.js +93 -8
- package/build/shared/interfaces/messageAPI/handover.js +4 -4
- package/build/shared/interfaces/resources/IAuditEvent.js +1 -0
- package/build/shared/interfaces/resources/IConnectionSchema.js +3 -0
- package/build/shared/interfaces/resources/IEndpoint.js +1 -0
- package/build/shared/interfaces/resources/IExtension.js +3 -0
- package/build/shared/interfaces/resources/ILargeLanguageModel.js +24 -5
- package/build/shared/interfaces/resources/INodeDescriptorSet.js +24 -1
- package/build/shared/interfaces/resources/TNLUConnectorType.js +0 -1
- package/build/shared/interfaces/resources/TRestChannelType.js +16 -11
- package/build/shared/interfaces/resources/TSocketChannelType.js +5 -1
- package/build/shared/interfaces/resources/TWebhookChannelType.js +6 -1
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +21 -3
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +13 -2
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeStore.js +1 -1
- package/build/shared/interfaces/resources/settings/IAgentSettings.js +3 -23
- package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
- package/build/shared/interfaces/resources/settings/ITranslationSettings.js +63 -0
- package/build/shared/interfaces/resources/settings/index.js +4 -1
- package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/IReadVoiceGatewayAccountRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/ISetupVoiceGatewayAccountRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/ICallCounterAggregatedValue_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/IGetCallCounterOrganisationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/IGetCallCounterRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IGetKnowledgeQueryCounterOrganisationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IGetKnowledgeQueryCounterRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IKnowlegeQueryCounterAggregatedValue_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/resources/nluconnector/v2.0/TNLUConnectorType_2_0.js +0 -2
- package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/IUploadResumableRest_2_0.js +17 -0
- package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/index.js +3 -0
- package/build/shared/interfaces/security/ICallCounterAggregatedValue.js +3 -0
- package/build/shared/interfaces/security/IKnowledgeQueryCounterAggregatedValue.js +3 -0
- package/build/shared/interfaces/security/IPermission.js +3 -0
- package/build/shared/interfaces/security/IRole.js +9 -1
- package/build/shared/interfaces/security/index.js +2 -1
- package/build/shared/interfaces/trainer/ITrainerRecord.js +2 -0
- package/build/test.js +27 -0
- package/package.json +19 -17
- package/types/index.d.ts +823 -140
package/types/index.d.ts
CHANGED
|
@@ -414,10 +414,12 @@ export interface IGetAuthorizationCodeParameters {
|
|
|
414
414
|
declare const organisationWidePermissions: readonly [
|
|
415
415
|
"analyticsOdata",
|
|
416
416
|
"apiKeys",
|
|
417
|
+
"assignProject",
|
|
417
418
|
"liveAgentAccount",
|
|
418
419
|
"projects",
|
|
419
420
|
"userDetails",
|
|
420
|
-
"users"
|
|
421
|
+
"users",
|
|
422
|
+
"voiceGatewayAccount"
|
|
421
423
|
];
|
|
422
424
|
export declare type TOrganisationWidePermissions = typeof organisationWidePermissions[number];
|
|
423
425
|
declare const projectWidePermissions: readonly [
|
|
@@ -480,12 +482,6 @@ export declare type TTimestamp = number;
|
|
|
480
482
|
* has. These are dates when a resource was created and modified as well as information
|
|
481
483
|
* about the user who initially created a resource and who modified it the last time.
|
|
482
484
|
* type: object
|
|
483
|
-
* required:
|
|
484
|
-
* - _id
|
|
485
|
-
* - createdAt
|
|
486
|
-
* - lastChanged
|
|
487
|
-
* - createdBy
|
|
488
|
-
* - lastChangedBy
|
|
489
485
|
* properties:
|
|
490
486
|
* _id:
|
|
491
487
|
* $ref: '#/components/schemas/TMongoId'
|
|
@@ -912,21 +908,25 @@ declare const referenceKeys: readonly [
|
|
|
912
908
|
"storeReference",
|
|
913
909
|
"sourceReference"
|
|
914
910
|
];
|
|
915
|
-
export declare type TReferenceKeys = typeof referenceKeys[number];
|
|
911
|
+
export declare type TReferenceKeys = (typeof referenceKeys)[number];
|
|
916
912
|
export declare type TReferenceAndEntityMetaKeys = TReferenceKeys | TEntityMetaKeys | "referenceId";
|
|
917
913
|
export declare type TNonQueriableKeys<T> = TReferenceKeys;
|
|
918
914
|
declare const organisationWideRoles: readonly [
|
|
919
915
|
"admin",
|
|
920
916
|
"apiKeys",
|
|
921
917
|
"base_role",
|
|
918
|
+
"basicSupportUser",
|
|
919
|
+
"fullSupportUser",
|
|
922
920
|
"liveAgentAdmin",
|
|
923
921
|
"liveAgentAgent",
|
|
924
922
|
"liveAgentSupervisor",
|
|
925
923
|
"livechat",
|
|
926
924
|
"odata",
|
|
925
|
+
"projectAssigner",
|
|
927
926
|
"projectManager",
|
|
928
927
|
"userManager",
|
|
929
|
-
"userDetailsViewer"
|
|
928
|
+
"userDetailsViewer",
|
|
929
|
+
"voiceGatewayUser"
|
|
930
930
|
];
|
|
931
931
|
export declare type TOrganisationWideRole = typeof organisationWideRoles[number];
|
|
932
932
|
declare const projectWideRoles: readonly [
|
|
@@ -1066,6 +1066,8 @@ export interface ICrudPermissions {
|
|
|
1066
1066
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1067
1067
|
* tokens:
|
|
1068
1068
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1069
|
+
* voiceGatewayAccount:
|
|
1070
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1069
1071
|
* roles:
|
|
1070
1072
|
* type: array
|
|
1071
1073
|
* items:
|
|
@@ -1540,6 +1542,7 @@ export interface IHttpAdapter {
|
|
|
1540
1542
|
request(request: IHttpRequest, client: any): PromiseLike<IHttpResponse>;
|
|
1541
1543
|
setConfig(config: IRestAPIClientConfig): void;
|
|
1542
1544
|
}
|
|
1545
|
+
export declare type TTusAPIOperation<Data = void, ReturnValue = void> = (args: Data) => ReturnValue;
|
|
1543
1546
|
declare const arrayTResourceType: readonly [
|
|
1544
1547
|
"agentassistconfig",
|
|
1545
1548
|
"agentSettings",
|
|
@@ -1601,7 +1604,6 @@ declare const arrayNLUConnectorType: readonly [
|
|
|
1601
1604
|
"dialogflow",
|
|
1602
1605
|
"dialogflowBuiltIn",
|
|
1603
1606
|
"amazonLexBuiltIn",
|
|
1604
|
-
"twilioAutopilotBuiltIn",
|
|
1605
1607
|
"luis",
|
|
1606
1608
|
"watson",
|
|
1607
1609
|
"noNlu",
|
|
@@ -1818,24 +1820,26 @@ declare const webhookChannelTypes: readonly [
|
|
|
1818
1820
|
"ringCentralEngage",
|
|
1819
1821
|
"intercom",
|
|
1820
1822
|
"whatsapp",
|
|
1821
|
-
"eightByEight"
|
|
1823
|
+
"eightByEight",
|
|
1824
|
+
"agentAssistVoice"
|
|
1822
1825
|
];
|
|
1823
1826
|
export declare type TWebhookChannelType = typeof webhookChannelTypes[number];
|
|
1824
1827
|
declare const restChannelTypes: readonly [
|
|
1825
1828
|
"alexa",
|
|
1826
1829
|
"audioCodes",
|
|
1827
1830
|
"avaya",
|
|
1831
|
+
"bandwidth",
|
|
1828
1832
|
"dialogflow",
|
|
1829
|
-
"google",
|
|
1830
1833
|
"line",
|
|
1831
1834
|
"microsoftTeams",
|
|
1832
1835
|
"rest",
|
|
1833
|
-
"twilio-autopilot",
|
|
1834
1836
|
"twilio-sms",
|
|
1835
1837
|
"twilio",
|
|
1836
1838
|
"userlike",
|
|
1837
1839
|
"nonConversational",
|
|
1838
|
-
"amazonLex"
|
|
1840
|
+
"amazonLex",
|
|
1841
|
+
"genesysBotConnector",
|
|
1842
|
+
"niceCXOne"
|
|
1839
1843
|
];
|
|
1840
1844
|
export declare type TRestChannelType = typeof restChannelTypes[number];
|
|
1841
1845
|
declare const socketChannelTypes: readonly [
|
|
@@ -1844,7 +1848,8 @@ declare const socketChannelTypes: readonly [
|
|
|
1844
1848
|
"admin-webchat",
|
|
1845
1849
|
"socket",
|
|
1846
1850
|
"voiceGateway2",
|
|
1847
|
-
"liveAgentAssist"
|
|
1851
|
+
"liveAgentAssist",
|
|
1852
|
+
"webchat3"
|
|
1848
1853
|
];
|
|
1849
1854
|
export declare type TSocketChannelType = typeof socketChannelTypes[number];
|
|
1850
1855
|
export interface IBaseTransformerFunction {
|
|
@@ -2035,6 +2040,7 @@ declare const handoverProviders: readonly [
|
|
|
2035
2040
|
"salesforce",
|
|
2036
2041
|
"liveAgent",
|
|
2037
2042
|
"genesysCloud",
|
|
2043
|
+
"genesysCloudOM",
|
|
2038
2044
|
"eightByEight"
|
|
2039
2045
|
];
|
|
2040
2046
|
export declare type THandoverProvider = typeof handoverProviders[number];
|
|
@@ -2049,7 +2055,7 @@ declare const whisperAssistConfigurations: readonly [
|
|
|
2049
2055
|
"template"
|
|
2050
2056
|
];
|
|
2051
2057
|
export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
|
|
2052
|
-
export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings;
|
|
2058
|
+
export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
|
|
2053
2059
|
export interface IRCEHandoverSettings {
|
|
2054
2060
|
/**
|
|
2055
2061
|
* Whether to forward all conversations
|
|
@@ -2059,6 +2065,11 @@ export interface IRCEHandoverSettings {
|
|
|
2059
2065
|
* was triggered.
|
|
2060
2066
|
*/
|
|
2061
2067
|
forwardOnlyHandoverConversations?: boolean;
|
|
2068
|
+
/**
|
|
2069
|
+
* Indicates if queue updates should be enabled
|
|
2070
|
+
* to receive events about the estimated wait time
|
|
2071
|
+
*/
|
|
2072
|
+
getQueueUpdates?: boolean;
|
|
2062
2073
|
/**
|
|
2063
2074
|
* The API access token
|
|
2064
2075
|
* you can create within RCE
|
|
@@ -2182,6 +2193,7 @@ export interface IAgentAssistSettings {
|
|
|
2182
2193
|
enableTranscriptTile?: boolean;
|
|
2183
2194
|
enableTranscriptTileChatInput?: boolean;
|
|
2184
2195
|
redactTranscriptTileMessages?: boolean;
|
|
2196
|
+
oAuth2Connection?: string;
|
|
2185
2197
|
}
|
|
2186
2198
|
export interface IGenesysCloudHandoverSettings {
|
|
2187
2199
|
host: string;
|
|
@@ -2200,13 +2212,31 @@ export interface IGenesysCloudHandoverSettings {
|
|
|
2200
2212
|
*/
|
|
2201
2213
|
forwardOnlyHandoverConversations: true;
|
|
2202
2214
|
}
|
|
2215
|
+
export interface IGenesysCloudOMHandoverSettings {
|
|
2216
|
+
host: string;
|
|
2217
|
+
deploymentName: string;
|
|
2218
|
+
queue: string;
|
|
2219
|
+
webhookSecret: string;
|
|
2220
|
+
sendProfile: boolean;
|
|
2221
|
+
clientId: string;
|
|
2222
|
+
clientSecret: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* This setting cannot be changed,
|
|
2225
|
+
* since the cognigy client only supports
|
|
2226
|
+
* forwarding handover conversations. The value
|
|
2227
|
+
* is therefore set to 'true'
|
|
2228
|
+
*/
|
|
2229
|
+
forwardOnlyHandoverConversations: true;
|
|
2230
|
+
}
|
|
2203
2231
|
export interface IHandoverStatusInputObject {
|
|
2204
2232
|
status: THandoverStatus;
|
|
2233
|
+
eventType?: "queueUpdate" | "handoverInactivity";
|
|
2205
2234
|
inactivityCount?: number;
|
|
2206
2235
|
error?: {
|
|
2207
2236
|
reason: "unsupported" | "error";
|
|
2208
2237
|
message: string;
|
|
2209
2238
|
};
|
|
2239
|
+
data?: any;
|
|
2210
2240
|
}
|
|
2211
2241
|
export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject";
|
|
2212
2242
|
export interface IEndpointTranslationSettings {
|
|
@@ -2214,6 +2244,9 @@ export interface IEndpointTranslationSettings {
|
|
|
2214
2244
|
flowLanguage: string;
|
|
2215
2245
|
inputLanguage: "auto" | string;
|
|
2216
2246
|
noTranslateMarker: string;
|
|
2247
|
+
glossaryId?: string;
|
|
2248
|
+
glossaryIdInput?: string;
|
|
2249
|
+
formality?: "default" | "more" | "less" | "prefer_more" | "prefer_less";
|
|
2217
2250
|
padPayloads: boolean;
|
|
2218
2251
|
alwaysRemoveNoTranslateMarker: boolean;
|
|
2219
2252
|
setInputLanguageOnExecutionCount: number;
|
|
@@ -2259,6 +2292,8 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2259
2292
|
useContactProfiles: boolean;
|
|
2260
2293
|
/** Whether we should store analytics for this endpoint */
|
|
2261
2294
|
useAnalytics: boolean;
|
|
2295
|
+
/** Whether we should store data payloads into analytics for this endpoint */
|
|
2296
|
+
storeDataPayload: boolean;
|
|
2262
2297
|
/** Whether we should use Chatbase to collect analytics */
|
|
2263
2298
|
useChatbaseAnalytics: boolean;
|
|
2264
2299
|
/** The apikey for the Chatbase bot */
|
|
@@ -2320,7 +2355,6 @@ export interface IGraphEndpointDependency {
|
|
|
2320
2355
|
* - facebook
|
|
2321
2356
|
* - alexa
|
|
2322
2357
|
* - slack
|
|
2323
|
-
* - google
|
|
2324
2358
|
* - generic
|
|
2325
2359
|
* - inject
|
|
2326
2360
|
* - rest
|
|
@@ -2331,7 +2365,6 @@ export interface IGraphEndpointDependency {
|
|
|
2331
2365
|
* - dialogflow
|
|
2332
2366
|
* - twilio
|
|
2333
2367
|
* - twilio-sms
|
|
2334
|
-
* - twilio-autopilot
|
|
2335
2368
|
* - line
|
|
2336
2369
|
* - intercom
|
|
2337
2370
|
* - microsoftBotFramework
|
|
@@ -2342,6 +2375,19 @@ export interface IGraphEndpointDependency {
|
|
|
2342
2375
|
* - nonConversational
|
|
2343
2376
|
* - voiceGateway2
|
|
2344
2377
|
* - amazonLex
|
|
2378
|
+
* - workplace
|
|
2379
|
+
* - webhook
|
|
2380
|
+
* - abstractRest
|
|
2381
|
+
* - userlike
|
|
2382
|
+
* - ringCentralEngage
|
|
2383
|
+
* - audioCodes
|
|
2384
|
+
* - bandwidth
|
|
2385
|
+
* - whatsapp
|
|
2386
|
+
* - eightByEight
|
|
2387
|
+
* - genesysBotConnector
|
|
2388
|
+
* - niceCXOne
|
|
2389
|
+
* - agentAssistVoice
|
|
2390
|
+
* - webchat3
|
|
2345
2391
|
*/
|
|
2346
2392
|
export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
|
|
2347
2393
|
declare const endpointTypes: readonly [
|
|
@@ -2349,7 +2395,6 @@ declare const endpointTypes: readonly [
|
|
|
2349
2395
|
"workplace",
|
|
2350
2396
|
"alexa",
|
|
2351
2397
|
"slack",
|
|
2352
|
-
"google",
|
|
2353
2398
|
"webhook",
|
|
2354
2399
|
"rest",
|
|
2355
2400
|
"abstractRest",
|
|
@@ -2359,7 +2404,6 @@ declare const endpointTypes: readonly [
|
|
|
2359
2404
|
"dialogflow",
|
|
2360
2405
|
"twilio",
|
|
2361
2406
|
"twilioSms",
|
|
2362
|
-
"twilioAutopilot",
|
|
2363
2407
|
"line",
|
|
2364
2408
|
"intercom",
|
|
2365
2409
|
"microsoftBotFramework",
|
|
@@ -2373,9 +2417,19 @@ declare const endpointTypes: readonly [
|
|
|
2373
2417
|
"voiceGateway2",
|
|
2374
2418
|
"whatsapp",
|
|
2375
2419
|
"amazonLex",
|
|
2376
|
-
"eightByEight"
|
|
2420
|
+
"eightByEight",
|
|
2421
|
+
"bandwidth",
|
|
2422
|
+
"genesysBotConnector",
|
|
2423
|
+
"niceCXOne",
|
|
2424
|
+
"agentAssistVoice",
|
|
2425
|
+
"webchat3"
|
|
2377
2426
|
];
|
|
2378
2427
|
export declare type TEndpointType = typeof endpointTypes[number];
|
|
2428
|
+
declare const transferTypes: readonly [
|
|
2429
|
+
"dial",
|
|
2430
|
+
"sip:refer"
|
|
2431
|
+
];
|
|
2432
|
+
export declare type TTransferType = typeof transferTypes[number];
|
|
2379
2433
|
export interface IWebchatPersistentMenu {
|
|
2380
2434
|
/**
|
|
2381
2435
|
* The title of the persistent menu
|
|
@@ -2398,28 +2452,69 @@ export interface IWebchatPersistentMenu {
|
|
|
2398
2452
|
payload: string;
|
|
2399
2453
|
}[];
|
|
2400
2454
|
}
|
|
2401
|
-
declare const callEvents: readonly [
|
|
2402
|
-
any,
|
|
2403
|
-
"RECOGNIZED_SPEECH",
|
|
2404
|
-
"RECOGNIZED_DTMF",
|
|
2405
|
-
"CALL_CREATED",
|
|
2406
|
-
"CALL_RECONNECTED",
|
|
2407
|
-
"CALL_COMPLETED",
|
|
2408
|
-
"CALL_FAILED",
|
|
2409
|
-
"USER_INPUT_TIMEOUT",
|
|
2410
|
-
"ANSWERING_MACHINE_DETECTION"
|
|
2411
|
-
];
|
|
2412
|
-
export declare type TCallEvent = typeof callEvents[number];
|
|
2413
2455
|
export interface ICallEventSettings {
|
|
2414
2456
|
enabled: boolean;
|
|
2415
|
-
|
|
2416
|
-
action: "inject" | "executeFlow";
|
|
2457
|
+
action: "inject" | "executeFlow" | "transfer" | "none";
|
|
2417
2458
|
flowId: string;
|
|
2418
2459
|
entrypoint?: string;
|
|
2419
2460
|
injectText?: string;
|
|
2420
2461
|
injectData?: string;
|
|
2462
|
+
failover?: ICallEventFailoverSettings;
|
|
2463
|
+
}
|
|
2464
|
+
export interface ICallEventFailoverSettings {
|
|
2465
|
+
enabled?: boolean;
|
|
2466
|
+
type?: TTransferType;
|
|
2467
|
+
headers?: string;
|
|
2468
|
+
to?: string;
|
|
2469
|
+
reason?: string;
|
|
2470
|
+
dialCallerId?: string;
|
|
2471
|
+
dialMusic?: string;
|
|
2472
|
+
dialTimeout?: number;
|
|
2473
|
+
dialTranscribeEnabled?: boolean;
|
|
2474
|
+
dialTranscribeVendor?: string;
|
|
2475
|
+
dialTranscribeLanguage?: string;
|
|
2476
|
+
dialTranscribeWebhook?: string;
|
|
2477
|
+
dialTranscribeRecognitionChannel?: number;
|
|
2478
|
+
dialTranscribeRecognitionGoogleModel?: string;
|
|
2479
|
+
dialTranscribeLabel?: string;
|
|
2480
|
+
dialTranscribeDeepgramTier?: string;
|
|
2481
|
+
dialTranscribeDeepgramModel?: string;
|
|
2482
|
+
referredBy?: string;
|
|
2483
|
+
deepgramSmartFormatting?: boolean;
|
|
2484
|
+
deepgramEndpointing?: boolean;
|
|
2485
|
+
deepgramEndpointingValue?: number;
|
|
2486
|
+
}
|
|
2487
|
+
export interface ICallEvents {
|
|
2488
|
+
amd?: ICallEventSettings;
|
|
2489
|
+
callCreated?: ICallEventSettings;
|
|
2490
|
+
callCompleted?: ICallEventSettings;
|
|
2491
|
+
callFailed?: ICallEventSettings;
|
|
2492
|
+
callReconnected?: ICallEventSettings;
|
|
2493
|
+
userInputTimeout?: ICallEventSettings;
|
|
2494
|
+
recognizedSpeech?: ICallEventSettings;
|
|
2495
|
+
recognizedDtmf?: ICallEventSettings;
|
|
2496
|
+
transferReferSuccess?: ICallEventSettings;
|
|
2497
|
+
transferReferError?: ICallEventSettings;
|
|
2498
|
+
transferDialSuccess?: ICallEventSettings;
|
|
2499
|
+
transferDialError?: ICallEventSettings;
|
|
2500
|
+
userBusy?: ICallEventSettings;
|
|
2501
|
+
noAnswer?: ICallEventSettings;
|
|
2502
|
+
}
|
|
2503
|
+
export interface IVGProsodySettings {
|
|
2504
|
+
outputSpeed?: number;
|
|
2505
|
+
outputPitch?: number;
|
|
2506
|
+
outputVolume?: number;
|
|
2507
|
+
}
|
|
2508
|
+
export interface IVGGenericSettings {
|
|
2509
|
+
prosodySettings?: IVGProsodySettings;
|
|
2510
|
+
showBestTranscriptOnly?: boolean;
|
|
2511
|
+
}
|
|
2512
|
+
export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
|
|
2513
|
+
callEvents: ICallEvents;
|
|
2514
|
+
failover?: ICallEventFailoverSettings;
|
|
2515
|
+
genericSettings?: IVGGenericSettings;
|
|
2421
2516
|
}
|
|
2422
|
-
export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | {};
|
|
2517
|
+
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 | {};
|
|
2423
2518
|
export declare type TAvayaVoice = "man" | "woman" | string;
|
|
2424
2519
|
declare const avayaSttTtsLanguages: readonly [
|
|
2425
2520
|
"cy-GB",
|
|
@@ -2642,6 +2737,8 @@ export interface IGenericEndpointSettings {
|
|
|
2642
2737
|
basicAuthPassword: string;
|
|
2643
2738
|
webhookUrl: string;
|
|
2644
2739
|
}
|
|
2740
|
+
export interface IAgentAssistVoiceEndpointSettings {
|
|
2741
|
+
}
|
|
2645
2742
|
export interface ISunshineConversationsEndpointSettings extends IEndpointSessionSettings {
|
|
2646
2743
|
sunshineConversationsChannelKeyId: string;
|
|
2647
2744
|
sunshineConversationsChannelSecret: string;
|
|
@@ -2703,9 +2800,6 @@ export interface IMicrosoftBotFrameworkEndpointSettings extends IEndpointSession
|
|
|
2703
2800
|
connectionName: string;
|
|
2704
2801
|
tenantId: string;
|
|
2705
2802
|
}
|
|
2706
|
-
export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
|
|
2707
|
-
callEvents: ICallEventSettings;
|
|
2708
|
-
}
|
|
2709
2803
|
/**
|
|
2710
2804
|
* Settings that are shared by both
|
|
2711
2805
|
* Webchat and Webchat2
|
|
@@ -3000,6 +3094,203 @@ export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSetting
|
|
|
3000
3094
|
title: string;
|
|
3001
3095
|
};
|
|
3002
3096
|
}
|
|
3097
|
+
export interface IWebchat3EndpointSettings extends IWebchatEndpointSharedSettings {
|
|
3098
|
+
/**
|
|
3099
|
+
* List of plugin urls that should be
|
|
3100
|
+
* loaded for the auto-deployed webchat
|
|
3101
|
+
*/
|
|
3102
|
+
pluginUrls: string[];
|
|
3103
|
+
/**
|
|
3104
|
+
* The title that will show up on top of
|
|
3105
|
+
* the webchat's Header
|
|
3106
|
+
*/
|
|
3107
|
+
title: string;
|
|
3108
|
+
/**
|
|
3109
|
+
* The start behavior of the
|
|
3110
|
+
* webchat, e.g. whether a start button
|
|
3111
|
+
* should be rendered.
|
|
3112
|
+
*/
|
|
3113
|
+
startBehavior: TWebchat2StartBehavior;
|
|
3114
|
+
/**
|
|
3115
|
+
* If this is true, the webchat will apply
|
|
3116
|
+
* generic styling to HTML message content.
|
|
3117
|
+
*
|
|
3118
|
+
* This is e.g. useful if we are using HTML generated by Markdown.
|
|
3119
|
+
*/
|
|
3120
|
+
enableGenericHTMLStyling: boolean;
|
|
3121
|
+
/**
|
|
3122
|
+
* Setting that decides the display of the rating button in the webchat
|
|
3123
|
+
*/
|
|
3124
|
+
enableRating: TWebchatEnableRating;
|
|
3125
|
+
/**
|
|
3126
|
+
* The title displayed in the rating dialog prompt
|
|
3127
|
+
*/
|
|
3128
|
+
ratingTitleText: string;
|
|
3129
|
+
/**
|
|
3130
|
+
* The text displayed above the comment field in the rating dialog prompt
|
|
3131
|
+
*/
|
|
3132
|
+
ratingCommentText: string;
|
|
3133
|
+
/**
|
|
3134
|
+
* The text displayed in the message history after giving a rating
|
|
3135
|
+
* (text is followed by the icon representing the rating)
|
|
3136
|
+
*/
|
|
3137
|
+
ratingMessageHistoryRatingText: string;
|
|
3138
|
+
/**
|
|
3139
|
+
* The text displayed in the message history after giving a rating, if there was a comment sent
|
|
3140
|
+
* (text is followed by the actual comment)
|
|
3141
|
+
*/
|
|
3142
|
+
ratingMessageHistoryCommentText: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* This setting is used to decide whether to sanitize HTML content in the Webchat or not
|
|
3145
|
+
*/
|
|
3146
|
+
disableHtmlContentSanitization: boolean;
|
|
3147
|
+
/**
|
|
3148
|
+
* This setting is used to decide whether to sanitize JavaScript from URL buttons / Default Actions
|
|
3149
|
+
* in the Webchat or not
|
|
3150
|
+
*/
|
|
3151
|
+
disableUrlButtonSanitization: boolean;
|
|
3152
|
+
/**
|
|
3153
|
+
* This setting is used to decide whether a connectivity indicator should be displayed
|
|
3154
|
+
*/
|
|
3155
|
+
enableConnectionStatusIndicator: boolean;
|
|
3156
|
+
/**
|
|
3157
|
+
* This setting activates the automatic collation of input messages with a delay for the webchat
|
|
3158
|
+
*/
|
|
3159
|
+
enableInputCollation: boolean;
|
|
3160
|
+
/**
|
|
3161
|
+
* This setting configures the delay for the automatic input collation in miliseconds. Defaults to 1000
|
|
3162
|
+
*/
|
|
3163
|
+
inputCollationTimeout: number;
|
|
3164
|
+
/**
|
|
3165
|
+
* This setting is used to decide whether unread messages should be indicated in the title of a minimized webchat widget
|
|
3166
|
+
*/
|
|
3167
|
+
enableUnreadMessageTitleIndicator: boolean;
|
|
3168
|
+
/**
|
|
3169
|
+
* This setting is used to decide whether engagement messages should be displayed in the chat history
|
|
3170
|
+
*/
|
|
3171
|
+
showEngagementMessagesInChat: boolean;
|
|
3172
|
+
/**
|
|
3173
|
+
* The text that should be sent to engage the customer
|
|
3174
|
+
*/
|
|
3175
|
+
engagementMessageText: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* This setting is used to decide whether a badge with the number of unread messages should be displayed in the minimized webchat widget
|
|
3178
|
+
*/
|
|
3179
|
+
enableUnreadMessageBadge: boolean;
|
|
3180
|
+
/**
|
|
3181
|
+
* This setting is used to decide whether to show a message preview for incoming messages if the webchat widget is minimized
|
|
3182
|
+
*/
|
|
3183
|
+
enableUnreadMessagePreview: boolean;
|
|
3184
|
+
/**
|
|
3185
|
+
* This setting is used to decide whether a sound should be triggered for incoming messages if the webchat widget is minimized
|
|
3186
|
+
*/
|
|
3187
|
+
enableUnreadMessageSound: boolean;
|
|
3188
|
+
/**
|
|
3189
|
+
* This setting is used to decide whether images should be resized dynamically
|
|
3190
|
+
*/
|
|
3191
|
+
dynamicImageAspectRatio: boolean;
|
|
3192
|
+
/**
|
|
3193
|
+
* This setting is used to decide whether the input should be focused right after a postback button is pressed
|
|
3194
|
+
*/
|
|
3195
|
+
focusInputAfterPostback: boolean;
|
|
3196
|
+
/**
|
|
3197
|
+
* If this is "true", the webchat will use a regular one-line text input instead of an automatically growing text field
|
|
3198
|
+
*/
|
|
3199
|
+
disableInputAutogrow: boolean;
|
|
3200
|
+
/**
|
|
3201
|
+
* Defines the number of line rows the text input will grow to before showing a vertical scrollbar
|
|
3202
|
+
*/
|
|
3203
|
+
inputAutogrowMaxRows: number;
|
|
3204
|
+
/**
|
|
3205
|
+
* This setting is used to disable autocomplete for the input as on Samsung smartphones the autosuggestion overlaps the virtual keyboard
|
|
3206
|
+
*/
|
|
3207
|
+
disableInputAutocomplete: boolean;
|
|
3208
|
+
/**
|
|
3209
|
+
* This setting is used to enable or disable the "integrated demo webchat" for this endpoint. If this is "off", the Demo Webchat will not be publically accessible.
|
|
3210
|
+
*/
|
|
3211
|
+
enableDemoWebchat: boolean;
|
|
3212
|
+
/**
|
|
3213
|
+
* This setting is used to enable or disable branding in webchat.If true, hides "Powered by Cognigy" link.
|
|
3214
|
+
*/
|
|
3215
|
+
disableBranding?: boolean;
|
|
3216
|
+
/**
|
|
3217
|
+
* Whether to display the file attachment button
|
|
3218
|
+
*/
|
|
3219
|
+
enableFileAttachment: boolean;
|
|
3220
|
+
/**
|
|
3221
|
+
* The maximum allowed size of the attachment
|
|
3222
|
+
*/
|
|
3223
|
+
fileAttachmentMaxSize: number;
|
|
3224
|
+
/**
|
|
3225
|
+
* Maintenance mode foncifuration for the Webchat Widget
|
|
3226
|
+
*/
|
|
3227
|
+
maintenance: {
|
|
3228
|
+
/**
|
|
3229
|
+
* Whether the Maintenance mode is enabled
|
|
3230
|
+
*/
|
|
3231
|
+
enabled: boolean;
|
|
3232
|
+
/**
|
|
3233
|
+
* The maintenance mode. Possible values are:
|
|
3234
|
+
* "hide" - The chat window will be hidden during maintenance
|
|
3235
|
+
* "disable" - The message bubble will be disabled with a mouse over text during maintenance
|
|
3236
|
+
* "inform" - The Webchat Widget will start normally, but show a maintenance mode message
|
|
3237
|
+
*/
|
|
3238
|
+
mode: string;
|
|
3239
|
+
/**
|
|
3240
|
+
* The text that is displayed in the mouse over text of the bubble or the maintenance mode message
|
|
3241
|
+
*/
|
|
3242
|
+
text: string;
|
|
3243
|
+
/**
|
|
3244
|
+
* The title that is displayed to the user in the information when opening the bot during maintenance
|
|
3245
|
+
*/
|
|
3246
|
+
title: string;
|
|
3247
|
+
};
|
|
3248
|
+
/**
|
|
3249
|
+
* Office Hours configuration for the Webchat Widget
|
|
3250
|
+
*/
|
|
3251
|
+
businessHours: {
|
|
3252
|
+
/**
|
|
3253
|
+
* Specified hours during which the Webchat Widget should be available
|
|
3254
|
+
*/
|
|
3255
|
+
businessHours: {
|
|
3256
|
+
/**
|
|
3257
|
+
* Start time of the business hours, e.g. 09:00
|
|
3258
|
+
*/
|
|
3259
|
+
startTime: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* End time of the business hours, e.g. 17:00
|
|
3262
|
+
*/
|
|
3263
|
+
endTime: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* Week day of the business hours in lower case, e.g. "monday"
|
|
3266
|
+
*/
|
|
3267
|
+
weekDay: string;
|
|
3268
|
+
}[];
|
|
3269
|
+
/**
|
|
3270
|
+
* Whether the Office Hours are enabled
|
|
3271
|
+
*/
|
|
3272
|
+
enabled: boolean;
|
|
3273
|
+
/**
|
|
3274
|
+
* The business hours mode. Possible values are:
|
|
3275
|
+
* "hide" - The chat window will be hidden out of business hours
|
|
3276
|
+
* "disable" - The message bubble will be disabled with a mouse over text out of business hours
|
|
3277
|
+
* "inform" - The Webchat Widget will start normally, but show an out of business hours message
|
|
3278
|
+
*/
|
|
3279
|
+
mode: string;
|
|
3280
|
+
/**
|
|
3281
|
+
* The text that is displayed in the mouse over text of the bubble or the out of business hours message
|
|
3282
|
+
*/
|
|
3283
|
+
text: string;
|
|
3284
|
+
/**
|
|
3285
|
+
* The timezone that is used to calculate of the user is calling out of business hours
|
|
3286
|
+
*/
|
|
3287
|
+
timeZone: string;
|
|
3288
|
+
/**
|
|
3289
|
+
* The title that is displayed to the user in the information when opening the bot out of business hours
|
|
3290
|
+
*/
|
|
3291
|
+
title: string;
|
|
3292
|
+
};
|
|
3293
|
+
}
|
|
3003
3294
|
/**
|
|
3004
3295
|
* Setting to enable rating for the Webchat.
|
|
3005
3296
|
* Valid types are:
|
|
@@ -3069,6 +3360,13 @@ export interface IUserlikeUnifiedMessagingEndpointSettings {
|
|
|
3069
3360
|
securityToken: string;
|
|
3070
3361
|
}
|
|
3071
3362
|
export declare type IUserlikeEndpointSettings = IUserlikeRestEndpointSettings | IUserlikeUnifiedMessagingEndpointSettings;
|
|
3363
|
+
export interface IBandwidthEndpointSettings {
|
|
3364
|
+
/**
|
|
3365
|
+
* If true the BandwidthWebsocketClient is used.
|
|
3366
|
+
* Default: false
|
|
3367
|
+
*/
|
|
3368
|
+
enableAsyncCommunication: boolean;
|
|
3369
|
+
}
|
|
3072
3370
|
export interface IAudioCodesEndpointSettings {
|
|
3073
3371
|
/**
|
|
3074
3372
|
* If true the AudioCodesWebsocketClient is used.
|
|
@@ -3202,12 +3500,17 @@ export interface IEightByEightEndpointSettings extends IEndpointSessionSettings
|
|
|
3202
3500
|
/** Settings to store attachments at a cloud provider */
|
|
3203
3501
|
fileStorageSettings?: IFileStorageSettings;
|
|
3204
3502
|
}
|
|
3503
|
+
export interface IGenesysBotConnectorEndpointSettings {
|
|
3504
|
+
verifyToken: string;
|
|
3505
|
+
}
|
|
3506
|
+
export interface INiceCXOneEndpointSettings {
|
|
3507
|
+
verifyToken: string;
|
|
3508
|
+
}
|
|
3205
3509
|
declare const arrayNLUConnectorType_2_0: readonly [
|
|
3206
3510
|
"alexa",
|
|
3207
3511
|
"dialogflow",
|
|
3208
3512
|
"dialogflowBuiltIn",
|
|
3209
3513
|
"amazonLexBuiltIn",
|
|
3210
|
-
"twilioAutopilotBuiltIn",
|
|
3211
3514
|
"luis",
|
|
3212
3515
|
"watson",
|
|
3213
3516
|
"noNlu",
|
|
@@ -3219,8 +3522,12 @@ declare const arrayNLUConnectorType_2_0: readonly [
|
|
|
3219
3522
|
export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
|
|
3220
3523
|
declare const generativeAIModels: readonly [
|
|
3221
3524
|
"gpt-3.5-turbo",
|
|
3525
|
+
"gpt-3.5-turbo-instruct",
|
|
3526
|
+
"gpt-4",
|
|
3222
3527
|
"text-davinci-003",
|
|
3223
3528
|
"text-embedding-ada-002",
|
|
3529
|
+
"luminous-extended-control",
|
|
3530
|
+
"luminous-embedding-128",
|
|
3224
3531
|
"claude-v1-100k",
|
|
3225
3532
|
"claude-instant-v1",
|
|
3226
3533
|
"text-bison@001"
|
|
@@ -3229,19 +3536,21 @@ export declare type TGenerativeAIModels = typeof generativeAIModels[number];
|
|
|
3229
3536
|
declare const generativeAIProviders: readonly [
|
|
3230
3537
|
"azureOpenAI",
|
|
3231
3538
|
"openAI",
|
|
3539
|
+
"alephAlpha",
|
|
3232
3540
|
"anthropic",
|
|
3233
3541
|
"googleVertexAI"
|
|
3234
3542
|
];
|
|
3235
3543
|
export declare type TGenerativeAIProviders = typeof generativeAIProviders[number];
|
|
3236
3544
|
declare const generativeAIUseCases: readonly [
|
|
3237
|
-
"
|
|
3545
|
+
"knowledgeSearch",
|
|
3546
|
+
"gptPromptNode",
|
|
3547
|
+
"gptConversation",
|
|
3238
3548
|
"aiEnhancedOutputs",
|
|
3239
|
-
"
|
|
3549
|
+
"sentimentAnalysis",
|
|
3550
|
+
"intentSentenceGeneration",
|
|
3240
3551
|
"flowGeneration",
|
|
3241
|
-
"gptConversation",
|
|
3242
|
-
"gptPromptNode",
|
|
3243
3552
|
"generateNodeOutput",
|
|
3244
|
-
"
|
|
3553
|
+
"lexiconGeneration"
|
|
3245
3554
|
];
|
|
3246
3555
|
export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
|
|
3247
3556
|
export interface IGenerativeAIUseCaseSettings {
|
|
@@ -3936,55 +4245,63 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
|
|
|
3936
4245
|
* - google
|
|
3937
4246
|
* - deepl
|
|
3938
4247
|
*/
|
|
3939
|
-
export declare type TTranslationProvider_2_0 = "
|
|
4248
|
+
export declare type TTranslationProvider_2_0 = "microsoft" | "google" | "deepl" | "none";
|
|
3940
4249
|
/**
|
|
3941
4250
|
* @openapi
|
|
3942
4251
|
*
|
|
3943
4252
|
* components:
|
|
3944
4253
|
* schemas:
|
|
3945
|
-
*
|
|
4254
|
+
* TranslationConnection:
|
|
3946
4255
|
* type: object
|
|
3947
4256
|
* properties:
|
|
3948
|
-
*
|
|
3949
|
-
* $ref: '#/components/schemas/TTranslationProvider_2_0'
|
|
3950
|
-
* translationAPIKey:
|
|
4257
|
+
* connecionId:
|
|
3951
4258
|
* type: string
|
|
3952
|
-
*
|
|
3953
|
-
*
|
|
3954
|
-
* translationProviderCustomBaseUrl:
|
|
4259
|
+
* description: ReferenceId to the connection provider
|
|
4260
|
+
* retries:
|
|
3955
4261
|
* type: string
|
|
3956
|
-
*
|
|
3957
|
-
*
|
|
3958
|
-
*
|
|
3959
|
-
* type:
|
|
3960
|
-
*
|
|
3961
|
-
*
|
|
3962
|
-
*
|
|
3963
|
-
*
|
|
3964
|
-
*
|
|
3965
|
-
*
|
|
3966
|
-
*
|
|
3967
|
-
*
|
|
3968
|
-
*
|
|
3969
|
-
*
|
|
3970
|
-
*
|
|
3971
|
-
*
|
|
3972
|
-
*
|
|
3973
|
-
*
|
|
3974
|
-
*
|
|
3975
|
-
*
|
|
3976
|
-
* type:
|
|
3977
|
-
*
|
|
3978
|
-
*
|
|
4262
|
+
* description: Number of retries
|
|
4263
|
+
* default: 1
|
|
4264
|
+
* timeout:
|
|
4265
|
+
* type: string
|
|
4266
|
+
* description: Timeout in milliseconds
|
|
4267
|
+
* default: 3000
|
|
4268
|
+
* cacheExpiry:
|
|
4269
|
+
* type: string
|
|
4270
|
+
* description: Cache expiry in milliseconds
|
|
4271
|
+
* default: 0
|
|
4272
|
+
* customBaseUrl:
|
|
4273
|
+
* type: string
|
|
4274
|
+
* description: Custom base url
|
|
4275
|
+
* default: ""
|
|
4276
|
+
* IAgentTranslationSettings_2_0:
|
|
4277
|
+
* type: object
|
|
4278
|
+
* properties:
|
|
4279
|
+
* provider:
|
|
4280
|
+
* $ref: '#/components/schemas/TTranslationProvider_2_0'
|
|
4281
|
+
* connections:
|
|
4282
|
+
* type: object
|
|
4283
|
+
* properties:
|
|
4284
|
+
* microsoft:
|
|
4285
|
+
* $ref: '#/components/schemas/TranslationConnection'
|
|
4286
|
+
* deepl:
|
|
4287
|
+
* $ref: '#/components/schemas/TranslationConnection'
|
|
4288
|
+
* google:
|
|
4289
|
+
* $ref: '#/components/schemas/TranslationConnection'
|
|
3979
4290
|
*/
|
|
4291
|
+
export interface ITranslationProviderFieldNames_2_0 {
|
|
4292
|
+
connectionId: string | null;
|
|
4293
|
+
retries: number;
|
|
4294
|
+
timeout: number;
|
|
4295
|
+
cacheExpiry: number;
|
|
4296
|
+
customBaseUrl?: string;
|
|
4297
|
+
}
|
|
3980
4298
|
export interface IAgentTranslationSettings_2_0 {
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
translationRegion?: string;
|
|
4299
|
+
provider: TTranslationProvider_2_0;
|
|
4300
|
+
connections: {
|
|
4301
|
+
microsoft: ITranslationProviderFieldNames_2_0;
|
|
4302
|
+
google: ITranslationProviderFieldNames_2_0;
|
|
4303
|
+
deepl: ITranslationProviderFieldNames_2_0;
|
|
4304
|
+
};
|
|
3988
4305
|
}
|
|
3989
4306
|
/**
|
|
3990
4307
|
* @openapi
|
|
@@ -4057,6 +4374,8 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
4057
4374
|
* enum:
|
|
4058
4375
|
* - openAI
|
|
4059
4376
|
* - azureOpenAI
|
|
4377
|
+
* - anthropic
|
|
4378
|
+
* - googleVertexAI
|
|
4060
4379
|
*/
|
|
4061
4380
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
4062
4381
|
/**
|
|
@@ -5823,6 +6142,11 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
5823
6142
|
* that trigger a handover. If this setting is true,
|
|
5824
6143
|
* then we will only forward conversations were handover
|
|
5825
6144
|
* was triggered.
|
|
6145
|
+
* getQueueUpdates:
|
|
6146
|
+
* type: boolean
|
|
6147
|
+
* description: >
|
|
6148
|
+
* (rce) Indicates if queue updates should be enabled
|
|
6149
|
+
* to receive events about the estimated wait time
|
|
5826
6150
|
* apiVersion:
|
|
5827
6151
|
* type: string
|
|
5828
6152
|
* description: (salesforce) Salesforce LiveAgent API Version
|
|
@@ -5864,10 +6188,10 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
|
|
|
5864
6188
|
* properties:
|
|
5865
6189
|
* agentAssistFlowId:
|
|
5866
6190
|
* type: string
|
|
5867
|
-
* description:
|
|
6191
|
+
* description: Copilot flow ID
|
|
5868
6192
|
* agentAssistConfigId:
|
|
5869
6193
|
* type: string
|
|
5870
|
-
* description: Selected
|
|
6194
|
+
* description: Selected Copilot Config ReferenceId
|
|
5871
6195
|
* enableTranscriptTile:
|
|
5872
6196
|
* type: boolean
|
|
5873
6197
|
* description: Enable the transcript tile
|
|
@@ -6009,6 +6333,15 @@ export interface IHandoverSettings_2_0 {
|
|
|
6009
6333
|
* noTranslateMarker:
|
|
6010
6334
|
* type: string
|
|
6011
6335
|
* description: Don't translate inputs and outputs which are prefixed with this prefix
|
|
6336
|
+
* glossaryId:
|
|
6337
|
+
* type: string
|
|
6338
|
+
* description: The glossary to use for the bot output translation
|
|
6339
|
+
* glossaryIdInput:
|
|
6340
|
+
* type: string
|
|
6341
|
+
* description: The glossary to use for the user input translation
|
|
6342
|
+
* formality:
|
|
6343
|
+
* type: string
|
|
6344
|
+
* description: Sets whether the translated text should lean towards formal or informal language
|
|
6012
6345
|
* padPayloads:
|
|
6013
6346
|
* type: boolean
|
|
6014
6347
|
* description: If true, prevents all user inputs based on payloads to be translated
|
|
@@ -6024,6 +6357,9 @@ export interface IEndpointTranslationSettings_2_0 {
|
|
|
6024
6357
|
flowLanguage: string;
|
|
6025
6358
|
inputLanguage: "auto" | string;
|
|
6026
6359
|
noTranslateMarker: string;
|
|
6360
|
+
glossaryId?: string;
|
|
6361
|
+
glossaryIdInput?: string;
|
|
6362
|
+
formality?: "default" | "more" | "less" | "prefer_more" | "prefer_less";
|
|
6027
6363
|
padPayloads: boolean;
|
|
6028
6364
|
alwaysRemoveNoTranslateMarker: boolean;
|
|
6029
6365
|
setInputLanguageOnExecutionCount: number;
|
|
@@ -6048,6 +6384,8 @@ export interface IEndpointFileStorageSettings_2_0 {
|
|
|
6048
6384
|
* description: Whether or not organisation data privacy settings are enabled
|
|
6049
6385
|
* useAnalytics:
|
|
6050
6386
|
* type: boolean
|
|
6387
|
+
* storeDataPayload:
|
|
6388
|
+
* type: boolean
|
|
6051
6389
|
* useContactProfiles:
|
|
6052
6390
|
* type: boolean
|
|
6053
6391
|
* useConversations:
|
|
@@ -6062,6 +6400,7 @@ export interface IEndpointFileStorageSettings_2_0 {
|
|
|
6062
6400
|
export interface IEndpoitOrgDataPrivacySettings_2_0 {
|
|
6063
6401
|
enabled: boolean;
|
|
6064
6402
|
useAnalytics: boolean;
|
|
6403
|
+
storeDataPayload?: boolean;
|
|
6065
6404
|
useContactProfiles: boolean;
|
|
6066
6405
|
useConversations: boolean;
|
|
6067
6406
|
maskIPAddress?: boolean;
|
|
@@ -7310,9 +7649,17 @@ export interface IGraphConnection {
|
|
|
7310
7649
|
referenceId: string;
|
|
7311
7650
|
properties: Pick<IConnection, "type" | "extension" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
7312
7651
|
}
|
|
7652
|
+
export interface ILLModelSelection {
|
|
7653
|
+
customModel: string;
|
|
7654
|
+
}
|
|
7655
|
+
export interface IOpenAIMeta extends ILLModelSelection {
|
|
7656
|
+
}
|
|
7657
|
+
export interface IAlephAlphaMeta extends ILLModelSelection {
|
|
7658
|
+
}
|
|
7313
7659
|
export interface IAzureOpenAIMeta {
|
|
7314
|
-
resourceName
|
|
7315
|
-
deploymentName
|
|
7660
|
+
resourceName?: string;
|
|
7661
|
+
deploymentName?: string;
|
|
7662
|
+
baseCustomUrl?: string | null;
|
|
7316
7663
|
apiVersion?: string;
|
|
7317
7664
|
}
|
|
7318
7665
|
export interface IGoogleVertexAIMeta {
|
|
@@ -7333,6 +7680,8 @@ export interface ILargeLanguageModel extends IEntityMeta {
|
|
|
7333
7680
|
organisationReference: TMongoId;
|
|
7334
7681
|
azureOpenAI?: IAzureOpenAIMeta;
|
|
7335
7682
|
googleVertexAI?: IGoogleVertexAIMeta;
|
|
7683
|
+
openAI?: IOpenAIMeta;
|
|
7684
|
+
alephAlpha?: IAlephAlphaMeta;
|
|
7336
7685
|
}
|
|
7337
7686
|
export interface IGraphLargeLanguageModelDependencyAttachment {
|
|
7338
7687
|
_id: string;
|
|
@@ -7656,6 +8005,7 @@ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number]
|
|
|
7656
8005
|
* - gptPromptNode
|
|
7657
8006
|
* - generateNodeOutput
|
|
7658
8007
|
* - knowledgeSearch
|
|
8008
|
+
* - sentimentAnalysis
|
|
7659
8009
|
*/
|
|
7660
8010
|
export interface IGenerativeAIUseCase {
|
|
7661
8011
|
useCase: TGenerativeAIUseCases;
|
|
@@ -7665,19 +8015,30 @@ export interface IVoiceGateway2VadParams {
|
|
|
7665
8015
|
voiceMs?: number;
|
|
7666
8016
|
mode?: number;
|
|
7667
8017
|
}
|
|
7668
|
-
export declare type TVoiceGateway2TTSVendor = "
|
|
8018
|
+
export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
|
|
7669
8019
|
export interface IVoiceGateway2SynthesizerParams {
|
|
7670
|
-
vendor?: TVoiceGateway2TTSVendor;
|
|
8020
|
+
vendor?: TVoiceGateway2TTSVendor | "default" | "none";
|
|
7671
8021
|
language?: string;
|
|
7672
8022
|
voice?: string;
|
|
8023
|
+
label?: string;
|
|
8024
|
+
fallbackVendor?: string;
|
|
8025
|
+
fallbackLabel?: string;
|
|
8026
|
+
fallbackLanguage?: string;
|
|
8027
|
+
fallbackVoice?: string;
|
|
7673
8028
|
engine?: "standard" | "neural";
|
|
7674
8029
|
gender?: "MALE" | "FEMALE" | "NEUTRAL";
|
|
7675
8030
|
azureServiceEndpoint?: string;
|
|
8031
|
+
options?: object;
|
|
7676
8032
|
}
|
|
7677
|
-
export declare type TVoiceGateway2STTVendor = "
|
|
8033
|
+
export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
|
|
8034
|
+
export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
|
|
7678
8035
|
export interface IVoiceGateway2RecognizerParams {
|
|
7679
|
-
vendor?: TVoiceGateway2STTVendor;
|
|
8036
|
+
vendor?: TVoiceGateway2STTVendor | "default" | "none";
|
|
7680
8037
|
language?: string;
|
|
8038
|
+
label?: string;
|
|
8039
|
+
fallbackVendor?: string;
|
|
8040
|
+
fallbackLabel?: string;
|
|
8041
|
+
fallbackLanguage?: string;
|
|
7681
8042
|
vad?: IVoiceGateway2VadParams;
|
|
7682
8043
|
hints?: string[];
|
|
7683
8044
|
hintsBoost?: number;
|
|
@@ -7704,7 +8065,6 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
7704
8065
|
requestSnr?: boolean;
|
|
7705
8066
|
initialSpeechTimeoutMs?: number;
|
|
7706
8067
|
azureSttEndpointId?: string;
|
|
7707
|
-
azureTtsDeploymentId?: string;
|
|
7708
8068
|
audioLogging?: boolean;
|
|
7709
8069
|
asrDtmfTerminationDigit?: string;
|
|
7710
8070
|
asrTimeout?: number;
|
|
@@ -7713,6 +8073,7 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
7713
8073
|
ibmOptions?: TVoiceGateway2IbmOptions;
|
|
7714
8074
|
nvidiaOptions?: TVoiceGateway2NvidiaOptions;
|
|
7715
8075
|
sonioxOptions?: TVoiceGateway2SonioxOptions;
|
|
8076
|
+
model?: TVoiceGateway2GoogleModel;
|
|
7716
8077
|
}
|
|
7717
8078
|
export declare type TVoiceGateway2NuanceOptions = {
|
|
7718
8079
|
clientId?: string;
|
|
@@ -7761,9 +8122,10 @@ export declare type TVoiceGateway2DeepgramOptions = {
|
|
|
7761
8122
|
search?: string[];
|
|
7762
8123
|
replace?: string[];
|
|
7763
8124
|
keywords?: string[];
|
|
7764
|
-
endpointing?: boolean;
|
|
8125
|
+
endpointing?: boolean | number;
|
|
7765
8126
|
vadTurnoff?: number;
|
|
7766
8127
|
tag?: string;
|
|
8128
|
+
smartFormatting?: boolean;
|
|
7767
8129
|
};
|
|
7768
8130
|
export declare type TVoiceGateway2NvidiaOptions = {
|
|
7769
8131
|
rivaUri?: string;
|
|
@@ -7898,6 +8260,9 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
|
|
|
7898
8260
|
quickReply: string;
|
|
7899
8261
|
chatwootInboxId: string;
|
|
7900
8262
|
liveAgentInboxId: string;
|
|
8263
|
+
liveAgentSkills: string[];
|
|
8264
|
+
liveAgentLanguages: string[];
|
|
8265
|
+
liveAgentPriority: "none" | "urgent" | "high" | "medium" | "low";
|
|
7901
8266
|
additionalCategoryIds: string[];
|
|
7902
8267
|
sendTranscriptAsFirstMessage: boolean;
|
|
7903
8268
|
buttonId: string;
|
|
@@ -7924,6 +8289,8 @@ export interface ICheckAgentAvailabilityNodeParams extends INodeFunctionBasePara
|
|
|
7924
8289
|
config: {
|
|
7925
8290
|
chatwootInboxId: string;
|
|
7926
8291
|
liveAgentInboxId: string;
|
|
8292
|
+
liveAgentSkills: Array<string>;
|
|
8293
|
+
liveAgentLanguages: Array<string>;
|
|
7927
8294
|
genesysCloudSkills: Array<string>;
|
|
7928
8295
|
genesysCloudProfileSkills: Array<string>;
|
|
7929
8296
|
genesysCloudLanguageSkills: Array<string>;
|
|
@@ -7950,6 +8317,21 @@ export interface ISchedulingErrorNodeParams extends INodeFunctionBaseParams {
|
|
|
7950
8317
|
export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
|
|
7951
8318
|
tile: any;
|
|
7952
8319
|
}
|
|
8320
|
+
export interface ISendConfigUpdateParams extends INodeFunctionBaseParams {
|
|
8321
|
+
agentAssistConfig: {
|
|
8322
|
+
grid: {
|
|
8323
|
+
columns: number;
|
|
8324
|
+
rows: number;
|
|
8325
|
+
gap: number;
|
|
8326
|
+
};
|
|
8327
|
+
tiles: Record<string, {
|
|
8328
|
+
x: number;
|
|
8329
|
+
y: number;
|
|
8330
|
+
rows: number;
|
|
8331
|
+
columns: number;
|
|
8332
|
+
}>;
|
|
8333
|
+
};
|
|
8334
|
+
}
|
|
7953
8335
|
export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
|
|
7954
8336
|
config: {
|
|
7955
8337
|
lexiconId: string;
|
|
@@ -8023,6 +8405,10 @@ export interface ILastConversationEntry {
|
|
|
8023
8405
|
source: "user" | "bot";
|
|
8024
8406
|
text: string;
|
|
8025
8407
|
}
|
|
8408
|
+
export interface OpenAIChatMessage {
|
|
8409
|
+
role: "system" | "user" | "assistant";
|
|
8410
|
+
content: string;
|
|
8411
|
+
}
|
|
8026
8412
|
export interface IGenerativeSlot {
|
|
8027
8413
|
tag: string;
|
|
8028
8414
|
description: string;
|
|
@@ -8053,7 +8439,7 @@ export interface INodeWithAiRephraseConfig {
|
|
|
8053
8439
|
generativeAI_amountOfLastUserInputs: number;
|
|
8054
8440
|
generativeAI_customInputs: string[];
|
|
8055
8441
|
generativeAI_temperature: number;
|
|
8056
|
-
|
|
8442
|
+
promptType: TPromptTypes;
|
|
8057
8443
|
questionType?: TRephraseWithAIQuestionType;
|
|
8058
8444
|
}
|
|
8059
8445
|
export interface ISayNodeConfigParams {
|
|
@@ -8109,6 +8495,19 @@ export interface IQuestionNodeParams extends INodeFunctionBaseParams {
|
|
|
8109
8495
|
export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
8110
8496
|
validationMessage: string;
|
|
8111
8497
|
repromptCondition: string;
|
|
8498
|
+
repromptLLMProvider: string;
|
|
8499
|
+
repromptLLMPrompt: string;
|
|
8500
|
+
repromptLLMTurns: number;
|
|
8501
|
+
repromptType: "text" | "say" | "llm" | "execute";
|
|
8502
|
+
repromptSay: ISayParams["config"]["say"];
|
|
8503
|
+
repromptFlowNode: {
|
|
8504
|
+
flow: string;
|
|
8505
|
+
node: string;
|
|
8506
|
+
isGoto?: boolean;
|
|
8507
|
+
};
|
|
8508
|
+
repromptParseIntents?: boolean;
|
|
8509
|
+
repromptParseKeyphrases?: boolean;
|
|
8510
|
+
repromptAbsorbContext?: boolean;
|
|
8112
8511
|
validationRepeat: boolean;
|
|
8113
8512
|
storeResultInContext: boolean;
|
|
8114
8513
|
contextKey: string;
|
|
@@ -8284,6 +8683,12 @@ export interface IRunGenerativeAIPromptOptions {
|
|
|
8284
8683
|
* @deprecated should not inject the prompt anymore, use getPrompt() instead
|
|
8285
8684
|
*/
|
|
8286
8685
|
prompt?: string;
|
|
8686
|
+
/** Text to calculate the embedding vector */
|
|
8687
|
+
embeddingText?: string;
|
|
8688
|
+
/**
|
|
8689
|
+
* Instead of a prompt, we can also provide messages in OpenAI's chat format
|
|
8690
|
+
*/
|
|
8691
|
+
chat?: OpenAIChatMessage[];
|
|
8287
8692
|
/** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
|
|
8288
8693
|
promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
|
|
8289
8694
|
/** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
|
|
@@ -8330,10 +8735,28 @@ export interface IRunGenerativeAIPromptOptions {
|
|
|
8330
8735
|
* The useCase of the prompt.
|
|
8331
8736
|
*/
|
|
8332
8737
|
useCase?: string;
|
|
8738
|
+
/**
|
|
8739
|
+
* Whether to stream the response or not.
|
|
8740
|
+
*/
|
|
8741
|
+
stream?: boolean;
|
|
8742
|
+
/**
|
|
8743
|
+
* Callback function for stream data
|
|
8744
|
+
*/
|
|
8745
|
+
streamOnDataHandler?: Function;
|
|
8746
|
+
/**
|
|
8747
|
+
* Array of tokens which signal the end of a sentence and trigger
|
|
8748
|
+
* flushing of token buffer to the provided handler
|
|
8749
|
+
*/
|
|
8750
|
+
streamStopTokens?: string[];
|
|
8751
|
+
/**
|
|
8752
|
+
* A string denoting the reference ID of the chosen LLM provider
|
|
8753
|
+
*/
|
|
8754
|
+
llmProviderReferenceId?: string;
|
|
8333
8755
|
}
|
|
8334
8756
|
export interface IOpenAiCredentials {
|
|
8335
8757
|
apiType?: TGenerativeAIProviders;
|
|
8336
8758
|
apiKey: string;
|
|
8759
|
+
apiCustomBaseUrl?: string;
|
|
8337
8760
|
apiResourceName?: string;
|
|
8338
8761
|
apiDeploymentName?: string;
|
|
8339
8762
|
apiVersion?: string;
|
|
@@ -8347,6 +8770,7 @@ export interface IKnowledgeSearchData extends IPayloadBaseMetaData {
|
|
|
8347
8770
|
knowledgeStoreIds?: string[];
|
|
8348
8771
|
openAiCredentials?: IOpenAiCredentials;
|
|
8349
8772
|
sessionId?: string;
|
|
8773
|
+
tags?: string[];
|
|
8350
8774
|
}
|
|
8351
8775
|
export interface IKnowledgeSearchReturnValue {
|
|
8352
8776
|
status: "success" | "error";
|
|
@@ -8355,19 +8779,26 @@ export interface IKnowledgeSearchReturnValue {
|
|
|
8355
8779
|
topK: [
|
|
8356
8780
|
{
|
|
8357
8781
|
text: string;
|
|
8358
|
-
certainty: number;
|
|
8359
8782
|
distance: number;
|
|
8360
|
-
|
|
8361
|
-
|
|
8362
|
-
|
|
8363
|
-
|
|
8364
|
-
|
|
8365
|
-
|
|
8783
|
+
sourceReferenceId: string;
|
|
8784
|
+
sourceMetaData: {
|
|
8785
|
+
sourceName: string;
|
|
8786
|
+
sourceType: string;
|
|
8787
|
+
title: string;
|
|
8788
|
+
url: string;
|
|
8789
|
+
[key: string]: any;
|
|
8790
|
+
};
|
|
8791
|
+
chunkMetaData?: {
|
|
8792
|
+
[key: string]: any;
|
|
8366
8793
|
};
|
|
8794
|
+
order: number;
|
|
8367
8795
|
}
|
|
8368
8796
|
];
|
|
8369
8797
|
};
|
|
8370
8798
|
}
|
|
8799
|
+
export interface IGetConversationTranscriptParams {
|
|
8800
|
+
turnLimit: number;
|
|
8801
|
+
}
|
|
8371
8802
|
export interface ISensitiveLoggingSettings {
|
|
8372
8803
|
maskLogging: boolean;
|
|
8373
8804
|
maskAnalytics: boolean;
|
|
@@ -8425,6 +8856,7 @@ export interface IActions {
|
|
|
8425
8856
|
deleteSystemContext?: (key: string) => void;
|
|
8426
8857
|
getCache?: (key: string) => void;
|
|
8427
8858
|
getContext?: (key: string) => any;
|
|
8859
|
+
getConversationTranscript?: (mode: "string" | "json", options: IGetConversationTranscriptParams) => ILastConversationEntry[];
|
|
8428
8860
|
getLastTopic?: (type: any, age: number) => void;
|
|
8429
8861
|
getState?: () => string;
|
|
8430
8862
|
getSystemContext?: (key: string) => any;
|
|
@@ -8470,6 +8902,7 @@ export interface IActions {
|
|
|
8470
8902
|
say?: (text: string, data?: any, settings?: ISayNodeSettings) => void;
|
|
8471
8903
|
sendHttpRequest?: (httpRequestParams: IHttpRequestNodeParams) => Promise<void>;
|
|
8472
8904
|
sendTileUpdateToAgentAssistWorkspace: (params: ISendTileUpdateParams) => Promise<void>;
|
|
8905
|
+
sendConfigUpdateToAgentAssistWorkspace: (params: ISendConfigUpdateParams) => Promise<void>;
|
|
8473
8906
|
setCache?: (key: string, val: any) => void;
|
|
8474
8907
|
setContext?: (key: string, value: any) => void;
|
|
8475
8908
|
setContextAndPersist?: (key: string, value: any) => Promise<void>;
|
|
@@ -8497,6 +8930,7 @@ export interface IActions {
|
|
|
8497
8930
|
updateProfile?: (profileSchemaField: string, value: any) => Promise<any>;
|
|
8498
8931
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
8499
8932
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
8933
|
+
getAgentAssistConfigId: () => string;
|
|
8500
8934
|
}
|
|
8501
8935
|
export interface ICognigyNLPProperties {
|
|
8502
8936
|
/** The original text of the user */
|
|
@@ -9013,7 +9447,7 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
|
|
|
9013
9447
|
setInputLanguageOnExecutionCount: number;
|
|
9014
9448
|
};
|
|
9015
9449
|
}
|
|
9016
|
-
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal"> {
|
|
9450
|
+
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal" | "getConversationTranscript"> {
|
|
9017
9451
|
setNextNode: (nodeId: string, newFlowId?: string) => void;
|
|
9018
9452
|
resetNextNodes: () => void;
|
|
9019
9453
|
stopExecution: () => void;
|
|
@@ -9101,6 +9535,9 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
9101
9535
|
completeGoal: (goal: string) => void;
|
|
9102
9536
|
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
9103
9537
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
9538
|
+
getAgentAssistConfigId: () => string;
|
|
9539
|
+
countGPTTokens?: (prompt: string) => number;
|
|
9540
|
+
getConversationTranscript?: (mode: string, options?: any) => any;
|
|
9104
9541
|
}
|
|
9105
9542
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
9106
9543
|
api: INodeExecutionAPI;
|
|
@@ -9223,7 +9660,8 @@ declare const nodePreviewTypes: readonly [
|
|
|
9223
9660
|
"text",
|
|
9224
9661
|
"sayNode",
|
|
9225
9662
|
"custom",
|
|
9226
|
-
"resource"
|
|
9663
|
+
"resource",
|
|
9664
|
+
"image"
|
|
9227
9665
|
];
|
|
9228
9666
|
export declare type TNodePreviewType = typeof nodePreviewTypes[number];
|
|
9229
9667
|
export interface INodePreview {
|
|
@@ -9266,7 +9704,9 @@ export interface INodeDependencies {
|
|
|
9266
9704
|
}
|
|
9267
9705
|
declare const nodeFieldTypes: readonly [
|
|
9268
9706
|
"adaptivecard",
|
|
9707
|
+
"agentAssistConfig",
|
|
9269
9708
|
"appTemplate",
|
|
9709
|
+
"backgroundSelector",
|
|
9270
9710
|
"caseNode",
|
|
9271
9711
|
"checkbox",
|
|
9272
9712
|
"chipInput",
|
|
@@ -9285,6 +9725,9 @@ declare const nodeFieldTypes: readonly [
|
|
|
9285
9725
|
"json",
|
|
9286
9726
|
"keyValuePairs",
|
|
9287
9727
|
"knowledgeStore",
|
|
9728
|
+
"knowledgeStoreSelect",
|
|
9729
|
+
"knowledgeSourceTags",
|
|
9730
|
+
"llmSelect",
|
|
9288
9731
|
"lexicon",
|
|
9289
9732
|
"localeField",
|
|
9290
9733
|
"node",
|
|
@@ -9299,6 +9742,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
9299
9742
|
"sttLanguageAzureSelect",
|
|
9300
9743
|
"sttLanguageGoogleSelect",
|
|
9301
9744
|
"sttSelect",
|
|
9745
|
+
"sttTierModelSelect",
|
|
9302
9746
|
"switchNode",
|
|
9303
9747
|
"text",
|
|
9304
9748
|
"textArray",
|
|
@@ -9366,6 +9810,8 @@ export interface INodeSection {
|
|
|
9366
9810
|
key: string;
|
|
9367
9811
|
/** Human readable lable of the seciton, e.g. 'Authentication' */
|
|
9368
9812
|
label: string | INodeFieldTranslations;
|
|
9813
|
+
/** Human readable description of the section, e.g. 'Configure authentication for this node' */
|
|
9814
|
+
description?: string | INodeFieldTranslations;
|
|
9369
9815
|
/** Condition whether this section should be rendered */
|
|
9370
9816
|
condition?: TNodeFieldCondition;
|
|
9371
9817
|
/** Whether the sections should be collapsed by default (default: false) */
|
|
@@ -9417,11 +9863,17 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
9417
9863
|
/** The form defines how fields and sections should be render in order */
|
|
9418
9864
|
form?: INodeFieldAndSectionFormElement[];
|
|
9419
9865
|
}
|
|
9866
|
+
export interface IParams {
|
|
9867
|
+
[key: string]: any;
|
|
9868
|
+
}
|
|
9420
9869
|
export interface IConnectionSchemaField {
|
|
9421
9870
|
_id?: TMongoId;
|
|
9422
9871
|
/** The field name, e.g. 'client_id' */
|
|
9423
9872
|
fieldName: string;
|
|
9424
9873
|
required?: boolean;
|
|
9874
|
+
label?: string;
|
|
9875
|
+
description?: string;
|
|
9876
|
+
params?: IParams;
|
|
9425
9877
|
}
|
|
9426
9878
|
export interface IConnectionSchema extends IEntityMeta {
|
|
9427
9879
|
_id: TMongoId;
|
|
@@ -9453,7 +9905,9 @@ export interface IAppTemplate extends IEntityMeta {
|
|
|
9453
9905
|
organisationReference: TMongoId;
|
|
9454
9906
|
}
|
|
9455
9907
|
export declare type IExtensionType = "nodes";
|
|
9456
|
-
export interface IExtension extends
|
|
9908
|
+
export interface IExtension extends IExtensionData, IExtensionNodePackage {
|
|
9909
|
+
}
|
|
9910
|
+
export interface IExtensionData extends IEntityMeta {
|
|
9457
9911
|
/** The name of the extension */
|
|
9458
9912
|
name: string;
|
|
9459
9913
|
/** Optional human readable name of the extension */
|
|
@@ -9543,7 +9997,9 @@ export interface IGraphFunction {
|
|
|
9543
9997
|
}
|
|
9544
9998
|
declare const knowledgeStoreStatus: readonly [
|
|
9545
9999
|
"ready",
|
|
9546
|
-
"
|
|
10000
|
+
"ingesting",
|
|
10001
|
+
"warning",
|
|
10002
|
+
"empty"
|
|
9547
10003
|
];
|
|
9548
10004
|
export declare type TKnowledgeStoreStatus = typeof knowledgeStoreStatus[number];
|
|
9549
10005
|
export interface IKnowledgeStore extends IEntityMeta {
|
|
@@ -9556,12 +10012,21 @@ export interface IKnowledgeStore extends IEntityMeta {
|
|
|
9556
10012
|
projectReference: TMongoId;
|
|
9557
10013
|
organisationReference: TMongoId;
|
|
9558
10014
|
}
|
|
10015
|
+
export interface IGraphKnowledgeStoreAttachmentSource {
|
|
10016
|
+
_id: string;
|
|
10017
|
+
type: "attachedSource";
|
|
10018
|
+
}
|
|
10019
|
+
export interface IGraphKnowledgeStoreAttachmentChunk {
|
|
10020
|
+
_id: string;
|
|
10021
|
+
type: "attachedChunk";
|
|
10022
|
+
}
|
|
9559
10023
|
export interface IGraphKnowledgeStore {
|
|
9560
10024
|
type: "knowledgeStore";
|
|
9561
10025
|
_id: TMongoId;
|
|
9562
10026
|
name: string;
|
|
9563
10027
|
referenceId: string;
|
|
9564
10028
|
properties: Pick<IKnowledgeStore, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
|
|
10029
|
+
dependencies?: (IGraphKnowledgeStoreAttachmentSource | IGraphKnowledgeStoreAttachmentChunk)[];
|
|
9565
10030
|
}
|
|
9566
10031
|
export interface ILexicon extends IEntityMeta {
|
|
9567
10032
|
name: string;
|
|
@@ -11177,7 +11642,7 @@ export interface INodeAppearance_2_0 {
|
|
|
11177
11642
|
variant?: "regular" | "mini" | "hexagon";
|
|
11178
11643
|
}
|
|
11179
11644
|
export interface INodePreview_2_0 {
|
|
11180
|
-
type: "text" | "sayNode" | "custom" | "resource";
|
|
11645
|
+
type: "text" | "sayNode" | "custom" | "resource" | "image";
|
|
11181
11646
|
key: string;
|
|
11182
11647
|
}
|
|
11183
11648
|
export interface INodeConstraints_2_0 {
|
|
@@ -11212,7 +11677,7 @@ export interface INodeField_2_0 {
|
|
|
11212
11677
|
};
|
|
11213
11678
|
}
|
|
11214
11679
|
export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
|
|
11215
|
-
export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect";
|
|
11680
|
+
export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "sttTierModelSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect";
|
|
11216
11681
|
export interface INodeDependencies_2_0 {
|
|
11217
11682
|
/** A list of Node types */
|
|
11218
11683
|
children: string[];
|
|
@@ -11291,6 +11756,8 @@ export interface INodeSection_2_0 {
|
|
|
11291
11756
|
key: string;
|
|
11292
11757
|
/** Human readable lable of the seciton, e.g. 'Authentication' */
|
|
11293
11758
|
label: string | INodeFieldTranslations;
|
|
11759
|
+
/** Human readable description of the section, e.g. 'Configure authentication for this node' */
|
|
11760
|
+
description?: string | INodeFieldTranslations;
|
|
11294
11761
|
/** Condition whether this section should be rendered */
|
|
11295
11762
|
condition?: INodeFieldCondition_2_0;
|
|
11296
11763
|
/** Whether the sections should be collapsed by default (default: false) */
|
|
@@ -12762,6 +13229,8 @@ declare const journeyStepGoals: readonly [
|
|
|
12762
13229
|
"createEndpoint",
|
|
12763
13230
|
"createLexicon",
|
|
12764
13231
|
"createSnapshot",
|
|
13232
|
+
"createKnowledgeStore",
|
|
13233
|
+
"createKnowledgeSource",
|
|
12765
13234
|
"openWebchat",
|
|
12766
13235
|
"createCodeNode",
|
|
12767
13236
|
"createHttpRequestNode",
|
|
@@ -12769,6 +13238,10 @@ declare const journeyStepGoals: readonly [
|
|
|
12769
13238
|
"createQuestionNode",
|
|
12770
13239
|
"createSayNode",
|
|
12771
13240
|
"createLookupNode",
|
|
13241
|
+
"createKnowledgeSearchNode",
|
|
13242
|
+
"createSearchExtractOutputNode",
|
|
13243
|
+
"createGptConversationNode",
|
|
13244
|
+
"createLlmPromptNode",
|
|
12772
13245
|
"updateCaseNode",
|
|
12773
13246
|
"updateHttpRequestNode",
|
|
12774
13247
|
"updateIfNode",
|
|
@@ -13883,7 +14356,6 @@ export interface IVoiceConfigParams {
|
|
|
13883
14356
|
bargeInOnDtmf: boolean;
|
|
13884
14357
|
bargeInSticky: boolean;
|
|
13885
14358
|
enableAdvancedSTTConfig: boolean;
|
|
13886
|
-
enableAdvancedTTSConfig: boolean;
|
|
13887
14359
|
sttLanguage: string;
|
|
13888
14360
|
sttVendor: string;
|
|
13889
14361
|
sttHints: string[];
|
|
@@ -13892,11 +14364,13 @@ export interface IVoiceConfigParams {
|
|
|
13892
14364
|
sttVadEnabled: boolean;
|
|
13893
14365
|
sttVadMode: number;
|
|
13894
14366
|
sttVadVoiceMs: number;
|
|
14367
|
+
sttLabel: string;
|
|
13895
14368
|
ttsDisableCache: boolean;
|
|
13896
14369
|
ttsVoice: string;
|
|
13897
14370
|
ttsLanguage: string;
|
|
13898
|
-
|
|
13899
|
-
|
|
14371
|
+
ttsModel: string;
|
|
14372
|
+
ttsVendor: TVoiceGateway2TTSVendor | "default" | "none";
|
|
14373
|
+
ttsLabel: string;
|
|
13900
14374
|
azureSttContextId: string;
|
|
13901
14375
|
azureSpeechRecognitionMode: string;
|
|
13902
14376
|
azureEnableAudioLogging: boolean;
|
|
@@ -13904,6 +14378,7 @@ export interface IVoiceConfigParams {
|
|
|
13904
14378
|
googleDisablePunctuation: boolean;
|
|
13905
14379
|
googleInteractionType: string;
|
|
13906
14380
|
googleHintsBoost: number;
|
|
14381
|
+
googleModel: TVoiceGateway2GoogleModel;
|
|
13907
14382
|
userNoInputMode: TVoiceGateway2UserNoInputMode;
|
|
13908
14383
|
userNoInputTimeout: number;
|
|
13909
14384
|
userNoInputRetries: number;
|
|
@@ -13934,6 +14409,11 @@ export interface IVoiceConfigParams {
|
|
|
13934
14409
|
sttGoogleLang1: string;
|
|
13935
14410
|
sttGoogleLang2: string;
|
|
13936
14411
|
sttGoogleLang3: string;
|
|
14412
|
+
sttDeepgramTier: string;
|
|
14413
|
+
sttDeepgramModel: string;
|
|
14414
|
+
deepgramEndpointing: boolean;
|
|
14415
|
+
deepgramEndpointingValue: number;
|
|
14416
|
+
deepgramSmartFormatting: boolean;
|
|
13937
14417
|
}
|
|
13938
14418
|
export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
|
|
13939
14419
|
config: IVoiceConfigParams;
|
|
@@ -13953,6 +14433,7 @@ export interface ITransferParams extends INodeFunctionBaseParams {
|
|
|
13953
14433
|
config: {
|
|
13954
14434
|
transferReason: string;
|
|
13955
14435
|
referTo: string;
|
|
14436
|
+
referredBy: string;
|
|
13956
14437
|
useTransferSipHeaders: boolean;
|
|
13957
14438
|
transferSipHeaders: any;
|
|
13958
14439
|
};
|
|
@@ -13979,6 +14460,7 @@ export interface ISendMetadataParams extends INodeFunctionBaseParams {
|
|
|
13979
14460
|
}
|
|
13980
14461
|
export interface IMuteSpeechInputParamsConfig {
|
|
13981
14462
|
muteSpeechInput: boolean;
|
|
14463
|
+
muteDtmfInput: boolean;
|
|
13982
14464
|
}
|
|
13983
14465
|
export interface IMuteSpeechInputParams extends INodeFunctionBaseParams {
|
|
13984
14466
|
config: IMuteSpeechInputParamsConfig;
|
|
@@ -13992,11 +14474,16 @@ export interface IVoiceConfigParams {
|
|
|
13992
14474
|
ttsVoice: string;
|
|
13993
14475
|
ttsLanguage: string;
|
|
13994
14476
|
ttsVendor: TVoiceGateway2TTSVendor;
|
|
14477
|
+
ttsModel: string;
|
|
13995
14478
|
sttDisablePunctuation: boolean;
|
|
13996
14479
|
azureSttContextId: string;
|
|
13997
14480
|
azureEnableAudioLogging: boolean;
|
|
13998
|
-
|
|
13999
|
-
|
|
14481
|
+
googleModel: TVoiceGateway2GoogleModel;
|
|
14482
|
+
sttDeepgramTier: string;
|
|
14483
|
+
sttDeepgramModel: string;
|
|
14484
|
+
deepgramEndpointing: boolean;
|
|
14485
|
+
deepgramEndpointingValue: number;
|
|
14486
|
+
deepgramSmartFormatting: boolean;
|
|
14000
14487
|
}
|
|
14001
14488
|
export interface ISessionSpeechParams extends INodeFunctionBaseParams {
|
|
14002
14489
|
config: IVoiceConfigParams;
|
|
@@ -14360,16 +14847,28 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
|
14360
14847
|
transferType: "refer" | "dial";
|
|
14361
14848
|
transferReason: string;
|
|
14362
14849
|
transferTarget: string;
|
|
14850
|
+
referredBy: string;
|
|
14363
14851
|
useTransferSipHeaders: boolean;
|
|
14364
14852
|
transferSipHeaders: {
|
|
14365
14853
|
[key: string]: string | object;
|
|
14366
14854
|
};
|
|
14855
|
+
agentAssistEnabled: boolean;
|
|
14856
|
+
agentAssistHeadersKey?: string;
|
|
14367
14857
|
dialCallerId?: string;
|
|
14368
14858
|
dialMusic?: string;
|
|
14859
|
+
dialTimeout?: number;
|
|
14369
14860
|
dialTranscriptionWebhook?: string;
|
|
14370
14861
|
recognitionChannel: number;
|
|
14371
14862
|
sttLanguage: string;
|
|
14372
14863
|
sttVendor: string;
|
|
14864
|
+
sttDeepgramTier: string;
|
|
14865
|
+
sttDeepgramModel: string;
|
|
14866
|
+
sttDisablePunctuation: boolean;
|
|
14867
|
+
googleModel: TVoiceGateway2GoogleModel;
|
|
14868
|
+
sttLabel: string;
|
|
14869
|
+
deepgramEndpointing: boolean;
|
|
14870
|
+
deepgramEndpointingValue: number;
|
|
14871
|
+
deepgramSmartFormatting: boolean;
|
|
14373
14872
|
amdEnabled: boolean;
|
|
14374
14873
|
amdRedirectOnMachineDetected: boolean;
|
|
14375
14874
|
amdRedirectText: string;
|
|
@@ -14392,6 +14891,7 @@ export interface IRecordNodeParams extends INodeFunctionBaseParams {
|
|
|
14392
14891
|
}
|
|
14393
14892
|
export interface IMuteSpeechInputParamsConfig {
|
|
14394
14893
|
muteSpeechInput: boolean;
|
|
14894
|
+
muteDtmfInput: boolean;
|
|
14395
14895
|
}
|
|
14396
14896
|
export interface IMuteSpeechInputParams extends INodeFunctionBaseParams {
|
|
14397
14897
|
config: IMuteSpeechInputParamsConfig;
|
|
@@ -14407,6 +14907,48 @@ export interface ICognigyVoiceGateway2Nodes {
|
|
|
14407
14907
|
"recordNode": ICreateChartNodeBasicNodesData<"recordNode", IRecordNodeParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
14408
14908
|
"muteSpeechInputNode": ICreateChartNodeBasicNodesData<"muteSpeechInput", IMuteSpeechInputParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
14409
14909
|
}
|
|
14910
|
+
export interface ISearchExtractOutputNodeParams extends INodeFunctionBaseParams {
|
|
14911
|
+
config: {
|
|
14912
|
+
mode: "seo" | "se" | "s";
|
|
14913
|
+
followUpDetection: "none" | "transcript";
|
|
14914
|
+
followUpDetectionSteps: number;
|
|
14915
|
+
hallucinationShield: boolean;
|
|
14916
|
+
topK: number;
|
|
14917
|
+
searchString: string;
|
|
14918
|
+
searchStoreLocation: "input" | "context" | "default";
|
|
14919
|
+
searchStoreLocationContextKey: string;
|
|
14920
|
+
searchStoreLocationInputKey: string;
|
|
14921
|
+
searchSourceTags: string[];
|
|
14922
|
+
knowledgeStoreId?: string;
|
|
14923
|
+
prompt: string;
|
|
14924
|
+
temperature: number;
|
|
14925
|
+
maxTokens: number;
|
|
14926
|
+
topP: number;
|
|
14927
|
+
presencePenalty: number;
|
|
14928
|
+
frequencyPenalty: number;
|
|
14929
|
+
useStop: boolean;
|
|
14930
|
+
stop: string[];
|
|
14931
|
+
storeLocation: string;
|
|
14932
|
+
contextKey: string;
|
|
14933
|
+
inputKey: string;
|
|
14934
|
+
timeout: number;
|
|
14935
|
+
timeoutMessage: string;
|
|
14936
|
+
outputMode: "text" | "stream" | "adaptiveCard";
|
|
14937
|
+
outputFallback: string;
|
|
14938
|
+
errorHandling: "stop" | "continue" | "goto";
|
|
14939
|
+
errorHandlingGotoTarget: {
|
|
14940
|
+
flow: string;
|
|
14941
|
+
node: string;
|
|
14942
|
+
};
|
|
14943
|
+
organisationId: string;
|
|
14944
|
+
streamStopTokens: string[];
|
|
14945
|
+
streamDescription: string;
|
|
14946
|
+
searchStringDescription: string;
|
|
14947
|
+
debugLogTokenCount: boolean;
|
|
14948
|
+
debugLogRequestAndCompletion: boolean;
|
|
14949
|
+
debugDescription: string;
|
|
14950
|
+
};
|
|
14951
|
+
}
|
|
14410
14952
|
export interface ICognigyBasicNodes {
|
|
14411
14953
|
addToContext: ICreateChartNodeBasicNodesData<"addToContext", IAddToContextNodeParams, TBASIC_EXTENSION>;
|
|
14412
14954
|
copyDataToContext: ICreateChartNodeBasicNodesData<"copyDataToContext", ICopyDataToContextNodeParams, TBASIC_EXTENSION>;
|
|
@@ -14452,6 +14994,7 @@ export interface ICognigyBasicNodes {
|
|
|
14452
14994
|
handoverV2: ICreateChartNodeBasicNodesData<"handoverV2", IHandoverNodeV2Params, TBASIC_EXTENSION>;
|
|
14453
14995
|
checkAgentAvailability: ICreateChartNodeBasicNodesData<"checkAgentAvailability", ICheckAgentAvailabilityNodeParams, TBASIC_EXTENSION>;
|
|
14454
14996
|
sendTileUpdateToAgentAssistWorkspace: ICreateChartNodeBasicNodesData<"sendTileUpdateToAgentAssistWorkspace", ISendTileUpdateParams, TBASIC_EXTENSION>;
|
|
14997
|
+
sendConfigUpdateToAgentAssistWorkspace: ICreateChartNodeBasicNodesData<"sendConfigUpdateToAgentAssistWorkspace", ISendConfigUpdateParams, TBASIC_EXTENSION>;
|
|
14455
14998
|
httpRequest: ICreateChartNodeBasicNodesData<"httpRequest", IHttpRequestNodeParams, TBASIC_EXTENSION>;
|
|
14456
14999
|
triggerFunction: ICreateChartNodeBasicNodesData<"triggerFunction", ITriggerFunctionNodeParams, TBASIC_EXTENSION>;
|
|
14457
15000
|
onScheduled: ICreateChartNodeBasicNodesData<"onScheduled", IScheduledNodeParams, TBASIC_EXTENSION>;
|
|
@@ -14472,6 +15015,7 @@ export interface ICognigyBasicNodes {
|
|
|
14472
15015
|
muteSpeechInput: ICreateChartNodeBasicNodesData<"muteSpeechInput", IMuteSpeechInputParams, TBASIC_EXTENSION>;
|
|
14473
15016
|
sendMetadata: ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TBASIC_EXTENSION>;
|
|
14474
15017
|
assistInfo: ICreateChartNodeBasicNodesData<"assistInfo", IAssistInfoNodeParams, TBASIC_EXTENSION>;
|
|
15018
|
+
searchExtractOutput: ICreateChartNodeBasicNodesData<"searchExtractOutput", ISearchExtractOutputNodeParams, TBASIC_EXTENSION>;
|
|
14475
15019
|
}
|
|
14476
15020
|
export interface ICognigyNodes {
|
|
14477
15021
|
"@cognigy/basic-nodes": ICognigyBasicNodes;
|
|
@@ -14703,24 +15247,32 @@ export interface IIndexYesNoSentencesRestReturnValue_2_0 extends ICursorBasedPag
|
|
|
14703
15247
|
* properties:
|
|
14704
15248
|
* columns:
|
|
14705
15249
|
* type: number
|
|
15250
|
+
* description: Number of columns in the grid.
|
|
14706
15251
|
* rows:
|
|
14707
15252
|
* type: number
|
|
15253
|
+
* description: Number of rows in the grid.
|
|
14708
15254
|
* gap:
|
|
14709
15255
|
* type: number
|
|
15256
|
+
* description: Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used.
|
|
14710
15257
|
* tiles:
|
|
14711
15258
|
* type: object
|
|
14712
15259
|
* properties:
|
|
14713
15260
|
* tile-id:
|
|
14714
15261
|
* type: object
|
|
15262
|
+
* description: The Tile ID is used in the Flow Nodes to fill in this specific tile.
|
|
14715
15263
|
* properties:
|
|
14716
15264
|
* x:
|
|
14717
15265
|
* type: number
|
|
15266
|
+
* description: The row number where the tile is located, starting from 1.
|
|
14718
15267
|
* y:
|
|
14719
15268
|
* type: number
|
|
15269
|
+
* description: The column number where the tile is located, starting from 1.
|
|
14720
15270
|
* columns:
|
|
14721
15271
|
* type: number
|
|
15272
|
+
* description: The number of columns the tile should occupy. The default value is 1.
|
|
14722
15273
|
* rows:
|
|
14723
15274
|
* type: number
|
|
15275
|
+
* description: The number of rows the tile should occupy. The default value is 1.
|
|
14724
15276
|
*
|
|
14725
15277
|
* IAgentAssistConfigData_2_0:
|
|
14726
15278
|
* type: object
|
|
@@ -14848,6 +15400,23 @@ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<I
|
|
|
14848
15400
|
}
|
|
14849
15401
|
export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
|
|
14850
15402
|
}
|
|
15403
|
+
export interface IOpenAIMeta_2_0 {
|
|
15404
|
+
customModel: string;
|
|
15405
|
+
}
|
|
15406
|
+
export interface IAlephAlphaMeta_2_0 {
|
|
15407
|
+
customModel: string;
|
|
15408
|
+
}
|
|
15409
|
+
export interface IAzureOpenAIMeta_2_0 {
|
|
15410
|
+
resourceName?: string;
|
|
15411
|
+
deploymentName?: string;
|
|
15412
|
+
baseCustomUrl?: string | null;
|
|
15413
|
+
apiVersion?: string;
|
|
15414
|
+
}
|
|
15415
|
+
export interface IGoogleVertexAIMeta_2_0 {
|
|
15416
|
+
location: string;
|
|
15417
|
+
apiEndPoint: string;
|
|
15418
|
+
publisher?: string;
|
|
15419
|
+
}
|
|
14851
15420
|
/**
|
|
14852
15421
|
* @openapi
|
|
14853
15422
|
*
|
|
@@ -14875,6 +15444,13 @@ export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBas
|
|
|
14875
15444
|
* type: boolean
|
|
14876
15445
|
* description: Sets the LLM to default (fallback) if no other LLM is set
|
|
14877
15446
|
* example: false
|
|
15447
|
+
* openAI:
|
|
15448
|
+
* type: object
|
|
15449
|
+
* description: OpenAI specific meta data
|
|
15450
|
+
* properties:
|
|
15451
|
+
* customModel:
|
|
15452
|
+
* type: string
|
|
15453
|
+
* example: gpt-4-32k-0613
|
|
14878
15454
|
* azureOpenAI:
|
|
14879
15455
|
* type: object
|
|
14880
15456
|
* description: Azure OpenAI specific meta data
|
|
@@ -14919,7 +15495,13 @@ export interface ILargeLanguageModel_2_0 {
|
|
|
14919
15495
|
createdBy: TMongoId;
|
|
14920
15496
|
lastChangedBy: TMongoId;
|
|
14921
15497
|
/** Meta data for the AzureOpenAI connection */
|
|
14922
|
-
azureOpenAI?:
|
|
15498
|
+
azureOpenAI?: IAzureOpenAIMeta_2_0;
|
|
15499
|
+
/** Meta data for the OpenAI LLM */
|
|
15500
|
+
openAI?: IOpenAIMeta_2_0;
|
|
15501
|
+
/** Meta Data for the AlephAlpha LLM */
|
|
15502
|
+
alephAlpha?: IAlephAlphaMeta_2_0;
|
|
15503
|
+
/** Meta data for the GoogleVertexAI connection */
|
|
15504
|
+
googleVertexAI?: IGoogleVertexAIMeta_2_0;
|
|
14923
15505
|
}
|
|
14924
15506
|
export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
|
|
14925
15507
|
}
|
|
@@ -14943,10 +15525,13 @@ export interface IUpdateLargeLanguageModelRestData_2_0 extends IUpdateLargeLangu
|
|
|
14943
15525
|
}
|
|
14944
15526
|
export interface IUpdateLargeLanguageModelRestReturnValue_2_0 {
|
|
14945
15527
|
}
|
|
15528
|
+
export interface IDeleteLargeLanguageModelRestQuery_2_0 {
|
|
15529
|
+
force?: string;
|
|
15530
|
+
}
|
|
14946
15531
|
export interface IDeleteLargeLanguageModelRestDataParams_2_0 {
|
|
14947
15532
|
largeLanguageModelId: string;
|
|
14948
15533
|
}
|
|
14949
|
-
export interface IDeleteLargeLanguageModelRestData_2_0 extends IDeleteLargeLanguageModelRestDataParams_2_0 {
|
|
15534
|
+
export interface IDeleteLargeLanguageModelRestData_2_0 extends IDeleteLargeLanguageModelRestDataParams_2_0, IDeleteLargeLanguageModelRestQuery_2_0 {
|
|
14950
15535
|
}
|
|
14951
15536
|
export interface IDeleteLargeLanguageModelRestReturnValue_2_0 {
|
|
14952
15537
|
}
|
|
@@ -15071,12 +15656,16 @@ export interface IUpdateKnowledgeStoreRestReturnValue_2_0 {
|
|
|
15071
15656
|
declare const knowledgeSourceStatus: readonly [
|
|
15072
15657
|
"ready",
|
|
15073
15658
|
"ingesting",
|
|
15074
|
-
"disabled"
|
|
15659
|
+
"disabled",
|
|
15660
|
+
"failure"
|
|
15075
15661
|
];
|
|
15076
15662
|
export declare type TKnowledgeSourceStatus = typeof knowledgeSourceStatus[number];
|
|
15077
15663
|
declare const knowledgeSourceType: readonly [
|
|
15078
|
-
"
|
|
15079
|
-
"
|
|
15664
|
+
"pdf",
|
|
15665
|
+
"txt",
|
|
15666
|
+
"docx",
|
|
15667
|
+
"ctxt",
|
|
15668
|
+
"url",
|
|
15080
15669
|
"manual"
|
|
15081
15670
|
];
|
|
15082
15671
|
export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
|
|
@@ -15085,6 +15674,8 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15085
15674
|
fileName?: string;
|
|
15086
15675
|
mimeType?: string;
|
|
15087
15676
|
url?: string;
|
|
15677
|
+
failReason?: string;
|
|
15678
|
+
tags?: string[];
|
|
15088
15679
|
}
|
|
15089
15680
|
/**
|
|
15090
15681
|
* @openapi
|
|
@@ -15106,10 +15697,20 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15106
15697
|
* type:
|
|
15107
15698
|
* type: string
|
|
15108
15699
|
* enum:
|
|
15109
|
-
* -
|
|
15700
|
+
* - url
|
|
15110
15701
|
* - manual
|
|
15111
|
-
* -
|
|
15702
|
+
* - pdf
|
|
15703
|
+
* - txt
|
|
15704
|
+
* - ctxt
|
|
15112
15705
|
* description: The type of source for the Knowledge store
|
|
15706
|
+
* metaData:
|
|
15707
|
+
* type: object
|
|
15708
|
+
* properties:
|
|
15709
|
+
* tags:
|
|
15710
|
+
* type: array
|
|
15711
|
+
* items:
|
|
15712
|
+
* type: string
|
|
15713
|
+
* example: "tag1"
|
|
15113
15714
|
* IKnowledgeSourceDataUpdate_2_0:
|
|
15114
15715
|
* allOf:
|
|
15115
15716
|
* - type: object
|
|
@@ -15136,7 +15737,7 @@ export interface IKnowledgeSourceMetaData {
|
|
|
15136
15737
|
* url:
|
|
15137
15738
|
* type: string
|
|
15138
15739
|
* example: "https://www.some-article.com"
|
|
15139
|
-
* description: The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "
|
|
15740
|
+
* description: The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "url"
|
|
15140
15741
|
*
|
|
15141
15742
|
* IKnowledgeSourceData_2_0:
|
|
15142
15743
|
* allOf:
|
|
@@ -15176,6 +15777,7 @@ export interface IKnowledgeSource_2_0 {
|
|
|
15176
15777
|
type: TKnowledgeSourceType;
|
|
15177
15778
|
chunkCount: number;
|
|
15178
15779
|
metaData: IKnowledgeSourceMetaData;
|
|
15780
|
+
data: Record<string, unknown>;
|
|
15179
15781
|
storeReference: TMongoId;
|
|
15180
15782
|
projectReference: TMongoId;
|
|
15181
15783
|
organisationReference: TMongoId;
|
|
@@ -15194,7 +15796,7 @@ export interface IIndexKnowledgeSourcesRestReturnValue_2_0 extends ICursorBasedP
|
|
|
15194
15796
|
export interface ICreateKnowledgeSourceRestDataParams_2_0 {
|
|
15195
15797
|
knowledgeStoreId: string;
|
|
15196
15798
|
}
|
|
15197
|
-
export interface ICreateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "type">> {
|
|
15799
|
+
export interface ICreateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "type" | "metaData">> {
|
|
15198
15800
|
url?: string;
|
|
15199
15801
|
}
|
|
15200
15802
|
export interface ICreateKnowledgeSourceRestData_2_0 extends ICreateKnowledgeSourceRestDataParams_2_0, ICreateKnowledgeSourceRestDataBody_2_0 {
|
|
@@ -15219,7 +15821,7 @@ export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSour
|
|
|
15219
15821
|
}
|
|
15220
15822
|
export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
|
|
15221
15823
|
}
|
|
15222
|
-
export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status">> {
|
|
15824
|
+
export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
|
|
15223
15825
|
}
|
|
15224
15826
|
export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
|
|
15225
15827
|
knowledgeStoreId: string;
|
|
@@ -15234,6 +15836,7 @@ export interface IUploadKnowledgeSourceFileRestDataParams_2_0 {
|
|
|
15234
15836
|
}
|
|
15235
15837
|
export interface IUploadKnowledgeSourceFileRestDataBody_2_0 {
|
|
15236
15838
|
file: File | Buffer;
|
|
15839
|
+
tags?: string[];
|
|
15237
15840
|
}
|
|
15238
15841
|
export interface IUploadKnowledgeSourceFileRestData_2_0 extends IUploadKnowledgeSourceFileRestDataParams_2_0, IUploadKnowledgeSourceFileRestDataBody_2_0 {
|
|
15239
15842
|
}
|
|
@@ -15348,6 +15951,43 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
|
|
|
15348
15951
|
}
|
|
15349
15952
|
export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
|
|
15350
15953
|
}
|
|
15954
|
+
declare const uploadResumableTypes: readonly [
|
|
15955
|
+
"snapshots"
|
|
15956
|
+
];
|
|
15957
|
+
export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
|
|
15958
|
+
export interface HttpRequest {
|
|
15959
|
+
getMethod(): string;
|
|
15960
|
+
getURL(): string;
|
|
15961
|
+
setHeader(header: string, value: string): void;
|
|
15962
|
+
getHeader(header: string): string;
|
|
15963
|
+
setProgressHandler(handler: (bytesSent: number) => void): void;
|
|
15964
|
+
send(body: any): Promise<HttpResponse>;
|
|
15965
|
+
abort(): Promise<void>;
|
|
15966
|
+
getUnderlyingObject(): any;
|
|
15967
|
+
}
|
|
15968
|
+
export interface HttpResponse {
|
|
15969
|
+
getStatus(): number;
|
|
15970
|
+
getHeader(header: string): string;
|
|
15971
|
+
getBody(): string;
|
|
15972
|
+
getUnderlyingObject(): any;
|
|
15973
|
+
}
|
|
15974
|
+
export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
|
|
15975
|
+
file: Buffer | File;
|
|
15976
|
+
onError?: ((error: Error) => void) | null;
|
|
15977
|
+
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
15978
|
+
onSuccess?: (() => void) | null;
|
|
15979
|
+
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
15980
|
+
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
15981
|
+
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
15982
|
+
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
15983
|
+
}
|
|
15984
|
+
export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
|
|
15985
|
+
uploadType: TUploadResumableTypes;
|
|
15986
|
+
}
|
|
15987
|
+
export interface IUploadResumableRestReturnValue_2_0 {
|
|
15988
|
+
fileName: string;
|
|
15989
|
+
url: string;
|
|
15990
|
+
}
|
|
15351
15991
|
export interface ResourcesAPIGroup_2_0 {
|
|
15352
15992
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
15353
15993
|
indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
|
|
@@ -15581,6 +16221,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
15581
16221
|
readKnowledgeChunk: TRestAPIOperation<IReadKnowledgeChunkRestData_2_0, IReadKnowledgeChunkRestReturnValue_2_0>;
|
|
15582
16222
|
deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
|
|
15583
16223
|
updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
|
|
16224
|
+
uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
|
|
15584
16225
|
}
|
|
15585
16226
|
declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
|
|
15586
16227
|
/**
|
|
@@ -17348,6 +17989,7 @@ declare const actionTypes: readonly [
|
|
|
17348
17989
|
"setupCognigyLiveAgent",
|
|
17349
17990
|
"setupCognigyLiveAgentInbox",
|
|
17350
17991
|
"setupCognigyGenerativeAI",
|
|
17992
|
+
"setupVoiceGatewayAccount",
|
|
17351
17993
|
"updateCognigyLiveAgentInbox",
|
|
17352
17994
|
"trainAllProjectFlows",
|
|
17353
17995
|
"trainIntents",
|
|
@@ -17391,7 +18033,7 @@ export declare type TActionType = typeof actionTypes[number];
|
|
|
17391
18033
|
* description: Additional resource types for audit purposes
|
|
17392
18034
|
* example: node
|
|
17393
18035
|
* enum:
|
|
17394
|
-
* -
|
|
18036
|
+
* - aicopilotconfig
|
|
17395
18037
|
* - apiKey
|
|
17396
18038
|
* - analytics
|
|
17397
18039
|
* - connectionField
|
|
@@ -17421,7 +18063,7 @@ export declare type TActionType = typeof actionTypes[number];
|
|
|
17421
18063
|
* - user
|
|
17422
18064
|
* - yesNoIntent
|
|
17423
18065
|
*/
|
|
17424
|
-
export declare type TResourceTypeAdditional = "
|
|
18066
|
+
export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
|
|
17425
18067
|
/**
|
|
17426
18068
|
* @openapi
|
|
17427
18069
|
* components:
|
|
@@ -17668,6 +18310,7 @@ export interface IGetSystemMessageRestReturnValue_2_0 {
|
|
|
17668
18310
|
*
|
|
17669
18311
|
* IUserDataCreate_2_0:
|
|
17670
18312
|
* type: object
|
|
18313
|
+
* required: ['id', 'name', 'password']
|
|
17671
18314
|
* properties:
|
|
17672
18315
|
* id:
|
|
17673
18316
|
* type: string
|
|
@@ -17910,26 +18553,22 @@ export interface ICreateUserRestReturnValue_2_0 extends IUser_2_0 {
|
|
|
17910
18553
|
* newPassword:
|
|
17911
18554
|
* type: string
|
|
17912
18555
|
*
|
|
17913
|
-
* IManagementUserAdditional_2_0:
|
|
17914
|
-
* type: object
|
|
17915
|
-
* properties:
|
|
17916
|
-
* newPassword:
|
|
17917
|
-
* type: string
|
|
17918
|
-
*
|
|
17919
18556
|
* IUserUpdate_2_0:
|
|
17920
18557
|
* allOf:
|
|
17921
|
-
* -
|
|
18558
|
+
* - type: object
|
|
18559
|
+
* properties:
|
|
18560
|
+
* name:
|
|
18561
|
+
* type: string
|
|
17922
18562
|
* - $ref: '#/components/schemas/IUserAdditional_2_0'
|
|
17923
18563
|
*
|
|
17924
18564
|
* IUserUpdateMe_2_0:
|
|
17925
18565
|
* allOf:
|
|
17926
|
-
* -
|
|
18566
|
+
* - type: object
|
|
18567
|
+
* properties:
|
|
18568
|
+
* name:
|
|
18569
|
+
* type: string
|
|
17927
18570
|
* - $ref: '#/components/schemas/IUserMeAdditional_2_0'
|
|
17928
18571
|
*
|
|
17929
|
-
* IManagementUserUpdate_2_0:
|
|
17930
|
-
* allOf:
|
|
17931
|
-
* - $ref: '#/components/schemas/IUser_2_0'
|
|
17932
|
-
* - $ref: '#/components/schemas/IManagementUserAdditional_2_0'
|
|
17933
18572
|
*/
|
|
17934
18573
|
export interface IUserUpdate_2_0 extends Pick<IUser_2_0, "name"> {
|
|
17935
18574
|
newPassword: string;
|
|
@@ -18296,6 +18935,14 @@ export declare type TServicesNames = typeof servicesNames[number];
|
|
|
18296
18935
|
export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
|
|
18297
18936
|
[key in keyof TServicesNames]: string[];
|
|
18298
18937
|
};
|
|
18938
|
+
export interface IReadVoiceGatewayAccountRestReturnValue_2_0 {
|
|
18939
|
+
voiceGatewayAccount: string;
|
|
18940
|
+
}
|
|
18941
|
+
export interface ISetupVoiceGatewayRestDataBody_2_0 {
|
|
18942
|
+
accountSid: string;
|
|
18943
|
+
}
|
|
18944
|
+
export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDataBody_2_0 {
|
|
18945
|
+
}
|
|
18299
18946
|
export interface AdministrationAPIGroup_2_0 {
|
|
18300
18947
|
requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
|
|
18301
18948
|
validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
|
|
@@ -18344,6 +18991,8 @@ export interface AdministrationAPIGroup_2_0 {
|
|
|
18344
18991
|
readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
|
|
18345
18992
|
requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
|
|
18346
18993
|
readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
|
|
18994
|
+
setupVoiceGatewayAccount: TRestAPIOperation<ISetupVoiceGatewayRestData_2_0, {}>;
|
|
18995
|
+
readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
|
|
18347
18996
|
}
|
|
18348
18997
|
declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
|
|
18349
18998
|
/**
|
|
@@ -18465,9 +19114,6 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
|
|
|
18465
19114
|
* IOrganisationData_2_0:
|
|
18466
19115
|
* type: object
|
|
18467
19116
|
* properties:
|
|
18468
|
-
* name:
|
|
18469
|
-
* type: string
|
|
18470
|
-
* description: The name of this organisation
|
|
18471
19117
|
* disabled:
|
|
18472
19118
|
* type: boolean
|
|
18473
19119
|
* description: Flag whether this organisation is currently disabled
|
|
@@ -18494,6 +19140,18 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
|
|
|
18494
19140
|
* IOrganisation_2_0:
|
|
18495
19141
|
* allOf:
|
|
18496
19142
|
* - $ref: '#/components/schemas/IOrganisationData_2_0'
|
|
19143
|
+
* properties:
|
|
19144
|
+
* name:
|
|
19145
|
+
* type: string
|
|
19146
|
+
* description: The name of this organisation
|
|
19147
|
+
* required: ['name']
|
|
19148
|
+
* IUpdateOrganisation_2_0:
|
|
19149
|
+
* allOf:
|
|
19150
|
+
* - $ref: '#/components/schemas/IOrganisationData_2_0'
|
|
19151
|
+
* properties:
|
|
19152
|
+
* name:
|
|
19153
|
+
* type: string
|
|
19154
|
+
* description: The name of this organisation
|
|
18497
19155
|
*/
|
|
18498
19156
|
export interface IOrganisation_2_0 {
|
|
18499
19157
|
/** The mongo object id of this organisation */
|
|
@@ -18737,12 +19395,13 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
|
|
|
18737
19395
|
* schemas:
|
|
18738
19396
|
* IUserDataManagement_2_0:
|
|
18739
19397
|
* type: object
|
|
19398
|
+
* required: ['id', 'name', 'password', 'organisation']
|
|
18740
19399
|
* properties:
|
|
18741
19400
|
* id:
|
|
18742
19401
|
* type: string
|
|
18743
19402
|
* name:
|
|
18744
19403
|
* type: string
|
|
18745
|
-
* password:
|
|
19404
|
+
* password:
|
|
18746
19405
|
* type: string
|
|
18747
19406
|
* organisation:
|
|
18748
19407
|
* $ref: '#/components/schemas/TMongoId'
|
|
@@ -18755,6 +19414,29 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
|
|
|
18755
19414
|
* disabled:
|
|
18756
19415
|
* type: boolean
|
|
18757
19416
|
*
|
|
19417
|
+
* IUserUpdateDataManagement_2_0:
|
|
19418
|
+
* type: object
|
|
19419
|
+
* properties:
|
|
19420
|
+
* id:
|
|
19421
|
+
* type: string
|
|
19422
|
+
* name:
|
|
19423
|
+
* type: string
|
|
19424
|
+
* acceptedTOS:
|
|
19425
|
+
* type: boolean
|
|
19426
|
+
* disabled:
|
|
19427
|
+
* type: boolean
|
|
19428
|
+
*
|
|
19429
|
+
* IManagementUserAdditional_2_0:
|
|
19430
|
+
* type: object
|
|
19431
|
+
* properties:
|
|
19432
|
+
* newPassword:
|
|
19433
|
+
* type: string
|
|
19434
|
+
*
|
|
19435
|
+
* IManagementUserUpdate_2_0:
|
|
19436
|
+
* allOf:
|
|
19437
|
+
* - $ref: '#/components/schemas/IUserUpdateDataManagement_2_0'
|
|
19438
|
+
* - $ref: '#/components/schemas/IManagementUserAdditional_2_0'
|
|
19439
|
+
*
|
|
18758
19440
|
* IUserManagement_2_0:
|
|
18759
19441
|
* allOf:
|
|
18760
19442
|
* - $ref: '#/components/schemas/IUserDataManagement_2_0'
|
|
@@ -19011,6 +19693,7 @@ export interface IRestAPIClientConstructor {
|
|
|
19011
19693
|
export interface IRestAPIClientProperties<T = IRestAPIClientConfig> {
|
|
19012
19694
|
config: T;
|
|
19013
19695
|
setBaseUrl: (baseUrl: string) => void;
|
|
19696
|
+
getBaseUrl: () => string;
|
|
19014
19697
|
setInterceptors: (data: ISetInterceptors) => void;
|
|
19015
19698
|
}
|
|
19016
19699
|
export interface ISetInterceptors {
|