@cognigy/rest-api-client 2025.11.0 → 2025.13.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 +10 -0
- package/build/RestAPIClient.js +7 -0
- package/build/apigroups/ResourcesAPIGroup_2_0.js +4 -0
- package/build/apigroups/SimulationAPIGroup_2_0.js +58 -0
- package/build/apigroups/index.js +3 -1
- package/build/shared/charts/descriptors/analytics/trackGoal.js +3 -1
- package/build/shared/charts/descriptors/index.js +7 -1
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +4 -2
- package/build/shared/charts/descriptors/message/question/question.js +24 -5
- package/build/shared/charts/descriptors/service/GPTPrompt.js +15 -1
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +32 -173
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +2 -2
- package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +175 -0
- package/build/shared/charts/descriptors/service/aiAgent/loadAiAgent.js +194 -0
- package/build/shared/charts/descriptors/service/aiOpsCenterConnection.js +12 -0
- package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
- package/build/shared/charts/descriptors/service/index.js +13 -1
- package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +922 -0
- package/build/shared/charts/descriptors/service/llmPrompt/llmPromptDefault.js +31 -0
- package/build/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +196 -0
- package/build/shared/charts/descriptors/service/llmPrompt/llmPromptTool.js +139 -0
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +2 -2
- package/build/shared/constants.js +1 -5
- package/build/shared/interfaces/debugEvents/IGoalCompletedEventPayload.js +3 -0
- package/build/shared/interfaces/debugEvents/TDebugEventType.js +1 -0
- package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +12 -1
- package/build/shared/interfaces/resources/IAuditEvent.js +3 -0
- package/build/shared/interfaces/resources/ILargeLanguageModel.js +1 -0
- package/build/shared/interfaces/resources/TResourceType.js +2 -0
- package/build/shared/interfaces/resources/TRestChannelType.js +5 -0
- package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +2 -1
- package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +5 -18
- package/build/shared/interfaces/restAPI/operations/generateOutput/v2.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js +1 -1
- package/build/shared/interfaces/restAPI/simulation/simulation/ICreateSimulationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulation/IDeleteSimulationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulation/IIndexSimulationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulation/IReadSimulationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulation/IScheduleSimulationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulation/ISimulationRest_2_0.js +9 -0
- package/build/shared/interfaces/restAPI/simulation/simulation/IUpdateSimulationRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRun/IIndexSimulationRunRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRun/IReadSimulationRunRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js +19 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IGetAllSimulationRunBatchRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IIndexSimulationRunBatchRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IReadSimulationRunBatchRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/ISimulationRunBatchRest_2_0.js +9 -0
- package/build/shared/interfaces/security/IPermission.js +2 -0
- package/build/shared/interfaces/security/IRole.js +3 -1
- package/build/shared/interfaces/security/index.js +1 -1
- package/dist/esm/RestAPIClient.js +7 -0
- package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +4 -0
- package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +44 -0
- package/dist/esm/apigroups/index.js +1 -0
- package/dist/esm/shared/charts/descriptors/analytics/trackGoal.js +3 -1
- package/dist/esm/shared/charts/descriptors/index.js +8 -2
- package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +4 -2
- package/dist/esm/shared/charts/descriptors/message/question/question.js +24 -5
- package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +15 -1
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +33 -174
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +2 -2
- package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +172 -0
- package/dist/esm/shared/charts/descriptors/service/aiAgent/loadAiAgent.js +192 -0
- package/dist/esm/shared/charts/descriptors/service/aiOpsCenterConnection.js +9 -0
- package/dist/esm/shared/charts/descriptors/service/handoverV2.js +1 -1
- package/dist/esm/shared/charts/descriptors/service/index.js +6 -0
- package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +909 -0
- package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptDefault.js +28 -0
- package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +193 -0
- package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptTool.js +136 -0
- package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +2 -2
- package/dist/esm/shared/constants.js +1 -5
- package/dist/esm/shared/interfaces/debugEvents/IGoalCompletedEventPayload.js +2 -0
- package/dist/esm/shared/interfaces/debugEvents/TDebugEventType.js +1 -0
- package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +12 -1
- package/dist/esm/shared/interfaces/resources/IAuditEvent.js +3 -0
- package/dist/esm/shared/interfaces/resources/ILargeLanguageModel.js +1 -0
- package/dist/esm/shared/interfaces/resources/TResourceType.js +2 -0
- package/dist/esm/shared/interfaces/resources/TRestChannelType.js +5 -0
- package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +2 -1
- package/dist/esm/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -17
- package/dist/esm/shared/interfaces/restAPI/operations/generateOutput/v2.0/index.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js +1 -1
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/ICreateSimulationRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IDeleteSimulationRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IIndexSimulationRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IReadSimulationRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IScheduleSimulationRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/ISimulationRest_2_0.js +6 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IUpdateSimulationRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/IIndexSimulationRunRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/IReadSimulationRunRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js +16 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IGetAllSimulationRunBatchRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IIndexSimulationRunBatchRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IReadSimulationRunBatchRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/ISimulationRunBatchRest_2_0.js +6 -0
- package/dist/esm/shared/interfaces/security/IPermission.js +2 -0
- package/dist/esm/shared/interfaces/security/IRole.js +3 -1
- package/dist/esm/shared/interfaces/security/index.js +1 -1
- package/package.json +1 -1
- package/types/index.d.ts +394 -45
package/types/index.d.ts
CHANGED
|
@@ -464,7 +464,8 @@ declare const projectWidePermissions: readonly [
|
|
|
464
464
|
"tasks",
|
|
465
465
|
"tokens",
|
|
466
466
|
"yesNoIntents",
|
|
467
|
-
"dataPrivacySettings"
|
|
467
|
+
"dataPrivacySettings",
|
|
468
|
+
"simulator"
|
|
468
469
|
];
|
|
469
470
|
export declare type TProjectWidePermissions = typeof projectWidePermissions[number];
|
|
470
471
|
export declare type TMongoId = string;
|
|
@@ -958,7 +959,8 @@ declare const arrayTResourceType: readonly [
|
|
|
958
959
|
"slotFiller",
|
|
959
960
|
"snapshot",
|
|
960
961
|
"snippet",
|
|
961
|
-
"aiAgent"
|
|
962
|
+
"aiAgent",
|
|
963
|
+
"simulation"
|
|
962
964
|
];
|
|
963
965
|
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
964
966
|
declare const arrayTChartableResourceType: readonly [
|
|
@@ -1052,7 +1054,8 @@ declare const projectWideRoles: readonly [
|
|
|
1052
1054
|
"tokenEditor",
|
|
1053
1055
|
"data_privacy_admin",
|
|
1054
1056
|
"data_privacy_editor",
|
|
1055
|
-
"data_privacy_viewer"
|
|
1057
|
+
"data_privacy_viewer",
|
|
1058
|
+
"simulator_admin"
|
|
1056
1059
|
];
|
|
1057
1060
|
export declare type TProjectWideRole = typeof projectWideRoles[number];
|
|
1058
1061
|
/**
|
|
@@ -1252,6 +1255,8 @@ export interface IOrganisationWideAcl {
|
|
|
1252
1255
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1253
1256
|
* users:
|
|
1254
1257
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1258
|
+
* simulator:
|
|
1259
|
+
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1255
1260
|
* additionalProperties:
|
|
1256
1261
|
* $ref: '#/components/schemas/ICrudPermissions'
|
|
1257
1262
|
* roles:
|
|
@@ -1614,6 +1619,7 @@ export interface IRestAPIClientVersionConfiguration {
|
|
|
1614
1619
|
analytics: "2.0";
|
|
1615
1620
|
jwt: "2.0";
|
|
1616
1621
|
opsCenter: "2.0";
|
|
1622
|
+
simulation: "2.0";
|
|
1617
1623
|
}
|
|
1618
1624
|
export declare type THttpLib = "axios";
|
|
1619
1625
|
/**
|
|
@@ -1911,7 +1917,8 @@ declare const restChannelTypes: readonly [
|
|
|
1911
1917
|
"amazonLex",
|
|
1912
1918
|
"genesysBotConnector",
|
|
1913
1919
|
"niceCXOne",
|
|
1914
|
-
"niceCXOneAAH"
|
|
1920
|
+
"niceCXOneAAH",
|
|
1921
|
+
"zoomContactCenter"
|
|
1915
1922
|
];
|
|
1916
1923
|
export declare type TRestChannelType = typeof restChannelTypes[number];
|
|
1917
1924
|
declare const socketChannelTypes: readonly [
|
|
@@ -4345,6 +4352,9 @@ declare const generativeAIModels: readonly [
|
|
|
4345
4352
|
"gpt-4",
|
|
4346
4353
|
"gpt-4o",
|
|
4347
4354
|
"gpt-4o-mini",
|
|
4355
|
+
"gpt-4.1",
|
|
4356
|
+
"gpt-4.1-mini",
|
|
4357
|
+
"gpt-4.1-nano",
|
|
4348
4358
|
"luminous-extended-control",
|
|
4349
4359
|
"claude-v1-100k",
|
|
4350
4360
|
"claude-instant-v1",
|
|
@@ -4352,6 +4362,11 @@ declare const generativeAIModels: readonly [
|
|
|
4352
4362
|
"claude-3-haiku-20240307",
|
|
4353
4363
|
"claude-3-sonnet-20240229",
|
|
4354
4364
|
"claude-3-5-sonnet-20241022",
|
|
4365
|
+
"claude-3-7-sonnet-20250219",
|
|
4366
|
+
"claude-3-5-sonnet-latest",
|
|
4367
|
+
"claude-3-7-sonnet-latest",
|
|
4368
|
+
"claude-opus-4-0",
|
|
4369
|
+
"claude-sonnet-4-0",
|
|
4355
4370
|
"text-bison@001",
|
|
4356
4371
|
"custom-model",
|
|
4357
4372
|
"gemini-1.0-pro",
|
|
@@ -4363,11 +4378,14 @@ declare const generativeAIModels: readonly [
|
|
|
4363
4378
|
"amazon.nova-pro-v1:0",
|
|
4364
4379
|
"amazon.nova-micro-v1:0",
|
|
4365
4380
|
"anthropic.claude-3-5-sonnet-20240620-v1:0",
|
|
4366
|
-
"claude-3-7-sonnet-20250219",
|
|
4367
4381
|
"mistral-large-2411",
|
|
4368
4382
|
"mistral-small-2503",
|
|
4369
4383
|
"pixtral-large-2411",
|
|
4370
4384
|
"pixtral-12b-2409",
|
|
4385
|
+
"mistral-large-latest",
|
|
4386
|
+
"pixtral-large-latest",
|
|
4387
|
+
"mistral-medium-latest",
|
|
4388
|
+
"mistral-small-latest",
|
|
4371
4389
|
"text-embedding-3-small",
|
|
4372
4390
|
"text-embedding-3-large",
|
|
4373
4391
|
"text-embedding-ada-002",
|
|
@@ -4459,6 +4477,13 @@ declare const modeType: readonly [
|
|
|
4459
4477
|
"embedding"
|
|
4460
4478
|
];
|
|
4461
4479
|
export declare type TModeType = typeof modeType[number];
|
|
4480
|
+
export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
|
|
4481
|
+
export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
|
|
4482
|
+
export declare type TSQL_EXTENSION = "@cognigy/mssql";
|
|
4483
|
+
export declare type TSMTP_EXTENSION = "@cognigy/smtp";
|
|
4484
|
+
export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
|
|
4485
|
+
export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
|
|
4486
|
+
export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
|
|
4462
4487
|
export interface IGenerativeAIUseCaseSettings {
|
|
4463
4488
|
largeLanguageModelId: string | null;
|
|
4464
4489
|
temperature: number;
|
|
@@ -5304,6 +5329,7 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
5304
5329
|
* - mistral
|
|
5305
5330
|
*/
|
|
5306
5331
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
5332
|
+
export declare type TConfigurableGenerativeAIUseCases = Exclude<TGenerativeAIUseCases, "intentSentenceGeneration" | "flowGeneration" | "generateNodeOutput" | "lexiconGeneration">;
|
|
5307
5333
|
/**
|
|
5308
5334
|
* @openapi
|
|
5309
5335
|
*
|
|
@@ -5319,27 +5345,19 @@ export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
|
5319
5345
|
* properties:
|
|
5320
5346
|
* designTimeGeneration:
|
|
5321
5347
|
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5322
|
-
* intentSentenceGeneration:
|
|
5323
|
-
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5324
5348
|
* aiEnhancedOutputs:
|
|
5325
5349
|
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5326
|
-
* lexiconGeneration:
|
|
5327
|
-
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5328
|
-
* flowGeneration:
|
|
5329
|
-
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5330
5350
|
* gptConversation:
|
|
5331
5351
|
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5332
5352
|
* gptPromptNode:
|
|
5333
5353
|
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5334
|
-
* generateNodeOutput:
|
|
5335
|
-
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5336
5354
|
* knowledgeSearch:
|
|
5337
5355
|
* $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
|
|
5338
5356
|
*/
|
|
5339
5357
|
export interface IGenerativeAISettings_2_0 {
|
|
5340
5358
|
enabled: boolean;
|
|
5341
5359
|
useCasesSettings: {
|
|
5342
|
-
[key in
|
|
5360
|
+
[key in TConfigurableGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
|
|
5343
5361
|
};
|
|
5344
5362
|
}
|
|
5345
5363
|
/**
|
|
@@ -8737,6 +8755,7 @@ export interface IOpenAIMeta {
|
|
|
8737
8755
|
export interface IOpenAICompatibleMeta {
|
|
8738
8756
|
customModel: string;
|
|
8739
8757
|
baseCustomUrl: string;
|
|
8758
|
+
customAuthHeader?: string;
|
|
8740
8759
|
}
|
|
8741
8760
|
export interface IAlephAlphaMeta {
|
|
8742
8761
|
customModel?: string;
|
|
@@ -9026,7 +9045,8 @@ declare const arrayTDebugEventTypes: readonly [
|
|
|
9026
9045
|
"switchedFlow",
|
|
9027
9046
|
"nluWarning",
|
|
9028
9047
|
"debugMessage",
|
|
9029
|
-
"debugError"
|
|
9048
|
+
"debugError",
|
|
9049
|
+
"goalCompleted"
|
|
9030
9050
|
];
|
|
9031
9051
|
export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
|
|
9032
9052
|
export interface IInputChangedEventPayload {
|
|
@@ -9123,7 +9143,28 @@ export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayload
|
|
|
9123
9143
|
message: object;
|
|
9124
9144
|
}
|
|
9125
9145
|
export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
|
|
9126
|
-
export
|
|
9146
|
+
export interface IGoalAnalyticsPayload {
|
|
9147
|
+
analyticsdata: IGoalEscalations;
|
|
9148
|
+
data: IPayloadBaseMetaData;
|
|
9149
|
+
}
|
|
9150
|
+
export interface IGoalAnalyticsData {
|
|
9151
|
+
projectId: string;
|
|
9152
|
+
organisationId: string;
|
|
9153
|
+
sessionId: string;
|
|
9154
|
+
referenceId: string;
|
|
9155
|
+
version: string;
|
|
9156
|
+
timestamp: Date;
|
|
9157
|
+
goalCycleId: string;
|
|
9158
|
+
stepId: string;
|
|
9159
|
+
goalId: string;
|
|
9160
|
+
contactId: string;
|
|
9161
|
+
stepType?: string;
|
|
9162
|
+
}
|
|
9163
|
+
export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
|
|
9164
|
+
}
|
|
9165
|
+
export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
|
|
9166
|
+
}
|
|
9167
|
+
export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
|
|
9127
9168
|
declare const audioPreviewProviders: readonly [
|
|
9128
9169
|
"microsoft",
|
|
9129
9170
|
"google",
|
|
@@ -9582,6 +9623,15 @@ export interface IGraphAiAgent {
|
|
|
9582
9623
|
properties: Pick<IAiAgent, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy" | "knowledgeReferenceId">;
|
|
9583
9624
|
dependencies?: IAiAgentDependencies[];
|
|
9584
9625
|
}
|
|
9626
|
+
export interface ILoadAiAgentNodeParams extends INodeFunctionBaseParams {
|
|
9627
|
+
config: {
|
|
9628
|
+
aiAgent: IAiAgent;
|
|
9629
|
+
storeLocation: string;
|
|
9630
|
+
contextKey: string;
|
|
9631
|
+
inputKey: string;
|
|
9632
|
+
keyWarning: string;
|
|
9633
|
+
};
|
|
9634
|
+
}
|
|
9585
9635
|
export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
|
|
9586
9636
|
tile: any;
|
|
9587
9637
|
}
|
|
@@ -10473,23 +10523,6 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
|
|
|
10473
10523
|
timeout: number;
|
|
10474
10524
|
};
|
|
10475
10525
|
}
|
|
10476
|
-
export interface IGoalAnalyticsPayload {
|
|
10477
|
-
analyticsdata: IGoalEscalations;
|
|
10478
|
-
data: IPayloadBaseMetaData;
|
|
10479
|
-
}
|
|
10480
|
-
export interface IGoalAnalyticsData {
|
|
10481
|
-
projectId: string;
|
|
10482
|
-
organisationId: string;
|
|
10483
|
-
sessionId: string;
|
|
10484
|
-
version: string;
|
|
10485
|
-
timestamp: Date;
|
|
10486
|
-
goalCycleId: string;
|
|
10487
|
-
stepId: string;
|
|
10488
|
-
goalId: string;
|
|
10489
|
-
contactId: string;
|
|
10490
|
-
}
|
|
10491
|
-
export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
|
|
10492
|
-
}
|
|
10493
10526
|
export interface IEndpointSettings {
|
|
10494
10527
|
isFeatureAccmEnabled?: boolean;
|
|
10495
10528
|
}
|
|
@@ -10688,7 +10721,6 @@ export interface IActions {
|
|
|
10688
10721
|
getAgentAssistConfigId: () => string;
|
|
10689
10722
|
getNluEmbeddingCredentials: () => Promise<INluEmbeddingCredentials>;
|
|
10690
10723
|
getMetadata: () => IGetMetaDataActionValue;
|
|
10691
|
-
sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
|
|
10692
10724
|
getEndpointSettings: () => IEndpointSettings;
|
|
10693
10725
|
getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
|
|
10694
10726
|
addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
|
|
@@ -11350,6 +11382,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
11350
11382
|
}) => Promise<{
|
|
11351
11383
|
[x: string]: unknown;
|
|
11352
11384
|
}>;
|
|
11385
|
+
sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
|
|
11353
11386
|
}
|
|
11354
11387
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
11355
11388
|
api: INodeExecutionAPI;
|
|
@@ -16002,13 +16035,6 @@ export interface IComposePackageDownloadLinkRestData_2_0 extends IComposePackage
|
|
|
16002
16035
|
export interface IComposePackageDownloadLinkRestReturnValue_2_0 {
|
|
16003
16036
|
downloadLink: string;
|
|
16004
16037
|
}
|
|
16005
|
-
export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
|
|
16006
|
-
export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
|
|
16007
|
-
export declare type TSQL_EXTENSION = "@cognigy/mssql";
|
|
16008
|
-
export declare type TSMTP_EXTENSION = "@cognigy/smtp";
|
|
16009
|
-
export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
|
|
16010
|
-
export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
|
|
16011
|
-
export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
|
|
16012
16038
|
export interface ICreateChartNodeBasicNodesData<T extends string = string, D extends INodeFunctionBaseParams = any, E extends string = string> extends Partial<Omit<IChartNode<T, D, E>, TReferenceAndEntityMetaKeys | "type" | "extension">> {
|
|
16013
16039
|
type: T;
|
|
16014
16040
|
extension?: E;
|
|
@@ -16354,6 +16380,7 @@ export interface ITrackGoalNodeParams extends INodeFunctionBaseParams {
|
|
|
16354
16380
|
goal: {
|
|
16355
16381
|
goalId: string;
|
|
16356
16382
|
name: string;
|
|
16383
|
+
referenceId: string;
|
|
16357
16384
|
version: string;
|
|
16358
16385
|
selectedSteps: {
|
|
16359
16386
|
stepId: string;
|
|
@@ -16831,6 +16858,7 @@ export interface ICognigyBasicNodes {
|
|
|
16831
16858
|
sendMetadata: ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TBASIC_EXTENSION>;
|
|
16832
16859
|
assistInfo: ICreateChartNodeBasicNodesData<"assistInfo", IAssistInfoNodeParams, TBASIC_EXTENSION>;
|
|
16833
16860
|
searchExtractOutput: ICreateChartNodeBasicNodesData<"searchExtractOutput", ISearchExtractOutputNodeParams, TBASIC_EXTENSION>;
|
|
16861
|
+
extractAiAgent: ICreateChartNodeBasicNodesData<"extractAiAgent", ILoadAiAgentNodeParams, TBASIC_EXTENSION>;
|
|
16834
16862
|
}
|
|
16835
16863
|
export interface ICognigyNodes {
|
|
16836
16864
|
"@cognigy/basic-nodes": ICognigyBasicNodes;
|
|
@@ -17171,6 +17199,7 @@ export interface IOpenAIMeta_2_0 {
|
|
|
17171
17199
|
export interface IOpenAICompatibleMeta_2_0 {
|
|
17172
17200
|
customModel: string;
|
|
17173
17201
|
baseCustomUrl: string;
|
|
17202
|
+
customAuthHeader?: string;
|
|
17174
17203
|
}
|
|
17175
17204
|
export interface IAnthropicMeta_2_0 {
|
|
17176
17205
|
customModel?: string;
|
|
@@ -17334,6 +17363,21 @@ export interface IGoogleGeminiMeta_2_0 {
|
|
|
17334
17363
|
* baseCustomUrl:
|
|
17335
17364
|
* type: string
|
|
17336
17365
|
* example: https://api.aleph-alpha.com
|
|
17366
|
+
* openAICompatible:
|
|
17367
|
+
* type: object
|
|
17368
|
+
* description: OpenAI compatible provider
|
|
17369
|
+
* properties:
|
|
17370
|
+
* customModel:
|
|
17371
|
+
* type: string
|
|
17372
|
+
* example: luminous-003
|
|
17373
|
+
* description: The custom model name. This does not work with embedding models
|
|
17374
|
+
* baseCustomUrl:
|
|
17375
|
+
* type: string
|
|
17376
|
+
* example: https://own-llm-deployment.company.com/openai/v1
|
|
17377
|
+
* customAuthHeader:
|
|
17378
|
+
* type: string
|
|
17379
|
+
* example: Ocp-Apim-Subscription-Key
|
|
17380
|
+
* description: The api key will be sent via this http header if specified
|
|
17337
17381
|
*
|
|
17338
17382
|
* ILargeLanguageModelFields_2_0:
|
|
17339
17383
|
* allOf:
|
|
@@ -18423,6 +18467,22 @@ export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDa
|
|
|
18423
18467
|
}
|
|
18424
18468
|
export interface IGenerateNluScoresRestReturnValue_2_0 {
|
|
18425
18469
|
}
|
|
18470
|
+
export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
|
|
18471
|
+
useCase: string;
|
|
18472
|
+
params?: Record<string, string>;
|
|
18473
|
+
messages?: {
|
|
18474
|
+
role: "user" | "assistant";
|
|
18475
|
+
content: string;
|
|
18476
|
+
}[];
|
|
18477
|
+
}
|
|
18478
|
+
export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
|
|
18479
|
+
projectId: string;
|
|
18480
|
+
}
|
|
18481
|
+
export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
|
|
18482
|
+
}
|
|
18483
|
+
export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
|
|
18484
|
+
output: string;
|
|
18485
|
+
}
|
|
18426
18486
|
/**
|
|
18427
18487
|
* @openapi
|
|
18428
18488
|
*
|
|
@@ -18894,6 +18954,7 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
18894
18954
|
updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
|
|
18895
18955
|
uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
|
|
18896
18956
|
generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
|
|
18957
|
+
generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
|
|
18897
18958
|
}
|
|
18898
18959
|
declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
|
|
18899
18960
|
/**
|
|
@@ -20788,7 +20849,10 @@ declare const actionTypes: readonly [
|
|
|
20788
20849
|
"updateFlowSettings",
|
|
20789
20850
|
"optionsResolver",
|
|
20790
20851
|
"processKnowledgeSourceUrl",
|
|
20791
|
-
"processKnowledgeSourceFile"
|
|
20852
|
+
"processKnowledgeSourceFile",
|
|
20853
|
+
"setupObservationConfig",
|
|
20854
|
+
"updateObservationConfig",
|
|
20855
|
+
"resolveAiOpsCenterError"
|
|
20792
20856
|
];
|
|
20793
20857
|
export declare type TActionType = typeof actionTypes[number];
|
|
20794
20858
|
/**
|
|
@@ -20841,7 +20905,7 @@ export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "an
|
|
|
20841
20905
|
* - $ref: '#/components/schemas/TResourceType'
|
|
20842
20906
|
* - $ref: '#/components/schemas/TResourceTypeAdditional'
|
|
20843
20907
|
*/
|
|
20844
|
-
export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional;
|
|
20908
|
+
export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional | "AiOpsCenterError";
|
|
20845
20909
|
/***
|
|
20846
20910
|
* @openapi
|
|
20847
20911
|
* components:
|
|
@@ -22650,13 +22714,18 @@ export interface IIndexOpsCenterErrorsRestReturnValue_2_0 {
|
|
|
22650
22714
|
items?: IGetOpsCenterError[];
|
|
22651
22715
|
}
|
|
22652
22716
|
declare const notificationChannels: readonly [
|
|
22653
|
-
"email"
|
|
22717
|
+
"email",
|
|
22718
|
+
"webhook"
|
|
22654
22719
|
];
|
|
22655
22720
|
export declare type NotificationChannel = (typeof notificationChannels)[number];
|
|
22656
22721
|
export interface NotificationConfig {
|
|
22657
22722
|
channel: NotificationChannel;
|
|
22658
22723
|
/** List of email addresses to send notifications to. */
|
|
22659
22724
|
addresses: string[];
|
|
22725
|
+
webhook?: {
|
|
22726
|
+
url: string;
|
|
22727
|
+
connectionId: string;
|
|
22728
|
+
};
|
|
22660
22729
|
}
|
|
22661
22730
|
export interface AlertingConfig {
|
|
22662
22731
|
configuredAlerts: {
|
|
@@ -22711,7 +22780,282 @@ export interface AIOpsCenterAPIGroup_2_0 {
|
|
|
22711
22780
|
indexOpsCenterAlerts: TRestAPIOperation<IIndexOpsCenterAlertsRestData_2_0, IIndexOpsCenterAlertsRestReturnValue_2_0>;
|
|
22712
22781
|
}
|
|
22713
22782
|
declare function AIOpsCenterAPIGroup_2_0(instance: Base): AIOpsCenterAPIGroup_2_0;
|
|
22714
|
-
|
|
22783
|
+
declare enum ESuccessCriterionTypeRest_2_0 {
|
|
22784
|
+
TEXT = "text",
|
|
22785
|
+
GOAL_COMPLETED = "goalCompleted"
|
|
22786
|
+
}
|
|
22787
|
+
export interface ISuccessCriteriaRest_2_0 {
|
|
22788
|
+
type: ESuccessCriterionTypeRest_2_0;
|
|
22789
|
+
params: Record<string, unknown>;
|
|
22790
|
+
}
|
|
22791
|
+
export interface IProjectMetadataRest_2_0 {
|
|
22792
|
+
projectReference: string;
|
|
22793
|
+
organisationReference: string;
|
|
22794
|
+
}
|
|
22795
|
+
export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
|
|
22796
|
+
id: string;
|
|
22797
|
+
name: string;
|
|
22798
|
+
persona: string;
|
|
22799
|
+
personaName: string;
|
|
22800
|
+
mission: string;
|
|
22801
|
+
successCriteria: ISuccessCriteriaRest_2_0[];
|
|
22802
|
+
maxTurns?: number;
|
|
22803
|
+
timeout?: number;
|
|
22804
|
+
createdAt?: number;
|
|
22805
|
+
createdBy: string;
|
|
22806
|
+
updatedAt?: number;
|
|
22807
|
+
updatedBy: string;
|
|
22808
|
+
lastChanged: number;
|
|
22809
|
+
lastChangedBy?: string;
|
|
22810
|
+
expiresAt?: Date;
|
|
22811
|
+
}
|
|
22812
|
+
export interface IIndexSimulationsRestDataQuery_2_0 {
|
|
22813
|
+
projectId?: string;
|
|
22814
|
+
filter?: string;
|
|
22815
|
+
limit?: number;
|
|
22816
|
+
skip?: number;
|
|
22817
|
+
sort?: string;
|
|
22818
|
+
next?: string;
|
|
22819
|
+
previous?: string;
|
|
22820
|
+
}
|
|
22821
|
+
export interface IIndexSimulationsRestData_2_0 extends IIndexSimulationsRestDataQuery_2_0 {
|
|
22822
|
+
}
|
|
22823
|
+
export interface IIndexSimulationsRestReturnValue_2_0 {
|
|
22824
|
+
data: ISimulationRest_2_0[];
|
|
22825
|
+
pagination: {
|
|
22826
|
+
total: number;
|
|
22827
|
+
limit: number;
|
|
22828
|
+
skip: number;
|
|
22829
|
+
hasMore: boolean;
|
|
22830
|
+
next?: string;
|
|
22831
|
+
previous?: string;
|
|
22832
|
+
};
|
|
22833
|
+
}
|
|
22834
|
+
export interface ICreateSimulationRestData_2_0 {
|
|
22835
|
+
name: string;
|
|
22836
|
+
persona: string;
|
|
22837
|
+
personaName: string;
|
|
22838
|
+
mission: string;
|
|
22839
|
+
successCriteria: ISuccessCriteriaRest_2_0[];
|
|
22840
|
+
maxTurns?: number;
|
|
22841
|
+
timeout?: number;
|
|
22842
|
+
projectReference: string;
|
|
22843
|
+
organisationReference: string;
|
|
22844
|
+
}
|
|
22845
|
+
export interface ICreateSimulationRestReturnValue_2_0 {
|
|
22846
|
+
simulation: ISimulationRest_2_0;
|
|
22847
|
+
}
|
|
22848
|
+
export interface IUpdateSimulationsRestDataQuery_2_0 {
|
|
22849
|
+
projectId: string;
|
|
22850
|
+
}
|
|
22851
|
+
export interface IUpdateSimulationsRestDataParams_2_0 {
|
|
22852
|
+
simulationReference: string;
|
|
22853
|
+
}
|
|
22854
|
+
export interface IUpdateSimulationsRestDataBody_2_0 {
|
|
22855
|
+
name?: string;
|
|
22856
|
+
persona?: string;
|
|
22857
|
+
personaName?: string;
|
|
22858
|
+
mission?: string;
|
|
22859
|
+
successCriteria?: ISuccessCriteriaRest_2_0[];
|
|
22860
|
+
maxTurns?: number;
|
|
22861
|
+
timeout?: number;
|
|
22862
|
+
}
|
|
22863
|
+
export interface IUpdateSimulationRestData_2_0 extends IUpdateSimulationsRestDataQuery_2_0, IUpdateSimulationsRestDataParams_2_0, IUpdateSimulationsRestDataBody_2_0 {
|
|
22864
|
+
}
|
|
22865
|
+
export interface IUpdateSimulationRestReturnValue_2_0 {
|
|
22866
|
+
simulation: ISimulationRest_2_0;
|
|
22867
|
+
}
|
|
22868
|
+
export interface IDeleteSimulationsRestDataQuery_2_0 {
|
|
22869
|
+
projectId: string;
|
|
22870
|
+
}
|
|
22871
|
+
export interface IDeleteSimulationRestData_2_0 extends IDeleteSimulationsRestDataQuery_2_0 {
|
|
22872
|
+
simulationReference: string;
|
|
22873
|
+
}
|
|
22874
|
+
export interface IDeleteSimulationRestReturnValue_2_0 {
|
|
22875
|
+
}
|
|
22876
|
+
export interface IReadSimulationsRestDataQuery_2_0 {
|
|
22877
|
+
projectId: string;
|
|
22878
|
+
}
|
|
22879
|
+
export interface IReadSimulationRestData_2_0 extends IReadSimulationsRestDataQuery_2_0 {
|
|
22880
|
+
simulationReference: string;
|
|
22881
|
+
}
|
|
22882
|
+
export interface IReadSimulationRestReturnValue_2_0 {
|
|
22883
|
+
simulation: ISimulationRest_2_0;
|
|
22884
|
+
}
|
|
22885
|
+
export interface IScheduleSimulationRestDataParams_2_0 {
|
|
22886
|
+
simulationReference: string;
|
|
22887
|
+
}
|
|
22888
|
+
export interface IScheduleSimulationRestDataBody_2_0 {
|
|
22889
|
+
name: string;
|
|
22890
|
+
largeLanguageModelReferenceId: string;
|
|
22891
|
+
runConfig: {
|
|
22892
|
+
flowReferenceId: string;
|
|
22893
|
+
localeReferenceId?: string;
|
|
22894
|
+
entrypoint: string;
|
|
22895
|
+
};
|
|
22896
|
+
projectReference: string;
|
|
22897
|
+
numberOfExecutions: number;
|
|
22898
|
+
}
|
|
22899
|
+
export interface IScheduleSimulationRestData_2_0 extends IScheduleSimulationRestDataParams_2_0, IScheduleSimulationRestDataBody_2_0 {
|
|
22900
|
+
}
|
|
22901
|
+
export interface IScheduleSimulationRestReturnValue_2_0 {
|
|
22902
|
+
simulation: ISimulationRest_2_0;
|
|
22903
|
+
}
|
|
22904
|
+
declare const SimulationRunBatchStatus: readonly [
|
|
22905
|
+
"IN_PROGRESS",
|
|
22906
|
+
"COMPLETED",
|
|
22907
|
+
"FAILED"
|
|
22908
|
+
];
|
|
22909
|
+
export declare type TSimulationRunBatchStatusRest_2_0 = typeof SimulationRunBatchStatus[number];
|
|
22910
|
+
export interface ISimulationRunBatchRest_2_0 {
|
|
22911
|
+
id: string;
|
|
22912
|
+
name: string;
|
|
22913
|
+
status: TSimulationRunBatchStatusRest_2_0;
|
|
22914
|
+
numberOfExecutions: number;
|
|
22915
|
+
successRate?: number;
|
|
22916
|
+
efficiency?: number;
|
|
22917
|
+
simulationReference: string;
|
|
22918
|
+
projectReference: string;
|
|
22919
|
+
organisationReference: string;
|
|
22920
|
+
runConfig: {
|
|
22921
|
+
flowReferenceId: string;
|
|
22922
|
+
localeReferenceId?: string;
|
|
22923
|
+
entrypoint: string;
|
|
22924
|
+
};
|
|
22925
|
+
createdAt: number;
|
|
22926
|
+
createdBy: string;
|
|
22927
|
+
largeLanguageModelReferenceId: string;
|
|
22928
|
+
updatedAt?: number;
|
|
22929
|
+
completedAt?: number;
|
|
22930
|
+
expiresAt?: Date;
|
|
22931
|
+
}
|
|
22932
|
+
export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
|
|
22933
|
+
projectId: string;
|
|
22934
|
+
filter?: number;
|
|
22935
|
+
limit?: number;
|
|
22936
|
+
skip?: number;
|
|
22937
|
+
sort?: string;
|
|
22938
|
+
next?: string;
|
|
22939
|
+
previous?: string;
|
|
22940
|
+
}
|
|
22941
|
+
export interface IIndexSimulationRunBatchesRestData_2_0 extends IIndexSimulationRunBatchesRestDataQuery_2_0 {
|
|
22942
|
+
}
|
|
22943
|
+
export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
|
|
22944
|
+
simulationRunBatches: ISimulationRunBatchRest_2_0[];
|
|
22945
|
+
}
|
|
22946
|
+
export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
|
|
22947
|
+
projectId: string;
|
|
22948
|
+
filter?: string;
|
|
22949
|
+
limit?: number;
|
|
22950
|
+
skip?: number;
|
|
22951
|
+
sort?: string;
|
|
22952
|
+
next?: string;
|
|
22953
|
+
previous?: string;
|
|
22954
|
+
}
|
|
22955
|
+
export interface IGetAllSimulationRunBatchesRestData_2_0 extends IGetAllSimulationRunBatchesRestDataQuery_2_0 {
|
|
22956
|
+
simulationReference: string;
|
|
22957
|
+
}
|
|
22958
|
+
export interface IGetAllSimulationRunBatchesRestReturnValue_2_0 {
|
|
22959
|
+
simulationRunBatches: ISimulationRunBatchRest_2_0[];
|
|
22960
|
+
}
|
|
22961
|
+
export interface IReadSimulationRunBatchRestDataQuery_2_0 {
|
|
22962
|
+
projectId: string;
|
|
22963
|
+
}
|
|
22964
|
+
export interface IReadSimulationRunBatchRestData_2_0 extends IReadSimulationRunBatchRestDataQuery_2_0 {
|
|
22965
|
+
simulationReference: string;
|
|
22966
|
+
simulationRunBatchReference: string;
|
|
22967
|
+
}
|
|
22968
|
+
export interface IReadSimulationRunBatchRestReturnValue_2_0 {
|
|
22969
|
+
simulationRunBatch: ISimulationRunBatchRest_2_0;
|
|
22970
|
+
}
|
|
22971
|
+
declare enum ETurnTypeRest_2_0 {
|
|
22972
|
+
INPUT = "input",
|
|
22973
|
+
OUTPUT = "output"
|
|
22974
|
+
}
|
|
22975
|
+
export interface ITurnRest_2_0 {
|
|
22976
|
+
type: ETurnTypeRest_2_0;
|
|
22977
|
+
text: string;
|
|
22978
|
+
data?: Record<string, unknown>;
|
|
22979
|
+
}
|
|
22980
|
+
declare enum ESuccessCriteriaTypeRest_2_0 {
|
|
22981
|
+
TEXT = "text"
|
|
22982
|
+
}
|
|
22983
|
+
export interface ISuccessCriteriaRest_2_0 {
|
|
22984
|
+
type: ESuccessCriteriaTypeRest_2_0;
|
|
22985
|
+
params: {
|
|
22986
|
+
text: string;
|
|
22987
|
+
};
|
|
22988
|
+
}
|
|
22989
|
+
declare enum ESentimentTypeRest_2_0 {
|
|
22990
|
+
POSITIVE = "POSITIVE",
|
|
22991
|
+
NEUTRAL = "NEUTRAL",
|
|
22992
|
+
NEGATIVE = "NEGATIVE"
|
|
22993
|
+
}
|
|
22994
|
+
export interface ISimulationRunRest_2_0 {
|
|
22995
|
+
id: string;
|
|
22996
|
+
organisationReference: string;
|
|
22997
|
+
projectReference: string;
|
|
22998
|
+
simulationReference: string;
|
|
22999
|
+
simulationRunBatchReference: string;
|
|
23000
|
+
sequence: number;
|
|
23001
|
+
largeLanguageModelReferenceId: string;
|
|
23002
|
+
turns: ITurnRest_2_0[];
|
|
23003
|
+
totalTurns: number;
|
|
23004
|
+
successCriteria: ISuccessCriteriaRest_2_0[];
|
|
23005
|
+
metrics: {
|
|
23006
|
+
sentiment: ESentimentTypeRest_2_0;
|
|
23007
|
+
outOfScope: string;
|
|
23008
|
+
efficiency: number;
|
|
23009
|
+
topic: string;
|
|
23010
|
+
success: boolean;
|
|
23011
|
+
};
|
|
23012
|
+
createdAt: number;
|
|
23013
|
+
createdBy: string;
|
|
23014
|
+
duration?: number;
|
|
23015
|
+
expiresAt?: Date;
|
|
23016
|
+
}
|
|
23017
|
+
export interface IIndexSimulationRunsRestDataQuery_2_0 {
|
|
23018
|
+
projectId: string;
|
|
23019
|
+
filter?: string;
|
|
23020
|
+
limit?: number;
|
|
23021
|
+
skip?: number;
|
|
23022
|
+
sort?: string;
|
|
23023
|
+
next?: string;
|
|
23024
|
+
previous?: string;
|
|
23025
|
+
}
|
|
23026
|
+
export interface IIndexSimulationRunsRestData_2_0 extends IIndexSimulationRunsRestDataQuery_2_0 {
|
|
23027
|
+
simulationRunBatchReference: string;
|
|
23028
|
+
simulationReference: string;
|
|
23029
|
+
}
|
|
23030
|
+
export interface IIndexSimulationRunsRestReturnValue_2_0 {
|
|
23031
|
+
simulationRuns: ISimulationRunRest_2_0[];
|
|
23032
|
+
}
|
|
23033
|
+
export interface IReadSimulationRunRestDataQuery_2_0 {
|
|
23034
|
+
projectId: string;
|
|
23035
|
+
}
|
|
23036
|
+
export interface IReadSimulationRunRestData_2_0 extends IReadSimulationRunRestDataQuery_2_0 {
|
|
23037
|
+
simulationRunReference: string;
|
|
23038
|
+
simulationRunBatchReference: string;
|
|
23039
|
+
simulationReference: string;
|
|
23040
|
+
}
|
|
23041
|
+
export interface IReadSimulationRunRestReturnValue_2_0 {
|
|
23042
|
+
simulationRun: ISimulationRunRest_2_0;
|
|
23043
|
+
}
|
|
23044
|
+
export interface SimulationAPIGroup_2_0 {
|
|
23045
|
+
indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
|
|
23046
|
+
createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
|
|
23047
|
+
updateSimulation: TRestAPIOperation<IUpdateSimulationRestData_2_0, IUpdateSimulationRestReturnValue_2_0>;
|
|
23048
|
+
deleteSimulation: TRestAPIOperation<IDeleteSimulationRestData_2_0, IDeleteSimulationRestReturnValue_2_0>;
|
|
23049
|
+
readSimulation: TRestAPIOperation<IReadSimulationRestData_2_0, IReadSimulationRestReturnValue_2_0>;
|
|
23050
|
+
scheduleSimulation: TRestAPIOperation<IScheduleSimulationRestData_2_0, IScheduleSimulationRestReturnValue_2_0>;
|
|
23051
|
+
indexSimulationRunBatches: TRestAPIOperation<IIndexSimulationRunBatchesRestData_2_0, IIndexSimulationRunBatchesRestReturnValue_2_0>;
|
|
23052
|
+
getAllSimulationRunBatches: TRestAPIOperation<IGetAllSimulationRunBatchesRestData_2_0, IGetAllSimulationRunBatchesRestReturnValue_2_0>;
|
|
23053
|
+
readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
|
|
23054
|
+
indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
|
|
23055
|
+
readSimulationRun: TRestAPIOperation<IReadSimulationRunRestData_2_0, IReadSimulationRunRestReturnValue_2_0>;
|
|
23056
|
+
}
|
|
23057
|
+
declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
|
|
23058
|
+
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>;
|
|
22715
23059
|
export declare type TResourceAPIVersionType<T> = T extends {
|
|
22716
23060
|
versions: {
|
|
22717
23061
|
resources: "2.0";
|
|
@@ -22762,6 +23106,11 @@ export declare type TAIOpsCenterAPIVersionType<T> = T extends {
|
|
|
22762
23106
|
aiops: "1.0";
|
|
22763
23107
|
};
|
|
22764
23108
|
} ? AIOpsCenterAPIGroup_2_0 : AIOpsCenterAPIGroup_2_0;
|
|
23109
|
+
export declare type TSimulationAPIVersionType<T> = T extends {
|
|
23110
|
+
versions: {
|
|
23111
|
+
simulation: "2.0";
|
|
23112
|
+
};
|
|
23113
|
+
} ? SimulationAPIGroup_2_0 : SimulationAPIGroup_2_0;
|
|
22765
23114
|
export declare type TRestAPIClient<T extends IRestAPIClientConfig = IRestAPIClientConfig> = TRestAPIGroupsTypeByConfiguration<T> & AuthenticationAPI & IRestAPIClientProperties<T> & IHttpAdapterAPI;
|
|
22766
23115
|
export interface IRestAPIClientConstructor {
|
|
22767
23116
|
new <T extends IRestAPIClientConfig>(config?: T): TRestAPIClient<T>;
|