@cognigy/rest-api-client 2025.25.0 → 2026.1.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 -0
- package/build/apigroups/ResourcesAPIGroup_2_0.js +14 -0
- package/build/apigroups/SimulationAPIGroup_2_0.js +15 -1
- package/build/authentication/AuthenticationAPI.js +1 -0
- package/build/shared/charts/createNodeDescriptor.js +1 -0
- package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +14 -0
- package/build/shared/charts/descriptors/analytics/updateProfile.js +5 -0
- package/build/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +7 -0
- package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +9 -0
- package/build/shared/charts/descriptors/index.js +2 -0
- package/build/shared/charts/descriptors/message/question/question.js +5 -0
- package/build/shared/charts/descriptors/message/say.js +3 -0
- package/build/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js +239 -0
- package/build/shared/charts/descriptors/service/agentTools/handoverToHumanAgentTool.js +783 -0
- package/build/shared/charts/descriptors/service/agentTools/sendEmailTool.js +33 -4
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +23 -20
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +4 -2
- package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +3 -1
- package/build/shared/charts/descriptors/service/aiAgent/helpers/parseMcpHeaders.js +26 -0
- package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
- package/build/shared/charts/descriptors/service/httpRequest.js +3 -0
- package/build/shared/charts/descriptors/service/index.js +5 -1
- package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +11 -4
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +17 -11
- package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +5 -5
- package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +2 -2
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +13 -4
- package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +4 -4
- package/build/shared/interfaces/amqpInterface.js +1 -0
- package/build/shared/interfaces/messageAPI/endpoints.js +1 -1
- package/build/shared/interfaces/resources/IChart.js +10 -1
- package/build/shared/interfaces/resources/IChartNode.js +32 -4
- package/build/shared/interfaces/resources/IEndpoint.js +1 -0
- package/build/shared/interfaces/resources/INodeDescriptorSet.js +8 -0
- package/build/shared/interfaces/resources/TResourceType.js +1 -0
- package/build/shared/interfaces/resources/chart/IChartExecutableNode.js +10 -1
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeConnector.js +49 -0
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
- package/build/shared/interfaces/restAPI/administration/user/v2.0/IExchangeCXoneTokenRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/ICreateKnowledgeConnectorRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IDeleteKnowledgeConnectorRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IIndexKnowledgeConnectorsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IKnowledgeConnector_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IReadKnowledgeConnectorRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IUpdateKnowledgeConnectorRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/scheduler/ICreateSchedulerRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/scheduler/IGetSchedulerRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/scheduler/ISchedulerRest_2_0.js +12 -0
- package/build/shared/interfaces/restAPI/simulation/scheduler/IUpdateSchedulerRest_2_0.js +3 -0
- package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +14 -0
- package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +15 -1
- package/dist/esm/authentication/AuthenticationAPI.js +1 -0
- package/dist/esm/shared/charts/createNodeDescriptor.js +1 -0
- package/dist/esm/shared/charts/descriptors/analytics/overwriteAnalytics.js +14 -0
- package/dist/esm/shared/charts/descriptors/analytics/updateProfile.js +5 -0
- package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +7 -0
- package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +9 -0
- package/dist/esm/shared/charts/descriptors/index.js +3 -1
- package/dist/esm/shared/charts/descriptors/message/question/question.js +5 -0
- package/dist/esm/shared/charts/descriptors/message/say.js +3 -0
- package/dist/esm/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js +237 -0
- package/dist/esm/shared/charts/descriptors/service/agentTools/handoverToHumanAgentTool.js +770 -0
- package/dist/esm/shared/charts/descriptors/service/agentTools/sendEmailTool.js +33 -4
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +23 -20
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +4 -2
- package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +3 -1
- package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/parseMcpHeaders.js +25 -0
- package/dist/esm/shared/charts/descriptors/service/handoverV2.js +1 -1
- package/dist/esm/shared/charts/descriptors/service/httpRequest.js +3 -0
- package/dist/esm/shared/charts/descriptors/service/index.js +2 -0
- package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +11 -4
- package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +17 -11
- package/dist/esm/shared/charts/descriptors/voice/mappers/transfer.mapper.js +5 -5
- package/dist/esm/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +2 -2
- package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +13 -4
- package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/transfer.js +4 -4
- package/dist/esm/shared/interfaces/amqpInterface.js +1 -0
- package/dist/esm/shared/interfaces/messageAPI/endpoints.js +1 -1
- package/dist/esm/shared/interfaces/resources/IChart.js +10 -1
- package/dist/esm/shared/interfaces/resources/IChartNode.js +32 -4
- package/dist/esm/shared/interfaces/resources/IEndpoint.js +1 -0
- package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js +8 -0
- package/dist/esm/shared/interfaces/resources/TResourceType.js +1 -0
- package/dist/esm/shared/interfaces/resources/chart/IChartExecutableNode.js +10 -1
- package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeConnector.js +46 -0
- package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
- package/dist/esm/shared/interfaces/restAPI/administration/user/v2.0/IExchangeCXoneTokenRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/ICreateKnowledgeConnectorRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IDeleteKnowledgeConnectorRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IIndexKnowledgeConnectorsRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IKnowledgeConnector_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IReadKnowledgeConnectorRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IUpdateKnowledgeConnectorRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/ICreateSchedulerRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/IGetSchedulerRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/ISchedulerRest_2_0.js +9 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/IUpdateSchedulerRest_2_0.js +2 -0
- package/package.json +1 -1
- package/types/index.d.ts +528 -11
package/types/index.d.ts
CHANGED
|
@@ -935,6 +935,7 @@ declare const referenceKeys: readonly [
|
|
|
935
935
|
"resourceReference",
|
|
936
936
|
"snapshotReference",
|
|
937
937
|
"subResourceReference",
|
|
938
|
+
"connectorReference",
|
|
938
939
|
"storeReference",
|
|
939
940
|
"sourceReference"
|
|
940
941
|
];
|
|
@@ -965,6 +966,7 @@ declare const arrayTResourceType: readonly [
|
|
|
965
966
|
"knowledgeStore",
|
|
966
967
|
"knowledgeSource",
|
|
967
968
|
"knowledgeChunk",
|
|
969
|
+
"knowledgeConnector",
|
|
968
970
|
"lexicon",
|
|
969
971
|
"lexiconEntry",
|
|
970
972
|
"lexiconKeyphrase",
|
|
@@ -1609,6 +1611,20 @@ export interface IExchangeOneTimeTokenForRefreshTokenRestData_2_0 extends IExcha
|
|
|
1609
1611
|
export interface IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0 {
|
|
1610
1612
|
refreshToken: string;
|
|
1611
1613
|
}
|
|
1614
|
+
/**
|
|
1615
|
+
* @openapi
|
|
1616
|
+
*
|
|
1617
|
+
* components:
|
|
1618
|
+
* schemas:
|
|
1619
|
+
* IExchangeCXoneTokenRestReturnValue_2_0:
|
|
1620
|
+
* type: object
|
|
1621
|
+
* properties:
|
|
1622
|
+
* refreshToken:
|
|
1623
|
+
* type: string
|
|
1624
|
+
*/
|
|
1625
|
+
export interface IExchangeCXoneTokenRestReturnValue_2_0 {
|
|
1626
|
+
refreshToken: string;
|
|
1627
|
+
}
|
|
1612
1628
|
export interface AuthenticationAPI {
|
|
1613
1629
|
authenticationHandler?: IAuthenticationAdapter;
|
|
1614
1630
|
setCredentials: (credentials: TAuthenticationCredentials) => void;
|
|
@@ -1621,6 +1637,7 @@ export interface AuthenticationAPI {
|
|
|
1621
1637
|
webfinger: TRestAPIOperation<IWebfingerRestData, IWebfingerRestReturnValue>;
|
|
1622
1638
|
getAuthorizationCode?: (data: IGetAuthorizationCodeParameters) => Promise<IGetAuthorizationCodeResponse>;
|
|
1623
1639
|
exchangeOneTimeTokenForRefreshToken: TRestAPIOperation<IExchangeOneTimeTokenForRefreshTokenRestData_2_0, IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0>;
|
|
1640
|
+
exchangeCXoneToken: TRestAPIOperation<{}, IExchangeCXoneTokenRestReturnValue_2_0>;
|
|
1624
1641
|
generateManagementUIAuthToken: TRestAPIOperation<void, {
|
|
1625
1642
|
token: string;
|
|
1626
1643
|
}>;
|
|
@@ -2530,6 +2547,10 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2530
2547
|
label: string;
|
|
2531
2548
|
active: boolean;
|
|
2532
2549
|
};
|
|
2550
|
+
/**
|
|
2551
|
+
* Whether to enable mocking code for the node execution
|
|
2552
|
+
*/
|
|
2553
|
+
enableMocking?: boolean;
|
|
2533
2554
|
}
|
|
2534
2555
|
export interface IGraphEndpoint {
|
|
2535
2556
|
type: "endpoint";
|
|
@@ -3045,7 +3066,6 @@ export interface IVoiceGateway2SynthesizerParams {
|
|
|
3045
3066
|
model?: string;
|
|
3046
3067
|
}
|
|
3047
3068
|
export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
|
|
3048
|
-
export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
|
|
3049
3069
|
export interface IVoiceGateway2RecognizerParams {
|
|
3050
3070
|
vendor?: string;
|
|
3051
3071
|
language?: string;
|
|
@@ -3087,7 +3107,8 @@ export interface IVoiceGateway2RecognizerParams {
|
|
|
3087
3107
|
ibmOptions?: TVoiceGateway2IbmOptions;
|
|
3088
3108
|
nvidiaOptions?: TVoiceGateway2NvidiaOptions;
|
|
3089
3109
|
sonioxOptions?: TVoiceGateway2SonioxOptions;
|
|
3090
|
-
|
|
3110
|
+
openaiOptions?: TVoiceGateway2OpenaiOptions;
|
|
3111
|
+
model?: string;
|
|
3091
3112
|
}
|
|
3092
3113
|
export declare type TVoiceGateway2NuanceOptions = {
|
|
3093
3114
|
clientId?: string;
|
|
@@ -3163,6 +3184,10 @@ export declare type TVoiceGateway2SonioxOptions = {
|
|
|
3163
3184
|
metadata?: object;
|
|
3164
3185
|
storage?: object;
|
|
3165
3186
|
};
|
|
3187
|
+
export declare type TVoiceGateway2OpenaiOptions = {
|
|
3188
|
+
model?: string;
|
|
3189
|
+
apiKey?: string;
|
|
3190
|
+
};
|
|
3166
3191
|
export declare type TVoiceGateway2IbmOptions = {
|
|
3167
3192
|
sttApiKey?: string;
|
|
3168
3193
|
sttRegion?: string;
|
|
@@ -7845,6 +7870,8 @@ export interface IEndpoint_2_0 {
|
|
|
7845
7870
|
sipConnectivityInfo?: ISipConnectivityInfo;
|
|
7846
7871
|
/** The label of the webrtc widget */
|
|
7847
7872
|
webrtcWidgetConfig?: IWebrtcWidgetConfig;
|
|
7873
|
+
/** Whether to enable mocking code for the node execution */
|
|
7874
|
+
enableMocking: boolean;
|
|
7848
7875
|
}
|
|
7849
7876
|
export interface ITransformerFunction_2_0 {
|
|
7850
7877
|
/**
|
|
@@ -9209,6 +9236,10 @@ export interface IGraphAgentAssistConfig {
|
|
|
9209
9236
|
* items:
|
|
9210
9237
|
* type: string
|
|
9211
9238
|
* description: MongoDB ObjectId representing a project
|
|
9239
|
+
* example:
|
|
9240
|
+
* - "68edf5dd4c931f68d31111"
|
|
9241
|
+
* - "690b02fc100e454245adde111"
|
|
9242
|
+
* - "68e6eda61ff68d2111"
|
|
9212
9243
|
*
|
|
9213
9244
|
* IGlobalResourceFields_2_0:
|
|
9214
9245
|
* allOf:
|
|
@@ -9440,6 +9471,7 @@ export interface ICodeNodeParams extends ICodeNodeBasicParams {
|
|
|
9440
9471
|
hasError?: boolean;
|
|
9441
9472
|
transpiled?: string;
|
|
9442
9473
|
};
|
|
9474
|
+
IsMockCodeExecution?: boolean;
|
|
9443
9475
|
}
|
|
9444
9476
|
export interface ICodeNodeBasicParams extends INodeFunctionBaseParams {
|
|
9445
9477
|
config: {
|
|
@@ -10659,6 +10691,10 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
|
10659
10691
|
}
|
|
10660
10692
|
export interface IEndpointSettings {
|
|
10661
10693
|
isFeatureAccmEnabled?: boolean;
|
|
10694
|
+
/**
|
|
10695
|
+
* Whether to enable mocking code for the node execution
|
|
10696
|
+
*/
|
|
10697
|
+
enableMocking?: boolean;
|
|
10662
10698
|
}
|
|
10663
10699
|
export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
|
|
10664
10700
|
id: string;
|
|
@@ -10691,6 +10727,16 @@ export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeF
|
|
|
10691
10727
|
*/
|
|
10692
10728
|
isDisabled: boolean;
|
|
10693
10729
|
analyticsLabel?: string;
|
|
10730
|
+
/**
|
|
10731
|
+
* Mock object to replace the node function with a mock function,
|
|
10732
|
+
* when the mock mode is enabled for the node and the endpoint settings allow it.
|
|
10733
|
+
*/
|
|
10734
|
+
mock: {
|
|
10735
|
+
isEnabled: boolean;
|
|
10736
|
+
code: string;
|
|
10737
|
+
transpiled?: string;
|
|
10738
|
+
hasError?: boolean;
|
|
10739
|
+
};
|
|
10694
10740
|
}
|
|
10695
10741
|
/**
|
|
10696
10742
|
* @param meta.contactNumber DirectQuery views this is as an identifier similar to a session ID
|
|
@@ -10971,6 +11017,7 @@ export interface IGetMetaDataActionValue {
|
|
|
10971
11017
|
snapshotName: string;
|
|
10972
11018
|
isFollowSessionActive: boolean;
|
|
10973
11019
|
contactId: string;
|
|
11020
|
+
enableMocking: boolean;
|
|
10974
11021
|
}
|
|
10975
11022
|
export interface ICognigyNLPProperties {
|
|
10976
11023
|
/** The original text of the user */
|
|
@@ -11246,6 +11293,7 @@ export interface ISendEmailNodeParams extends INodeFunctionBaseParams {
|
|
|
11246
11293
|
googleWarning: string;
|
|
11247
11294
|
recipient: string;
|
|
11248
11295
|
from: string;
|
|
11296
|
+
senderName: string;
|
|
11249
11297
|
message: string;
|
|
11250
11298
|
subject: string;
|
|
11251
11299
|
replyTo: string;
|
|
@@ -11269,7 +11317,7 @@ export interface ISendEmailNodeParams extends INodeFunctionBaseParams {
|
|
|
11269
11317
|
} & (ISMTPEmailConnection);
|
|
11270
11318
|
}
|
|
11271
11319
|
export interface IEmailNotificationNodeParams extends INodeFunctionBaseParams {
|
|
11272
|
-
config: Pick<ISendEmailNodeParams["config"], "recipient" | "message" | "subject" | "cc" | "bcc" | "priority" | "async" | "storeLocation" | "inputKey" | "contextKey" | "stopOnError">;
|
|
11320
|
+
config: Pick<ISendEmailNodeParams["config"], "senderName" | "recipient" | "message" | "subject" | "cc" | "bcc" | "priority" | "async" | "storeLocation" | "inputKey" | "contextKey" | "stopOnError">;
|
|
11273
11321
|
}
|
|
11274
11322
|
export interface ISQLConnectionFields {
|
|
11275
11323
|
host: string;
|
|
@@ -11774,6 +11822,7 @@ declare const nodeFieldTypes: readonly [
|
|
|
11774
11822
|
"checkAgentAvailabilityConfig",
|
|
11775
11823
|
"chipInput",
|
|
11776
11824
|
"code",
|
|
11825
|
+
"mockCode",
|
|
11777
11826
|
"cognigyLLMText",
|
|
11778
11827
|
"cognigyText",
|
|
11779
11828
|
"cognigyTextArray",
|
|
@@ -11936,6 +11985,9 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
|
|
|
11936
11985
|
sections?: INodeSection[];
|
|
11937
11986
|
/** The form defines how fields and sections should be render in order */
|
|
11938
11987
|
form?: INodeFieldAndSectionFormElement[];
|
|
11988
|
+
mocking?: {
|
|
11989
|
+
defaultMockCode?: string;
|
|
11990
|
+
};
|
|
11939
11991
|
}
|
|
11940
11992
|
export interface IAppTemplate extends IEntityMeta {
|
|
11941
11993
|
/** The object id of this app template */
|
|
@@ -13474,7 +13526,17 @@ export interface IChart_2_0 {
|
|
|
13474
13526
|
* analyticsLabel:
|
|
13475
13527
|
* type: string
|
|
13476
13528
|
* example: "condition"
|
|
13477
|
-
|
|
13529
|
+
* mock:
|
|
13530
|
+
* type: object
|
|
13531
|
+
* properties:
|
|
13532
|
+
* isEnabled:
|
|
13533
|
+
* type: boolean
|
|
13534
|
+
* example: false
|
|
13535
|
+
* code:
|
|
13536
|
+
* type: string
|
|
13537
|
+
* example: "console.log('Hello, world!');"
|
|
13538
|
+
* description: Mock code to be executed when the mock mode is enabled.
|
|
13539
|
+
* nullable: false
|
|
13478
13540
|
*
|
|
13479
13541
|
* IChartNode_2_0:
|
|
13480
13542
|
* allOf:
|
|
@@ -13498,6 +13560,10 @@ export interface IChartNode_2_0<T extends INodeFunctionBaseParams = any> {
|
|
|
13498
13560
|
extension: string;
|
|
13499
13561
|
localeReference: string;
|
|
13500
13562
|
analyticsLabel?: string;
|
|
13563
|
+
mock: {
|
|
13564
|
+
isEnabled: boolean;
|
|
13565
|
+
code: string;
|
|
13566
|
+
};
|
|
13501
13567
|
}
|
|
13502
13568
|
declare enum ConvertActionType {
|
|
13503
13569
|
ADDED = "added",
|
|
@@ -13506,6 +13572,12 @@ declare enum ConvertActionType {
|
|
|
13506
13572
|
}
|
|
13507
13573
|
export declare type TConvertAction = (typeof ConvertActionType)[keyof typeof ConvertActionType];
|
|
13508
13574
|
export declare type TNodeConversionMetadata = Record<string, TConvertAction>;
|
|
13575
|
+
export interface IMockData {
|
|
13576
|
+
isEnabled: boolean;
|
|
13577
|
+
code: string;
|
|
13578
|
+
transpiled?: string;
|
|
13579
|
+
hasError?: boolean;
|
|
13580
|
+
}
|
|
13509
13581
|
export interface IChartNodeBase {
|
|
13510
13582
|
_id: TMongoId;
|
|
13511
13583
|
referenceId: string;
|
|
@@ -13533,6 +13605,7 @@ export interface IChartNodeBase {
|
|
|
13533
13605
|
resourceReference: TMongoId;
|
|
13534
13606
|
projectReference: TMongoId;
|
|
13535
13607
|
organisationReference: TMongoId;
|
|
13608
|
+
mock: IMockData;
|
|
13536
13609
|
}
|
|
13537
13610
|
export interface IChartNode<T extends string = string, D extends INodeFunctionBaseParams = any, E extends string = string> extends IChartNodeBase {
|
|
13538
13611
|
type: T;
|
|
@@ -14480,7 +14553,7 @@ export interface INodeField_2_0 {
|
|
|
14480
14553
|
};
|
|
14481
14554
|
}
|
|
14482
14555
|
export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
|
|
14483
|
-
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";
|
|
14556
|
+
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" | "mock";
|
|
14484
14557
|
export interface INodeDependencies_2_0 {
|
|
14485
14558
|
/** A list of Node types */
|
|
14486
14559
|
children: string[];
|
|
@@ -16943,7 +17016,7 @@ export interface IVoiceConfigParams {
|
|
|
16943
17016
|
sttGoogleLang1: string;
|
|
16944
17017
|
sttGoogleLang2: string;
|
|
16945
17018
|
sttGoogleLang3: string;
|
|
16946
|
-
|
|
17019
|
+
sttModel: string;
|
|
16947
17020
|
deepgramEndpointing: boolean;
|
|
16948
17021
|
deepgramEndpointingValue: number;
|
|
16949
17022
|
deepgramSmartFormatting: boolean;
|
|
@@ -17019,7 +17092,7 @@ export interface IVoiceConfigParams {
|
|
|
17019
17092
|
azureSttContextId: string;
|
|
17020
17093
|
azureEnableAudioLogging: boolean;
|
|
17021
17094
|
googleModel: TVoiceGateway2GoogleModel;
|
|
17022
|
-
|
|
17095
|
+
sttModel: string;
|
|
17023
17096
|
deepgramEndpointing: boolean;
|
|
17024
17097
|
deepgramEndpointingValue: number;
|
|
17025
17098
|
deepgramSmartFormatting: boolean;
|
|
@@ -17435,7 +17508,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
|
|
|
17435
17508
|
recognitionChannel: number;
|
|
17436
17509
|
sttLanguage: string;
|
|
17437
17510
|
sttVendor: string;
|
|
17438
|
-
|
|
17511
|
+
sttModel: string;
|
|
17439
17512
|
sttDisablePunctuation: boolean;
|
|
17440
17513
|
googleModel: TVoiceGateway2GoogleModel;
|
|
17441
17514
|
sttLabel: string;
|
|
@@ -18169,9 +18242,13 @@ export interface IGoogleGeminiMeta_2_0 {
|
|
|
18169
18242
|
* - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
|
|
18170
18243
|
* - $ref: '#/components/schemas/IEntityMeta'
|
|
18171
18244
|
* ILargeLanguageModel_2_0:
|
|
18172
|
-
*
|
|
18173
|
-
* -
|
|
18174
|
-
*
|
|
18245
|
+
* oneOf:
|
|
18246
|
+
* - allOf:
|
|
18247
|
+
* - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
|
|
18248
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
18249
|
+
* - allOf:
|
|
18250
|
+
* - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
|
|
18251
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
18175
18252
|
*/
|
|
18176
18253
|
export interface ILargeLanguageModel_2_0 extends IGlobalResource {
|
|
18177
18254
|
referenceId: string;
|
|
@@ -18501,6 +18578,7 @@ export interface IKnowledgeSourceMetaData {
|
|
|
18501
18578
|
id: string;
|
|
18502
18579
|
type: string;
|
|
18503
18580
|
};
|
|
18581
|
+
contentHashOrTimestamp?: string;
|
|
18504
18582
|
}
|
|
18505
18583
|
/**
|
|
18506
18584
|
* @openapi
|
|
@@ -18527,6 +18605,7 @@ export interface IKnowledgeSourceMetaData {
|
|
|
18527
18605
|
* - pdf
|
|
18528
18606
|
* - txt
|
|
18529
18607
|
* - ctxt
|
|
18608
|
+
* - extension
|
|
18530
18609
|
* description: The type of source for the Knowledge store
|
|
18531
18610
|
* metaData:
|
|
18532
18611
|
* type: object
|
|
@@ -18579,6 +18658,15 @@ export interface IKnowledgeSourceMetaData {
|
|
|
18579
18658
|
* properties:
|
|
18580
18659
|
* metaData:
|
|
18581
18660
|
* type: object
|
|
18661
|
+
* data:
|
|
18662
|
+
* type: object
|
|
18663
|
+
* additionalProperties: true
|
|
18664
|
+
* description: Custom metadata object to store additional information in the KnowledgeSource
|
|
18665
|
+
* example:
|
|
18666
|
+
* _id: "x4xU6hMntv23p"
|
|
18667
|
+
* sys_CreatedAt: "2019-12-16T11:40:45.7212"
|
|
18668
|
+
* sys_UpdatedAt: "2025-10-01T07:46:04.5932"
|
|
18669
|
+
* Type: "FAQ"
|
|
18582
18670
|
* chunkCount:
|
|
18583
18671
|
* type: integer
|
|
18584
18672
|
* status:
|
|
@@ -18587,6 +18675,10 @@ export interface IKnowledgeSourceMetaData {
|
|
|
18587
18675
|
* - ready
|
|
18588
18676
|
* - ingesting
|
|
18589
18677
|
* - disabled
|
|
18678
|
+
* connectorReference:
|
|
18679
|
+
* type: string
|
|
18680
|
+
* format: uuid
|
|
18681
|
+
* description: The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
|
|
18590
18682
|
*
|
|
18591
18683
|
* IKnowledgeSourceGeneratedData_2_0:
|
|
18592
18684
|
* type: object
|
|
@@ -18595,6 +18687,20 @@ export interface IKnowledgeSourceMetaData {
|
|
|
18595
18687
|
* type: string
|
|
18596
18688
|
* format: uuid
|
|
18597
18689
|
*
|
|
18690
|
+
* IKnowledgeSourceDataTypeExtension_2_0:
|
|
18691
|
+
* type: object
|
|
18692
|
+
* properties:
|
|
18693
|
+
* connectorId:
|
|
18694
|
+
* type: string
|
|
18695
|
+
* format: uuid
|
|
18696
|
+
* description: The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
|
|
18697
|
+
* example:
|
|
18698
|
+
* name: "mysource"
|
|
18699
|
+
* description: "mysource description"
|
|
18700
|
+
* type: "extension"
|
|
18701
|
+
* metaData:
|
|
18702
|
+
* tags: ["tag1"]
|
|
18703
|
+
* connectorId: "uuid"
|
|
18598
18704
|
* IKnowledgeSource_2_0:
|
|
18599
18705
|
* allOf:
|
|
18600
18706
|
* - $ref: '#/components/schemas/IKnowledgeSourceData_2_0'
|
|
@@ -18612,6 +18718,7 @@ export interface IKnowledgeSource_2_0 {
|
|
|
18612
18718
|
metaData: IKnowledgeSourceMetaData;
|
|
18613
18719
|
data: Record<string, unknown>;
|
|
18614
18720
|
storeReference: TMongoId;
|
|
18721
|
+
connectorReference?: TMongoId;
|
|
18615
18722
|
projectReference: TMongoId;
|
|
18616
18723
|
organisationReference: TMongoId;
|
|
18617
18724
|
createdAt: number;
|
|
@@ -18798,6 +18905,241 @@ export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensi
|
|
|
18798
18905
|
}
|
|
18799
18906
|
export interface IRunKnowledgeExtensionRestReturnValue_2_0 extends ICreatedTask_2_0 {
|
|
18800
18907
|
}
|
|
18908
|
+
declare const knowledgeConnectorExecutionStatus: readonly [
|
|
18909
|
+
"none",
|
|
18910
|
+
"queued",
|
|
18911
|
+
"active",
|
|
18912
|
+
"done",
|
|
18913
|
+
"error"
|
|
18914
|
+
];
|
|
18915
|
+
export declare type KnowledgeConnectorExecutionStatus = typeof knowledgeConnectorExecutionStatus[number];
|
|
18916
|
+
/**
|
|
18917
|
+
* @openapi
|
|
18918
|
+
*
|
|
18919
|
+
* components:
|
|
18920
|
+
* schemas:
|
|
18921
|
+
* IKnowledgeConnectorCreatePayload_2_0:
|
|
18922
|
+
* allOf:
|
|
18923
|
+
* - $ref: '#/components/schemas/IKnowledgeConnectorExtensionReference_2_0'
|
|
18924
|
+
* - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
|
|
18925
|
+
*
|
|
18926
|
+
* IKnowledgeConnectorUpdatePayload_2_0:
|
|
18927
|
+
* allOf:
|
|
18928
|
+
* - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
|
|
18929
|
+
*
|
|
18930
|
+
* IKnowledgeConnectorExtensionReference_2_0:
|
|
18931
|
+
* type: object
|
|
18932
|
+
* properties:
|
|
18933
|
+
* extension:
|
|
18934
|
+
* type: string
|
|
18935
|
+
* description: The name of the extension
|
|
18936
|
+
* example: "confluence"
|
|
18937
|
+
* version:
|
|
18938
|
+
* type: string
|
|
18939
|
+
* description: The version of extension identifier
|
|
18940
|
+
* example: "1.1.0"
|
|
18941
|
+
* type:
|
|
18942
|
+
* type: string
|
|
18943
|
+
* description: The Knowledge Connector type identifier within an extension
|
|
18944
|
+
* example: "MyConfluenceConnector"
|
|
18945
|
+
*
|
|
18946
|
+
* IKnowledgeConnectorData_2_0:
|
|
18947
|
+
* type: object
|
|
18948
|
+
* properties:
|
|
18949
|
+
* config:
|
|
18950
|
+
* type: object
|
|
18951
|
+
* description: The configuration of the KnowledgeConnector
|
|
18952
|
+
* name:
|
|
18953
|
+
* type: string
|
|
18954
|
+
* description: The name of the KnowledgeConnector
|
|
18955
|
+
* example: "My Knowledge Connector"
|
|
18956
|
+
* schedule:
|
|
18957
|
+
* type: object
|
|
18958
|
+
* properties:
|
|
18959
|
+
* enabled:
|
|
18960
|
+
* type: boolean
|
|
18961
|
+
* description: If scheduled execution is enabled or not
|
|
18962
|
+
* example: true
|
|
18963
|
+
* start:
|
|
18964
|
+
* $ref: '#/components/schemas/TTimestamp'
|
|
18965
|
+
* description: Start date and time to calculate scheduled execution
|
|
18966
|
+
* hour:
|
|
18967
|
+
* type: number
|
|
18968
|
+
* description: Hour to start the scheduled execution
|
|
18969
|
+
* example: 1
|
|
18970
|
+
* minute:
|
|
18971
|
+
* type: number
|
|
18972
|
+
* description: Minute to start the scheduled execution
|
|
18973
|
+
* example: 1
|
|
18974
|
+
* weekDays:
|
|
18975
|
+
* type: array
|
|
18976
|
+
* items:
|
|
18977
|
+
* type: number
|
|
18978
|
+
* description: Repeat x days of the week, Monday = 0 ... Sunday = 6
|
|
18979
|
+
* example: [0,3]
|
|
18980
|
+
*
|
|
18981
|
+
* IKnowledgeConnectorExecution_2_0:
|
|
18982
|
+
* type: object
|
|
18983
|
+
* properties:
|
|
18984
|
+
* lastExecution:
|
|
18985
|
+
* $ref: '#/components/schemas/TTimestamp'
|
|
18986
|
+
* description: Unix-timestamp when the last execution was triggered
|
|
18987
|
+
* lastExecutionStatus:
|
|
18988
|
+
* type: string
|
|
18989
|
+
* description: Last execution status of the KnowledgeConnector
|
|
18990
|
+
* enum:
|
|
18991
|
+
* - none
|
|
18992
|
+
* - queued
|
|
18993
|
+
* - active
|
|
18994
|
+
* - done
|
|
18995
|
+
* - error
|
|
18996
|
+
*
|
|
18997
|
+
* IKnowledgeConnector_2_0:
|
|
18998
|
+
* allOf:
|
|
18999
|
+
* - $ref: '#/components/schemas/IKnowledgeConnectorExtensionReference_2_0'
|
|
19000
|
+
* - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
|
|
19001
|
+
* - $ref: '#/components/schemas/IKnowledgeConnectorExecution_2_0'
|
|
19002
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
19003
|
+
*/
|
|
19004
|
+
export interface IKnowledgeConnector_2_0 {
|
|
19005
|
+
/**
|
|
19006
|
+
* Extension nam
|
|
19007
|
+
*/
|
|
19008
|
+
extension: string;
|
|
19009
|
+
/**
|
|
19010
|
+
* The type identifier of Knowledge Connector within an Extension
|
|
19011
|
+
*/
|
|
19012
|
+
type: string;
|
|
19013
|
+
/**
|
|
19014
|
+
* The version of the Knowledge Connector Extension
|
|
19015
|
+
*/
|
|
19016
|
+
version: string;
|
|
19017
|
+
/**
|
|
19018
|
+
* The configuration of the KnowledgeConnector
|
|
19019
|
+
*/
|
|
19020
|
+
config: Record<string, unknown>;
|
|
19021
|
+
/**
|
|
19022
|
+
* The name of the KnowledgeConnector
|
|
19023
|
+
*/
|
|
19024
|
+
name: string;
|
|
19025
|
+
/**
|
|
19026
|
+
* Schedule configuration
|
|
19027
|
+
*/
|
|
19028
|
+
schedule: {
|
|
19029
|
+
/**
|
|
19030
|
+
* If scheduled execution is enabled or not
|
|
19031
|
+
*/
|
|
19032
|
+
enabled: boolean;
|
|
19033
|
+
/**
|
|
19034
|
+
* Start date and time to calculate scheduled execution
|
|
19035
|
+
*/
|
|
19036
|
+
start: number;
|
|
19037
|
+
/**
|
|
19038
|
+
* Hour to start the scheduled execution
|
|
19039
|
+
*/
|
|
19040
|
+
hour: number;
|
|
19041
|
+
/**
|
|
19042
|
+
* Minute to start the scheduled execution
|
|
19043
|
+
*/
|
|
19044
|
+
minute: number;
|
|
19045
|
+
/**
|
|
19046
|
+
* Repeat x days of the week
|
|
19047
|
+
*/
|
|
19048
|
+
weekDays: Array<number>;
|
|
19049
|
+
};
|
|
19050
|
+
_id: TMongoId;
|
|
19051
|
+
referenceId: TMongoId;
|
|
19052
|
+
/**
|
|
19053
|
+
* The knowledge store Id to which the KnowledgeSource belongs to
|
|
19054
|
+
*/
|
|
19055
|
+
storeReference: TMongoId;
|
|
19056
|
+
/**
|
|
19057
|
+
* The project Id to which the KnowledgeSource belongs to
|
|
19058
|
+
*/
|
|
19059
|
+
projectReference: TMongoId;
|
|
19060
|
+
/**
|
|
19061
|
+
* The organisation Id to which the KnowledgeSource belongs to
|
|
19062
|
+
*/
|
|
19063
|
+
organisationReference: TMongoId;
|
|
19064
|
+
/**
|
|
19065
|
+
* Time of last execution
|
|
19066
|
+
*/
|
|
19067
|
+
lastExecution: number;
|
|
19068
|
+
/**
|
|
19069
|
+
* Last execution status of the KnowledgeConnector
|
|
19070
|
+
*/
|
|
19071
|
+
lastExecutionStatus: KnowledgeConnectorExecutionStatus;
|
|
19072
|
+
/**
|
|
19073
|
+
* Unix-timestamp when the enKnowledgeSourcetity was created initially
|
|
19074
|
+
*/
|
|
19075
|
+
createdAt: number;
|
|
19076
|
+
/**
|
|
19077
|
+
* Unix-timestamp when the KnowledgeSource was changed last time
|
|
19078
|
+
*/
|
|
19079
|
+
lastChanged: number;
|
|
19080
|
+
/**
|
|
19081
|
+
* Id of the user who created the KnowledgeSource initially
|
|
19082
|
+
*/
|
|
19083
|
+
createdBy: TMongoId;
|
|
19084
|
+
/**
|
|
19085
|
+
* Id of the user who did the last modification
|
|
19086
|
+
*/
|
|
19087
|
+
lastChangedBy: TMongoId;
|
|
19088
|
+
}
|
|
19089
|
+
export interface ICreateKnowledgeConnectorRestDataParams_2_0 {
|
|
19090
|
+
knowledgeStoreId: string;
|
|
19091
|
+
}
|
|
19092
|
+
export interface ICreateKnowledgeConnectorRestDataBody_2_0 {
|
|
19093
|
+
extension: string;
|
|
19094
|
+
type: string;
|
|
19095
|
+
version: string;
|
|
19096
|
+
config: object;
|
|
19097
|
+
name: string;
|
|
19098
|
+
schedule: {
|
|
19099
|
+
enabled: boolean;
|
|
19100
|
+
start: number;
|
|
19101
|
+
hour: number;
|
|
19102
|
+
minute: number;
|
|
19103
|
+
weekDays: Array<number>;
|
|
19104
|
+
};
|
|
19105
|
+
}
|
|
19106
|
+
export interface ICreateKnowledgeConnectorRestData_2_0 extends ICreateKnowledgeConnectorRestDataParams_2_0, ICreateKnowledgeConnectorRestDataBody_2_0 {
|
|
19107
|
+
}
|
|
19108
|
+
export interface ICreateKnowledgeConnectorRestReturnValue_2_0 extends IKnowledgeConnector_2_0 {
|
|
19109
|
+
}
|
|
19110
|
+
export interface IIndexKnowledgeConnectorsRestDataParams_2_0 {
|
|
19111
|
+
knowledgeStoreId: string;
|
|
19112
|
+
}
|
|
19113
|
+
export interface IIndexKnowledgeConnectorsRestData_2_0 extends IIndexKnowledgeConnectorsRestDataParams_2_0, IRestPagination<IKnowledgeConnector_2_0> {
|
|
19114
|
+
}
|
|
19115
|
+
export interface IIndexKnowledgeConnectorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeConnector_2_0> {
|
|
19116
|
+
}
|
|
19117
|
+
export interface IReadKnowledgeConnectorRestDataParams_2_0 {
|
|
19118
|
+
knowledgeStoreId: string;
|
|
19119
|
+
connectorId: string;
|
|
19120
|
+
}
|
|
19121
|
+
export interface IReadKnowledgeConnectorRestData_2_0 extends IReadKnowledgeConnectorRestDataParams_2_0 {
|
|
19122
|
+
}
|
|
19123
|
+
export interface IReadKnowledgeConnectorRestReturnValue_2_0 extends IKnowledgeConnector_2_0 {
|
|
19124
|
+
}
|
|
19125
|
+
export interface IDeleteKnowledgeConnectorRestDataParams_2_0 {
|
|
19126
|
+
knowledgeStoreId: string;
|
|
19127
|
+
connectorId: string;
|
|
19128
|
+
}
|
|
19129
|
+
export interface IDeleteKnowledgeConnectorRestData_2_0 extends IDeleteKnowledgeConnectorRestDataParams_2_0 {
|
|
19130
|
+
}
|
|
19131
|
+
export interface IDeleteKnowledgeConnectorRestReturnValue_2_0 {
|
|
19132
|
+
}
|
|
19133
|
+
export interface IUpdateKnowledgeConnectorRestDataBody_2_0 extends Partial<Pick<IKnowledgeConnector_2_0, "version" | "name" | "config" | "schedule">> {
|
|
19134
|
+
}
|
|
19135
|
+
export interface IUpdateKnowledgeConnectorRestDataParams_2_0 {
|
|
19136
|
+
knowledgeStoreId: string;
|
|
19137
|
+
connectorId: string;
|
|
19138
|
+
}
|
|
19139
|
+
export interface IUpdateKnowledgeConnectorRestData_2_0 extends IUpdateKnowledgeConnectorRestDataBody_2_0, IUpdateKnowledgeConnectorRestDataParams_2_0 {
|
|
19140
|
+
}
|
|
19141
|
+
export interface IUpdateKnowledgeConnectorRestReturnValue_2_0 {
|
|
19142
|
+
}
|
|
18801
19143
|
/**
|
|
18802
19144
|
* @openapi
|
|
18803
19145
|
*
|
|
@@ -19512,6 +19854,11 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
19512
19854
|
readKnowledgeChunk: TRestAPIOperation<IReadKnowledgeChunkRestData_2_0, IReadKnowledgeChunkRestReturnValue_2_0>;
|
|
19513
19855
|
deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
|
|
19514
19856
|
updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
|
|
19857
|
+
indexKnowledgeConnectors: TRestAPIOperation<IIndexKnowledgeConnectorsRestData_2_0, IIndexKnowledgeConnectorsRestReturnValue_2_0>;
|
|
19858
|
+
createKnowledgeConnector: TRestAPIOperation<ICreateKnowledgeConnectorRestData_2_0, ICreateKnowledgeConnectorRestReturnValue_2_0>;
|
|
19859
|
+
readKnowledgeConnector: TRestAPIOperation<IReadKnowledgeConnectorRestData_2_0, IReadKnowledgeConnectorRestReturnValue_2_0>;
|
|
19860
|
+
updateKnowledgeConnector: TRestAPIOperation<IUpdateKnowledgeConnectorRestData_2_0, IUpdateKnowledgeConnectorRestReturnValue_2_0>;
|
|
19861
|
+
deleteKnowledgeConnector: TRestAPIOperation<IDeleteKnowledgeConnectorRestData_2_0, IDeleteKnowledgeConnectorRestReturnValue_2_0>;
|
|
19515
19862
|
uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
|
|
19516
19863
|
generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
|
|
19517
19864
|
generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
|
|
@@ -23669,6 +24016,7 @@ export interface IScheduleSimulationRestDataBody_2_0 {
|
|
|
23669
24016
|
userId?: string;
|
|
23670
24017
|
finalPing?: number;
|
|
23671
24018
|
data?: Record<string, unknown>;
|
|
24019
|
+
enableMocking?: boolean;
|
|
23672
24020
|
};
|
|
23673
24021
|
projectReference: string;
|
|
23674
24022
|
numberOfExecutions: number;
|
|
@@ -23739,6 +24087,44 @@ export interface ISimulationErrorInfoRest_2_0 {
|
|
|
23739
24087
|
message?: string;
|
|
23740
24088
|
technicalDetails?: string;
|
|
23741
24089
|
}
|
|
24090
|
+
/**
|
|
24091
|
+
* Token usage for a specific purpose (user message generation, success criteria evaluation, etc.)
|
|
24092
|
+
*/
|
|
24093
|
+
export interface ITokenUsageByPurposeItemRest_2_0 {
|
|
24094
|
+
inputTokens: number;
|
|
24095
|
+
outputTokens: number;
|
|
24096
|
+
totalTokens: number;
|
|
24097
|
+
}
|
|
24098
|
+
/**
|
|
24099
|
+
* Token usage breakdown by purpose/category
|
|
24100
|
+
*/
|
|
24101
|
+
export interface ITokensByPurposeRest_2_0 {
|
|
24102
|
+
/** Tokens used for generating user messages during conversation */
|
|
24103
|
+
userMessageGeneration: ITokenUsageByPurposeItemRest_2_0;
|
|
24104
|
+
/** Tokens used for evaluating success criteria */
|
|
24105
|
+
successCriteriaEvaluation: ITokenUsageByPurposeItemRest_2_0;
|
|
24106
|
+
/** Tokens used for sentiment analysis */
|
|
24107
|
+
sentimentAnalysis: ITokenUsageByPurposeItemRest_2_0;
|
|
24108
|
+
}
|
|
24109
|
+
export interface ITokenUsageRest_2_0 {
|
|
24110
|
+
inputTokens: number;
|
|
24111
|
+
outputTokens: number;
|
|
24112
|
+
totalTokens: number;
|
|
24113
|
+
calculationMethod: "api" | "estimate";
|
|
24114
|
+
llmReferenceId: string;
|
|
24115
|
+
/** Human-readable name of the LLM (e.g., "Production GPT-4") */
|
|
24116
|
+
llmName: string;
|
|
24117
|
+
/** LLM provider (e.g., "openAI", "anthropic", "azureOpenAI") */
|
|
24118
|
+
llmProvider: string;
|
|
24119
|
+
/** LLM model type (e.g., "gpt-4", "claude-3") */
|
|
24120
|
+
llmModelType: string;
|
|
24121
|
+
/** Human-readable name of the simulation */
|
|
24122
|
+
simulationName: string;
|
|
24123
|
+
turnsWithTokenUsage: number;
|
|
24124
|
+
averageTokensPerTurn: number;
|
|
24125
|
+
/** Detailed breakdown of token usage by purpose (user message generation, success criteria, sentiment analysis) */
|
|
24126
|
+
tokensByPurpose?: ITokensByPurposeRest_2_0;
|
|
24127
|
+
}
|
|
23742
24128
|
export interface ISuccessRateRest_2_0 {
|
|
23743
24129
|
percentage: number;
|
|
23744
24130
|
fraction: string;
|
|
@@ -23773,6 +24159,7 @@ export interface ISimulationRunRest_2_0 {
|
|
|
23773
24159
|
isConversationEnded?: boolean;
|
|
23774
24160
|
errorInfo?: ISimulationErrorInfoRest_2_0;
|
|
23775
24161
|
status?: ESimulationStatusRest_2_0;
|
|
24162
|
+
tokenUsage?: ITokenUsageRest_2_0;
|
|
23776
24163
|
};
|
|
23777
24164
|
createdAt: number;
|
|
23778
24165
|
createdBy: string;
|
|
@@ -23801,6 +24188,47 @@ export interface IAverageSuccessRateForRunsRest_2_0 {
|
|
|
23801
24188
|
total: number;
|
|
23802
24189
|
average: number;
|
|
23803
24190
|
}
|
|
24191
|
+
/**
|
|
24192
|
+
* Token usage breakdown for a specific purpose
|
|
24193
|
+
*/
|
|
24194
|
+
export interface ITokenUsageByPurposeRest_2_0 {
|
|
24195
|
+
inputTokens: number;
|
|
24196
|
+
outputTokens: number;
|
|
24197
|
+
totalTokens: number;
|
|
24198
|
+
}
|
|
24199
|
+
/**
|
|
24200
|
+
* Aggregated token usage breakdown by purpose for batch
|
|
24201
|
+
*/
|
|
24202
|
+
export interface IBatchTokensByPurposeRest_2_0 {
|
|
24203
|
+
/** Tokens used for generating user messages during conversation */
|
|
24204
|
+
userMessageGeneration: ITokenUsageByPurposeRest_2_0;
|
|
24205
|
+
/** Tokens used for evaluating success criteria */
|
|
24206
|
+
successCriteriaEvaluation: ITokenUsageByPurposeRest_2_0;
|
|
24207
|
+
/** Tokens used for sentiment analysis */
|
|
24208
|
+
sentimentAnalysis: ITokenUsageByPurposeRest_2_0;
|
|
24209
|
+
}
|
|
24210
|
+
export interface IBatchTokenUsageRest_2_0 {
|
|
24211
|
+
totalInputTokens: number;
|
|
24212
|
+
totalOutputTokens: number;
|
|
24213
|
+
totalTokens: number;
|
|
24214
|
+
averageInputTokensPerRun: number;
|
|
24215
|
+
averageOutputTokensPerRun: number;
|
|
24216
|
+
averageTokensPerRun: number;
|
|
24217
|
+
averageTokensPerTurn: number;
|
|
24218
|
+
runsWithTokenUsage: number;
|
|
24219
|
+
calculationMethod: "api" | "estimate" | "mixed";
|
|
24220
|
+
llmReferenceId: string;
|
|
24221
|
+
/** Human-readable name of the LLM (e.g., "Production GPT-4") */
|
|
24222
|
+
llmName: string;
|
|
24223
|
+
/** LLM provider (e.g., "openAI", "anthropic", "azureOpenAI") */
|
|
24224
|
+
llmProvider: string;
|
|
24225
|
+
/** LLM model type (e.g., "gpt-4", "claude-3") */
|
|
24226
|
+
llmModelType: string;
|
|
24227
|
+
/** Human-readable name of the simulation */
|
|
24228
|
+
simulationName: string;
|
|
24229
|
+
/** Detailed breakdown of token usage by purpose (aggregated across all runs) */
|
|
24230
|
+
tokensByPurpose?: IBatchTokensByPurposeRest_2_0;
|
|
24231
|
+
}
|
|
23804
24232
|
export interface IBatchMetricsRest_2_0 {
|
|
23805
24233
|
_v: number;
|
|
23806
24234
|
efficiencyScore?: IEfficiencyScoreRest_2_0[];
|
|
@@ -23815,6 +24243,7 @@ export interface IBatchMetricsRest_2_0 {
|
|
|
23815
24243
|
failed: number;
|
|
23816
24244
|
notExecuted?: number;
|
|
23817
24245
|
};
|
|
24246
|
+
tokenUsage?: IBatchTokenUsageRest_2_0;
|
|
23818
24247
|
}
|
|
23819
24248
|
export interface ISimulationRunBatchRest_2_0 {
|
|
23820
24249
|
id: string;
|
|
@@ -24204,6 +24633,91 @@ export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunB
|
|
|
24204
24633
|
export interface IStopSimulationRunBatchRestReturnValue_2_0 {
|
|
24205
24634
|
simulationRunBatchId: ISimulationRunBatchRest_2_0;
|
|
24206
24635
|
}
|
|
24636
|
+
declare enum ESchedulerFrequencyRest_2_0 {
|
|
24637
|
+
DAILY = "daily",
|
|
24638
|
+
EVERY_THREE_DAYS = "every three days",
|
|
24639
|
+
WEEKLY = "weekly",
|
|
24640
|
+
BIWEEKLY = "biweekly",
|
|
24641
|
+
MONTHLY = "monthly"
|
|
24642
|
+
}
|
|
24643
|
+
export interface ISchedulerRunConfigRest_2_0 {
|
|
24644
|
+
flowReferenceId: string;
|
|
24645
|
+
localeReferenceId?: string;
|
|
24646
|
+
entrypoint: string;
|
|
24647
|
+
largeLanguageModelReferenceId: string;
|
|
24648
|
+
userId?: string;
|
|
24649
|
+
finalPing?: number;
|
|
24650
|
+
data?: Record<string, unknown>;
|
|
24651
|
+
enableMocking?: boolean;
|
|
24652
|
+
}
|
|
24653
|
+
export interface ISchedulerRest_2_0 extends IProjectMetadataRest_2_0 {
|
|
24654
|
+
id: string;
|
|
24655
|
+
runConfig: ISchedulerRunConfigRest_2_0;
|
|
24656
|
+
enableSchedule: boolean;
|
|
24657
|
+
frequency: ESchedulerFrequencyRest_2_0;
|
|
24658
|
+
time: string;
|
|
24659
|
+
numberOfRuns: number;
|
|
24660
|
+
nextScheduledRun: string;
|
|
24661
|
+
emailNotifications: string[];
|
|
24662
|
+
scenarioName: string;
|
|
24663
|
+
runName: string;
|
|
24664
|
+
simulationReference: string;
|
|
24665
|
+
endDate?: string;
|
|
24666
|
+
createdAt: number;
|
|
24667
|
+
lastChanged: number;
|
|
24668
|
+
createdBy: string;
|
|
24669
|
+
lastChangedBy: string;
|
|
24670
|
+
}
|
|
24671
|
+
export interface ICreateSchedulerRestDataParams_2_0 {
|
|
24672
|
+
simulationReference: string;
|
|
24673
|
+
}
|
|
24674
|
+
export interface ICreateSchedulerRestDataBody_2_0 {
|
|
24675
|
+
runConfig: ISchedulerRunConfigRest_2_0;
|
|
24676
|
+
enableSchedule: boolean;
|
|
24677
|
+
frequency: ESchedulerFrequencyRest_2_0;
|
|
24678
|
+
time: string;
|
|
24679
|
+
numberOfRuns: number;
|
|
24680
|
+
emailNotifications?: string[];
|
|
24681
|
+
scenarioName?: string;
|
|
24682
|
+
runName: string;
|
|
24683
|
+
endDate?: string;
|
|
24684
|
+
}
|
|
24685
|
+
export interface ICreateSchedulerRestData_2_0 extends ICreateSchedulerRestDataParams_2_0, ICreateSchedulerRestDataBody_2_0 {
|
|
24686
|
+
}
|
|
24687
|
+
export interface ICreateSchedulerRestReturnValue_2_0 {
|
|
24688
|
+
scheduler: ISchedulerRest_2_0;
|
|
24689
|
+
}
|
|
24690
|
+
export interface IUpdateSchedulerRestDataParams_2_0 {
|
|
24691
|
+
simulationReference: string;
|
|
24692
|
+
schedulerId: string;
|
|
24693
|
+
}
|
|
24694
|
+
export interface IUpdateSchedulerRestDataBody_2_0 {
|
|
24695
|
+
runConfig?: ISchedulerRunConfigRest_2_0;
|
|
24696
|
+
enableSchedule?: boolean;
|
|
24697
|
+
frequency?: ESchedulerFrequencyRest_2_0;
|
|
24698
|
+
time?: string;
|
|
24699
|
+
numberOfRuns?: number;
|
|
24700
|
+
nextScheduledRun?: string;
|
|
24701
|
+
emailNotifications?: string[];
|
|
24702
|
+
scenarioName?: string;
|
|
24703
|
+
runName?: string;
|
|
24704
|
+
endDate?: string;
|
|
24705
|
+
}
|
|
24706
|
+
export interface IUpdateSchedulerRestData_2_0 extends IUpdateSchedulerRestDataParams_2_0, IUpdateSchedulerRestDataBody_2_0 {
|
|
24707
|
+
projectId?: string;
|
|
24708
|
+
}
|
|
24709
|
+
export interface IUpdateSchedulerRestReturnValue_2_0 {
|
|
24710
|
+
scheduler: ISchedulerRest_2_0;
|
|
24711
|
+
}
|
|
24712
|
+
export interface IGetSchedulerRestDataParams_2_0 {
|
|
24713
|
+
simulationReference: string;
|
|
24714
|
+
}
|
|
24715
|
+
export interface IGetSchedulerRestData_2_0 extends IGetSchedulerRestDataParams_2_0 {
|
|
24716
|
+
projectId?: string;
|
|
24717
|
+
}
|
|
24718
|
+
export interface IGetSchedulerRestReturnValue_2_0 {
|
|
24719
|
+
scheduler: ISchedulerRest_2_0 | null;
|
|
24720
|
+
}
|
|
24207
24721
|
export interface SimulationAPIGroup_2_0 {
|
|
24208
24722
|
indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
|
|
24209
24723
|
createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
|
|
@@ -24223,6 +24737,9 @@ export interface SimulationAPIGroup_2_0 {
|
|
|
24223
24737
|
regeneratePersonaField: TRestAPIOperation<IRegeneratePersonaFieldRestData_2_0, IRegeneratePersonaFieldRestReturnValue_2_0>;
|
|
24224
24738
|
generateBulkPersona: TRestAPIOperation<IGenerateBulkPersonaRestData_2_0, IGenerateBulkPersonaRestReturnValue_2_0>;
|
|
24225
24739
|
generatePersonaFromTranscript: TRestAPIOperation<IGeneratePersonaFromTranscriptRestData_2_0, IGeneratePersonaFromTranscriptRestReturnValue_2_0>;
|
|
24740
|
+
getScheduler: TRestAPIOperation<IGetSchedulerRestData_2_0, IGetSchedulerRestReturnValue_2_0>;
|
|
24741
|
+
createScheduler: TRestAPIOperation<ICreateSchedulerRestData_2_0, ICreateSchedulerRestReturnValue_2_0>;
|
|
24742
|
+
updateScheduler: TRestAPIOperation<IUpdateSchedulerRestData_2_0, IUpdateSchedulerRestReturnValue_2_0>;
|
|
24226
24743
|
}
|
|
24227
24744
|
declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
|
|
24228
24745
|
export declare type TRestAPIGroupsTypeByConfiguration<T extends IRestAPIClientConfig> = TResourceAPIVersionType<T> & TJWTAuthAPIVersionType<T> & TInsightsAPIVersionType<T> & TMetricsAPIVersionType<T> & TSessionAPIVersionType<T> & TExternalAPIVersionType<T> & TAdministrationAPIVersionType<T> & TManagementAPIVersionType<T> & TAnalyticsAPIVersionType<T> & TAIOpsCenterAPIVersionType<T> & TSimulationAPIVersionType<T>;
|