@cognigy/rest-api-client 0.13.2 → 0.14.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 +5 -1
- package/build/apigroups/ResourcesAPIGroup_2_0.js +15 -3
- package/build/shared/charts/descriptors/apps/setHtmlAppState.js +83 -13
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnection.js +14 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +19 -0
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +11 -0
- package/build/shared/charts/descriptors/index.js +8 -5
- package/build/shared/charts/descriptors/message/question/optionalQuestion.js +22 -6
- package/build/shared/charts/descriptors/message/question/question.js +193 -25
- package/build/shared/charts/descriptors/message/say.js +33 -2
- package/build/shared/charts/descriptors/service/completeText.js +316 -0
- package/build/shared/charts/descriptors/service/handoverV2.js +47 -1
- package/build/shared/charts/descriptors/service/index.js +3 -1
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +40 -7
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +93 -32
- package/build/shared/charts/descriptors/voice/nodes/play.js +8 -6
- package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +90 -8
- package/build/shared/charts/descriptors/voice/nodes/transfer.js +2 -2
- package/build/shared/charts/descriptors/voice/utils/helper.js +11 -1
- package/build/shared/charts/descriptors/voicegateway/nodes/agentAssist.js +2 -2
- package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +4 -1
- package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js +3 -3
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +125 -26
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +91 -7
- package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +18 -11
- package/build/shared/charts/descriptors/voicegateway2/utils/strip-nulls.js +4 -1
- package/build/shared/charts/helpers/generativeAI/getRephraseWithAIFields.js +100 -0
- package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +44 -0
- package/build/shared/constants.js +2 -1
- package/build/shared/interfaces/ai.js +16 -0
- package/build/shared/interfaces/analytics/IAnalyticsDataGoals.js +3 -0
- package/build/shared/interfaces/endpointInterface.js +1 -0
- package/build/shared/interfaces/filemanager/IRuntimeFile.js +30 -0
- package/build/shared/interfaces/filemanager/index.js +1 -0
- package/build/shared/interfaces/handover.js +39 -3
- package/build/shared/interfaces/messageAPI/endpoints.js +2 -0
- package/build/shared/interfaces/messageAPI/handover.js +6 -0
- package/build/shared/interfaces/resources/IConnectionSchema.js +2 -1
- package/build/shared/interfaces/resources/IExtension.js +2 -1
- package/build/shared/interfaces/resources/IFlow.js +2 -1
- package/build/shared/interfaces/resources/ILexicon.js +15 -2
- package/build/shared/interfaces/resources/INodeDescriptorSet.js +1 -1
- package/build/shared/interfaces/resources/intent/IIntent.js +5 -2
- package/build/shared/interfaces/resources/intent/IIntentRelation.js +3 -1
- package/build/shared/interfaces/resources/settings/IAgentSettings.js +9 -4
- package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +136 -0
- package/build/shared/interfaces/resources/settings/index.js +7 -1
- package/build/shared/interfaces/restAPI/resources/flow/v2.0/sentence/IGenerateSentencesRest_2_0.js +3 -0
- package/package.json +1 -1
- package/types/index.d.ts +569 -184
package/types/index.d.ts
CHANGED
|
@@ -2410,6 +2410,14 @@ export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSetting
|
|
|
2410
2410
|
* This setting is used to enable or disable branding in webchat.If true, hides "Powered by Cognigy" link.
|
|
2411
2411
|
*/
|
|
2412
2412
|
disableBranding?: boolean;
|
|
2413
|
+
/**
|
|
2414
|
+
* Whether to display the file attachment button
|
|
2415
|
+
*/
|
|
2416
|
+
enableFileAttachment: boolean;
|
|
2417
|
+
/**
|
|
2418
|
+
* The maximum allowed size of the attachment
|
|
2419
|
+
*/
|
|
2420
|
+
fileAttachmentMaxSize: number;
|
|
2413
2421
|
}
|
|
2414
2422
|
/**
|
|
2415
2423
|
* Setting to enable rating for the Webchat.
|
|
@@ -2767,6 +2775,8 @@ export interface ISearchResourcesRestReturnValue_2_0 extends ICursorBasedPaginat
|
|
|
2767
2775
|
* properties:
|
|
2768
2776
|
* name:
|
|
2769
2777
|
* type: string
|
|
2778
|
+
* description:
|
|
2779
|
+
* type: string
|
|
2770
2780
|
* referenceId:
|
|
2771
2781
|
* type: string
|
|
2772
2782
|
* format: uuid
|
|
@@ -2778,6 +2788,7 @@ export interface IFlowIndexItem_2_0 {
|
|
|
2778
2788
|
_id: TMongoId;
|
|
2779
2789
|
referenceId: string;
|
|
2780
2790
|
name: string;
|
|
2791
|
+
description?: string;
|
|
2781
2792
|
isTrainingOutOfDate: boolean;
|
|
2782
2793
|
createdAt: number;
|
|
2783
2794
|
lastChanged: number;
|
|
@@ -2899,6 +2910,8 @@ export interface ITrainGroupFeedbackReport_2_0 {
|
|
|
2899
2910
|
* properties:
|
|
2900
2911
|
* name:
|
|
2901
2912
|
* type: string
|
|
2913
|
+
* description:
|
|
2914
|
+
* type: string
|
|
2902
2915
|
* context:
|
|
2903
2916
|
* type: object
|
|
2904
2917
|
* attachedFlows:
|
|
@@ -2935,6 +2948,7 @@ export interface IFlow_2_0 {
|
|
|
2935
2948
|
_id: TMongoId;
|
|
2936
2949
|
referenceId: string;
|
|
2937
2950
|
name: string;
|
|
2951
|
+
description?: string;
|
|
2938
2952
|
context: any;
|
|
2939
2953
|
attachedFlows: TMongoId[];
|
|
2940
2954
|
attachedLexicons: TMongoId[];
|
|
@@ -3030,6 +3044,8 @@ export interface IBatchFlowsRestData_2_0 extends IBatchFlowsRestDataBody_2_0, IB
|
|
|
3030
3044
|
export interface IBatchFlowsRestReturnValue_2_0 {
|
|
3031
3045
|
}
|
|
3032
3046
|
export interface ICreateFlowRestDataBody_2_0 extends IProjectScope, Partial<Omit<IFlow_2_0, TReferenceAndEntityMetaKeys | "isTrainingOutOfDate" | "feedbackReport">> {
|
|
3047
|
+
transcript?: string;
|
|
3048
|
+
flowGenerationInput?: string;
|
|
3033
3049
|
}
|
|
3034
3050
|
export interface ICreateFlowRestData_2_0 extends ICreateFlowRestDataBody_2_0 {
|
|
3035
3051
|
}
|
|
@@ -3148,6 +3164,7 @@ export interface IFlowInDB extends IEntityMeta {
|
|
|
3148
3164
|
*/
|
|
3149
3165
|
referenceId: string;
|
|
3150
3166
|
name: string;
|
|
3167
|
+
description?: string;
|
|
3151
3168
|
context: any;
|
|
3152
3169
|
attachedFlows: TMongoId[];
|
|
3153
3170
|
img: string;
|
|
@@ -3382,6 +3399,10 @@ export interface IRemoveIntentFromFlowStateRestReturnValue_2_0 {
|
|
|
3382
3399
|
* type: string
|
|
3383
3400
|
* description: The name of the lexicon
|
|
3384
3401
|
* example: New Lexicon
|
|
3402
|
+
* description:
|
|
3403
|
+
* type: string
|
|
3404
|
+
* description: A meaningful description of the lexicon
|
|
3405
|
+
* example: Countries members of the European Union, e.g. Spain
|
|
3385
3406
|
* referenceId:
|
|
3386
3407
|
* type: string
|
|
3387
3408
|
* format: uuid
|
|
@@ -3394,6 +3415,7 @@ export interface IRemoveIntentFromFlowStateRestReturnValue_2_0 {
|
|
|
3394
3415
|
export interface ILexiconIndexItem_2_0 {
|
|
3395
3416
|
_id: TMongoId;
|
|
3396
3417
|
name: string;
|
|
3418
|
+
description?: string;
|
|
3397
3419
|
referenceId: string;
|
|
3398
3420
|
createdAt: number;
|
|
3399
3421
|
lastChanged: number;
|
|
@@ -3417,7 +3439,11 @@ export interface IIndexLexiconsRestReturnValue_2_0 extends ICursorBasedPaginatio
|
|
|
3417
3439
|
* name:
|
|
3418
3440
|
* type: string
|
|
3419
3441
|
* description: The name of the lexicon
|
|
3420
|
-
* example:
|
|
3442
|
+
* example: EU countries
|
|
3443
|
+
* description:
|
|
3444
|
+
* type: string
|
|
3445
|
+
* description: A meaningful description of the lexicon
|
|
3446
|
+
* example: Countries members of the European Union, e.g. Spain
|
|
3421
3447
|
*
|
|
3422
3448
|
* ILexiconGeneratedData_2_0:
|
|
3423
3449
|
* type: object
|
|
@@ -3437,6 +3463,7 @@ export interface IIndexLexiconsRestReturnValue_2_0 extends ICursorBasedPaginatio
|
|
|
3437
3463
|
export interface ILexicon_2_0 {
|
|
3438
3464
|
_id: TMongoId;
|
|
3439
3465
|
name: string;
|
|
3466
|
+
description?: string;
|
|
3440
3467
|
referenceId: string;
|
|
3441
3468
|
createdAt: number;
|
|
3442
3469
|
lastChanged: number;
|
|
@@ -3455,8 +3482,49 @@ export interface IBatchLexiconsRestReturnValue_2_0 {
|
|
|
3455
3482
|
}
|
|
3456
3483
|
export interface ICreateLexiconRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILexicon_2_0, keyof IEntityMeta>> {
|
|
3457
3484
|
}
|
|
3485
|
+
/**
|
|
3486
|
+
* @openapi
|
|
3487
|
+
* components:
|
|
3488
|
+
* parameters:
|
|
3489
|
+
* shouldGenerateLexiconEntriesParams:
|
|
3490
|
+
* in: query
|
|
3491
|
+
* name: shouldGenerateLexiconEntries
|
|
3492
|
+
* description: Flag to allow the Lexicon creation to use the generative AI to generate entries.
|
|
3493
|
+
* example: true
|
|
3494
|
+
* required: false
|
|
3495
|
+
* schema:
|
|
3496
|
+
* type: boolean
|
|
3497
|
+
* generateLexiconEntriesLimitParam:
|
|
3498
|
+
* in: query
|
|
3499
|
+
* name: generateLexiconEntriesLimit
|
|
3500
|
+
* description: Number of entries to be generated by the Generative AI.
|
|
3501
|
+
* example: 8
|
|
3502
|
+
* required: false
|
|
3503
|
+
* schema:
|
|
3504
|
+
* type: integer
|
|
3505
|
+
* defaultSlotParam:
|
|
3506
|
+
* in: query
|
|
3507
|
+
* name: defaultSlot
|
|
3508
|
+
* description: Default Slot where to associate the generated Lexicon entries.
|
|
3509
|
+
* example: testSlot
|
|
3510
|
+
* required: false
|
|
3511
|
+
* schema:
|
|
3512
|
+
* type: string
|
|
3513
|
+
* languageCode:
|
|
3514
|
+
* in: query
|
|
3515
|
+
* name: languageCode
|
|
3516
|
+
* description: Language code.
|
|
3517
|
+
* required: false
|
|
3518
|
+
* schema:
|
|
3519
|
+
* type: string
|
|
3520
|
+
*
|
|
3521
|
+
*/
|
|
3458
3522
|
export interface ICreateLexiconRestDataQuery_2_0 {
|
|
3459
3523
|
resourceId?: string;
|
|
3524
|
+
shouldGenerateLexiconEntries?: boolean;
|
|
3525
|
+
generateLexiconEntriesLimit?: number;
|
|
3526
|
+
defaultSlot?: string;
|
|
3527
|
+
languageCode?: string;
|
|
3460
3528
|
}
|
|
3461
3529
|
export interface ICreateLexiconRestData_2_0 extends ICreateLexiconRestDataBody_2_0, ICreateLexiconRestDataQuery_2_0 {
|
|
3462
3530
|
}
|
|
@@ -4077,6 +4145,13 @@ export interface IIndexEndpointsRestData_2_0 extends IRestPagination<IEndpointIn
|
|
|
4077
4145
|
}
|
|
4078
4146
|
export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IEndpointIndexItem_2_0> {
|
|
4079
4147
|
}
|
|
4148
|
+
export interface IAnalyticsDataGoals {
|
|
4149
|
+
entityReferenceId: string;
|
|
4150
|
+
flowName: string;
|
|
4151
|
+
flowReferenceId: string;
|
|
4152
|
+
label: string;
|
|
4153
|
+
timestamp: number;
|
|
4154
|
+
}
|
|
4080
4155
|
export interface IBaseAnalyticsData {
|
|
4081
4156
|
projectId: string;
|
|
4082
4157
|
projectName: string;
|
|
@@ -4101,7 +4176,7 @@ export interface IBaseAnalyticsData {
|
|
|
4101
4176
|
executionTime: number;
|
|
4102
4177
|
execution?: number;
|
|
4103
4178
|
nodesVisited: Array<string>;
|
|
4104
|
-
completedGoals: Array<
|
|
4179
|
+
completedGoals: Array<IAnalyticsDataGoals>;
|
|
4105
4180
|
}
|
|
4106
4181
|
declare const analyticsType: readonly [
|
|
4107
4182
|
"input",
|
|
@@ -4187,7 +4262,7 @@ export interface IAnalyticsFlowHistoryData extends IAnalyticsFlowMeta {
|
|
|
4187
4262
|
}
|
|
4188
4263
|
export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyticsUserInputData, IAnalyticsStepData {
|
|
4189
4264
|
entrypointType: TEntrypointType;
|
|
4190
|
-
trackedGoals:
|
|
4265
|
+
trackedGoals: IAnalyticsDataGoals[];
|
|
4191
4266
|
localeName: string;
|
|
4192
4267
|
endpointName: string;
|
|
4193
4268
|
endpointUrlToken: string;
|
|
@@ -4224,7 +4299,8 @@ declare const handoverProviders: readonly [
|
|
|
4224
4299
|
"chatwoot",
|
|
4225
4300
|
"salesforce",
|
|
4226
4301
|
"liveAgent",
|
|
4227
|
-
"genesysCloud"
|
|
4302
|
+
"genesysCloud",
|
|
4303
|
+
"eightByEight"
|
|
4228
4304
|
];
|
|
4229
4305
|
export declare type THandoverProvider = typeof handoverProviders[number];
|
|
4230
4306
|
export interface IHandoverSettings {
|
|
@@ -4238,7 +4314,7 @@ declare const whisperAssistConfigurations: readonly [
|
|
|
4238
4314
|
"template"
|
|
4239
4315
|
];
|
|
4240
4316
|
export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
|
|
4241
|
-
export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IGenesysCloudHandoverSettings;
|
|
4317
|
+
export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings;
|
|
4242
4318
|
export interface IRCEHandoverSettings {
|
|
4243
4319
|
/**
|
|
4244
4320
|
* Whether to forward all conversations
|
|
@@ -4284,6 +4360,33 @@ export interface IRCEHandoverSettings {
|
|
|
4284
4360
|
*/
|
|
4285
4361
|
agentCategoryId: string;
|
|
4286
4362
|
}
|
|
4363
|
+
export interface IEightByEightHandoverSettings {
|
|
4364
|
+
/**
|
|
4365
|
+
* The API access token
|
|
4366
|
+
* you can create within 8x8
|
|
4367
|
+
*/
|
|
4368
|
+
/**
|
|
4369
|
+
* The API URL to the 8x8 environment
|
|
4370
|
+
*/
|
|
4371
|
+
baseUrl: string;
|
|
4372
|
+
/**
|
|
4373
|
+
* The API access token
|
|
4374
|
+
* you can create within 8x8
|
|
4375
|
+
*/
|
|
4376
|
+
apiKey: string;
|
|
4377
|
+
/**
|
|
4378
|
+
* It is a key which has
|
|
4379
|
+
* to be included in the header
|
|
4380
|
+
*/
|
|
4381
|
+
apiTenant: string;
|
|
4382
|
+
/**
|
|
4383
|
+
* This setting cannot be changed,
|
|
4384
|
+
* since the chatwoot client only supports
|
|
4385
|
+
* forwarding handover conversations. The value
|
|
4386
|
+
* is therefore set to 'true'
|
|
4387
|
+
*/
|
|
4388
|
+
forwardOnlyHandoverConversations: true;
|
|
4389
|
+
}
|
|
4287
4390
|
export interface IChatwootHandoverSettings {
|
|
4288
4391
|
baseUrl: string;
|
|
4289
4392
|
accountId: string;
|
|
@@ -6531,6 +6634,11 @@ export interface IIntentFeedbackInDBReport {
|
|
|
6531
6634
|
fScore: number;
|
|
6532
6635
|
};
|
|
6533
6636
|
}
|
|
6637
|
+
declare const biasTowardsParentOrChildIntentsTypes: readonly [
|
|
6638
|
+
"parents",
|
|
6639
|
+
"children"
|
|
6640
|
+
];
|
|
6641
|
+
export declare type TBiasTowardsParentOrChildIntentsTypes = typeof biasTowardsParentOrChildIntentsTypes[number];
|
|
6534
6642
|
declare const intentTypes: readonly [
|
|
6535
6643
|
"yesNoIntent",
|
|
6536
6644
|
"default"
|
|
@@ -6555,6 +6663,7 @@ export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
|
|
|
6555
6663
|
}
|
|
6556
6664
|
export interface IIntent extends IEntityMeta, ILocalizedIntentData {
|
|
6557
6665
|
name: string;
|
|
6666
|
+
description?: string;
|
|
6558
6667
|
referenceId: string;
|
|
6559
6668
|
isRejectIntent: boolean;
|
|
6560
6669
|
isDisabled: boolean;
|
|
@@ -6562,6 +6671,7 @@ export interface IIntent extends IEntityMeta, ILocalizedIntentData {
|
|
|
6562
6671
|
data: any;
|
|
6563
6672
|
nodeReferenceId: string;
|
|
6564
6673
|
childFeatures?: boolean | string[];
|
|
6674
|
+
biasTowardsParentOrChildIntents: TBiasTowardsParentOrChildIntentsTypes;
|
|
6565
6675
|
parentIntentId?: string;
|
|
6566
6676
|
feedbackReport: IIntentFeedbackInDBReport;
|
|
6567
6677
|
intentRelationReferences: TMongoId[];
|
|
@@ -6645,9 +6755,13 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
|
|
|
6645
6755
|
quickReply: string;
|
|
6646
6756
|
chatwootInboxId: string;
|
|
6647
6757
|
liveAgentInboxId: string;
|
|
6758
|
+
additionalCategoryIds: string[];
|
|
6648
6759
|
sendTranscriptAsFirstMessage: boolean;
|
|
6649
6760
|
salesforcePrechatDetails: object[];
|
|
6650
6761
|
salesforcePrechatEntities: object[];
|
|
6762
|
+
eightByEightChannelId: string;
|
|
6763
|
+
eightByEightQueueId: string;
|
|
6764
|
+
eightByEightJSONProps: object[];
|
|
6651
6765
|
repeatHandoverMessage: boolean;
|
|
6652
6766
|
sendResolveEvent: boolean;
|
|
6653
6767
|
resolveBehavior: "resetEntrypoint" | "continueEntrypoint";
|
|
@@ -6752,6 +6866,192 @@ export interface IFuzzySearchParams extends INodeFunctionBaseParams {
|
|
|
6752
6866
|
contextKey: string;
|
|
6753
6867
|
};
|
|
6754
6868
|
}
|
|
6869
|
+
export declare type INodeAiEnhancedRephraseOutputMode = "none" | "userInputs" | "customInputs";
|
|
6870
|
+
export interface INodeWithAiRephraseConfig {
|
|
6871
|
+
generativeAI_rephraseOutputMode: INodeAiEnhancedRephraseOutputMode;
|
|
6872
|
+
generativeAI_amountOfLastUserInputs: number;
|
|
6873
|
+
generativeAI_customInputs: string[];
|
|
6874
|
+
generativeAI_temperature: number;
|
|
6875
|
+
promtType: TPromptTypes;
|
|
6876
|
+
questionType?: TRephraseWithAIQuestionType;
|
|
6877
|
+
}
|
|
6878
|
+
export interface ISayNodeConfigParams {
|
|
6879
|
+
text: string | string[];
|
|
6880
|
+
data: any;
|
|
6881
|
+
loop: boolean;
|
|
6882
|
+
linear: boolean;
|
|
6883
|
+
liveAgentSettings?: ILiveAgentSettings;
|
|
6884
|
+
type: "text" | "quickReplies" | "gallery" | "buttons" | "image" | "list" | "adaptiveCard";
|
|
6885
|
+
_cognigy: {
|
|
6886
|
+
[key: string]: unknown;
|
|
6887
|
+
};
|
|
6888
|
+
_data: {
|
|
6889
|
+
[key: string]: any;
|
|
6890
|
+
};
|
|
6891
|
+
}
|
|
6892
|
+
export interface ISayNodeConfig extends INodeWithAiRephraseConfig {
|
|
6893
|
+
say: ISayNodeConfigParams;
|
|
6894
|
+
}
|
|
6895
|
+
export interface ISayParams extends INodeFunctionBaseParams {
|
|
6896
|
+
config: ISayNodeConfig;
|
|
6897
|
+
organisationId: string;
|
|
6898
|
+
}
|
|
6899
|
+
export interface IOptionalQuestionNodeParams extends INodeFunctionBaseParams {
|
|
6900
|
+
config: IOptionalQuestionNodeOtherConfig | IOptionalQuestionNodeKeyphraseConfig | IOptionalQuestionNodeRegexConfig;
|
|
6901
|
+
}
|
|
6902
|
+
export interface IOptionalQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
6903
|
+
say: ISayParams["config"]["say"];
|
|
6904
|
+
retentionTime: number;
|
|
6905
|
+
executeChildrenOnly: boolean;
|
|
6906
|
+
cognigyScript: "answer" | "question";
|
|
6907
|
+
storeResultInContext: boolean;
|
|
6908
|
+
contextKey: string;
|
|
6909
|
+
storeDetailedResults: boolean;
|
|
6910
|
+
}
|
|
6911
|
+
export interface IOptionalQuestionNodeKeyphraseConfig extends IOptionalQuestionNodeSharedConfig {
|
|
6912
|
+
type: "keyphrase";
|
|
6913
|
+
keyphraseTag: string;
|
|
6914
|
+
usePositiveOnly: boolean;
|
|
6915
|
+
}
|
|
6916
|
+
export interface IOptionalQuestionNodeRegexConfig extends IOptionalQuestionNodeSharedConfig {
|
|
6917
|
+
type: "regex";
|
|
6918
|
+
regex: string;
|
|
6919
|
+
}
|
|
6920
|
+
export interface IOptionalQuestionNodeOtherConfig extends IOptionalQuestionNodeSharedConfig {
|
|
6921
|
+
type: "email" | "number" | "temperature" | "age" | "date" | "duration" | "yesNo" | "money" | "percentage" | "intent" | "data" | "url" | "app";
|
|
6922
|
+
}
|
|
6923
|
+
export interface IQuestionNodeParams extends INodeFunctionBaseParams {
|
|
6924
|
+
config: IQuestionNodeDatepickerConfig | IQuestionNodeKeyphraseConfig | IQuestionNodeRegexConfig | IQuestionNodeOtherConfig;
|
|
6925
|
+
}
|
|
6926
|
+
export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
|
|
6927
|
+
validationMessage: string;
|
|
6928
|
+
repromptCondition: string;
|
|
6929
|
+
validationRepeat: boolean;
|
|
6930
|
+
storeResultInContext: boolean;
|
|
6931
|
+
contextKey: string;
|
|
6932
|
+
skipIfResultInContext: boolean;
|
|
6933
|
+
onlyAcceptEscalationIntents: boolean;
|
|
6934
|
+
storeDetailedResults: boolean;
|
|
6935
|
+
storeInContactProfile: boolean;
|
|
6936
|
+
profileKey: string;
|
|
6937
|
+
say: ISayParams["config"]["say"];
|
|
6938
|
+
parseResultOnEntry: boolean;
|
|
6939
|
+
additionalValidation: string;
|
|
6940
|
+
maxExecutionDiff: number;
|
|
6941
|
+
resultLocation: string;
|
|
6942
|
+
skipRepromptOnIntent: boolean;
|
|
6943
|
+
escalateAnswersAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
|
|
6944
|
+
escalateAnswersThreshold: number;
|
|
6945
|
+
escalateAnswersGotoTarget: string;
|
|
6946
|
+
escalateAnswersExecuteTarget: string;
|
|
6947
|
+
escalateAnswersGotoExecutionMode: "continue" | "wait";
|
|
6948
|
+
escalateAnswersInjectedText: string;
|
|
6949
|
+
escalateAnswersInjectedData: string;
|
|
6950
|
+
escalateAnswersMessage: ISayParams["config"]["say"];
|
|
6951
|
+
escalateAnswersRepromptPrevention: boolean;
|
|
6952
|
+
escalateAnswersOnce: boolean;
|
|
6953
|
+
escalateAnswersHandoverText: string;
|
|
6954
|
+
escalateAnswersRepeatHandoverMessage: boolean;
|
|
6955
|
+
escalateAnswersHandoverCancelIntent: string;
|
|
6956
|
+
escalateAnswersHandoverQuickReply: string;
|
|
6957
|
+
escalateAnswersHandoverChatwootInboxId: string;
|
|
6958
|
+
escalateAnswersHandoverLiveAgentInboxId: string;
|
|
6959
|
+
escalateAnswersHandoverAdditionalCategoryIds: string[];
|
|
6960
|
+
escalateAnswersHandoverSendTranscriptAsFirstMessage: boolean;
|
|
6961
|
+
escalateAnswersHandoverSalesforcePrechatEntities: object[];
|
|
6962
|
+
escalateAnswersHandoverSalesforcePrechatDetails: object[];
|
|
6963
|
+
escalateAnswersHandoverEightByEightChannelId: string;
|
|
6964
|
+
escalateAnswersHandoverEightByEightQueueId: string;
|
|
6965
|
+
escalateAnswersHandoverEightByEightJSONProps: object[];
|
|
6966
|
+
escalateAnswersHandoverSendResolveEvent: boolean;
|
|
6967
|
+
escalateAnswersHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
|
|
6968
|
+
escalateAnswersAgentAssistInitMessage: string;
|
|
6969
|
+
escalateAnswersAllowAgentInject: boolean;
|
|
6970
|
+
escalateIntentsAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
|
|
6971
|
+
escalateIntentsValidIntents: string[];
|
|
6972
|
+
escalateIntentsThreshold: number;
|
|
6973
|
+
escalateIntentsGotoTarget: string;
|
|
6974
|
+
escalateIntentsExecuteTarget: string;
|
|
6975
|
+
escalateIntentsGotoExecutionMode: "continue" | "wait";
|
|
6976
|
+
escalateIntentsInjectedText: string;
|
|
6977
|
+
escalateIntentsInjectedData: any;
|
|
6978
|
+
escalateIntentsMessage: ISayParams["config"]["say"];
|
|
6979
|
+
escalateIntentsRepromptPrevention: boolean;
|
|
6980
|
+
escalateIntentsHandoverText: string;
|
|
6981
|
+
escalateIntentsRepeatHandoverMessage: boolean;
|
|
6982
|
+
escalateIntentsHandoverCancelIntent: string;
|
|
6983
|
+
escalateIntentsHandoverQuickReply: string;
|
|
6984
|
+
escalateIntentsHandoverChatwootInboxId: string;
|
|
6985
|
+
escalateIntentsHandoverLiveAgentInboxId: string;
|
|
6986
|
+
escalateIntentsHandoverAdditionalCategoryIds: string[];
|
|
6987
|
+
escalateIntentHandoverSendTranscriptAsFirstMessage: boolean;
|
|
6988
|
+
escalateIntentsHandoverSalesforcePrechatEntities: object[];
|
|
6989
|
+
escalateIntentsHandoverSalesforcePrechatDetails: object[];
|
|
6990
|
+
escalateIntentsHandoverEightByEightChannelId: string;
|
|
6991
|
+
escalateIntentsHandoverEightByEightQueueId: string;
|
|
6992
|
+
escalateIntentsHandoverEightByEightJSONProps: object[];
|
|
6993
|
+
escalateIntentsHandoverSendResolveEvent: boolean;
|
|
6994
|
+
escalateIntentsHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
|
|
6995
|
+
escalateIntentsAgentAssistInitMessage: string;
|
|
6996
|
+
escalateIntentsAllowAgentInject: boolean;
|
|
6997
|
+
reconfirmationBehaviour: "none" | "reconfirm";
|
|
6998
|
+
reconfirmationQuestion: string;
|
|
6999
|
+
reconfirmationQuestionReprompt: string;
|
|
7000
|
+
}
|
|
7001
|
+
export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig {
|
|
7002
|
+
type: "date";
|
|
7003
|
+
datepicker_eventName: string;
|
|
7004
|
+
datepicker_locale: string;
|
|
7005
|
+
datepicker_dateFormat: string;
|
|
7006
|
+
datepicker_time24Hours: boolean;
|
|
7007
|
+
datepicker_defaultDate: string;
|
|
7008
|
+
datepicker_minDate: string;
|
|
7009
|
+
datepicker_maxDate: string;
|
|
7010
|
+
datepicker_wantEnableDisable: "none" | "enable" | "disable";
|
|
7011
|
+
datepicker_disableEnableRange: boolean;
|
|
7012
|
+
datepicker_enabledDates: string[];
|
|
7013
|
+
datepicker_disabledDates: string[];
|
|
7014
|
+
datepicker_enableTime: boolean;
|
|
7015
|
+
datepicker_mode: "single" | "multiple" | "range";
|
|
7016
|
+
datepicker_openPickerButtonText: string;
|
|
7017
|
+
datepicker_cancelButtonText: string;
|
|
7018
|
+
datepicker_submitButtonText: string;
|
|
7019
|
+
datepicker_defaultHour: number;
|
|
7020
|
+
datepicker_defaultMinute: number;
|
|
7021
|
+
datepicker_enableSeconds: boolean;
|
|
7022
|
+
datepicker_hourIncrement: number;
|
|
7023
|
+
datepicker_minuteIncrement: number;
|
|
7024
|
+
datepicker_noCalendar: boolean;
|
|
7025
|
+
datepicker_weekNumbers: boolean;
|
|
7026
|
+
datepicker_hidePicker: boolean;
|
|
7027
|
+
datepicker_functionEnable: string;
|
|
7028
|
+
datepicker_functionDisable: string;
|
|
7029
|
+
}
|
|
7030
|
+
export interface IActiveQuestion {
|
|
7031
|
+
nodeId: string;
|
|
7032
|
+
type: "date" | "keyphrase" | "regex" | "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom";
|
|
7033
|
+
lastExecutedAt: number;
|
|
7034
|
+
forgetQuestionThreshold: number;
|
|
7035
|
+
repromptCount?: number;
|
|
7036
|
+
escalationCount?: number;
|
|
7037
|
+
tentativeAnswer?: any;
|
|
7038
|
+
tentativeAnswerShortform?: string;
|
|
7039
|
+
onlyAcceptEscalationIntents?: boolean;
|
|
7040
|
+
escalationIntents?: string[];
|
|
7041
|
+
}
|
|
7042
|
+
export interface IQuestionNodeKeyphraseConfig extends IQuestionNodeSharedConfig {
|
|
7043
|
+
type: "keyphrase";
|
|
7044
|
+
keyphraseTag: string;
|
|
7045
|
+
usePositiveOnly: boolean;
|
|
7046
|
+
}
|
|
7047
|
+
export interface IQuestionNodeRegexConfig extends IQuestionNodeSharedConfig {
|
|
7048
|
+
type: "regex";
|
|
7049
|
+
regex: string;
|
|
7050
|
+
}
|
|
7051
|
+
export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
|
|
7052
|
+
type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom";
|
|
7053
|
+
}
|
|
7054
|
+
export declare type TRephraseWithAIQuestionType = IActiveQuestion["type"] | IOptionalQuestionNodeOtherConfig["type"];
|
|
6755
7055
|
export interface ISensitiveLoggingSettings {
|
|
6756
7056
|
maskLogging: boolean;
|
|
6757
7057
|
maskAnalytics: boolean;
|
|
@@ -6778,6 +7078,17 @@ export interface IIntentScore {
|
|
|
6778
7078
|
flow?: string;
|
|
6779
7079
|
intentId?: string;
|
|
6780
7080
|
}
|
|
7081
|
+
export declare type TPromptTypes = "statement" | "question" | "reprompt";
|
|
7082
|
+
export interface IRephraseSentenceWithAIOptions {
|
|
7083
|
+
useLastUserInputs?: boolean;
|
|
7084
|
+
amountOfUserInputs?: number;
|
|
7085
|
+
customInputs?: string[];
|
|
7086
|
+
temperature?: number;
|
|
7087
|
+
promptType?: TPromptTypes;
|
|
7088
|
+
questionType?: TRephraseWithAIQuestionType;
|
|
7089
|
+
question?: string;
|
|
7090
|
+
answer?: string;
|
|
7091
|
+
}
|
|
6781
7092
|
export interface IActions {
|
|
6782
7093
|
addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
|
|
6783
7094
|
activateProfile?: () => Promise<any>;
|
|
@@ -6786,7 +7097,7 @@ export interface IActions {
|
|
|
6786
7097
|
checkAgentAvailability?: (params: ICheckAgentAvailabilityNodeParams) => void;
|
|
6787
7098
|
checkFrustration?: (nodeId: string, input: any) => void;
|
|
6788
7099
|
checkThink?: (id: string) => boolean;
|
|
6789
|
-
completeGoal?: (
|
|
7100
|
+
completeGoal?: (goalData: IAnalyticsDataGoals) => void;
|
|
6790
7101
|
deactivateProfile?: (deleteData: boolean) => Promise<any>;
|
|
6791
7102
|
deleteContext?: (key: string) => void;
|
|
6792
7103
|
deleteProfile?: () => Promise<any>;
|
|
@@ -6828,7 +7139,10 @@ export interface IActions {
|
|
|
6828
7139
|
outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata, settings?: ISayNodeSettings) => void;
|
|
6829
7140
|
reloadBrainFlow?: (flowReferenceId: string) => Promise<void>;
|
|
6830
7141
|
removeFromContext?: (key: string, value: string, mode: string) => void;
|
|
7142
|
+
rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
|
|
7143
|
+
rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
|
|
6831
7144
|
requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], agentAssistInitMessage?: string, providerResponse?: any) => void;
|
|
7145
|
+
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions) => Promise<string>;
|
|
6832
7146
|
resetContext?: () => Promise<object>;
|
|
6833
7147
|
resetFormBrain?: () => Promise<void>;
|
|
6834
7148
|
resetState?: () => Promise<string>;
|
|
@@ -7071,6 +7385,53 @@ export interface IExecuteCognigyNLUParams {
|
|
|
7071
7385
|
[key: string]: any;
|
|
7072
7386
|
};
|
|
7073
7387
|
}
|
|
7388
|
+
export interface IRunGenerativeAIPromptOptions {
|
|
7389
|
+
/** prompt - The prompt string to provide to the OpenAI engine. */
|
|
7390
|
+
prompt: string;
|
|
7391
|
+
/** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
|
|
7392
|
+
temperature?: number;
|
|
7393
|
+
/** model - (Optional) The OpenAI model to use. Defaults to 'text-davinci-003' */
|
|
7394
|
+
model?: OpenAiModels | AzureOpenAiModels;
|
|
7395
|
+
/** timeoutInMs - (Optional) The timeout for the request in ms. Defaults to 10000 */
|
|
7396
|
+
timeoutInMs?: number;
|
|
7397
|
+
/** maxTokens - (Optional) Upper bound on how many tokens the API will return.
|
|
7398
|
+
* The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length.
|
|
7399
|
+
* If not provided, we calculate the maximum: model_max_tokens - prompt_tokens */
|
|
7400
|
+
maxTokens?: number;
|
|
7401
|
+
/**
|
|
7402
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
7403
|
+
* So 0.1 means only the tokens comprising the top 10% probability mass are considered.
|
|
7404
|
+
* It is recommended altering this or temperature but not both.
|
|
7405
|
+
*/
|
|
7406
|
+
topP?: number;
|
|
7407
|
+
/**
|
|
7408
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far,
|
|
7409
|
+
* decreasing the model's likelihood to repeat the same line verbatim.
|
|
7410
|
+
*/
|
|
7411
|
+
frequencyPenalty?: number;
|
|
7412
|
+
/**
|
|
7413
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
|
|
7414
|
+
* increasing the model's likelihood to talk about new topics.
|
|
7415
|
+
*/
|
|
7416
|
+
presencePenalty?: number;
|
|
7417
|
+
/**
|
|
7418
|
+
* Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
|
|
7419
|
+
*/
|
|
7420
|
+
stop?: string[];
|
|
7421
|
+
}
|
|
7422
|
+
declare enum OpenAiModels {
|
|
7423
|
+
"davinci" = "text-davinci-003",
|
|
7424
|
+
"curie" = "text-curie-001",
|
|
7425
|
+
"babbage" = "text-babbage-001",
|
|
7426
|
+
"ada" = "text-ada-001"
|
|
7427
|
+
}
|
|
7428
|
+
declare enum AzureOpenAiModels {
|
|
7429
|
+
"davinci3" = "text-davinci-003",
|
|
7430
|
+
"davinci2" = "text-davinci-002",
|
|
7431
|
+
"curie" = "text-curie-001",
|
|
7432
|
+
"babbage" = "text-babbage-001",
|
|
7433
|
+
"ada" = "text-ada-001"
|
|
7434
|
+
}
|
|
7074
7435
|
export interface IExecuteFlowNodeConfig {
|
|
7075
7436
|
flowNode: {
|
|
7076
7437
|
flow: string;
|
|
@@ -7351,7 +7712,7 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
|
|
|
7351
7712
|
setInputLanguageOnExecutionCount: number;
|
|
7352
7713
|
};
|
|
7353
7714
|
}
|
|
7354
|
-
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply"> {
|
|
7715
|
+
export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply" | "completeGoal"> {
|
|
7355
7716
|
setNextNode: (nodeId: string, newFlowId?: string) => void;
|
|
7356
7717
|
resetNextNodes: () => void;
|
|
7357
7718
|
stopExecution: () => void;
|
|
@@ -7432,6 +7793,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
7432
7793
|
setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown>) => void;
|
|
7433
7794
|
getAppSessionPin: () => Promise<string>;
|
|
7434
7795
|
validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
|
|
7796
|
+
completeGoal: (goal: string) => void;
|
|
7435
7797
|
}
|
|
7436
7798
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
7437
7799
|
api: INodeExecutionAPI;
|
|
@@ -7480,6 +7842,7 @@ export interface INodeFunctionBaseParams {
|
|
|
7480
7842
|
[key: string]: any;
|
|
7481
7843
|
};
|
|
7482
7844
|
nodeId: string;
|
|
7845
|
+
organisationId?: string;
|
|
7483
7846
|
inputOptions?: INodeFunctionInputOptions;
|
|
7484
7847
|
}
|
|
7485
7848
|
export declare type TNodeChildConfigs = Pick<IChartExecutableNode, "id" | "type" | "config">;
|
|
@@ -7730,6 +8093,7 @@ export interface IConnectionSchemaField {
|
|
|
7730
8093
|
_id?: TMongoId;
|
|
7731
8094
|
/** The field name, e.g. 'client_id' */
|
|
7732
8095
|
fieldName: string;
|
|
8096
|
+
required?: boolean;
|
|
7733
8097
|
}
|
|
7734
8098
|
export interface IConnectionSchema extends IEntityMeta {
|
|
7735
8099
|
_id: TMongoId;
|
|
@@ -7851,6 +8215,7 @@ export interface IGraphFunction {
|
|
|
7851
8215
|
}
|
|
7852
8216
|
export interface ILexicon extends IEntityMeta {
|
|
7853
8217
|
name: string;
|
|
8218
|
+
description?: string;
|
|
7854
8219
|
referenceId: string;
|
|
7855
8220
|
projectReference: TMongoId;
|
|
7856
8221
|
organisationReference: TMongoId;
|
|
@@ -8195,7 +8560,10 @@ export interface IIntentFeedbackReport_2_0 {
|
|
|
8195
8560
|
* format: uuid
|
|
8196
8561
|
* name:
|
|
8197
8562
|
* type: string
|
|
8198
|
-
* example:
|
|
8563
|
+
* example: OrderFood
|
|
8564
|
+
* description:
|
|
8565
|
+
* type: string
|
|
8566
|
+
* example: Intent to order food
|
|
8199
8567
|
* tags:
|
|
8200
8568
|
* type: array
|
|
8201
8569
|
* items:
|
|
@@ -8215,6 +8583,7 @@ export interface IIntentIndexItem_2_0 {
|
|
|
8215
8583
|
_id: string;
|
|
8216
8584
|
referenceId: string;
|
|
8217
8585
|
name: string;
|
|
8586
|
+
description?: string;
|
|
8218
8587
|
tags: string[];
|
|
8219
8588
|
isRejectIntent: boolean;
|
|
8220
8589
|
isDisabled: boolean;
|
|
@@ -8243,7 +8612,10 @@ export interface IIndexIntentsRestReturnValue_2_0 extends ICursorBasedPagination
|
|
|
8243
8612
|
* properties:
|
|
8244
8613
|
* name:
|
|
8245
8614
|
* type: string
|
|
8246
|
-
* example:
|
|
8615
|
+
* example: OrderFood
|
|
8616
|
+
* description:
|
|
8617
|
+
* type: string
|
|
8618
|
+
* example: Intent to order food
|
|
8247
8619
|
* condition:
|
|
8248
8620
|
* type: string
|
|
8249
8621
|
* rules:
|
|
@@ -8275,6 +8647,11 @@ export interface IIndexIntentsRestReturnValue_2_0 extends ICursorBasedPagination
|
|
|
8275
8647
|
* items:
|
|
8276
8648
|
* $ref: '#/components/schemas/TMongoId'
|
|
8277
8649
|
* example: false
|
|
8650
|
+
* biasTowardsParentOrChildIntents:
|
|
8651
|
+
* type: string
|
|
8652
|
+
* enum:
|
|
8653
|
+
* - parents
|
|
8654
|
+
* - children
|
|
8278
8655
|
* parentIntentId:
|
|
8279
8656
|
* $ref: '#/components/schemas/TMongoId'
|
|
8280
8657
|
* analyticsLabel:
|
|
@@ -8302,6 +8679,7 @@ export interface IIntent_2_0 {
|
|
|
8302
8679
|
_id: string;
|
|
8303
8680
|
referenceId: string;
|
|
8304
8681
|
name: string;
|
|
8682
|
+
description?: string;
|
|
8305
8683
|
condition: string;
|
|
8306
8684
|
isRejectIntent: boolean;
|
|
8307
8685
|
isDisabled: boolean;
|
|
@@ -8316,6 +8694,7 @@ export interface IIntent_2_0 {
|
|
|
8316
8694
|
lastChangedBy: TMongoId;
|
|
8317
8695
|
nodeReferenceId: string;
|
|
8318
8696
|
childFeatures?: boolean | TMongoId[];
|
|
8697
|
+
biasTowardsParentOrChildIntents?: TBiasTowardsParentOrChildIntentsTypes;
|
|
8319
8698
|
parentIntentId?: TMongoId;
|
|
8320
8699
|
localeReference: TMongoId;
|
|
8321
8700
|
feedbackReport: IIntentFeedbackReport_2_0;
|
|
@@ -8342,6 +8721,8 @@ export interface ICreateIntentRestDataParams_2_0 {
|
|
|
8342
8721
|
flowId: string;
|
|
8343
8722
|
}
|
|
8344
8723
|
export interface ICreateIntentRestData_2_0 extends ICreateIntentRestDataBody_2_0, ICreateIntentRestDataParams_2_0 {
|
|
8724
|
+
shouldGenerateSentences?: boolean;
|
|
8725
|
+
generateSentenceLimit?: number;
|
|
8345
8726
|
}
|
|
8346
8727
|
export interface ICreateIntentRestReturnValue_2_0 extends IIntent_2_0 {
|
|
8347
8728
|
}
|
|
@@ -8757,6 +9138,17 @@ export interface IBatchSentencesRestReturnValue_2_0 {
|
|
|
8757
9138
|
updated: string[];
|
|
8758
9139
|
deleted: string[];
|
|
8759
9140
|
}
|
|
9141
|
+
export interface IGenerateSentencesRestDataParams_2_0 {
|
|
9142
|
+
flowId: string;
|
|
9143
|
+
intentId: string;
|
|
9144
|
+
}
|
|
9145
|
+
export interface IGenerateSentencesRestData_2_0 extends IGenerateSentencesRestDataParams_2_0 {
|
|
9146
|
+
localeId?: string;
|
|
9147
|
+
limit?: number;
|
|
9148
|
+
}
|
|
9149
|
+
export interface IGenerateSentencesRestReturnValue_2_0 {
|
|
9150
|
+
sentences: string[];
|
|
9151
|
+
}
|
|
8760
9152
|
/**
|
|
8761
9153
|
* @openapi
|
|
8762
9154
|
*
|
|
@@ -8885,19 +9277,27 @@ export interface IChart_2_0 {
|
|
|
8885
9277
|
* properties:
|
|
8886
9278
|
* type:
|
|
8887
9279
|
* type: string
|
|
8888
|
-
* example:
|
|
8889
|
-
*
|
|
8890
|
-
* type: string
|
|
8891
|
-
* format: uuid
|
|
9280
|
+
* example: if
|
|
9281
|
+
* description: Type of the Node
|
|
8892
9282
|
* extension:
|
|
8893
9283
|
* type: string
|
|
8894
9284
|
* example: "@cognigy/basic-nodes"
|
|
9285
|
+
* enum:
|
|
9286
|
+
* - "@cognigy/basic-nodes"
|
|
9287
|
+
* - "@cognigy/mongodb"
|
|
9288
|
+
* - "@cognigy/mssql"
|
|
9289
|
+
* - "@cognigy/smtp"
|
|
9290
|
+
* - "@cognigy/voicegateway"
|
|
9291
|
+
* - "@cognigy/microsoft"
|
|
9292
|
+
* - "@cognigy/voiceGateway2"
|
|
8895
9293
|
* label:
|
|
8896
9294
|
* type: string
|
|
8897
|
-
* example:
|
|
9295
|
+
* example: A new Node
|
|
9296
|
+
* description: Replaces the default name of the Node displayed in the Flow Editor.
|
|
8898
9297
|
* comment:
|
|
8899
9298
|
* type: string
|
|
8900
|
-
* example:
|
|
9299
|
+
* example: this is a very important node
|
|
9300
|
+
* description: Adds additional information about Nodes, for example, a specific of the Node.
|
|
8901
9301
|
* commentColor:
|
|
8902
9302
|
* oneOf:
|
|
8903
9303
|
* - $ref: '#/components/schemas/TCSSColor'
|
|
@@ -8905,8 +9305,6 @@ export interface IChart_2_0 {
|
|
|
8905
9305
|
* nullable: false
|
|
8906
9306
|
* enum:
|
|
8907
9307
|
* - ""
|
|
8908
|
-
* preview:
|
|
8909
|
-
* example: This is a fancy node
|
|
8910
9308
|
* isEntryPoint:
|
|
8911
9309
|
* type: boolean
|
|
8912
9310
|
* example: false
|
|
@@ -8915,10 +9313,14 @@ export interface IChart_2_0 {
|
|
|
8915
9313
|
* example: false
|
|
8916
9314
|
* config:
|
|
8917
9315
|
* type: object
|
|
9316
|
+
* example: {"condition":{"type":"rule","condition":"","rule":{"left":"1","operand":"gt","right":"2"}}}
|
|
8918
9317
|
* localeReference:
|
|
8919
9318
|
* type: string
|
|
9319
|
+
* example: "63bd8ebb648e6e739f1bbd82"
|
|
8920
9320
|
* analyticsLabel:
|
|
8921
9321
|
* type: string
|
|
9322
|
+
* example: "condition"
|
|
9323
|
+
|
|
8922
9324
|
*
|
|
8923
9325
|
* IChartNode_2_0:
|
|
8924
9326
|
* allOf:
|
|
@@ -9601,6 +10003,9 @@ export interface INodeFieldCondition_2_0 {
|
|
|
9601
10003
|
* type: array
|
|
9602
10004
|
* items:
|
|
9603
10005
|
* type: string
|
|
10006
|
+
* theme:
|
|
10007
|
+
* type: string
|
|
10008
|
+
* description: Used to highlight sections if they contain new features
|
|
9604
10009
|
*/
|
|
9605
10010
|
export interface INodeSection_2_0 {
|
|
9606
10011
|
/** Unique identifier for this section within all sections of a descriptor, e.g. 'authentication' */
|
|
@@ -9937,6 +10342,8 @@ export interface ISharedSettings_2_0 {
|
|
|
9937
10342
|
* $ref: '#/components/schemas/IAgentTranslationSettings_2_0'
|
|
9938
10343
|
* audioPreviewSettings:
|
|
9939
10344
|
* $ref: '#/components/schemas/IAgentAudioPreviewSettings_2_0'
|
|
10345
|
+
* generativeAISettings:
|
|
10346
|
+
* $ref: '#/components/schemas/IGenerativeAIModelSettings_2_0'
|
|
9940
10347
|
*
|
|
9941
10348
|
* IAgentSettings_2_0:
|
|
9942
10349
|
* allOf:
|
|
@@ -9960,6 +10367,7 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
|
|
|
9960
10367
|
lastChangedBy: TMongoId;
|
|
9961
10368
|
translationSettings: IAgentTranslationSettings_2_0;
|
|
9962
10369
|
audioPreviewSettings: IAgentAudioPreviewSettings_2_0;
|
|
10370
|
+
generativeAISettings: IGenerativeAISettings_2_0;
|
|
9963
10371
|
}
|
|
9964
10372
|
/**
|
|
9965
10373
|
* @openapi
|
|
@@ -10036,6 +10444,8 @@ export interface IAgentTranslationSettings_2_0 {
|
|
|
10036
10444
|
* enum:
|
|
10037
10445
|
* - none
|
|
10038
10446
|
* - microsoft
|
|
10447
|
+
* - google
|
|
10448
|
+
* - aws
|
|
10039
10449
|
*/
|
|
10040
10450
|
export declare type TAudioPreviewProvider_2_0 = "none" | "microsoft" | "google" | "aws";
|
|
10041
10451
|
/**
|
|
@@ -10157,6 +10567,127 @@ export interface IAgentAudioPreviewSettings_2_0 {
|
|
|
10157
10567
|
audioPreviewTimeout?: number;
|
|
10158
10568
|
audioPreviewCacheExpiry?: number;
|
|
10159
10569
|
}
|
|
10570
|
+
/**
|
|
10571
|
+
* @openapi
|
|
10572
|
+
*
|
|
10573
|
+
* components:
|
|
10574
|
+
* schemas:
|
|
10575
|
+
* TGenerativeAIProviders_2_0:
|
|
10576
|
+
* type: string
|
|
10577
|
+
* description: Supported Generative AI Providers
|
|
10578
|
+
* enum:
|
|
10579
|
+
* - none
|
|
10580
|
+
* - openAI
|
|
10581
|
+
* - azureOpenAI
|
|
10582
|
+
*/
|
|
10583
|
+
export declare type TGenerativeAIProviders_2_0 = "none" | "openAI" | "azureOpenAI";
|
|
10584
|
+
/**
|
|
10585
|
+
* @openapi
|
|
10586
|
+
*
|
|
10587
|
+
* components:
|
|
10588
|
+
* schemas:
|
|
10589
|
+
* TOpenAIModels_2_0:
|
|
10590
|
+
* type: string
|
|
10591
|
+
* description: Supported Generative AI Models
|
|
10592
|
+
* enum:
|
|
10593
|
+
* - text-davinci-003
|
|
10594
|
+
*/
|
|
10595
|
+
export declare type TOpenAIModels_2_0 = "text-davinci-003";
|
|
10596
|
+
/**
|
|
10597
|
+
* @openapi
|
|
10598
|
+
*
|
|
10599
|
+
* components:
|
|
10600
|
+
* schemas:
|
|
10601
|
+
* TAzureOpenAIModels_2_0:
|
|
10602
|
+
* type: string
|
|
10603
|
+
* description: Supported Generative AI Models
|
|
10604
|
+
* enum:
|
|
10605
|
+
* - text-davinci-002
|
|
10606
|
+
*/
|
|
10607
|
+
export declare type TAzureOpenAIModels_2_0 = "text-davinci-002";
|
|
10608
|
+
/**
|
|
10609
|
+
* @openapi
|
|
10610
|
+
*
|
|
10611
|
+
* components:
|
|
10612
|
+
* schemas:
|
|
10613
|
+
* IGenerativeAIMeta_2_0:
|
|
10614
|
+
* type: object
|
|
10615
|
+
* properties:
|
|
10616
|
+
* model:
|
|
10617
|
+
* $ref: '#/components/schemas/TOpenAIModels_2_0'
|
|
10618
|
+
* temperature:
|
|
10619
|
+
* type: integer
|
|
10620
|
+
* minimum: 0
|
|
10621
|
+
* maximum: 1
|
|
10622
|
+
* description: Defines the creativity of the model
|
|
10623
|
+
*/
|
|
10624
|
+
export interface IGenerativeAIMeta_2_0<MODELS extends TOpenAIModels_2_0 | TAzureOpenAIModels_2_0> {
|
|
10625
|
+
model: MODELS;
|
|
10626
|
+
temperature: number;
|
|
10627
|
+
}
|
|
10628
|
+
export interface IGenerativeAIModelSettings_2_0<P extends TGenerativeAIProviders_2_0, MODELS extends TOpenAIModels_2_0 | TAzureOpenAIModels_2_0, M extends IGenerativeAIMeta_2_0<MODELS>> {
|
|
10629
|
+
provider: P;
|
|
10630
|
+
connectionId?: string;
|
|
10631
|
+
intentGeneration: M;
|
|
10632
|
+
ouputContextualization: M;
|
|
10633
|
+
lexiconGeneration: M;
|
|
10634
|
+
flowGeneration: M;
|
|
10635
|
+
flowExplanation: M;
|
|
10636
|
+
}
|
|
10637
|
+
export interface IOpenAI_2_0 extends IGenerativeAIModelSettings_2_0<"openAI", TOpenAIModels_2_0, IGenerativeAIMeta_2_0<TOpenAIModels_2_0>> {
|
|
10638
|
+
}
|
|
10639
|
+
export interface IAzureOpenAI_2_0 extends IGenerativeAIModelSettings_2_0<"azureOpenAI", TAzureOpenAIModels_2_0, IGenerativeAIMeta_2_0<TAzureOpenAIModels_2_0>> {
|
|
10640
|
+
}
|
|
10641
|
+
/**
|
|
10642
|
+
* @openapi
|
|
10643
|
+
*
|
|
10644
|
+
* components:
|
|
10645
|
+
* schemas:
|
|
10646
|
+
* IGenerativeAIModelSettings_2_0:
|
|
10647
|
+
* type: object
|
|
10648
|
+
* properties:
|
|
10649
|
+
* generativeAIProvider:
|
|
10650
|
+
* $ref: '#/components/schemas/TGenerativeAIProviders_2_0'
|
|
10651
|
+
* openAI:
|
|
10652
|
+
* type: object
|
|
10653
|
+
* properties:
|
|
10654
|
+
* provider:
|
|
10655
|
+
* $ref: '#/components/schemas/TGenerativeAIProviders_2_0'
|
|
10656
|
+
* connectionId:
|
|
10657
|
+
* type: string
|
|
10658
|
+
* maxLength: 300
|
|
10659
|
+
* description: Cognigy GenerativeAI Provider Connection Id
|
|
10660
|
+
* intentGeneration:
|
|
10661
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10662
|
+
* ouputContextualization:
|
|
10663
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10664
|
+
* lexiconGeneration:
|
|
10665
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10666
|
+
* flowGeneration:
|
|
10667
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10668
|
+
* flowExplanation:
|
|
10669
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10670
|
+
* azureOpenAI:
|
|
10671
|
+
* type: object
|
|
10672
|
+
* properties:
|
|
10673
|
+
* provider:
|
|
10674
|
+
* $ref: '#/components/schemas/TGenerativeAIProviders_2_0'
|
|
10675
|
+
* intentGeneration:
|
|
10676
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10677
|
+
* ouputContextualization:
|
|
10678
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10679
|
+
* lexiconGeneration:
|
|
10680
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10681
|
+
* flowGeneration:
|
|
10682
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10683
|
+
* flowExplanation:
|
|
10684
|
+
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
10685
|
+
*/
|
|
10686
|
+
export interface IGenerativeAISettings_2_0 {
|
|
10687
|
+
generativeAIProvider: TGenerativeAIProviders_2_0;
|
|
10688
|
+
openAI?: IOpenAI_2_0;
|
|
10689
|
+
azureOpenAI?: IAzureOpenAI_2_0;
|
|
10690
|
+
}
|
|
10160
10691
|
export interface IReadAgentSettingsRestDataParams_2_0 extends IProjectScope {
|
|
10161
10692
|
}
|
|
10162
10693
|
export interface IReadAgentSettingsRestData_2_0 extends IReadAgentSettingsRestDataParams_2_0 {
|
|
@@ -12549,161 +13080,7 @@ export interface IDatePickerConfig {
|
|
|
12549
13080
|
export interface IDatePickerNodeParams extends INodeFunctionBaseParams {
|
|
12550
13081
|
config: IDatePickerConfig;
|
|
12551
13082
|
}
|
|
12552
|
-
export interface ISayNodeConfigParams {
|
|
12553
|
-
text: string | string[];
|
|
12554
|
-
data: any;
|
|
12555
|
-
loop: boolean;
|
|
12556
|
-
linear: boolean;
|
|
12557
|
-
liveAgentSettings?: ILiveAgentSettings;
|
|
12558
|
-
type: "text" | "quickReplies" | "gallery" | "buttons" | "image" | "list" | "adaptiveCard";
|
|
12559
|
-
_cognigy: {
|
|
12560
|
-
[key: string]: unknown;
|
|
12561
|
-
};
|
|
12562
|
-
_data: {
|
|
12563
|
-
[key: string]: any;
|
|
12564
|
-
};
|
|
12565
|
-
}
|
|
12566
|
-
export interface ISayParams extends INodeFunctionBaseParams {
|
|
12567
|
-
config: {
|
|
12568
|
-
say: ISayNodeConfigParams;
|
|
12569
|
-
};
|
|
12570
|
-
}
|
|
12571
13083
|
export declare type ISayNodeParams = ISayParams;
|
|
12572
|
-
export interface IQuestionNodeParams extends INodeFunctionBaseParams {
|
|
12573
|
-
config: IQuestionNodeDatepickerConfig | IQuestionNodeKeyphraseConfig | IQuestionNodeRegexConfig | IQuestionNodeOtherConfig;
|
|
12574
|
-
}
|
|
12575
|
-
export interface IQuestionNodeSharedConfig {
|
|
12576
|
-
validationMessage: string;
|
|
12577
|
-
repromptCondition: string;
|
|
12578
|
-
validationRepeat: boolean;
|
|
12579
|
-
storeResultInContext: boolean;
|
|
12580
|
-
contextKey: string;
|
|
12581
|
-
skipIfResultInContext: boolean;
|
|
12582
|
-
onlyAcceptEscalationIntents: boolean;
|
|
12583
|
-
storeDetailedResults: boolean;
|
|
12584
|
-
storeInContactProfile: boolean;
|
|
12585
|
-
profileKey: string;
|
|
12586
|
-
say: ISayParams["config"]["say"];
|
|
12587
|
-
parseResultOnEntry: boolean;
|
|
12588
|
-
additionalValidation: string;
|
|
12589
|
-
maxExecutionDiff: number;
|
|
12590
|
-
resultLocation: string;
|
|
12591
|
-
skipRepromptOnIntent: boolean;
|
|
12592
|
-
escalateAnswersAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
|
|
12593
|
-
escalateAnswersThreshold: number;
|
|
12594
|
-
escalateAnswersGotoTarget: string;
|
|
12595
|
-
escalateAnswersExecuteTarget: string;
|
|
12596
|
-
escalateAnswersGotoExecutionMode: "continue" | "wait";
|
|
12597
|
-
escalateAnswersInjectedText: string;
|
|
12598
|
-
escalateAnswersInjectedData: string;
|
|
12599
|
-
escalateAnswersMessage: ISayParams["config"]["say"];
|
|
12600
|
-
escalateAnswersRepromptPrevention: boolean;
|
|
12601
|
-
escalateAnswersOnce: boolean;
|
|
12602
|
-
escalateAnswersHandoverText: string;
|
|
12603
|
-
escalateAnswersRepeatHandoverMessage: boolean;
|
|
12604
|
-
escalateAnswersHandoverCancelIntent: string;
|
|
12605
|
-
escalateAnswersHandoverQuickReply: string;
|
|
12606
|
-
escalateAnswersHandoverChatwootInboxId: string;
|
|
12607
|
-
escalateAnswersHandoverLiveAgentInboxId: string;
|
|
12608
|
-
escalateAnswersHandoverSendTranscriptAsFirstMessage: boolean;
|
|
12609
|
-
escalateAnswersHandoverSalesforcePrechatEntities: object[];
|
|
12610
|
-
escalateAnswersHandoverSalesforcePrechatDetails: object[];
|
|
12611
|
-
escalateAnswersHandoverSendResolveEvent: boolean;
|
|
12612
|
-
escalateAnswersHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
|
|
12613
|
-
escalateAnswersAgentAssistInitMessage: string;
|
|
12614
|
-
escalateAnswersAllowAgentInject: boolean;
|
|
12615
|
-
escalateIntentsAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
|
|
12616
|
-
escalateIntentsValidIntents: string[];
|
|
12617
|
-
escalateIntentsThreshold: number;
|
|
12618
|
-
escalateIntentsGotoTarget: string;
|
|
12619
|
-
escalateIntentsExecuteTarget: string;
|
|
12620
|
-
escalateIntentsGotoExecutionMode: "continue" | "wait";
|
|
12621
|
-
escalateIntentsInjectedText: string;
|
|
12622
|
-
escalateIntentsInjectedData: any;
|
|
12623
|
-
escalateIntentsMessage: ISayParams["config"]["say"];
|
|
12624
|
-
escalateIntentsRepromptPrevention: boolean;
|
|
12625
|
-
escalateIntentsHandoverText: string;
|
|
12626
|
-
escalateIntentsRepeatHandoverMessage: boolean;
|
|
12627
|
-
escalateIntentsHandoverCancelIntent: string;
|
|
12628
|
-
escalateIntentsHandoverQuickReply: string;
|
|
12629
|
-
escalateIntentsHandoverChatwootInboxId: string;
|
|
12630
|
-
escalateIntentsHandoverLiveAgentInboxId: string;
|
|
12631
|
-
escalateIntentHandoverSendTranscriptAsFirstMessage: boolean;
|
|
12632
|
-
escalateIntentsHandoverSalesforcePrechatEntities: object[];
|
|
12633
|
-
escalateIntentsHandoverSalesforcePrechatDetails: object[];
|
|
12634
|
-
escalateIntentsHandoverSendResolveEvent: boolean;
|
|
12635
|
-
escalateIntentsHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
|
|
12636
|
-
escalateIntentsAgentAssistInitMessage: string;
|
|
12637
|
-
escalateIntentsAllowAgentInject: boolean;
|
|
12638
|
-
reconfirmationBehaviour: "none" | "reconfirm";
|
|
12639
|
-
reconfirmationQuestion: string;
|
|
12640
|
-
reconfirmationQuestionReprompt: string;
|
|
12641
|
-
}
|
|
12642
|
-
export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig {
|
|
12643
|
-
type: "date";
|
|
12644
|
-
datepicker_eventName: string;
|
|
12645
|
-
datepicker_locale: string;
|
|
12646
|
-
datepicker_dateFormat: string;
|
|
12647
|
-
datepicker_time24Hours: boolean;
|
|
12648
|
-
datepicker_defaultDate: string;
|
|
12649
|
-
datepicker_minDate: string;
|
|
12650
|
-
datepicker_maxDate: string;
|
|
12651
|
-
datepicker_wantEnableDisable: "none" | "enable" | "disable";
|
|
12652
|
-
datepicker_disableEnableRange: boolean;
|
|
12653
|
-
datepicker_enabledDates: string[];
|
|
12654
|
-
datepicker_disabledDates: string[];
|
|
12655
|
-
datepicker_enableTime: boolean;
|
|
12656
|
-
datepicker_mode: "single" | "multiple" | "range";
|
|
12657
|
-
datepicker_openPickerButtonText: string;
|
|
12658
|
-
datepicker_cancelButtonText: string;
|
|
12659
|
-
datepicker_submitButtonText: string;
|
|
12660
|
-
datepicker_defaultHour: number;
|
|
12661
|
-
datepicker_defaultMinute: number;
|
|
12662
|
-
datepicker_enableSeconds: boolean;
|
|
12663
|
-
datepicker_hourIncrement: number;
|
|
12664
|
-
datepicker_minuteIncrement: number;
|
|
12665
|
-
datepicker_noCalendar: boolean;
|
|
12666
|
-
datepicker_weekNumbers: boolean;
|
|
12667
|
-
datepicker_hidePicker: boolean;
|
|
12668
|
-
datepicker_functionEnable: string;
|
|
12669
|
-
datepicker_functionDisable: string;
|
|
12670
|
-
}
|
|
12671
|
-
export interface IQuestionNodeKeyphraseConfig extends IQuestionNodeSharedConfig {
|
|
12672
|
-
type: "keyphrase";
|
|
12673
|
-
keyphraseTag: string;
|
|
12674
|
-
usePositiveOnly: boolean;
|
|
12675
|
-
}
|
|
12676
|
-
export interface IQuestionNodeRegexConfig extends IQuestionNodeSharedConfig {
|
|
12677
|
-
type: "regex";
|
|
12678
|
-
regex: string;
|
|
12679
|
-
}
|
|
12680
|
-
export interface IQuestionNodeOtherConfig extends IQuestionNodeSharedConfig {
|
|
12681
|
-
type: "email" | "number" | "temperature" | "age" | "duration" | "yesNo" | "text" | "money" | "percentage" | "intent" | "data" | "url" | "custom";
|
|
12682
|
-
}
|
|
12683
|
-
export interface IOptionalQuestionNodeParams extends INodeFunctionBaseParams {
|
|
12684
|
-
config: IOptionalQuestionNodeOtherConfig | IOptionalQuestionNodeKeyphraseConfig | IOptionalQuestionNodeRegexConfig;
|
|
12685
|
-
}
|
|
12686
|
-
export interface IOptionalQuestionNodeSharedConfig {
|
|
12687
|
-
say: ISayParams["config"]["say"];
|
|
12688
|
-
retentionTime: number;
|
|
12689
|
-
executeChildrenOnly: boolean;
|
|
12690
|
-
cognigyScript: "answer" | "question";
|
|
12691
|
-
storeResultInContext: boolean;
|
|
12692
|
-
contextKey: string;
|
|
12693
|
-
storeDetailedResults: boolean;
|
|
12694
|
-
}
|
|
12695
|
-
export interface IOptionalQuestionNodeKeyphraseConfig extends IOptionalQuestionNodeSharedConfig {
|
|
12696
|
-
type: "keyphrase";
|
|
12697
|
-
keyphraseTag: string;
|
|
12698
|
-
usePositiveOnly: boolean;
|
|
12699
|
-
}
|
|
12700
|
-
export interface IOptionalQuestionNodeRegexConfig extends IOptionalQuestionNodeSharedConfig {
|
|
12701
|
-
type: "regex";
|
|
12702
|
-
regex: string;
|
|
12703
|
-
}
|
|
12704
|
-
export interface IOptionalQuestionNodeOtherConfig extends IOptionalQuestionNodeSharedConfig {
|
|
12705
|
-
type: "email" | "number" | "temperature" | "age" | "date" | "duration" | "yesNo" | "money" | "percentage" | "intent" | "data" | "url" | "app";
|
|
12706
|
-
}
|
|
12707
13084
|
export interface IContinuousASRParams extends INodeFunctionBaseParams {
|
|
12708
13085
|
config: {
|
|
12709
13086
|
asrEnabled: boolean;
|
|
@@ -12737,6 +13114,8 @@ export interface IVoiceConfigParams {
|
|
|
12737
13114
|
bargeInMinWordCount: number;
|
|
12738
13115
|
bargeInOnSpeech: boolean;
|
|
12739
13116
|
bargeInOnDtmf: boolean;
|
|
13117
|
+
enableAdvancedSTTConfig: boolean;
|
|
13118
|
+
enableAdvancedTTSConfig: boolean;
|
|
12740
13119
|
sttLanguage: string;
|
|
12741
13120
|
sttVendor: string;
|
|
12742
13121
|
sttHints: string[];
|
|
@@ -12749,7 +13128,7 @@ export interface IVoiceConfigParams {
|
|
|
12749
13128
|
ttsLanguage: string;
|
|
12750
13129
|
ttsVendor: TVoiceGateway2TTSVendor;
|
|
12751
13130
|
azureTtsDeploymentId: string;
|
|
12752
|
-
|
|
13131
|
+
azureSttContextId: string;
|
|
12753
13132
|
azureSpeechRecognitionMode: string;
|
|
12754
13133
|
azureEnableAudioLogging: boolean;
|
|
12755
13134
|
azureHintsBoost: number;
|
|
@@ -12810,6 +13189,7 @@ export interface IBargeInParams extends INodeFunctionBaseParams {
|
|
|
12810
13189
|
};
|
|
12811
13190
|
}
|
|
12812
13191
|
export interface IVoiceConfigParams {
|
|
13192
|
+
enableAdvancedSTTConfig: boolean;
|
|
12813
13193
|
sttLanguage: string;
|
|
12814
13194
|
sttVendor: string;
|
|
12815
13195
|
sttHints: string[];
|
|
@@ -12817,6 +13197,10 @@ export interface IVoiceConfigParams {
|
|
|
12817
13197
|
ttsLanguage: string;
|
|
12818
13198
|
ttsVendor: TVoiceGateway2TTSVendor;
|
|
12819
13199
|
sttDisablePunctuation: boolean;
|
|
13200
|
+
azureSttContextId: string;
|
|
13201
|
+
azureEnableAudioLogging: boolean;
|
|
13202
|
+
azureTtsDeploymentId: string;
|
|
13203
|
+
enableAdvancedTTSConfig: boolean;
|
|
12820
13204
|
}
|
|
12821
13205
|
export interface ISessionSpeechParams extends INodeFunctionBaseParams {
|
|
12822
13206
|
config: IVoiceConfigParams;
|
|
@@ -12897,12 +13281,6 @@ export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
|
|
|
12897
13281
|
appInterimScreenOverride?: string;
|
|
12898
13282
|
appConnectScreenOverride?: string;
|
|
12899
13283
|
}
|
|
12900
|
-
export interface ISetAppStateNodeParams extends INodeFunctionBaseParams {
|
|
12901
|
-
config: {
|
|
12902
|
-
appTemplateId: string;
|
|
12903
|
-
appTemplateData: Record<string, unknown>;
|
|
12904
|
-
};
|
|
12905
|
-
}
|
|
12906
13284
|
export interface IGetAppSessionPinNodeParams extends INodeFunctionBaseParams {
|
|
12907
13285
|
}
|
|
12908
13286
|
export declare type TCardType = "basic" | "suggested" | "table" | "custom";
|
|
@@ -13181,11 +13559,18 @@ export interface IPlayParamsConfig extends IVoiceConfigParams {
|
|
|
13181
13559
|
export interface IPlayParams extends INodeFunctionBaseParams {
|
|
13182
13560
|
config: IPlayParamsConfig;
|
|
13183
13561
|
}
|
|
13184
|
-
export interface
|
|
13562
|
+
export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
13185
13563
|
config: {
|
|
13186
|
-
|
|
13564
|
+
transferType: "refer" | "dial";
|
|
13565
|
+
transferReason: string;
|
|
13566
|
+
transferTarget: string;
|
|
13187
13567
|
useTransferSipHeaders: boolean;
|
|
13188
|
-
transferSipHeaders:
|
|
13568
|
+
transferSipHeaders: {
|
|
13569
|
+
[key: string]: string | object;
|
|
13570
|
+
};
|
|
13571
|
+
dialCallerId?: string;
|
|
13572
|
+
dialMusic?: string;
|
|
13573
|
+
dialTranscriptionWebhook?: string;
|
|
13189
13574
|
};
|
|
13190
13575
|
}
|
|
13191
13576
|
export interface ISendMetadataParams extends INodeFunctionBaseParams {
|
|
@@ -13200,8 +13585,8 @@ export interface ICognigyVoiceGateway2Nodes {
|
|
|
13200
13585
|
"dtmf": ICreateChartNodeBasicNodesData<"dtmf", IDtmfParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
13201
13586
|
"hangup": ICreateChartNodeBasicNodesData<"hangup", IHangupParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
13202
13587
|
"play": ICreateChartNodeBasicNodesData<"play", IPlayParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
13203
|
-
"refer": ICreateChartNodeBasicNodesData<"refer",
|
|
13204
|
-
"transfer": ICreateChartNodeBasicNodesData<"transfer",
|
|
13588
|
+
"refer": ICreateChartNodeBasicNodesData<"refer", ITransferNodeParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
13589
|
+
"transfer": ICreateChartNodeBasicNodesData<"transfer", ITransferNodeParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
13205
13590
|
"sendMetadata": ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TVOICE_GATEWAY_2_EXTENSION>;
|
|
13206
13591
|
}
|
|
13207
13592
|
export interface ICognigyBasicNodes {
|
|
@@ -13255,7 +13640,6 @@ export interface ICognigyBasicNodes {
|
|
|
13255
13640
|
question: ICreateChartNodeBasicNodesData<"question", IQuestionNodeParams, TBASIC_EXTENSION>;
|
|
13256
13641
|
optionalQuestion: ICreateChartNodeBasicNodesData<"optionalQuestion", IOptionalQuestionNodeParams, TBASIC_EXTENSION>;
|
|
13257
13642
|
initAppSession: ICreateChartNodeBasicNodesData<"initAppSession", IInitAppSessionNodeParams, TBASIC_EXTENSION>;
|
|
13258
|
-
setAppState: ICreateChartNodeBasicNodesData<"setAppState", ISetAppStateNodeParams, TBASIC_EXTENSION>;
|
|
13259
13643
|
getAppSessionPin: ICreateChartNodeBasicNodesData<"getAppSessionPin", IGetAppSessionPinNodeParams, TBASIC_EXTENSION>;
|
|
13260
13644
|
hangup: ICreateChartNodeBasicNodesData<"hangup", IHangupParams, TBASIC_EXTENSION>;
|
|
13261
13645
|
play: ICreateChartNodeBasicNodesData<"play", IPlayParams, TBASIC_EXTENSION>;
|
|
@@ -13700,6 +14084,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
13700
14084
|
readSentence: TRestAPIOperation<IReadSentenceRestData_2_0, IReadSentenceRestReturnValue_2_0>;
|
|
13701
14085
|
updateSentence: TRestAPIOperation<IUpdateSentenceRestData_2_0, IUpdateSentenceRestReturnValue_2_0>;
|
|
13702
14086
|
deleteSentence: TRestAPIOperation<IDeleteSentenceRestData_2_0, IDeleteSentenceRestReturnValue_2_0>;
|
|
14087
|
+
generateSentences: TRestAPIOperation<IGenerateSentencesRestData_2_0, IGenerateSentencesRestReturnValue_2_0>;
|
|
13703
14088
|
indexLearningSentences: TRestAPIOperation<IIndexLearningSentencesRestData_2_0, IIndexLearningSentencesRestReturnValue_2_0>;
|
|
13704
14089
|
readLearningSentence: TRestAPIOperation<IReadLearningSentenceRestData_2_0, IReadLearningSentenceRestReturnValue_2_0>;
|
|
13705
14090
|
deleteLearningSentence: TRestAPIOperation<IDeleteLearningSentenceRestData_2_0, IDeleteLearningSentenceRestReturnValue_2_0>;
|