@cognigy/rest-api-client 2025.12.0 → 2025.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.
Files changed (75) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/build/apigroups/ResourcesAPIGroup_2_0.js +8 -1
  3. package/build/apigroups/SimulationAPIGroup_2_0.js +4 -1
  4. package/build/shared/charts/descriptors/analytics/trackGoal.js +3 -1
  5. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
  6. package/build/shared/charts/descriptors/index.js +5 -0
  7. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +10 -6
  8. package/build/shared/charts/descriptors/message/question/question.js +12 -1
  9. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
  10. package/build/shared/charts/descriptors/service/GPTPrompt.js +21 -1
  11. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +71 -175
  12. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +2 -2
  13. package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +175 -0
  14. package/build/shared/charts/descriptors/service/aiAgent/loadAiAgent.js +194 -0
  15. package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
  16. package/build/shared/charts/descriptors/service/index.js +11 -1
  17. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +959 -0
  18. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptDefault.js +31 -0
  19. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +196 -0
  20. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptTool.js +139 -0
  21. package/build/shared/constants.js +1 -5
  22. package/build/shared/interfaces/debugEvents/IGoalCompletedEventPayload.js +3 -0
  23. package/build/shared/interfaces/debugEvents/TDebugEventType.js +1 -0
  24. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +12 -1
  25. package/build/shared/interfaces/messageAPI/handover.js +6 -0
  26. package/build/shared/interfaces/resources/ISimulation.js +9 -0
  27. package/build/shared/interfaces/resources/TResourceType.js +3 -0
  28. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +2 -1
  29. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +5 -18
  30. package/build/shared/interfaces/restAPI/operations/generateOutput/v2.0/index.js +3 -0
  31. package/build/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +3 -0
  32. package/build/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +3 -0
  33. package/build/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +3 -0
  34. package/build/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +3 -0
  35. package/build/shared/interfaces/security/IPermission.js +4 -0
  36. package/build/shared/interfaces/security/IRole.js +5 -1
  37. package/build/shared/interfaces/security/index.js +1 -1
  38. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +8 -1
  39. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +4 -1
  40. package/dist/esm/shared/charts/descriptors/analytics/trackGoal.js +3 -1
  41. package/dist/esm/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
  42. package/dist/esm/shared/charts/descriptors/index.js +6 -1
  43. package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +10 -6
  44. package/dist/esm/shared/charts/descriptors/message/question/question.js +12 -1
  45. package/dist/esm/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
  46. package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +21 -1
  47. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +72 -176
  48. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +2 -2
  49. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +172 -0
  50. package/dist/esm/shared/charts/descriptors/service/aiAgent/loadAiAgent.js +192 -0
  51. package/dist/esm/shared/charts/descriptors/service/handoverV2.js +1 -1
  52. package/dist/esm/shared/charts/descriptors/service/index.js +5 -0
  53. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +946 -0
  54. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptDefault.js +28 -0
  55. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +193 -0
  56. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptTool.js +136 -0
  57. package/dist/esm/shared/constants.js +1 -5
  58. package/dist/esm/shared/interfaces/debugEvents/IGoalCompletedEventPayload.js +2 -0
  59. package/dist/esm/shared/interfaces/debugEvents/TDebugEventType.js +1 -0
  60. package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +12 -1
  61. package/dist/esm/shared/interfaces/messageAPI/handover.js +6 -0
  62. package/dist/esm/shared/interfaces/resources/ISimulation.js +6 -0
  63. package/dist/esm/shared/interfaces/resources/TResourceType.js +3 -0
  64. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +2 -1
  65. package/dist/esm/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -17
  66. package/dist/esm/shared/interfaces/restAPI/operations/generateOutput/v2.0/index.js +2 -0
  67. package/dist/esm/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +2 -0
  68. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +2 -0
  69. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +2 -0
  70. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +2 -0
  71. package/dist/esm/shared/interfaces/security/IPermission.js +4 -0
  72. package/dist/esm/shared/interfaces/security/IRole.js +5 -1
  73. package/dist/esm/shared/interfaces/security/index.js +1 -1
  74. package/package.json +1 -1
  75. package/types/index.d.ts +2093 -1927
package/types/index.d.ts CHANGED
@@ -424,7 +424,8 @@ declare const organisationWidePermissions: readonly [
424
424
  "projects",
425
425
  "userDetails",
426
426
  "users",
427
- "voiceGatewayAccount"
427
+ "voiceGatewayAccount",
428
+ "opsCenter"
428
429
  ];
429
430
  export declare type TOrganisationWidePermissions = typeof organisationWidePermissions[number];
430
431
  declare const projectWidePermissions: readonly [
@@ -464,7 +465,8 @@ declare const projectWidePermissions: readonly [
464
465
  "tasks",
465
466
  "tokens",
466
467
  "yesNoIntents",
467
- "dataPrivacySettings"
468
+ "dataPrivacySettings",
469
+ "simulator"
468
470
  ];
469
471
  export declare type TProjectWidePermissions = typeof projectWidePermissions[number];
470
472
  export declare type TMongoId = string;
@@ -1010,7 +1012,8 @@ declare const organisationWideRoles: readonly [
1010
1012
  "projectManager",
1011
1013
  "userManager",
1012
1014
  "userDetailsViewer",
1013
- "voiceGatewayUser"
1015
+ "voiceGatewayUser",
1016
+ "opsCenterUser"
1014
1017
  ];
1015
1018
  export declare type TOrganisationWideRole = typeof organisationWideRoles[number];
1016
1019
  declare const projectWideRoles: readonly [
@@ -1053,7 +1056,8 @@ declare const projectWideRoles: readonly [
1053
1056
  "tokenEditor",
1054
1057
  "data_privacy_admin",
1055
1058
  "data_privacy_editor",
1056
- "data_privacy_viewer"
1059
+ "data_privacy_viewer",
1060
+ "simulator_admin"
1057
1061
  ];
1058
1062
  export declare type TProjectWideRole = typeof projectWideRoles[number];
1059
1063
  /**
@@ -1253,6 +1257,8 @@ export interface IOrganisationWideAcl {
1253
1257
  * $ref: '#/components/schemas/ICrudPermissions'
1254
1258
  * users:
1255
1259
  * $ref: '#/components/schemas/ICrudPermissions'
1260
+ * simulator:
1261
+ * $ref: '#/components/schemas/ICrudPermissions'
1256
1262
  * additionalProperties:
1257
1263
  * $ref: '#/components/schemas/ICrudPermissions'
1258
1264
  * roles:
@@ -4348,6 +4354,9 @@ declare const generativeAIModels: readonly [
4348
4354
  "gpt-4",
4349
4355
  "gpt-4o",
4350
4356
  "gpt-4o-mini",
4357
+ "gpt-4.1",
4358
+ "gpt-4.1-mini",
4359
+ "gpt-4.1-nano",
4351
4360
  "luminous-extended-control",
4352
4361
  "claude-v1-100k",
4353
4362
  "claude-instant-v1",
@@ -4355,6 +4364,11 @@ declare const generativeAIModels: readonly [
4355
4364
  "claude-3-haiku-20240307",
4356
4365
  "claude-3-sonnet-20240229",
4357
4366
  "claude-3-5-sonnet-20241022",
4367
+ "claude-3-7-sonnet-20250219",
4368
+ "claude-3-5-sonnet-latest",
4369
+ "claude-3-7-sonnet-latest",
4370
+ "claude-opus-4-0",
4371
+ "claude-sonnet-4-0",
4358
4372
  "text-bison@001",
4359
4373
  "custom-model",
4360
4374
  "gemini-1.0-pro",
@@ -4366,11 +4380,14 @@ declare const generativeAIModels: readonly [
4366
4380
  "amazon.nova-pro-v1:0",
4367
4381
  "amazon.nova-micro-v1:0",
4368
4382
  "anthropic.claude-3-5-sonnet-20240620-v1:0",
4369
- "claude-3-7-sonnet-20250219",
4370
4383
  "mistral-large-2411",
4371
4384
  "mistral-small-2503",
4372
4385
  "pixtral-large-2411",
4373
4386
  "pixtral-12b-2409",
4387
+ "mistral-large-latest",
4388
+ "pixtral-large-latest",
4389
+ "mistral-medium-latest",
4390
+ "mistral-small-latest",
4374
4391
  "text-embedding-3-small",
4375
4392
  "text-embedding-3-large",
4376
4393
  "text-embedding-ada-002",
@@ -4462,6 +4479,13 @@ declare const modeType: readonly [
4462
4479
  "embedding"
4463
4480
  ];
4464
4481
  export declare type TModeType = typeof modeType[number];
4482
+ export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
4483
+ export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
4484
+ export declare type TSQL_EXTENSION = "@cognigy/mssql";
4485
+ export declare type TSMTP_EXTENSION = "@cognigy/smtp";
4486
+ export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
4487
+ export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
4488
+ export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
4465
4489
  export interface IGenerativeAIUseCaseSettings {
4466
4490
  largeLanguageModelId: string | null;
4467
4491
  temperature: number;
@@ -5307,6 +5331,7 @@ export interface IAudioPreviewSettings_2_0 {
5307
5331
  * - mistral
5308
5332
  */
5309
5333
  export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
5334
+ export declare type TConfigurableGenerativeAIUseCases = Exclude<TGenerativeAIUseCases, "intentSentenceGeneration" | "flowGeneration" | "generateNodeOutput" | "lexiconGeneration">;
5310
5335
  /**
5311
5336
  * @openapi
5312
5337
  *
@@ -5322,27 +5347,19 @@ export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
5322
5347
  * properties:
5323
5348
  * designTimeGeneration:
5324
5349
  * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5325
- * intentSentenceGeneration:
5326
- * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5327
5350
  * aiEnhancedOutputs:
5328
5351
  * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5329
- * lexiconGeneration:
5330
- * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5331
- * flowGeneration:
5332
- * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5333
5352
  * gptConversation:
5334
5353
  * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5335
5354
  * gptPromptNode:
5336
5355
  * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5337
- * generateNodeOutput:
5338
- * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5339
5356
  * knowledgeSearch:
5340
5357
  * $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
5341
5358
  */
5342
5359
  export interface IGenerativeAISettings_2_0 {
5343
5360
  enabled: boolean;
5344
5361
  useCasesSettings: {
5345
- [key in TGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
5362
+ [key in TConfigurableGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
5346
5363
  };
5347
5364
  }
5348
5365
  /**
@@ -9030,7 +9047,8 @@ declare const arrayTDebugEventTypes: readonly [
9030
9047
  "switchedFlow",
9031
9048
  "nluWarning",
9032
9049
  "debugMessage",
9033
- "debugError"
9050
+ "debugError",
9051
+ "goalCompleted"
9034
9052
  ];
9035
9053
  export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
9036
9054
  export interface IInputChangedEventPayload {
@@ -9127,7 +9145,28 @@ export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayload
9127
9145
  message: object;
9128
9146
  }
9129
9147
  export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
9130
- export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload;
9148
+ export interface IGoalAnalyticsPayload {
9149
+ analyticsdata: IGoalEscalations;
9150
+ data: IPayloadBaseMetaData;
9151
+ }
9152
+ export interface IGoalAnalyticsData {
9153
+ projectId: string;
9154
+ organisationId: string;
9155
+ sessionId: string;
9156
+ referenceId: string;
9157
+ version: string;
9158
+ timestamp: Date;
9159
+ goalCycleId: string;
9160
+ stepId: string;
9161
+ goalId: string;
9162
+ contactId: string;
9163
+ stepType?: string;
9164
+ }
9165
+ export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
9166
+ }
9167
+ export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
9168
+ }
9169
+ export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
9131
9170
  declare const audioPreviewProviders: readonly [
9132
9171
  "microsoft",
9133
9172
  "google",
@@ -9586,6 +9625,15 @@ export interface IGraphAiAgent {
9586
9625
  properties: Pick<IAiAgent, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy" | "knowledgeReferenceId">;
9587
9626
  dependencies?: IAiAgentDependencies[];
9588
9627
  }
9628
+ export interface ILoadAiAgentNodeParams extends INodeFunctionBaseParams {
9629
+ config: {
9630
+ aiAgent: IAiAgent;
9631
+ storeLocation: string;
9632
+ contextKey: string;
9633
+ inputKey: string;
9634
+ keyWarning: string;
9635
+ };
9636
+ }
9589
9637
  export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
9590
9638
  tile: any;
9591
9639
  }
@@ -10477,23 +10525,6 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
10477
10525
  timeout: number;
10478
10526
  };
10479
10527
  }
10480
- export interface IGoalAnalyticsPayload {
10481
- analyticsdata: IGoalEscalations;
10482
- data: IPayloadBaseMetaData;
10483
- }
10484
- export interface IGoalAnalyticsData {
10485
- projectId: string;
10486
- organisationId: string;
10487
- sessionId: string;
10488
- version: string;
10489
- timestamp: Date;
10490
- goalCycleId: string;
10491
- stepId: string;
10492
- goalId: string;
10493
- contactId: string;
10494
- }
10495
- export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
10496
- }
10497
10528
  export interface IEndpointSettings {
10498
10529
  isFeatureAccmEnabled?: boolean;
10499
10530
  }
@@ -10692,7 +10723,6 @@ export interface IActions {
10692
10723
  getAgentAssistConfigId: () => string;
10693
10724
  getNluEmbeddingCredentials: () => Promise<INluEmbeddingCredentials>;
10694
10725
  getMetadata: () => IGetMetaDataActionValue;
10695
- sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
10696
10726
  getEndpointSettings: () => IEndpointSettings;
10697
10727
  getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
10698
10728
  addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
@@ -11354,6 +11384,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11354
11384
  }) => Promise<{
11355
11385
  [x: string]: unknown;
11356
11386
  }>;
11387
+ sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
11357
11388
  }
11358
11389
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
11359
11390
  api: INodeExecutionAPI;
@@ -12199,8 +12230,49 @@ export interface IHandoverProviderSettings {
12199
12230
  service: THandoverService;
12200
12231
  serviceSettings?: TServiceSettings;
12201
12232
  }
12233
+ declare enum SuccessCriterionType {
12234
+ TEXT = "text",
12235
+ GOAL_COMPLETED = "goalCompleted"
12236
+ }
12237
+ export interface ISuccessCriteriaTextParams {
12238
+ text: string;
12239
+ name: string;
12240
+ }
12241
+ export interface ISuccessCriteriaGoalParams {
12242
+ referenceId: string;
12243
+ name: string;
12244
+ }
12245
+ export interface ISuccessCriteria {
12246
+ type: SuccessCriterionType;
12247
+ params: ISuccessCriteriaTextParams | ISuccessCriteriaGoalParams;
12248
+ }
12249
+ export interface IProjectMetadata {
12250
+ projectReference: string;
12251
+ organisationReference: string;
12252
+ }
12253
+ export interface ISimulation extends IProjectMetadata {
12254
+ id: string;
12255
+ _id: string;
12256
+ referenceId: string;
12257
+ name: string;
12258
+ persona: string;
12259
+ personaName: string;
12260
+ mission: string;
12261
+ successCriteria: ISuccessCriteria[];
12262
+ maxTurns?: number;
12263
+ timeout?: number;
12264
+ createdAt?: number;
12265
+ createdBy: string;
12266
+ updatedAt?: number;
12267
+ updatedBy: string;
12268
+ lastChanged: number;
12269
+ lastChangedBy?: string;
12270
+ }
12271
+ export interface IGraphSimulation extends ISimulation {
12272
+ type: "simulation";
12273
+ }
12202
12274
  export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent;
12203
- export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
12275
+ export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook | IGraphSimulation;
12204
12276
  export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
12205
12277
  /**
12206
12278
  * @openapi
@@ -13423,601 +13495,822 @@ export interface IGenerateNodeOutputRestReturnValue_2_0 extends IGenerateNodeOut
13423
13495
  *
13424
13496
  * components:
13425
13497
  * schemas:
13426
- * INodeDescriptor_2_0:
13498
+ * IAiAgentData_2_0:
13427
13499
  * type: object
13428
13500
  * properties:
13429
- * type:
13501
+ * name:
13430
13502
  * type: string
13431
- * parentType:
13503
+ * example: "Cognigy AI Agent"
13504
+ * image:
13432
13505
  * type: string
13433
- * description: The type of the node parent, if there is one
13434
- * defaultLabel:
13435
- * oneOf:
13436
- * - type: string
13437
- * description: The label that should be used when a new Node of this type is created
13438
- * - type: object
13439
- * description: A localized version of the label that should be used when a new Node of this type is created
13440
- * properties:
13441
- * default:
13442
- * type: string
13443
- * enUS:
13444
- * type: string
13445
- * deDE:
13446
- * type: string
13447
- * esES:
13448
- * type: string
13449
- * jaJP:
13450
- * type: string
13451
- * koKR:
13452
- * type: string
13453
- * summary:
13454
- * oneOf:
13455
- * - type: string
13456
- * description: A short line of text that describes what this Node is used for
13457
- * - type: object
13458
- * description: A localized version of a short line of text that describes what this Node is used for
13459
- * properties:
13460
- * default:
13461
- * type: string
13462
- * enUS:
13463
- * type: string
13464
- * deDE:
13465
- * type: string
13466
- * esES:
13467
- * type: string
13468
- * jaJP:
13469
- * type: string
13470
- * koKR:
13471
- * type: string
13472
- * extension:
13506
+ * description: Avatar of the AI Agent.
13507
+ * example: "https://cognigy.com/ai-agent.png"
13508
+ * imageOptimizedFormat:
13509
+ * type: boolean
13510
+ * description: Whether the optimized image format defined by Cognigy is used.
13511
+ * example: true
13512
+ * knowledgeReferenceId:
13473
13513
  * type: string
13474
- * extensionImg:
13514
+ * format: uuid
13515
+ * description: A referenceId of a Knowledge Store this Agent will use as base knowledge.
13516
+ * example: "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
13517
+ * description:
13475
13518
  * type: string
13476
- * appearance:
13519
+ * maxLength: 1000
13520
+ * description: A short description of the AI Agent, up to 1000 characters.
13521
+ * example: "I am a virtual assistant that can help you with your questions."
13522
+ * speakingStyle:
13477
13523
  * type: object
13478
13524
  * properties:
13479
- * logo:
13525
+ * completeness:
13480
13526
  * type: string
13481
- * textColor:
13527
+ * formality:
13482
13528
  * type: string
13483
- * example: blue
13484
- * oneOf:
13485
- * - $ref: '#/components/schemas/TCSSColorName'
13486
- * - $ref: '#/components/schemas/TCognigyColorName'
13487
- * contrastTextColor:
13529
+ * example: { "completeness": "concise", "formality": "formal" }
13530
+ * voiceConfigs:
13531
+ * type: object
13532
+ * properties:
13533
+ * ttsVoice:
13488
13534
  * type: string
13489
- * example: blue
13490
- * oneOf:
13491
- * - $ref: '#/components/schemas/TCSSColorName'
13492
- * - $ref: '#/components/schemas/TCognigyColorName'
13493
- * color:
13535
+ * ttsLanguage:
13494
13536
  * type: string
13495
- * example: red
13496
- * oneOf:
13497
- * - $ref: '#/components/schemas/TCSSColorName'
13498
- * - $ref: '#/components/schemas/TCognigyColorName'
13499
- * variant:
13537
+ * ttsVendor:
13538
+ * enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
13500
13539
  * type: string
13501
- * enum:
13502
- * - regular
13503
- * - mini
13504
- * - hexagon
13505
- * behavior:
13506
- * type: object
13507
- * properties:
13508
- * stopping:
13509
- * type: boolean
13510
- * entrypoint:
13540
+ * ttsModel:
13541
+ * type: string
13542
+ * ttsLabel:
13543
+ * type: string
13544
+ * ttsDisableCache:
13511
13545
  * type: boolean
13512
- * constraints:
13546
+ * example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false }
13547
+ * enableVoiceConfigs:
13548
+ * type: boolean
13549
+ * description: Enables the use of voice configuration.
13550
+ * example: false
13551
+ * safetySettings:
13513
13552
  * type: object
13514
13553
  * properties:
13515
- * editable:
13516
- * type: boolean
13517
- * description: Should this node be editable
13518
- * deletable:
13519
- * type: boolean
13520
- * description: Should this node be deletable
13521
- * creatable:
13554
+ * avoidHarmfulContent:
13522
13555
  * type: boolean
13523
- * description: Should this node be manually creatable
13524
- * collapsable:
13556
+ * avoidUngroundedContent:
13525
13557
  * type: boolean
13526
- * description: Should this node be collapsable
13527
- * childFlowCreatable:
13558
+ * avoidCopyrightInfringements:
13528
13559
  * type: boolean
13529
- * description: Should it be possible to create child flow from this node
13530
- * movable:
13560
+ * preventJailbreakAndManipulation:
13531
13561
  * type: boolean
13532
- * description: Should this node be movable
13533
- * placement:
13534
- * type: object
13535
- * description: Additional placement information
13536
- * properties:
13537
- * predecessor:
13538
- * type: object
13539
- * properties:
13540
- * whitelist:
13541
- * items:
13542
- * type: string
13543
- * blacklist:
13544
- * items:
13545
- * type: string
13546
- * successor:
13547
- * type: object
13548
- * properties:
13549
- * whitelist:
13550
- * items:
13551
- * type: string
13552
- * blacklist:
13553
- * items:
13554
- * type: string
13555
- * children:
13556
- * type: object
13557
- * properties:
13558
- * whitelist:
13559
- * items:
13560
- * type: string
13561
- * blacklist:
13562
- * items:
13563
- * type: string
13564
- * dependencies:
13565
- * type: object
13566
- * properties:
13567
- * children:
13568
- * type: array
13569
- * items:
13570
- * type: string
13571
- * fields:
13572
- * type: array
13573
- * items:
13574
- * type: object
13575
- * properties:
13576
- * type:
13577
- * type: string
13578
- * enum:
13579
- * - text
13580
- * - rule
13581
- * key:
13582
- * type: string
13583
- * label:
13584
- * oneOf:
13585
- * - type: string
13586
- * - type: object
13587
- * properties:
13588
- * default:
13589
- * type: string
13590
- * enUS:
13591
- * type: string
13592
- * deDE:
13593
- * type: string
13594
- * esES:
13595
- * type: string
13596
- * jaJP:
13597
- * type: string
13598
- * koKR:
13599
- * type: string
13600
- * defaultValue:
13601
- * description: The default value for that field
13602
- * previews:
13603
- * type: array
13604
- * items:
13605
- * type: object
13606
- * properties:
13607
- * type:
13608
- * type: string
13609
- * enum:
13610
- * - message
13611
- * - image
13612
- * - code
13613
- * key:
13614
- * type: string
13615
- * tokens:
13616
- * type: array
13617
- * items:
13618
- * type: object
13619
- * properties:
13620
- * label:
13621
- * type: string
13622
- * maxLength: 30
13623
- * example: word count
13624
- * script:
13625
- * type: string
13626
- * maxLength: 500
13627
- * example: ci.text.split(' ').length
13628
- * type:
13629
- * type: string
13630
- * enum:
13631
- * - profile
13632
- * - input
13633
- * - context
13634
- * - custom
13635
- * - answer
13636
- * - flow-output
13637
- * - flow-input
13638
- * example: input
13639
- * tags:
13562
+ * contactProfilesOption:
13640
13563
  * type: string
13641
13564
  * enum:
13642
- * - basic
13643
- * - logic
13644
- * - message
13645
- * - profile
13646
- * - service
13647
- * - nlu
13648
- * - data
13649
- * sections:
13650
- * type: array
13651
- * items:
13652
- * $ref: '#/components/schemas/INodeFieldCondition_2_0'
13653
- * form:
13565
+ * - "none"
13566
+ * - "selectedProfileFields"
13567
+ * - "completeProfile"
13568
+ * - "profileMemoriesOnly"
13569
+ * description: Option to enable or customize Contact profiles selection for the AI Agent.
13570
+ * example: "selectedProfileFields"
13571
+ * contactProfilesSelected:
13654
13572
  * type: array
13655
13573
  * items:
13656
- * $ref: '#/components/schemas/INodeFieldAndSectionFormElement_2_0'
13574
+ * type: string
13575
+ * description: Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
13576
+ * example: ["name", "email"]
13577
+ * instructions:
13578
+ * type: string
13579
+ * description: Instructions for the AI Agent.
13580
+ * example: "I can help you with your questions, provide information and much more."
13581
+ * maxLength: 1000
13582
+ * IAiAgent_2_0:
13583
+ * allOf:
13584
+ * - $ref: '#/components/schemas/IAiAgentData_2_0'
13585
+ * - $ref: '#/components/schemas/IEntityMeta'
13657
13586
  */
13658
- export interface INodeDescriptor_2_0 {
13659
- type: string;
13660
- parentType?: string;
13661
- defaultLabel: string | INodeFieldTranslations;
13662
- summary: string | INodeFieldTranslations;
13663
- extension: string;
13664
- extensionImg: string;
13665
- appearance: INodeAppearance_2_0;
13666
- behavior?: INodeBehavior_2_0;
13667
- constraints?: INodeConstraints_2_0;
13668
- dependencies?: INodeDependencies_2_0;
13669
- fields?: INodeField_2_0[];
13670
- preview?: INodePreview_2_0;
13671
- tags?: TNodeTag[];
13672
- tokens?: Omit<ISnippet, TReferenceAndEntityMetaKeys>[];
13673
- /** Sections which allow to group multiple fields */
13674
- sections?: INodeSection_2_0[];
13675
- /** The form defines how fields and sections should be render in order */
13676
- form?: INodeFieldAndSectionFormElement_2_0[];
13587
+ export interface IAiAgent_2_0 {
13588
+ _id: TMongoId;
13589
+ name: string;
13590
+ referenceId: string;
13591
+ image: string;
13592
+ imageOptimizedFormat: boolean;
13593
+ instructions: string;
13594
+ knowledgeReferenceId: string;
13595
+ description: string;
13596
+ speakingStyle: ISpeakingStyle;
13597
+ voiceConfigs: IVoiceConfigParams;
13598
+ enableVoiceConfigs: boolean;
13599
+ safetySettings: ISafetySettings;
13600
+ contactProfilesOption: TContactProfileOptions;
13601
+ contactProfilesSelected: string[];
13602
+ projectReference: TMongoId;
13603
+ organisationReference: TMongoId;
13604
+ createdAt: number;
13605
+ lastChanged: number;
13606
+ createdBy: TMongoId;
13607
+ lastChangedBy: TMongoId;
13677
13608
  }
13678
- export interface INodeBehavior_2_0 {
13679
- stopping: boolean;
13680
- entrypoint: boolean;
13609
+ export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
13681
13610
  }
13682
- export interface INodeAppearance_2_0 {
13683
- color?: string;
13684
- textColor?: string;
13685
- contrastTextColor?: string;
13686
- showIcon?: boolean;
13687
- variant?: "regular" | "mini" | "hexagon";
13611
+ export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
13688
13612
  }
13689
- export interface INodePreview_2_0 {
13690
- type: "text" | "sayNode" | "custom" | "resource" | "image";
13691
- key: string;
13613
+ export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
13692
13614
  }
13693
- export interface INodeConstraints_2_0 {
13694
- editable?: boolean;
13695
- deletable?: boolean;
13696
- creatable?: boolean;
13697
- collapsable?: boolean;
13698
- /** Should it be possible to create child flow from this node */
13699
- childFlowCreatable?: boolean;
13700
- movable?: boolean;
13701
- placement: {
13702
- predecessor?: INodeConstraint_2_0;
13703
- successor?: INodeConstraint_2_0;
13704
- children?: INodeConstraint_2_0;
13705
- };
13615
+ export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
13706
13616
  }
13707
- export interface INodeConstraint_2_0 {
13708
- /** A list of Node types */
13709
- whitelist?: string[];
13710
- /** A list of Node types */
13711
- blacklist?: string[];
13617
+ export interface IUpdateAiAgentRestDataParams_2_0 {
13618
+ aiAgentId: string;
13712
13619
  }
13713
- export interface INodeField_2_0 {
13714
- type: TNodeFieldType_2_0;
13715
- key: string;
13716
- label: string | INodeFieldTranslations;
13717
- condition?: TNodeFieldCondition;
13718
- defaultValue: any;
13719
- description?: string | INodeFieldTranslations;
13720
- params?: {
13721
- [key: string]: any;
13722
- };
13620
+ export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
13723
13621
  }
13724
- export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
13725
- 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";
13726
- export interface INodeDependencies_2_0 {
13727
- /** A list of Node types */
13728
- children: string[];
13622
+ export interface IUpdateAiAgentRestReturnValue_2_0 {
13729
13623
  }
13730
- /**
13731
- * @openapi
13732
- *
13733
- * components:
13734
- * schemas:
13735
- * INodeFieldCondition_2_0:
13736
- * type: object
13737
- * properties:
13738
- * key:
13739
- * type: string
13740
- * description: The key of the Field whose value should be matched
13741
- * value:
13742
- * description: The expected value(s) that make this condition match
13743
- * negate:
13744
- * type: boolean
13745
- * description: If this is true, the condition result will be inverted
13746
- */
13747
- export interface INodeFieldCondition_2_0 {
13748
- /** The key of the Field whose value should be matched */
13749
- key: string;
13750
- /** The expected value(s) that make this condition match */
13751
- value: (string | number | boolean) | (string | number | boolean)[];
13752
- /** If this is true, the condition result will be inverted */
13753
- negate?: boolean;
13624
+ export interface IReadAiAgentRestDataParams_2_0 {
13625
+ aiAgentId: string;
13626
+ }
13627
+ export interface IReadAiAgentRestData_2_0 extends IReadAiAgentRestDataParams_2_0 {
13628
+ }
13629
+ export interface IReadAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
13630
+ }
13631
+ export interface IIndexAiAgentsRestData_2_0 extends IRestPagination<IAiAgent_2_0>, IProjectScope {
13632
+ }
13633
+ export interface IIndexAiAgentsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAiAgent_2_0> {
13634
+ }
13635
+ export interface IDeleteAiAgentRestDataParams_2_0 {
13636
+ aiAgentId: string;
13637
+ }
13638
+ export interface IDeleteAiAgentRestData_2_0 extends IDeleteAiAgentRestDataParams_2_0 {
13639
+ }
13640
+ export interface IDeleteAiAgentRestReturnValue_2_0 {
13754
13641
  }
13755
13642
  /**
13756
13643
  * @openapi
13757
- *
13758
13644
  * components:
13759
13645
  * schemas:
13760
- * INodeSection_2_0:
13646
+ * IAiAgentHiringTemplate_2_0:
13761
13647
  * type: object
13762
13648
  * properties:
13763
- * key:
13649
+ * templateId:
13764
13650
  * type: string
13765
- * description: Unique identifier for this section within all sections of a descriptor, e.g. 'authentication
13766
- * label:
13767
- * oneOf:
13768
- * - type: string
13769
- * description: Condition whether this section should be rendered
13770
- * - type: object
13771
- * description: A localized Condition whether this section should be rendered
13772
- * properties:
13773
- * default:
13774
- * type: string
13775
- * enUS:
13776
- * type: string
13777
- * deDE:
13778
- * type: string
13779
- * esES:
13780
- * type: string
13781
- * jaJP:
13782
- * type: string
13783
- * koKR:
13784
- * type: string
13785
- * condition:
13786
- * $ref: '#/components/schemas/INodeFieldCondition_2_0'
13787
- * defaultCollapsed:
13788
- * type: boolean
13789
- * description: Whether the sections should be collapsed by default
13790
- * default: false
13791
- * fields:
13792
- * type: array
13793
- * items:
13794
- * type: string
13795
- * theme:
13651
+ * description: The ID of the AI Agent template to hire.
13652
+ * example: RetailAssistant-Rita
13653
+ * aiAgentName:
13796
13654
  * type: string
13797
- * description: Used to highlight sections if they contain new features
13798
- */
13799
- export interface INodeSection_2_0 {
13800
- /** Unique identifier for this section within all sections of a descriptor, e.g. 'authentication' */
13801
- key: string;
13802
- /** Human readable lable of the seciton, e.g. 'Authentication' */
13803
- label: string | INodeFieldTranslations;
13804
- /** Human readable description of the section, e.g. 'Configure authentication for this node' */
13805
- description?: string | INodeFieldTranslations;
13806
- /** Condition whether this section should be rendered */
13807
- condition?: INodeFieldCondition_2_0;
13808
- /** Whether the sections should be collapsed by default (default: false) */
13809
- defaultCollapsed: boolean;
13810
- /** The fields that should be grouped in this section, points to 'key' of node-fields */
13811
- fields: string[];
13812
- }
13813
- /**
13814
- * @openapi
13815
- *
13816
- * components:
13817
- * schemas:
13818
- * INodeFieldAndSectionFormElement_2_0:
13819
- * type: object
13820
- * properties:
13821
- * key:
13655
+ * description: The name of the AI Agent.
13656
+ * example: Rita
13657
+ * aiAgentFileName:
13822
13658
  * type: string
13823
- * description: A key either pointing to a 'field -> key' or 'section -> key'
13824
- * type:
13659
+ * description: The file name of the AI Agent.
13660
+ * example: Rita.tar
13661
+ * aiAgentImage:
13825
13662
  * type: string
13826
- * description: The type of the pointer, either 'field' or 'section'
13827
- * enum:
13828
- * - field
13829
- * - section
13830
- */
13831
- export interface INodeFieldAndSectionFormElement_2_0 {
13832
- /** A key either pointing to a 'field -> key' or 'section -> key' */
13833
- key: string;
13834
- /** The type of the pointer, either 'field' or 'section' */
13835
- type: "field" | "section";
13836
- }
13837
- export interface IIndexNodeDescriptorsRest_2_0 {
13838
- resourceId: string;
13839
- resourceType: TChartableResourceType;
13840
- }
13841
- export interface IIndexNodeDescriptorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<INodeDescriptor_2_0> {
13842
- }
13843
- export interface IOptionsResolverRestDataBody_2_0 extends IProjectScope {
13844
- fieldKey: string;
13845
- extension: string;
13846
- nodeType: string;
13847
- dependencies: {
13848
- [fieldKey: string]: any;
13849
- };
13850
- }
13851
- /**
13852
- * @openapi
13853
- * components:
13854
- * schemas:
13855
- * IOptionsResolverRestReturnValue_2_0:
13856
- * type: object
13857
- * properties:
13858
- * options:
13859
- * type: array
13860
- * items:
13861
- * type: object
13862
- * properties:
13863
- * label:
13864
- * type: string
13865
- * value:
13866
- * type: string
13867
- */
13868
- export interface IOptionsResolverReturnData {
13869
- label: string;
13870
- value: string;
13871
- }
13872
- export interface IOptionsResolverRestReturnValue_2_0 {
13873
- options: IOptionsResolverReturnData[];
13874
- }
13875
- /**
13876
- * @openapi
13877
- *
13878
- * components:
13879
- * schemas:
13880
- * ILearningSentenceIndexItem_2_0:
13881
- * type: object
13882
- * properties:
13883
- * _id:
13884
- * $ref: '#/components/schemas/TMongoId'
13885
- * count:
13886
- * type: integer
13887
- * example: 42
13888
- * sentence:
13663
+ * description: The image of the AI Agent.
13664
+ * example: https://cognigy.com/rita.png
13665
+ * aiAgentDescription:
13889
13666
  * type: string
13890
- * example: How do you turn this on?
13667
+ * description: A short description of the AI Agent, up to 1000 characters.
13668
+ * example: "I am a virtual assistant that can help you with your questions."
13669
+ *
13891
13670
  */
13892
- export interface ILearningSentenceIndexItem_2_0 {
13893
- _id: string;
13894
- confirmedCount: number;
13895
- rejectedCount: number;
13896
- sentence: string;
13897
- }
13898
- export interface IIndexLearningSentencesRestDataParams_2_0 {
13899
- flowId?: string;
13900
- flowReferenceId: string;
13901
- intentId: string;
13671
+ export interface IAiAgentHiringTemplate_2_0 {
13672
+ templateId: string;
13673
+ aiAgentName: string;
13674
+ aiAgentFileName: string;
13675
+ aiAgentImage: string;
13676
+ aiAgentDescription: string;
13902
13677
  }
13903
- export interface IIndexLearningSentencesRestData_2_0 extends IRestPagination<ILearningSentenceIndexItem_2_0>, IIndexLearningSentencesRestDataParams_2_0 {
13678
+ export interface IGetAiAgentHiringTemplatesRestData_2_0 {
13904
13679
  }
13905
- export interface IIndexLearningSentencesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILearningSentenceIndexItem_2_0> {
13680
+ export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
13681
+ templates: IAiAgentHiringTemplate_2_0[];
13906
13682
  }
13907
13683
  /**
13908
13684
  * @openapi
13909
- *
13910
13685
  * components:
13911
13686
  * schemas:
13912
- * ILearningSentenceData_2_0:
13687
+ * IAiAgentTemplateId_2_0:
13913
13688
  * type: object
13914
13689
  * properties:
13915
- * confirmationCount:
13916
- * type: integer
13917
- * example: 42
13918
- * rejectedCount:
13919
- * type: integer
13920
- * example: 42
13921
- * sentence:
13690
+ * templateId:
13922
13691
  * type: string
13923
- * example: How do you turn this on?
13924
- *
13925
- * ILearningSentence_2_0:
13926
- * allOf:
13927
- * - $ref: '#/components/schemas/ILearningSentenceData_2_0'
13928
- * - $ref: '#/components/schemas/IEntityMeta'
13692
+ * description: The ID of the AI Agent template to hire.
13693
+ * example: insurance-agent-olivia
13694
+ * overrideAiAgentReferenceId:
13695
+ * type: string
13696
+ * description: The reference ID of the AI Agent to override the AI Agent from the hired package.
13697
+ * example: 5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b
13929
13698
  */
13930
- export interface ILearningSentence_2_0 {
13931
- _id: string;
13932
- confirmedCount: number;
13933
- rejectedCount: number;
13934
- sentence: string;
13935
- createdAt: number;
13936
- lastChanged: number;
13937
- createdBy: TMongoId;
13938
- lastChangedBy: TMongoId;
13939
- }
13940
- export interface IReadLearningSentenceRestDataParams_2_0 {
13941
- flowReferenceId: string;
13942
- flowId?: string;
13943
- learningSentenceId: string;
13944
- }
13945
- export interface IReadLearningSentenceRestData_2_0 extends IReadLearningSentenceRestDataParams_2_0 {
13946
- }
13947
- export interface IReadLearningSentenceRestReturnValue_2_0 extends ILearningSentence_2_0 {
13948
- }
13949
- export interface IDeleteLearningSentenceRestDataParams_2_0 {
13950
- learningSentenceId: string;
13951
- flowId?: string;
13952
- flowReferenceId: string;
13953
- }
13954
- export interface IDeleteLearningSentenceRestData_2_0 extends IDeleteLearningSentenceRestDataParams_2_0 {
13955
- }
13956
- export interface IDeleteLearningSentenceRestReturnValue_2_0 {
13957
- }
13958
- export interface IReadAgentSettingsRestDataParams_2_0 extends IProjectScope {
13959
- }
13960
- export interface IReadAgentSettingsRestData_2_0 extends IReadAgentSettingsRestDataParams_2_0 {
13961
- }
13962
- export interface IReadAgentSettingsRestReturnValue_2_0 extends IAgentSettings_2_0 {
13963
- }
13964
- export interface IUpdateAgentSettingsRestDataBody_2_0 extends RecursivePartial<Omit<IAgentSettings_2_0, keyof IEntityMeta>> {
13965
- }
13966
- export interface IUpdateAgentSettingsRestDataParams_2_0 extends IProjectScope {
13967
- }
13968
- export interface IUpdateAgentSettingsRestData_2_0 extends IUpdateAgentSettingsRestDataBody_2_0, IUpdateAgentSettingsRestDataParams_2_0 {
13699
+ export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
13700
+ templateId: string;
13701
+ overrideAiAgentReferenceId?: string;
13969
13702
  }
13970
- export interface IUpdateAgentSettingsRestReturnValue_2_0 {
13703
+ export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
13971
13704
  }
13972
- export interface ISetupCognigyGenerativeAIRestDataParams_2_0 extends IProjectScope {
13705
+ export interface IHireAiAgentRestReturnValue_2_0 {
13973
13706
  }
13974
- export interface ISetupCognigyGenerativeAIRestData_2_0 extends ISetupCognigyGenerativeAIRestDataParams_2_0 {
13707
+ export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
13708
+ name: string;
13975
13709
  }
13976
- export interface ISetupCognigyGenerativeAIRestReturnValue_2_0 {
13710
+ export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
13977
13711
  }
13978
- /**
13979
- * @openapi
13980
- *
13981
- * components:
13982
- * schemas:
13983
- * ILocaleSettings_2_0:
13984
- * type: object
13985
- * properties:
13986
- * localeReference:
13987
- * $ref: '#/components/schemas/TMongoId'
13988
- * inheritFallbackLocaleModel:
13989
- * type: boolean
13990
- */
13991
- export interface ILocaleSettings_2_0 {
13992
- localeReference: string;
13993
- inheritFallbackLocaleModel: boolean;
13712
+ export interface IValidateAiAgentNameRestReturnValue_2_0 {
13994
13713
  }
13995
13714
  /**
13996
13715
  * @openapi
13997
13716
  *
13998
13717
  * components:
13999
13718
  * schemas:
14000
- * IFlowSettingsData_2_0:
13719
+ * INodeDescriptor_2_0:
14001
13720
  * type: object
14002
13721
  * properties:
14003
- * continueExecutionAfterAttachedFlow:
14004
- * type: boolean
14005
- * continueExecutionAterDefaultReply:
14006
- * type: boolean
14007
- * continueExecutionAfterNegativeConfirmation:
14008
- * type: boolean
14009
- * passDefaultRepliesIntoFlow:
14010
- * type: boolean
14011
- * flowIntentMappingOrder:
13722
+ * type:
14012
13723
  * type: string
14013
- * enum: ["joint", "main", "attached"]
14014
- * useAttachedFlowThresholds:
14015
- * type: boolean
14016
- * useAttachedFlowContinueAfterDefaultReply:
14017
- * type: boolean
14018
- * useAttachedFlowPassDefaultRepliesIntoFlow:
14019
- * type: boolean
14020
- * implicitSlotParsing:
13724
+ * parentType:
13725
+ * type: string
13726
+ * description: The type of the node parent, if there is one
13727
+ * defaultLabel:
13728
+ * oneOf:
13729
+ * - type: string
13730
+ * description: The label that should be used when a new Node of this type is created
13731
+ * - type: object
13732
+ * description: A localized version of the label that should be used when a new Node of this type is created
13733
+ * properties:
13734
+ * default:
13735
+ * type: string
13736
+ * enUS:
13737
+ * type: string
13738
+ * deDE:
13739
+ * type: string
13740
+ * esES:
13741
+ * type: string
13742
+ * jaJP:
13743
+ * type: string
13744
+ * koKR:
13745
+ * type: string
13746
+ * summary:
13747
+ * oneOf:
13748
+ * - type: string
13749
+ * description: A short line of text that describes what this Node is used for
13750
+ * - type: object
13751
+ * description: A localized version of a short line of text that describes what this Node is used for
13752
+ * properties:
13753
+ * default:
13754
+ * type: string
13755
+ * enUS:
13756
+ * type: string
13757
+ * deDE:
13758
+ * type: string
13759
+ * esES:
13760
+ * type: string
13761
+ * jaJP:
13762
+ * type: string
13763
+ * koKR:
13764
+ * type: string
13765
+ * extension:
13766
+ * type: string
13767
+ * extensionImg:
13768
+ * type: string
13769
+ * appearance:
13770
+ * type: object
13771
+ * properties:
13772
+ * logo:
13773
+ * type: string
13774
+ * textColor:
13775
+ * type: string
13776
+ * example: blue
13777
+ * oneOf:
13778
+ * - $ref: '#/components/schemas/TCSSColorName'
13779
+ * - $ref: '#/components/schemas/TCognigyColorName'
13780
+ * contrastTextColor:
13781
+ * type: string
13782
+ * example: blue
13783
+ * oneOf:
13784
+ * - $ref: '#/components/schemas/TCSSColorName'
13785
+ * - $ref: '#/components/schemas/TCognigyColorName'
13786
+ * color:
13787
+ * type: string
13788
+ * example: red
13789
+ * oneOf:
13790
+ * - $ref: '#/components/schemas/TCSSColorName'
13791
+ * - $ref: '#/components/schemas/TCognigyColorName'
13792
+ * variant:
13793
+ * type: string
13794
+ * enum:
13795
+ * - regular
13796
+ * - mini
13797
+ * - hexagon
13798
+ * behavior:
13799
+ * type: object
13800
+ * properties:
13801
+ * stopping:
13802
+ * type: boolean
13803
+ * entrypoint:
13804
+ * type: boolean
13805
+ * constraints:
13806
+ * type: object
13807
+ * properties:
13808
+ * editable:
13809
+ * type: boolean
13810
+ * description: Should this node be editable
13811
+ * deletable:
13812
+ * type: boolean
13813
+ * description: Should this node be deletable
13814
+ * creatable:
13815
+ * type: boolean
13816
+ * description: Should this node be manually creatable
13817
+ * collapsable:
13818
+ * type: boolean
13819
+ * description: Should this node be collapsable
13820
+ * childFlowCreatable:
13821
+ * type: boolean
13822
+ * description: Should it be possible to create child flow from this node
13823
+ * movable:
13824
+ * type: boolean
13825
+ * description: Should this node be movable
13826
+ * placement:
13827
+ * type: object
13828
+ * description: Additional placement information
13829
+ * properties:
13830
+ * predecessor:
13831
+ * type: object
13832
+ * properties:
13833
+ * whitelist:
13834
+ * items:
13835
+ * type: string
13836
+ * blacklist:
13837
+ * items:
13838
+ * type: string
13839
+ * successor:
13840
+ * type: object
13841
+ * properties:
13842
+ * whitelist:
13843
+ * items:
13844
+ * type: string
13845
+ * blacklist:
13846
+ * items:
13847
+ * type: string
13848
+ * children:
13849
+ * type: object
13850
+ * properties:
13851
+ * whitelist:
13852
+ * items:
13853
+ * type: string
13854
+ * blacklist:
13855
+ * items:
13856
+ * type: string
13857
+ * dependencies:
13858
+ * type: object
13859
+ * properties:
13860
+ * children:
13861
+ * type: array
13862
+ * items:
13863
+ * type: string
13864
+ * fields:
13865
+ * type: array
13866
+ * items:
13867
+ * type: object
13868
+ * properties:
13869
+ * type:
13870
+ * type: string
13871
+ * enum:
13872
+ * - text
13873
+ * - rule
13874
+ * key:
13875
+ * type: string
13876
+ * label:
13877
+ * oneOf:
13878
+ * - type: string
13879
+ * - type: object
13880
+ * properties:
13881
+ * default:
13882
+ * type: string
13883
+ * enUS:
13884
+ * type: string
13885
+ * deDE:
13886
+ * type: string
13887
+ * esES:
13888
+ * type: string
13889
+ * jaJP:
13890
+ * type: string
13891
+ * koKR:
13892
+ * type: string
13893
+ * defaultValue:
13894
+ * description: The default value for that field
13895
+ * previews:
13896
+ * type: array
13897
+ * items:
13898
+ * type: object
13899
+ * properties:
13900
+ * type:
13901
+ * type: string
13902
+ * enum:
13903
+ * - message
13904
+ * - image
13905
+ * - code
13906
+ * key:
13907
+ * type: string
13908
+ * tokens:
13909
+ * type: array
13910
+ * items:
13911
+ * type: object
13912
+ * properties:
13913
+ * label:
13914
+ * type: string
13915
+ * maxLength: 30
13916
+ * example: word count
13917
+ * script:
13918
+ * type: string
13919
+ * maxLength: 500
13920
+ * example: ci.text.split(' ').length
13921
+ * type:
13922
+ * type: string
13923
+ * enum:
13924
+ * - profile
13925
+ * - input
13926
+ * - context
13927
+ * - custom
13928
+ * - answer
13929
+ * - flow-output
13930
+ * - flow-input
13931
+ * example: input
13932
+ * tags:
13933
+ * type: string
13934
+ * enum:
13935
+ * - basic
13936
+ * - logic
13937
+ * - message
13938
+ * - profile
13939
+ * - service
13940
+ * - nlu
13941
+ * - data
13942
+ * sections:
13943
+ * type: array
13944
+ * items:
13945
+ * $ref: '#/components/schemas/INodeFieldCondition_2_0'
13946
+ * form:
13947
+ * type: array
13948
+ * items:
13949
+ * $ref: '#/components/schemas/INodeFieldAndSectionFormElement_2_0'
13950
+ */
13951
+ export interface INodeDescriptor_2_0 {
13952
+ type: string;
13953
+ parentType?: string;
13954
+ defaultLabel: string | INodeFieldTranslations;
13955
+ summary: string | INodeFieldTranslations;
13956
+ extension: string;
13957
+ extensionImg: string;
13958
+ appearance: INodeAppearance_2_0;
13959
+ behavior?: INodeBehavior_2_0;
13960
+ constraints?: INodeConstraints_2_0;
13961
+ dependencies?: INodeDependencies_2_0;
13962
+ fields?: INodeField_2_0[];
13963
+ preview?: INodePreview_2_0;
13964
+ tags?: TNodeTag[];
13965
+ tokens?: Omit<ISnippet, TReferenceAndEntityMetaKeys>[];
13966
+ /** Sections which allow to group multiple fields */
13967
+ sections?: INodeSection_2_0[];
13968
+ /** The form defines how fields and sections should be render in order */
13969
+ form?: INodeFieldAndSectionFormElement_2_0[];
13970
+ }
13971
+ export interface INodeBehavior_2_0 {
13972
+ stopping: boolean;
13973
+ entrypoint: boolean;
13974
+ }
13975
+ export interface INodeAppearance_2_0 {
13976
+ color?: string;
13977
+ textColor?: string;
13978
+ contrastTextColor?: string;
13979
+ showIcon?: boolean;
13980
+ variant?: "regular" | "mini" | "hexagon";
13981
+ }
13982
+ export interface INodePreview_2_0 {
13983
+ type: "text" | "sayNode" | "custom" | "resource" | "image";
13984
+ key: string;
13985
+ }
13986
+ export interface INodeConstraints_2_0 {
13987
+ editable?: boolean;
13988
+ deletable?: boolean;
13989
+ creatable?: boolean;
13990
+ collapsable?: boolean;
13991
+ /** Should it be possible to create child flow from this node */
13992
+ childFlowCreatable?: boolean;
13993
+ movable?: boolean;
13994
+ placement: {
13995
+ predecessor?: INodeConstraint_2_0;
13996
+ successor?: INodeConstraint_2_0;
13997
+ children?: INodeConstraint_2_0;
13998
+ };
13999
+ }
14000
+ export interface INodeConstraint_2_0 {
14001
+ /** A list of Node types */
14002
+ whitelist?: string[];
14003
+ /** A list of Node types */
14004
+ blacklist?: string[];
14005
+ }
14006
+ export interface INodeField_2_0 {
14007
+ type: TNodeFieldType_2_0;
14008
+ key: string;
14009
+ label: string | INodeFieldTranslations;
14010
+ condition?: TNodeFieldCondition;
14011
+ defaultValue: any;
14012
+ description?: string | INodeFieldTranslations;
14013
+ params?: {
14014
+ [key: string]: any;
14015
+ };
14016
+ }
14017
+ export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
14018
+ 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";
14019
+ export interface INodeDependencies_2_0 {
14020
+ /** A list of Node types */
14021
+ children: string[];
14022
+ }
14023
+ /**
14024
+ * @openapi
14025
+ *
14026
+ * components:
14027
+ * schemas:
14028
+ * INodeFieldCondition_2_0:
14029
+ * type: object
14030
+ * properties:
14031
+ * key:
14032
+ * type: string
14033
+ * description: The key of the Field whose value should be matched
14034
+ * value:
14035
+ * description: The expected value(s) that make this condition match
14036
+ * negate:
14037
+ * type: boolean
14038
+ * description: If this is true, the condition result will be inverted
14039
+ */
14040
+ export interface INodeFieldCondition_2_0 {
14041
+ /** The key of the Field whose value should be matched */
14042
+ key: string;
14043
+ /** The expected value(s) that make this condition match */
14044
+ value: (string | number | boolean) | (string | number | boolean)[];
14045
+ /** If this is true, the condition result will be inverted */
14046
+ negate?: boolean;
14047
+ }
14048
+ /**
14049
+ * @openapi
14050
+ *
14051
+ * components:
14052
+ * schemas:
14053
+ * INodeSection_2_0:
14054
+ * type: object
14055
+ * properties:
14056
+ * key:
14057
+ * type: string
14058
+ * description: Unique identifier for this section within all sections of a descriptor, e.g. 'authentication
14059
+ * label:
14060
+ * oneOf:
14061
+ * - type: string
14062
+ * description: Condition whether this section should be rendered
14063
+ * - type: object
14064
+ * description: A localized Condition whether this section should be rendered
14065
+ * properties:
14066
+ * default:
14067
+ * type: string
14068
+ * enUS:
14069
+ * type: string
14070
+ * deDE:
14071
+ * type: string
14072
+ * esES:
14073
+ * type: string
14074
+ * jaJP:
14075
+ * type: string
14076
+ * koKR:
14077
+ * type: string
14078
+ * condition:
14079
+ * $ref: '#/components/schemas/INodeFieldCondition_2_0'
14080
+ * defaultCollapsed:
14081
+ * type: boolean
14082
+ * description: Whether the sections should be collapsed by default
14083
+ * default: false
14084
+ * fields:
14085
+ * type: array
14086
+ * items:
14087
+ * type: string
14088
+ * theme:
14089
+ * type: string
14090
+ * description: Used to highlight sections if they contain new features
14091
+ */
14092
+ export interface INodeSection_2_0 {
14093
+ /** Unique identifier for this section within all sections of a descriptor, e.g. 'authentication' */
14094
+ key: string;
14095
+ /** Human readable lable of the seciton, e.g. 'Authentication' */
14096
+ label: string | INodeFieldTranslations;
14097
+ /** Human readable description of the section, e.g. 'Configure authentication for this node' */
14098
+ description?: string | INodeFieldTranslations;
14099
+ /** Condition whether this section should be rendered */
14100
+ condition?: INodeFieldCondition_2_0;
14101
+ /** Whether the sections should be collapsed by default (default: false) */
14102
+ defaultCollapsed: boolean;
14103
+ /** The fields that should be grouped in this section, points to 'key' of node-fields */
14104
+ fields: string[];
14105
+ }
14106
+ /**
14107
+ * @openapi
14108
+ *
14109
+ * components:
14110
+ * schemas:
14111
+ * INodeFieldAndSectionFormElement_2_0:
14112
+ * type: object
14113
+ * properties:
14114
+ * key:
14115
+ * type: string
14116
+ * description: A key either pointing to a 'field -> key' or 'section -> key'
14117
+ * type:
14118
+ * type: string
14119
+ * description: The type of the pointer, either 'field' or 'section'
14120
+ * enum:
14121
+ * - field
14122
+ * - section
14123
+ */
14124
+ export interface INodeFieldAndSectionFormElement_2_0 {
14125
+ /** A key either pointing to a 'field -> key' or 'section -> key' */
14126
+ key: string;
14127
+ /** The type of the pointer, either 'field' or 'section' */
14128
+ type: "field" | "section";
14129
+ }
14130
+ export interface IIndexNodeDescriptorsRest_2_0 {
14131
+ resourceId: string;
14132
+ resourceType: TChartableResourceType;
14133
+ }
14134
+ export interface IIndexNodeDescriptorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<INodeDescriptor_2_0> {
14135
+ }
14136
+ export interface IOptionsResolverRestDataBody_2_0 extends IProjectScope {
14137
+ fieldKey: string;
14138
+ extension: string;
14139
+ nodeType: string;
14140
+ dependencies: {
14141
+ [fieldKey: string]: any;
14142
+ };
14143
+ }
14144
+ /**
14145
+ * @openapi
14146
+ * components:
14147
+ * schemas:
14148
+ * IOptionsResolverRestReturnValue_2_0:
14149
+ * type: object
14150
+ * properties:
14151
+ * options:
14152
+ * type: array
14153
+ * items:
14154
+ * type: object
14155
+ * properties:
14156
+ * label:
14157
+ * type: string
14158
+ * value:
14159
+ * type: string
14160
+ */
14161
+ export interface IOptionsResolverReturnData {
14162
+ label: string;
14163
+ value: string;
14164
+ }
14165
+ export interface IOptionsResolverRestReturnValue_2_0 {
14166
+ options: IOptionsResolverReturnData[];
14167
+ }
14168
+ /**
14169
+ * @openapi
14170
+ *
14171
+ * components:
14172
+ * schemas:
14173
+ * ILearningSentenceIndexItem_2_0:
14174
+ * type: object
14175
+ * properties:
14176
+ * _id:
14177
+ * $ref: '#/components/schemas/TMongoId'
14178
+ * count:
14179
+ * type: integer
14180
+ * example: 42
14181
+ * sentence:
14182
+ * type: string
14183
+ * example: How do you turn this on?
14184
+ */
14185
+ export interface ILearningSentenceIndexItem_2_0 {
14186
+ _id: string;
14187
+ confirmedCount: number;
14188
+ rejectedCount: number;
14189
+ sentence: string;
14190
+ }
14191
+ export interface IIndexLearningSentencesRestDataParams_2_0 {
14192
+ flowId?: string;
14193
+ flowReferenceId: string;
14194
+ intentId: string;
14195
+ }
14196
+ export interface IIndexLearningSentencesRestData_2_0 extends IRestPagination<ILearningSentenceIndexItem_2_0>, IIndexLearningSentencesRestDataParams_2_0 {
14197
+ }
14198
+ export interface IIndexLearningSentencesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILearningSentenceIndexItem_2_0> {
14199
+ }
14200
+ /**
14201
+ * @openapi
14202
+ *
14203
+ * components:
14204
+ * schemas:
14205
+ * ILearningSentenceData_2_0:
14206
+ * type: object
14207
+ * properties:
14208
+ * confirmationCount:
14209
+ * type: integer
14210
+ * example: 42
14211
+ * rejectedCount:
14212
+ * type: integer
14213
+ * example: 42
14214
+ * sentence:
14215
+ * type: string
14216
+ * example: How do you turn this on?
14217
+ *
14218
+ * ILearningSentence_2_0:
14219
+ * allOf:
14220
+ * - $ref: '#/components/schemas/ILearningSentenceData_2_0'
14221
+ * - $ref: '#/components/schemas/IEntityMeta'
14222
+ */
14223
+ export interface ILearningSentence_2_0 {
14224
+ _id: string;
14225
+ confirmedCount: number;
14226
+ rejectedCount: number;
14227
+ sentence: string;
14228
+ createdAt: number;
14229
+ lastChanged: number;
14230
+ createdBy: TMongoId;
14231
+ lastChangedBy: TMongoId;
14232
+ }
14233
+ export interface IReadLearningSentenceRestDataParams_2_0 {
14234
+ flowReferenceId: string;
14235
+ flowId?: string;
14236
+ learningSentenceId: string;
14237
+ }
14238
+ export interface IReadLearningSentenceRestData_2_0 extends IReadLearningSentenceRestDataParams_2_0 {
14239
+ }
14240
+ export interface IReadLearningSentenceRestReturnValue_2_0 extends ILearningSentence_2_0 {
14241
+ }
14242
+ export interface IDeleteLearningSentenceRestDataParams_2_0 {
14243
+ learningSentenceId: string;
14244
+ flowId?: string;
14245
+ flowReferenceId: string;
14246
+ }
14247
+ export interface IDeleteLearningSentenceRestData_2_0 extends IDeleteLearningSentenceRestDataParams_2_0 {
14248
+ }
14249
+ export interface IDeleteLearningSentenceRestReturnValue_2_0 {
14250
+ }
14251
+ export interface IReadAgentSettingsRestDataParams_2_0 extends IProjectScope {
14252
+ }
14253
+ export interface IReadAgentSettingsRestData_2_0 extends IReadAgentSettingsRestDataParams_2_0 {
14254
+ }
14255
+ export interface IReadAgentSettingsRestReturnValue_2_0 extends IAgentSettings_2_0 {
14256
+ }
14257
+ export interface IUpdateAgentSettingsRestDataBody_2_0 extends RecursivePartial<Omit<IAgentSettings_2_0, keyof IEntityMeta>> {
14258
+ }
14259
+ export interface IUpdateAgentSettingsRestDataParams_2_0 extends IProjectScope {
14260
+ }
14261
+ export interface IUpdateAgentSettingsRestData_2_0 extends IUpdateAgentSettingsRestDataBody_2_0, IUpdateAgentSettingsRestDataParams_2_0 {
14262
+ }
14263
+ export interface IUpdateAgentSettingsRestReturnValue_2_0 {
14264
+ }
14265
+ export interface ISetupCognigyGenerativeAIRestDataParams_2_0 extends IProjectScope {
14266
+ }
14267
+ export interface ISetupCognigyGenerativeAIRestData_2_0 extends ISetupCognigyGenerativeAIRestDataParams_2_0 {
14268
+ }
14269
+ export interface ISetupCognigyGenerativeAIRestReturnValue_2_0 {
14270
+ }
14271
+ /**
14272
+ * @openapi
14273
+ *
14274
+ * components:
14275
+ * schemas:
14276
+ * ILocaleSettings_2_0:
14277
+ * type: object
14278
+ * properties:
14279
+ * localeReference:
14280
+ * $ref: '#/components/schemas/TMongoId'
14281
+ * inheritFallbackLocaleModel:
14282
+ * type: boolean
14283
+ */
14284
+ export interface ILocaleSettings_2_0 {
14285
+ localeReference: string;
14286
+ inheritFallbackLocaleModel: boolean;
14287
+ }
14288
+ /**
14289
+ * @openapi
14290
+ *
14291
+ * components:
14292
+ * schemas:
14293
+ * IFlowSettingsData_2_0:
14294
+ * type: object
14295
+ * properties:
14296
+ * continueExecutionAfterAttachedFlow:
14297
+ * type: boolean
14298
+ * continueExecutionAterDefaultReply:
14299
+ * type: boolean
14300
+ * continueExecutionAfterNegativeConfirmation:
14301
+ * type: boolean
14302
+ * passDefaultRepliesIntoFlow:
14303
+ * type: boolean
14304
+ * flowIntentMappingOrder:
14305
+ * type: string
14306
+ * enum: ["joint", "main", "attached"]
14307
+ * useAttachedFlowThresholds:
14308
+ * type: boolean
14309
+ * useAttachedFlowContinueAfterDefaultReply:
14310
+ * type: boolean
14311
+ * useAttachedFlowPassDefaultRepliesIntoFlow:
14312
+ * type: boolean
14313
+ * implicitSlotParsing:
14021
14314
  * type: string
14022
14315
  * enum: ["disabled", "full", "system", "lexicon"]
14023
14316
  * useAttachedFlowImplicitSlotParsing:
@@ -16006,13 +16299,6 @@ export interface IComposePackageDownloadLinkRestData_2_0 extends IComposePackage
16006
16299
  export interface IComposePackageDownloadLinkRestReturnValue_2_0 {
16007
16300
  downloadLink: string;
16008
16301
  }
16009
- export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
16010
- export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
16011
- export declare type TSQL_EXTENSION = "@cognigy/mssql";
16012
- export declare type TSMTP_EXTENSION = "@cognigy/smtp";
16013
- export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
16014
- export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
16015
- export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
16016
16302
  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">> {
16017
16303
  type: T;
16018
16304
  extension?: E;
@@ -16358,6 +16644,7 @@ export interface ITrackGoalNodeParams extends INodeFunctionBaseParams {
16358
16644
  goal: {
16359
16645
  goalId: string;
16360
16646
  name: string;
16647
+ referenceId: string;
16361
16648
  version: string;
16362
16649
  selectedSteps: {
16363
16650
  stepId: string;
@@ -16835,6 +17122,7 @@ export interface ICognigyBasicNodes {
16835
17122
  sendMetadata: ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TBASIC_EXTENSION>;
16836
17123
  assistInfo: ICreateChartNodeBasicNodesData<"assistInfo", IAssistInfoNodeParams, TBASIC_EXTENSION>;
16837
17124
  searchExtractOutput: ICreateChartNodeBasicNodesData<"searchExtractOutput", ISearchExtractOutputNodeParams, TBASIC_EXTENSION>;
17125
+ extractAiAgent: ICreateChartNodeBasicNodesData<"extractAiAgent", ILoadAiAgentNodeParams, TBASIC_EXTENSION>;
16838
17126
  }
16839
17127
  export interface ICognigyNodes {
16840
17128
  "@cognigy/basic-nodes": ICognigyBasicNodes;
@@ -16952,1003 +17240,702 @@ export interface IVoicePrepareCall_2_0 {
16952
17240
  language: string;
16953
17241
  voice: string;
16954
17242
  }
16955
- export interface IVoicePrepareCallRestDataBody_2_0 extends IProjectScope, IVoicePrepareCall_2_0 {
16956
- }
16957
- export interface IVoicePrepareCallRestData_2_0 extends IVoicePrepareCallRestDataBody_2_0 {
16958
- }
16959
- export interface IVoicePrepareCallRestReturnValue_2_0 extends IVGCallSettings_2_0 {
16960
- }
16961
- /**
16962
- * @openapi
16963
- *
16964
- * components:
16965
- * schemas:
16966
- * ITestVoiceProvider_2_0:
16967
- * type: object
16968
- * properties:
16969
- * voiceProvider:
16970
- * type: string
16971
- * isCredentialsValid:
16972
- * type: boolean
16973
- * msg:
16974
- * type: string
16975
- * msgErr:
16976
- * type: string
16977
- *
16978
- */
16979
- export interface ITestVoiceProvider_2_0 {
16980
- voiceProvider: TAudioPreviewProvider;
16981
- isCredentialsValid: boolean;
16982
- msg: string;
16983
- msgErr?: string;
16984
- }
16985
- export interface ITestVoiceProviderRestDataBody_2_0 extends Partial<IProjectScope> {
16986
- }
16987
- export interface ITestVoiceProviderRestData_2_0 extends ITestVoiceProviderRestDataBody_2_0 {
16988
- }
16989
- export interface ITestVoiceProviderRestReturnValue_2_0 extends ITestVoiceProvider_2_0 {
16990
- }
16991
- /**
16992
- * @openapi
16993
- *
16994
- * components:
16995
- * schemas:
16996
- * ITestTranslationSettings_2_0:
16997
- * type: object
16998
- * properties:
16999
- * language:
17000
- * type: string
17001
- * error:
17002
- * type: object
17003
- * msg:
17004
- * type: string
17005
- *
17006
- */
17007
- export interface ITestTranslationSettings_2_0 {
17008
- language: string;
17009
- error?: InternalServerError;
17010
- msg: string;
17011
- }
17012
- export interface ITestTranslationSettingsRestDataBody_2_0 extends Partial<IProjectScope> {
17013
- }
17014
- export interface ITestTranslationSettingsRestData_2_0 extends ITestTranslationSettingsRestDataBody_2_0 {
17015
- }
17016
- export interface ITestTranslationSettingsRestReturnValue_2_0 extends ITestTranslationSettings_2_0 {
17017
- }
17018
- export interface ICreateYesNoSentenceRestDataBody_2_0 extends Partial<Omit<ISentence_2_0, TReferenceAndEntityMetaKeys | "feedbackReport" | "slots">> {
17019
- }
17020
- export interface ICreateYesNoSentenceRestDataParams_2_0 {
17021
- localeId: string;
17022
- intentId: string;
17023
- }
17024
- export interface ICreateYesNoSentenceRestData_2_0 extends ICreateYesNoSentenceRestDataBody_2_0, ICreateYesNoSentenceRestDataParams_2_0 {
17025
- }
17026
- export interface ICreateYesNoSentenceRestReturnValue_2_0 extends Omit<ISentence_2_0, "feedbackReport"> {
17027
- }
17028
- export interface IDeleteYesNoSentenceRestDataParams_2_0 {
17029
- localeId: string;
17030
- intentId: string;
17031
- sentenceId: string;
17032
- }
17033
- export interface IDeleteYesNoSentenceRestData_2_0 extends IDeleteYesNoSentenceRestDataParams_2_0 {
17034
- }
17035
- export interface IDeleteYesNoSentenceRestReturnValue_2_0 {
17036
- }
17037
- export interface IUpdateYesNoSentenceRestBody_2_0 extends Omit<ISentence_2_0, TReferenceAndEntityMetaKeys | "feedbackReport"> {
17038
- }
17039
- export interface IUpdateYesNoSentenceRestParams_2_0 {
17040
- localeId: string;
17041
- intentId: string;
17042
- sentenceId: string;
17043
- }
17044
- export interface IUpdateYesNoSentenceRestData_2_0 extends IUpdateYesNoSentenceRestParams_2_0, IUpdateYesNoSentenceRestBody_2_0 {
17045
- }
17046
- export interface IUpdateYesNoSentenceRestReturnValue_2_0 {
17047
- }
17048
- export interface IIndexYesNoSentencesRestDataParams_2_0 {
17049
- localeId: string;
17050
- intentId: string;
17051
- }
17052
- export interface IIndexYesNoSentencesRestData_2_0 extends IRestPagination<ISentenceIndexItem_2_0>, IIndexYesNoSentencesRestDataParams_2_0 {
17053
- }
17054
- export interface IIndexYesNoSentencesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ISentenceIndexItem_2_0> {
17055
- }
17056
- /**
17057
- * @openapi
17058
- *
17059
- * components:
17060
- * schemas:
17061
- * IAgentAssistGridConfig_2_0:
17062
- * type: object
17063
- * properties:
17064
- * grid:
17065
- * type: object
17066
- * properties:
17067
- * columns:
17068
- * type: number
17069
- * description: Number of columns in the grid.
17070
- * rows:
17071
- * type: number
17072
- * description: Number of rows in the grid.
17073
- * gap:
17074
- * type: number
17075
- * description: Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used.
17076
- * tiles:
17077
- * type: object
17078
- * properties:
17079
- * tile-id:
17080
- * type: object
17081
- * description: The Tile ID is used in the Flow Nodes to fill in this specific tile.
17082
- * properties:
17083
- * x:
17084
- * type: number
17085
- * description: The row number where the tile is located, starting from 1.
17086
- * y:
17087
- * type: number
17088
- * description: The column number where the tile is located, starting from 1.
17089
- * columns:
17090
- * type: number
17091
- * description: The number of columns the tile should occupy. The default value is 1.
17092
- * rows:
17093
- * type: number
17094
- * description: The number of rows the tile should occupy. The default value is 1.
17095
- *
17096
- * IAgentAssistConfigData_2_0:
17097
- * type: object
17098
- * properties:
17099
- * name:
17100
- * type: string
17101
- * description: The human readable name of the config.
17102
- * description:
17103
- * type: string
17104
- * description: The description which can be used to understand what the agent assist config contains in terms of tiles.
17105
- * config:
17106
- * type: object
17107
- * description: The actual grid-config.
17108
- * $ref: '#/components/schemas/IAgentAssistGridConfig_2_0'
17109
- *
17110
- * IAgentAssistConfigGeneratedData_2_0:
17111
- * type: object
17112
- * properties:
17113
- * referenceId:
17114
- * type: string
17115
- * format: uuid
17116
- *
17117
- * IAgentAssistConfig_2_0:
17118
- * allOf:
17119
- * - $ref: '#/components/schemas/IAgentAssistConfigData_2_0'
17120
- * - $ref: '#/components/schemas/IAgentAssistConfigGeneratedData_2_0'
17121
- * - $ref: '#/components/schemas/IEntityMeta'
17122
- */
17123
- export interface IAgentAssistConfig_2_0 {
17124
- _id: TMongoId;
17125
- name: string;
17126
- description: string;
17127
- config: IAgentAssistGridConfig;
17128
- referenceId: string;
17129
- projectReference: string;
17130
- organisationReference: string;
17131
- createdAt: number;
17132
- lastChanged: number;
17133
- createdBy: TMongoId;
17134
- lastChangedBy: TMongoId;
17135
- }
17136
- export interface ICreateAgentAssistConfigRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAgentAssistConfig_2_0, keyof IEntityMeta>> {
17137
- }
17138
- export interface ICreateAgentAssistConfigRestData_2_0 extends ICreateAgentAssistConfigRestDataBody_2_0 {
17139
- }
17140
- export interface ICreateAgentAssistConfigRestReturnValue_2_0 extends IAgentAssistConfig_2_0 {
17141
- }
17142
- export interface IUpdateAgentAssistConfigRestDataBody_2_0 extends Partial<Pick<IAgentAssistConfig_2_0, "name" | "description" | "config">> {
17143
- }
17144
- export interface IUpdateAgentAssistConfigRestDataParams_2_0 {
17145
- configId: string;
17146
- }
17147
- export interface IUpdateAgentAssistConfigRestData_2_0 extends IUpdateAgentAssistConfigRestDataBody_2_0, IUpdateAgentAssistConfigRestDataParams_2_0 {
17148
- }
17149
- export interface IUpdateAgentAssistConfigRestReturnValue_2_0 {
17150
- }
17151
- export interface IReadAgentAssistConfigRestDataParams_2_0 {
17152
- configId: string;
17153
- projectId?: string;
17154
- organisationId?: string;
17155
- }
17156
- export interface IReadAgentAssistConfigRestData_2_0 extends IReadAgentAssistConfigRestDataParams_2_0 {
17157
- }
17158
- export interface IReadAgentAssistConfigRestReturnValue_2_0 extends IAgentAssistConfig_2_0 {
17159
- }
17160
- export interface IDeleteAgentAssistConfigRestDataParams_2_0 {
17161
- configId: string;
17162
- }
17163
- export interface IDeleteAgentAssistConfigRestData_2_0 extends IDeleteAgentAssistConfigRestDataParams_2_0 {
17164
- }
17165
- export interface IDeleteAgentAssistConfigRestReturnValue_2_0 {
17166
- }
17167
- export interface IIndexAgentAssistConfigsRestData_2_0 extends IRestPagination<IAgentAssistConfig_2_0>, IProjectScope {
17168
- }
17169
- export interface IIndexAgentAssistConfigsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAgentAssistConfig_2_0> {
17170
- }
17171
- export interface IOpenAIMeta_2_0 {
17172
- customModel?: string;
17173
- baseCustomUrl?: string;
17174
- }
17175
- export interface IOpenAICompatibleMeta_2_0 {
17176
- customModel: string;
17177
- baseCustomUrl: string;
17178
- customAuthHeader?: string;
17179
- }
17180
- export interface IAnthropicMeta_2_0 {
17181
- customModel?: string;
17182
- }
17183
- export interface IAwsBedrockMeta_2_0 {
17184
- region: string;
17185
- customModel?: string;
17186
- }
17187
- export interface IAlephAlphaMeta_2_0 {
17188
- customModel?: string;
17189
- baseCustomUrl?: string;
17190
- }
17191
- export interface IAzureOpenAIMeta_2_0 {
17192
- resourceName?: string;
17193
- deploymentName?: string;
17194
- baseCustomUrl?: string | null;
17195
- apiVersion?: string;
17243
+ export interface IVoicePrepareCallRestDataBody_2_0 extends IProjectScope, IVoicePrepareCall_2_0 {
17196
17244
  }
17197
- export interface IGoogleVertexAIMeta_2_0 {
17198
- location: string;
17199
- apiEndPoint: string;
17200
- publisher?: string;
17245
+ export interface IVoicePrepareCallRestData_2_0 extends IVoicePrepareCallRestDataBody_2_0 {
17201
17246
  }
17202
- export interface IMistralMeta_2_0 {
17203
- customModel?: string;
17247
+ export interface IVoicePrepareCallRestReturnValue_2_0 extends IVGCallSettings_2_0 {
17204
17248
  }
17205
17249
  /**
17206
17250
  * @openapi
17207
17251
  *
17208
17252
  * components:
17209
17253
  * schemas:
17210
- * ILLMFallback_2_0:
17254
+ * ITestVoiceProvider_2_0:
17211
17255
  * type: object
17212
17256
  * properties:
17213
- * isFallbackEnabled:
17257
+ * voiceProvider:
17258
+ * type: string
17259
+ * isCredentialsValid:
17214
17260
  * type: boolean
17215
- * description: A flag that indicates whether the fallback configuration should be considered at all
17216
- * fallbackLLMReferenceId:
17261
+ * msg:
17217
17262
  * type: string
17218
- * description: The reference id of an existing largeLanguageModel
17219
- * immediateFallBack:
17220
- * type: object
17221
- * properties:
17222
- * failedRequests:
17223
- * type: number
17224
- * description: Number of failed requests to trigger the fallback LLM as 1st choice
17225
- * durationInMinutes:
17226
- * type: number
17227
- * description: Duration in minutes for which the fallback LLM should be used as 1st choice
17228
- * emailNotificationList:
17229
- * type: array
17230
- * items:
17231
- * type: string
17232
- * description: List of email addresses to notify when fallback is triggered
17233
- * description: Configuration for LLM fallback
17263
+ * msgErr:
17264
+ * type: string
17265
+ *
17234
17266
  */
17235
- export interface ILLMFallback_2_0 {
17236
- order: number;
17237
- isFallbackEnabled: boolean;
17238
- fallbackLLMReferenceId: string;
17239
- immediateFallBack: {
17240
- failedRequests: number;
17241
- durationInMinutes: number;
17242
- emailNotificationList: string[];
17243
- };
17267
+ export interface ITestVoiceProvider_2_0 {
17268
+ voiceProvider: TAudioPreviewProvider;
17269
+ isCredentialsValid: boolean;
17270
+ msg: string;
17271
+ msgErr?: string;
17244
17272
  }
17245
- /******************************************************************************/
17246
- /**
17247
- * IMPORTANT!
17248
- * Openapi components from the llm-providers pacakge, if you need to updtate something here
17249
- * make sure that the actual code in the llm-providers package is updated as well
17250
- */
17251
- /******************************************************************************/
17252
- export interface IGoogleGeminiMeta_2_0 {
17253
- location: string;
17273
+ export interface ITestVoiceProviderRestDataBody_2_0 extends Partial<IProjectScope> {
17274
+ }
17275
+ export interface ITestVoiceProviderRestData_2_0 extends ITestVoiceProviderRestDataBody_2_0 {
17276
+ }
17277
+ export interface ITestVoiceProviderRestReturnValue_2_0 extends ITestVoiceProvider_2_0 {
17254
17278
  }
17255
17279
  /**
17256
17280
  * @openapi
17257
17281
  *
17258
17282
  * components:
17259
17283
  * schemas:
17260
- * ILargeLanguageModelFieldsBase_2_0:
17284
+ * ITestTranslationSettings_2_0:
17261
17285
  * type: object
17262
- * required: ['name', 'modelType', 'provider', 'connectionId']
17263
17286
  * properties:
17264
- * name:
17265
- * type: string
17266
- * example: "LLM Name"
17267
- * description:
17268
- * type: string
17269
- * example: "LLM meaningful description"
17270
- * modelType:
17271
- * $ref: '#/components/schemas/TGenerativeAIModels'
17272
- * modelGroup:
17273
- * $ref: '#/components/schemas/TModelGroups'
17274
- * isCustomModel:
17275
- * type: boolean
17276
- * example: true
17277
- * provider:
17278
- * $ref: '#/components/schemas/TGenerativeAIProviders'
17279
- * connectionId:
17287
+ * language:
17280
17288
  * type: string
17281
- * description: The reference id of the GenerativeAI Provider Connection
17282
- * format: uuid
17283
- * openAI:
17284
- * type: object
17285
- * description: OpenAI specific meta data
17286
- * properties:
17287
- * customModel:
17288
- * type: string
17289
- * example: gpt-4-32k-0613
17290
- * description: The custom model name. This does not work with embedding models
17291
- * anthropic:
17292
- * type: object
17293
- * description: Anthropic specific meta data
17294
- * properties:
17295
- * customModel:
17296
- * type: string
17297
- * example: claude-3-opus-20240229
17298
- * description: The custom model name. This does not work with embedding models
17299
- * azureOpenAI:
17300
- * type: object
17301
- * description: Azure OpenAI specific meta data
17302
- * properties:
17303
- * resourceName:
17304
- * type: string
17305
- * deploymentName:
17306
- * type: string
17307
- * apiVersion:
17308
- * type: string
17309
- * baseCustomUrl:
17310
- * type: string
17311
- * example:
17312
- * - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
17313
- * - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
17314
- * - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
17315
- * googleVertexAI:
17316
- * type: object
17317
- * description: Google VertexAI specific meta data
17318
- * properties:
17319
- * location:
17320
- * type: string
17321
- * apiEndpoint:
17322
- * type: string
17323
- * publisher:
17324
- * type: string
17325
- * googleGemini:
17326
- * type: object
17327
- * description: Google Gemini specific meta data
17328
- * properties:
17329
- * location:
17330
- * type: string
17331
- * alephAlpha:
17332
- * type: object
17333
- * description: Aleph Alpha specific meta data
17334
- * properties:
17335
- * customModel:
17336
- * type: string
17337
- * example: luminous-003
17338
- * description: The custom model name. This does not work with embedding models
17339
- * baseCustomUrl:
17340
- * type: string
17341
- * example: https://api.aleph-alpha.com
17342
- * openAICompatible:
17289
+ * error:
17343
17290
  * type: object
17344
- * description: OpenAI compatible provider
17345
- * properties:
17346
- * customModel:
17347
- * type: string
17348
- * example: luminous-003
17349
- * description: The custom model name. This does not work with embedding models
17350
- * baseCustomUrl:
17351
- * type: string
17352
- * example: https://own-llm-deployment.company.com/openai/v1
17353
- * customAuthHeader:
17354
- * type: string
17355
- * example: Ocp-Apim-Subscription-Key
17356
- * description: The api key will be sent via this http header if specified
17291
+ * msg:
17292
+ * type: string
17357
17293
  *
17358
- * ILargeLanguageModelFields_2_0:
17359
- * allOf:
17360
- * - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
17361
- * - $ref: '#/components/schemas/IProjectResourceFields_2_0'
17362
- * - type: object
17363
- * properties:
17364
- * isDefault:
17365
- * type: boolean
17366
- * description: Sets the LLM to default (fallback) if no other LLM is set
17367
- * example: false
17368
- * fallbacks:
17369
- * type: array
17370
- * description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
17371
- * items:
17372
- * $ref: '#/components/schemas/ILLMFallback_2_0'
17373
- * IGlobalLargeLanguageModelFields_2_0:
17374
- * allOf:
17375
- * - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
17376
- * - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
17377
- * ILargeLanguageModelCreate_2_0:
17378
- * allOf:
17379
- * - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
17380
- * ILargeLanguageModelData_2_0:
17381
- * allOf:
17382
- * - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
17383
- * - type: object
17384
- * properties:
17385
- * referenceId:
17386
- * type: string
17387
- * description: The reference id of the LargeLanguageModel
17388
- * format: uuid
17389
- * IGlobalLargeLanguageModelData_2_0:
17390
- * allOf:
17391
- * - $ref: '#/components/schemas/IGlobalLargeLanguageModelFields_2_0'
17392
- * - type: object
17393
- * properties:
17394
- * referenceId:
17395
- * type: string
17396
- * description: The reference id of the LargeLanguageModel
17397
- * format: uuid
17398
- * IGlobalLargeLanguageModel_2_0:
17399
- * allOf:
17400
- * - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
17401
- * - $ref: '#/components/schemas/IEntityMeta'
17402
- * ILargeLanguageModel_2_0:
17403
- * allOf:
17404
- * - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
17405
- * - $ref: '#/components/schemas/IEntityMeta'
17406
17294
  */
17407
- export interface ILargeLanguageModel_2_0 extends IGlobalResource {
17408
- referenceId: string;
17409
- _id: TMongoId;
17410
- name: string;
17411
- description: string;
17412
- modelType: TGenerativeAIModels;
17413
- /** model type e.g. chat */
17414
- modelGroup?: TModeType;
17415
- isCustomModel?: boolean;
17416
- provider: TGenerativeAIProviders;
17417
- connectionId: string;
17418
- isDefault: boolean;
17419
- createdAt: number;
17420
- lastChanged: number;
17421
- createdBy: TMongoId;
17422
- lastChangedBy: TMongoId;
17423
- /** Meta data for the AzureOpenAI connection */
17424
- azureOpenAI?: IAzureOpenAIMeta_2_0;
17425
- /** Meta data for the OpenAI LLM */
17426
- openAI?: IOpenAIMeta_2_0;
17427
- /** Meta data for OpenAI Compatible LLMs */
17428
- openAICompatible?: IOpenAICompatibleMeta_2_0;
17429
- /** Meta Data for the AlephAlpha LLM */
17430
- alephAlpha?: IAlephAlphaMeta_2_0;
17431
- /** Meta data for the GoogleVertexAI connection */
17432
- googleVertexAI?: IGoogleVertexAIMeta_2_0;
17433
- /** Meta data for the GoogleGemini connection */
17434
- googleGemini?: IGoogleGeminiMeta_2_0;
17435
- /** Meta data for the Anthropic connection */
17436
- anthropic?: IAnthropicMeta_2_0;
17437
- /** Meta data for the AwsBedrock connection */
17438
- awsBedrock?: IAwsBedrockMeta_2_0;
17439
- /** Meta data for the Mistral connection */
17440
- mistral?: IMistralMeta_2_0;
17441
- /** Fallback LLM configuration */
17442
- fallbacks?: ILLMFallback_2_0[];
17295
+ export interface ITestTranslationSettings_2_0 {
17296
+ language: string;
17297
+ error?: InternalServerError;
17298
+ msg: string;
17299
+ }
17300
+ export interface ITestTranslationSettingsRestDataBody_2_0 extends Partial<IProjectScope> {
17301
+ }
17302
+ export interface ITestTranslationSettingsRestData_2_0 extends ITestTranslationSettingsRestDataBody_2_0 {
17303
+ }
17304
+ export interface ITestTranslationSettingsRestReturnValue_2_0 extends ITestTranslationSettings_2_0 {
17305
+ }
17306
+ export interface ICreateYesNoSentenceRestDataBody_2_0 extends Partial<Omit<ISentence_2_0, TReferenceAndEntityMetaKeys | "feedbackReport" | "slots">> {
17307
+ }
17308
+ export interface ICreateYesNoSentenceRestDataParams_2_0 {
17309
+ localeId: string;
17310
+ intentId: string;
17311
+ }
17312
+ export interface ICreateYesNoSentenceRestData_2_0 extends ICreateYesNoSentenceRestDataBody_2_0, ICreateYesNoSentenceRestDataParams_2_0 {
17313
+ }
17314
+ export interface ICreateYesNoSentenceRestReturnValue_2_0 extends Omit<ISentence_2_0, "feedbackReport"> {
17315
+ }
17316
+ export interface IDeleteYesNoSentenceRestDataParams_2_0 {
17317
+ localeId: string;
17318
+ intentId: string;
17319
+ sentenceId: string;
17320
+ }
17321
+ export interface IDeleteYesNoSentenceRestData_2_0 extends IDeleteYesNoSentenceRestDataParams_2_0 {
17322
+ }
17323
+ export interface IDeleteYesNoSentenceRestReturnValue_2_0 {
17324
+ }
17325
+ export interface IUpdateYesNoSentenceRestBody_2_0 extends Omit<ISentence_2_0, TReferenceAndEntityMetaKeys | "feedbackReport"> {
17326
+ }
17327
+ export interface IUpdateYesNoSentenceRestParams_2_0 {
17328
+ localeId: string;
17329
+ intentId: string;
17330
+ sentenceId: string;
17331
+ }
17332
+ export interface IUpdateYesNoSentenceRestData_2_0 extends IUpdateYesNoSentenceRestParams_2_0, IUpdateYesNoSentenceRestBody_2_0 {
17333
+ }
17334
+ export interface IUpdateYesNoSentenceRestReturnValue_2_0 {
17335
+ }
17336
+ export interface IIndexYesNoSentencesRestDataParams_2_0 {
17337
+ localeId: string;
17338
+ intentId: string;
17339
+ }
17340
+ export interface IIndexYesNoSentencesRestData_2_0 extends IRestPagination<ISentenceIndexItem_2_0>, IIndexYesNoSentencesRestDataParams_2_0 {
17341
+ }
17342
+ export interface IIndexYesNoSentencesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ISentenceIndexItem_2_0> {
17443
17343
  }
17444
17344
  /**
17445
17345
  * @openapi
17446
17346
  *
17447
17347
  * components:
17448
17348
  * schemas:
17449
- * ILargeLanguageModelIndexItem_2_0:
17450
- * allOf:
17451
- * - type: object
17349
+ * IAgentAssistGridConfig_2_0:
17350
+ * type: object
17351
+ * properties:
17352
+ * grid:
17353
+ * type: object
17452
17354
  * properties:
17453
- * referenceId:
17454
- * type: string
17455
- * description: The reference id of the LargeLanguageModel
17456
- * format: uuid
17457
- * name:
17458
- * type: string
17459
- * example: "LLM Name"
17460
- * description:
17461
- * type: string
17462
- * example: "LLM Name"
17463
- * modeltype:
17464
- * $ref: '#/components/schemas/TGenerativeAIModels'
17465
- * provider:
17466
- * $ref: '#/components/schemas/TGenerativeAIProviders'
17467
- * connectionId:
17468
- * type: string
17469
- * description: The reference id of the GenerativeAI Provider Connection
17470
- * format: uuid
17471
- * isDefault:
17472
- * type: boolean
17473
- * description: Sets the LLM to default (fallback) if no other LLM is set
17474
- * example: false
17355
+ * columns:
17356
+ * type: number
17357
+ * description: Number of columns in the grid.
17358
+ * rows:
17359
+ * type: number
17360
+ * description: Number of rows in the grid.
17361
+ * gap:
17362
+ * type: number
17363
+ * description: Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used.
17364
+ * tiles:
17365
+ * type: object
17366
+ * properties:
17367
+ * tile-id:
17368
+ * type: object
17369
+ * description: The Tile ID is used in the Flow Nodes to fill in this specific tile.
17370
+ * properties:
17371
+ * x:
17372
+ * type: number
17373
+ * description: The row number where the tile is located, starting from 1.
17374
+ * y:
17375
+ * type: number
17376
+ * description: The column number where the tile is located, starting from 1.
17377
+ * columns:
17378
+ * type: number
17379
+ * description: The number of columns the tile should occupy. The default value is 1.
17380
+ * rows:
17381
+ * type: number
17382
+ * description: The number of rows the tile should occupy. The default value is 1.
17383
+ *
17384
+ * IAgentAssistConfigData_2_0:
17385
+ * type: object
17386
+ * properties:
17387
+ * name:
17388
+ * type: string
17389
+ * description: The human readable name of the config.
17390
+ * description:
17391
+ * type: string
17392
+ * description: The description which can be used to understand what the agent assist config contains in terms of tiles.
17393
+ * config:
17394
+ * type: object
17395
+ * description: The actual grid-config.
17396
+ * $ref: '#/components/schemas/IAgentAssistGridConfig_2_0'
17397
+ *
17398
+ * IAgentAssistConfigGeneratedData_2_0:
17399
+ * type: object
17400
+ * properties:
17401
+ * referenceId:
17402
+ * type: string
17403
+ * format: uuid
17404
+ *
17405
+ * IAgentAssistConfig_2_0:
17406
+ * allOf:
17407
+ * - $ref: '#/components/schemas/IAgentAssistConfigData_2_0'
17408
+ * - $ref: '#/components/schemas/IAgentAssistConfigGeneratedData_2_0'
17475
17409
  * - $ref: '#/components/schemas/IEntityMeta'
17476
17410
  */
17477
- export interface ILargeLanguageModelIndexItem_2_0 extends IGlobalResource {
17478
- referenceId: string;
17411
+ export interface IAgentAssistConfig_2_0 {
17479
17412
  _id: TMongoId;
17480
17413
  name: string;
17481
17414
  description: string;
17482
- modelType: TGenerativeAIModels;
17483
- provider: TGenerativeAIProviders;
17484
- connectionId: string;
17485
- /** Fallback LLM configuration */
17486
- fallbacks?: ILLMFallback_2_0[];
17487
- isDefault: boolean;
17415
+ config: IAgentAssistGridConfig;
17416
+ referenceId: string;
17417
+ projectReference: string;
17418
+ organisationReference: string;
17488
17419
  createdAt: number;
17489
17420
  lastChanged: number;
17490
17421
  createdBy: TMongoId;
17491
17422
  lastChangedBy: TMongoId;
17492
17423
  }
17493
- export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Pick<IGlobalResource, "resourceLevel">, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
17424
+ export interface ICreateAgentAssistConfigRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAgentAssistConfig_2_0, keyof IEntityMeta>> {
17494
17425
  }
17495
- export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
17426
+ export interface ICreateAgentAssistConfigRestData_2_0 extends ICreateAgentAssistConfigRestDataBody_2_0 {
17496
17427
  }
17497
- export interface ICreateLargeLanguageModelRestDataBody_2_0 extends Partial<IProjectScope>, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
17428
+ export interface ICreateAgentAssistConfigRestReturnValue_2_0 extends IAgentAssistConfig_2_0 {
17498
17429
  }
17499
- export interface ICreateLargeLanguageModelRestData_2_0 extends ICreateLargeLanguageModelRestDataBody_2_0 {
17430
+ export interface IUpdateAgentAssistConfigRestDataBody_2_0 extends Partial<Pick<IAgentAssistConfig_2_0, "name" | "description" | "config">> {
17500
17431
  }
17501
- export interface ICreateLargeLanguageModelRestReturnValue_2_0 extends ILargeLanguageModel_2_0 {
17432
+ export interface IUpdateAgentAssistConfigRestDataParams_2_0 {
17433
+ configId: string;
17502
17434
  }
17503
- export interface IReadLargeLanguageModelRestDataParams_2_0 {
17504
- largeLanguageModelId: string;
17435
+ export interface IUpdateAgentAssistConfigRestData_2_0 extends IUpdateAgentAssistConfigRestDataBody_2_0, IUpdateAgentAssistConfigRestDataParams_2_0 {
17505
17436
  }
17506
- export interface IReadLargeLanguageModelRestData_2_0 extends IReadLargeLanguageModelRestDataParams_2_0 {
17437
+ export interface IUpdateAgentAssistConfigRestReturnValue_2_0 {
17507
17438
  }
17508
- export interface IReadLargeLanguageModelRestReturnValue_2_0 extends ILargeLanguageModel_2_0 {
17439
+ export interface IReadAgentAssistConfigRestDataParams_2_0 {
17440
+ configId: string;
17441
+ projectId?: string;
17442
+ organisationId?: string;
17509
17443
  }
17510
- export interface IUpdateLargeLanguageModelRestDataBody_2_0 extends Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta | keyof IProjectScope>> {
17444
+ export interface IReadAgentAssistConfigRestData_2_0 extends IReadAgentAssistConfigRestDataParams_2_0 {
17511
17445
  }
17512
- export interface IUpdateLargeLanguageModelRestDataParams_2_0 {
17513
- largeLanguageModelId: string;
17446
+ export interface IReadAgentAssistConfigRestReturnValue_2_0 extends IAgentAssistConfig_2_0 {
17514
17447
  }
17515
- export interface IUpdateLargeLanguageModelRestData_2_0 extends IUpdateLargeLanguageModelRestDataBody_2_0, IUpdateLargeLanguageModelRestDataParams_2_0 {
17448
+ export interface IDeleteAgentAssistConfigRestDataParams_2_0 {
17449
+ configId: string;
17516
17450
  }
17517
- export interface IUpdateLargeLanguageModelRestReturnValue_2_0 {
17451
+ export interface IDeleteAgentAssistConfigRestData_2_0 extends IDeleteAgentAssistConfigRestDataParams_2_0 {
17518
17452
  }
17519
- export interface IDeleteLargeLanguageModelRestQuery_2_0 {
17520
- force?: string;
17453
+ export interface IDeleteAgentAssistConfigRestReturnValue_2_0 {
17521
17454
  }
17522
- export interface IDeleteLargeLanguageModelRestDataParams_2_0 {
17523
- largeLanguageModelId: string;
17455
+ export interface IIndexAgentAssistConfigsRestData_2_0 extends IRestPagination<IAgentAssistConfig_2_0>, IProjectScope {
17524
17456
  }
17525
- export interface IDeleteLargeLanguageModelRestData_2_0 extends IDeleteLargeLanguageModelRestDataParams_2_0, IDeleteLargeLanguageModelRestQuery_2_0 {
17457
+ export interface IIndexAgentAssistConfigsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAgentAssistConfig_2_0> {
17526
17458
  }
17527
- export interface IDeleteLargeLanguageModelRestReturnValue_2_0 {
17459
+ export interface IOpenAIMeta_2_0 {
17460
+ customModel?: string;
17461
+ baseCustomUrl?: string;
17528
17462
  }
17529
- export interface ICloneLargeLanguageModelRestDataParams_2_0 {
17530
- largeLanguageModelId: string;
17463
+ export interface IOpenAICompatibleMeta_2_0 {
17464
+ customModel: string;
17465
+ baseCustomUrl: string;
17466
+ customAuthHeader?: string;
17531
17467
  }
17532
- export interface ICloneLargeLanguageModelRestData_2_0 extends ICloneLargeLanguageModelRestDataParams_2_0 {
17468
+ export interface IAnthropicMeta_2_0 {
17469
+ customModel?: string;
17533
17470
  }
17534
- export interface ICloneLargeLanguageModelRestReturnValue_2_0 extends ILargeLanguageModel_2_0 {
17471
+ export interface IAwsBedrockMeta_2_0 {
17472
+ region: string;
17473
+ customModel?: string;
17535
17474
  }
17536
- export interface ITestLargeLanguageModelRestDataParams_2_0 {
17537
- largeLanguageModelId: string;
17475
+ export interface IAlephAlphaMeta_2_0 {
17476
+ customModel?: string;
17477
+ baseCustomUrl?: string;
17538
17478
  }
17539
- export interface ITestLargeLanguageModelRestData_2_0 extends ITestLargeLanguageModelRestDataParams_2_0 {
17479
+ export interface IAzureOpenAIMeta_2_0 {
17480
+ resourceName?: string;
17481
+ deploymentName?: string;
17482
+ baseCustomUrl?: string | null;
17483
+ apiVersion?: string;
17540
17484
  }
17541
- export interface ITestLargeLanguageModelRestReturnValue_2_0 {
17542
- llmProvider: TGenerativeAIProviders;
17543
- isCredentialsValid: boolean;
17544
- msg: string;
17545
- msgErr?: string;
17485
+ export interface IGoogleVertexAIMeta_2_0 {
17486
+ location: string;
17487
+ apiEndPoint: string;
17488
+ publisher?: string;
17489
+ }
17490
+ export interface IMistralMeta_2_0 {
17491
+ customModel?: string;
17546
17492
  }
17547
17493
  /**
17548
17494
  * @openapi
17495
+ *
17549
17496
  * components:
17550
17497
  * schemas:
17551
- * IAvailableModelItem_2_0:
17498
+ * ILLMFallback_2_0:
17552
17499
  * type: object
17553
17500
  * properties:
17554
- * modelName:
17555
- * type: string
17556
- * modelId:
17501
+ * isFallbackEnabled:
17502
+ * type: boolean
17503
+ * description: A flag that indicates whether the fallback configuration should be considered at all
17504
+ * fallbackLLMReferenceId:
17557
17505
  * type: string
17558
- * providerName:
17559
- * type: array
17560
- *
17561
- */
17562
- /**
17563
- * @openapi
17564
- * components:
17565
- * schemas:
17566
- * IAvailableModelsForLLMProvider_2_0:
17567
- * allOf:
17568
- * - type: object
17506
+ * description: The reference id of an existing largeLanguageModel
17507
+ * immediateFallBack:
17508
+ * type: object
17569
17509
  * properties:
17570
- * availableModels:
17510
+ * failedRequests:
17511
+ * type: number
17512
+ * description: Number of failed requests to trigger the fallback LLM as 1st choice
17513
+ * durationInMinutes:
17514
+ * type: number
17515
+ * description: Duration in minutes for which the fallback LLM should be used as 1st choice
17516
+ * emailNotificationList:
17571
17517
  * type: array
17572
17518
  * items:
17573
- * $ref: '#/components/schemas/IAvailableModelItem_2_0'
17574
- *
17519
+ * type: string
17520
+ * description: List of email addresses to notify when fallback is triggered
17521
+ * description: Configuration for LLM fallback
17575
17522
  */
17576
- export interface IAvailableModelsForLLMProvider_2_0 {
17577
- availableModels: {
17578
- modelName: string;
17579
- modelId: string;
17580
- providerName: string;
17581
- }[];
17582
- }
17583
- export interface IGetAvailableModelsForLLMRestDataParams_2_0 {
17584
- largeLanguageModelId: string;
17585
- }
17586
- export interface IGetAvailableModelsForLLMRestData_2_0 extends IGetAvailableModelsForLLMRestDataParams_2_0 {
17587
- connectionRefId: string;
17523
+ export interface ILLMFallback_2_0 {
17524
+ order: number;
17525
+ isFallbackEnabled: boolean;
17526
+ fallbackLLMReferenceId: string;
17527
+ immediateFallBack: {
17528
+ failedRequests: number;
17529
+ durationInMinutes: number;
17530
+ emailNotificationList: string[];
17531
+ };
17588
17532
  }
17589
- export interface IGetAvailableModelsForLLMRestReturnValue_2_0 extends IAvailableModelsForLLMProvider_2_0 {
17533
+ /******************************************************************************/
17534
+ /**
17535
+ * IMPORTANT!
17536
+ * Openapi components from the llm-providers pacakge, if you need to updtate something here
17537
+ * make sure that the actual code in the llm-providers package is updated as well
17538
+ */
17539
+ /******************************************************************************/
17540
+ export interface IGoogleGeminiMeta_2_0 {
17541
+ location: string;
17590
17542
  }
17591
17543
  /**
17592
17544
  * @openapi
17593
17545
  *
17594
17546
  * components:
17595
17547
  * schemas:
17596
- * IKnowledgeStoreDataCreate_2_0:
17597
- * allOf:
17598
- * - type: object
17548
+ * ILargeLanguageModelFieldsBase_2_0:
17549
+ * type: object
17550
+ * required: ['name', 'modelType', 'provider', 'connectionId']
17551
+ * properties:
17552
+ * name:
17553
+ * type: string
17554
+ * example: "LLM Name"
17555
+ * description:
17556
+ * type: string
17557
+ * example: "LLM meaningful description"
17558
+ * modelType:
17559
+ * $ref: '#/components/schemas/TGenerativeAIModels'
17560
+ * modelGroup:
17561
+ * $ref: '#/components/schemas/TModelGroups'
17562
+ * isCustomModel:
17563
+ * type: boolean
17564
+ * example: true
17565
+ * provider:
17566
+ * $ref: '#/components/schemas/TGenerativeAIProviders'
17567
+ * connectionId:
17568
+ * type: string
17569
+ * description: The reference id of the GenerativeAI Provider Connection
17570
+ * format: uuid
17571
+ * openAI:
17572
+ * type: object
17573
+ * description: OpenAI specific meta data
17599
17574
  * properties:
17600
- * name:
17575
+ * customModel:
17601
17576
  * type: string
17602
- * example: "mystore"
17603
- * description: The name of the KnowledgeStore
17604
- * description:
17577
+ * example: gpt-4-32k-0613
17578
+ * description: The custom model name. This does not work with embedding models
17579
+ * anthropic:
17580
+ * type: object
17581
+ * description: Anthropic specific meta data
17582
+ * properties:
17583
+ * customModel:
17605
17584
  * type: string
17606
- * example: "mystore description"
17607
- * description: The description about what the knowledge store contains
17585
+ * example: claude-3-opus-20240229
17586
+ * description: The custom model name. This does not work with embedding models
17587
+ * azureOpenAI:
17588
+ * type: object
17589
+ * description: Azure OpenAI specific meta data
17590
+ * properties:
17591
+ * resourceName:
17592
+ * type: string
17593
+ * deploymentName:
17594
+ * type: string
17595
+ * apiVersion:
17596
+ * type: string
17597
+ * baseCustomUrl:
17598
+ * type: string
17599
+ * example:
17600
+ * - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
17601
+ * - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
17602
+ * - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
17603
+ * googleVertexAI:
17604
+ * type: object
17605
+ * description: Google VertexAI specific meta data
17606
+ * properties:
17607
+ * location:
17608
+ * type: string
17609
+ * apiEndpoint:
17610
+ * type: string
17611
+ * publisher:
17612
+ * type: string
17613
+ * googleGemini:
17614
+ * type: object
17615
+ * description: Google Gemini specific meta data
17616
+ * properties:
17617
+ * location:
17618
+ * type: string
17619
+ * alephAlpha:
17620
+ * type: object
17621
+ * description: Aleph Alpha specific meta data
17622
+ * properties:
17623
+ * customModel:
17624
+ * type: string
17625
+ * example: luminous-003
17626
+ * description: The custom model name. This does not work with embedding models
17627
+ * baseCustomUrl:
17628
+ * type: string
17629
+ * example: https://api.aleph-alpha.com
17630
+ * openAICompatible:
17631
+ * type: object
17632
+ * description: OpenAI compatible provider
17633
+ * properties:
17634
+ * customModel:
17635
+ * type: string
17636
+ * example: luminous-003
17637
+ * description: The custom model name. This does not work with embedding models
17638
+ * baseCustomUrl:
17639
+ * type: string
17640
+ * example: https://own-llm-deployment.company.com/openai/v1
17641
+ * customAuthHeader:
17642
+ * type: string
17643
+ * example: Ocp-Apim-Subscription-Key
17644
+ * description: The api key will be sent via this http header if specified
17608
17645
  *
17609
- * IKnowledgeStoreData_2_0:
17646
+ * ILargeLanguageModelFields_2_0:
17610
17647
  * allOf:
17611
- * - $ref: '#/components/schemas/IKnowledgeStoreDataCreate_2_0'
17648
+ * - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
17649
+ * - $ref: '#/components/schemas/IProjectResourceFields_2_0'
17612
17650
  * - type: object
17613
17651
  * properties:
17614
- * language:
17615
- * type: string
17616
- * example: "en-US"
17617
- * description: The language code
17618
- * status:
17619
- * type: string
17620
- * enum:
17621
- * - ready
17622
- * - warning
17623
- * documents:
17652
+ * isDefault:
17653
+ * type: boolean
17654
+ * description: Sets the LLM to default (fallback) if no other LLM is set
17655
+ * example: false
17656
+ * fallbacks:
17624
17657
  * type: array
17658
+ * description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
17625
17659
  * items:
17626
- * type: string
17627
- * example: "https://some-website.com/knowledgebase.txt"
17628
- * description: The document url or the file name ingested for the knowledge store
17629
- *
17630
- * IKnowledgeStoreGeneratedData_2_0:
17631
- * type: object
17632
- * properties:
17633
- * referenceId:
17634
- * type: string
17635
- * format: uuid
17636
- *
17637
- * IKnowledgeStore_2_0:
17660
+ * $ref: '#/components/schemas/ILLMFallback_2_0'
17661
+ * IGlobalLargeLanguageModelFields_2_0:
17638
17662
  * allOf:
17639
- * - $ref: '#/components/schemas/IKnowledgeStoreData_2_0'
17640
- * - $ref: '#/components/schemas/IKnowledgeStoreGeneratedData_2_0'
17641
- * - $ref: '#/components/schemas/IEntityMeta'
17642
- */
17643
- export interface IKnowledgeStore_2_0 {
17644
- _id: TMongoId;
17645
- referenceId: string;
17646
- name: string;
17647
- description: string;
17648
- status: TKnowledgeStoreStatus;
17649
- language: string;
17650
- documents: string[];
17651
- projectReference: TMongoId;
17652
- organisationReference: TMongoId;
17653
- createdAt: number;
17654
- lastChanged: number;
17655
- createdBy: TMongoId;
17656
- lastChangedBy: TMongoId;
17657
- }
17658
- export interface IIndexKnowledgeStoresRestData_2_0 extends IRestPagination<IKnowledgeStore_2_0>, Partial<IProjectScope> {
17659
- }
17660
- export interface IIndexKnowledgeStoresRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeStore_2_0> {
17661
- }
17662
- export interface ICreateKnowledgeStoreRestDataBody_2_0 extends IProjectScope, Partial<Omit<IKnowledgeStore_2_0, keyof IEntityMeta | "documents">> {
17663
- }
17664
- export interface ICreateKnowledgeStoreRestData_2_0 extends ICreateKnowledgeStoreRestDataBody_2_0 {
17665
- }
17666
- export interface ICreateKnowledgeStoreRestReturnValue_2_0 extends IKnowledgeStore_2_0 {
17667
- }
17668
- export interface IReadKnowledgeStoreRestDataParams_2_0 {
17669
- knowledgeStoreId: string;
17670
- }
17671
- export interface IReadKnowledgeStoreRestData_2_0 extends IReadKnowledgeStoreRestDataParams_2_0 {
17672
- }
17673
- export interface IReadKnowledgeStoreRestReturnValue_2_0 extends IKnowledgeStore_2_0 {
17674
- }
17675
- export interface IDeleteKnowledgeStoreRestDataParams_2_0 {
17676
- knowledgeStoreId: string;
17677
- }
17678
- export interface IDeleteKnowledgeStoreRestData_2_0 extends IDeleteKnowledgeStoreRestDataParams_2_0 {
17679
- }
17680
- export interface IDeleteKnowledgeStoreRestReturnValue_2_0 {
17681
- }
17682
- export interface IUpdateKnowledgeStoreRestDataBody_2_0 extends Partial<Pick<IKnowledgeStore_2_0, "name" | "description">> {
17683
- }
17684
- export interface IUpdateKnowledgeStoreRestDataParams_2_0 {
17685
- knowledgeStoreId: string;
17686
- }
17687
- export interface IUpdateKnowledgeStoreRestData_2_0 extends IUpdateKnowledgeStoreRestDataBody_2_0, IUpdateKnowledgeStoreRestDataParams_2_0 {
17688
- }
17689
- export interface IUpdateKnowledgeStoreRestReturnValue_2_0 {
17690
- }
17691
- declare const knowledgeSourceStatus: readonly [
17692
- "ready",
17693
- "ingesting",
17694
- "disabled",
17695
- "failure"
17696
- ];
17697
- export declare type TKnowledgeSourceStatus = typeof knowledgeSourceStatus[number];
17698
- declare const knowledgeSourceType: readonly [
17699
- "pdf",
17700
- "txt",
17701
- "docx",
17702
- "pptx",
17703
- "ctxt",
17704
- "url",
17705
- "manual",
17706
- "jpeg",
17707
- "jpg",
17708
- "png",
17709
- "bmp",
17710
- "heif",
17711
- "tiff"
17712
- ];
17713
- export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
17714
- export interface IKnowledgeSourceMetaData {
17715
- size?: number;
17716
- fileName?: string;
17717
- mimeType?: string;
17718
- url?: string;
17719
- failReason?: string;
17720
- tags?: string[];
17721
- extractedChunks?: number;
17663
+ * - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
17664
+ * - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
17665
+ * ILargeLanguageModelCreate_2_0:
17666
+ * allOf:
17667
+ * - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
17668
+ * ILargeLanguageModelData_2_0:
17669
+ * allOf:
17670
+ * - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
17671
+ * - type: object
17672
+ * properties:
17673
+ * referenceId:
17674
+ * type: string
17675
+ * description: The reference id of the LargeLanguageModel
17676
+ * format: uuid
17677
+ * IGlobalLargeLanguageModelData_2_0:
17678
+ * allOf:
17679
+ * - $ref: '#/components/schemas/IGlobalLargeLanguageModelFields_2_0'
17680
+ * - type: object
17681
+ * properties:
17682
+ * referenceId:
17683
+ * type: string
17684
+ * description: The reference id of the LargeLanguageModel
17685
+ * format: uuid
17686
+ * IGlobalLargeLanguageModel_2_0:
17687
+ * allOf:
17688
+ * - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
17689
+ * - $ref: '#/components/schemas/IEntityMeta'
17690
+ * ILargeLanguageModel_2_0:
17691
+ * allOf:
17692
+ * - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
17693
+ * - $ref: '#/components/schemas/IEntityMeta'
17694
+ */
17695
+ export interface ILargeLanguageModel_2_0 extends IGlobalResource {
17696
+ referenceId: string;
17697
+ _id: TMongoId;
17698
+ name: string;
17699
+ description: string;
17700
+ modelType: TGenerativeAIModels;
17701
+ /** model type e.g. chat */
17702
+ modelGroup?: TModeType;
17703
+ isCustomModel?: boolean;
17704
+ provider: TGenerativeAIProviders;
17705
+ connectionId: string;
17706
+ isDefault: boolean;
17707
+ createdAt: number;
17708
+ lastChanged: number;
17709
+ createdBy: TMongoId;
17710
+ lastChangedBy: TMongoId;
17711
+ /** Meta data for the AzureOpenAI connection */
17712
+ azureOpenAI?: IAzureOpenAIMeta_2_0;
17713
+ /** Meta data for the OpenAI LLM */
17714
+ openAI?: IOpenAIMeta_2_0;
17715
+ /** Meta data for OpenAI Compatible LLMs */
17716
+ openAICompatible?: IOpenAICompatibleMeta_2_0;
17717
+ /** Meta Data for the AlephAlpha LLM */
17718
+ alephAlpha?: IAlephAlphaMeta_2_0;
17719
+ /** Meta data for the GoogleVertexAI connection */
17720
+ googleVertexAI?: IGoogleVertexAIMeta_2_0;
17721
+ /** Meta data for the GoogleGemini connection */
17722
+ googleGemini?: IGoogleGeminiMeta_2_0;
17723
+ /** Meta data for the Anthropic connection */
17724
+ anthropic?: IAnthropicMeta_2_0;
17725
+ /** Meta data for the AwsBedrock connection */
17726
+ awsBedrock?: IAwsBedrockMeta_2_0;
17727
+ /** Meta data for the Mistral connection */
17728
+ mistral?: IMistralMeta_2_0;
17729
+ /** Fallback LLM configuration */
17730
+ fallbacks?: ILLMFallback_2_0[];
17722
17731
  }
17723
17732
  /**
17724
17733
  * @openapi
17725
17734
  *
17726
17735
  * components:
17727
17736
  * schemas:
17728
- * IKnowledgeSourceDataCreate_2_0:
17737
+ * ILargeLanguageModelIndexItem_2_0:
17729
17738
  * allOf:
17730
17739
  * - type: object
17731
17740
  * properties:
17732
- * name:
17733
- * type: string
17734
- * example: "mysource"
17735
- * description: The name of the KnowledgeSource
17736
- * description:
17737
- * type: string
17738
- * example: "mysource description"
17739
- * description: The description about what the knowledge source contains
17740
- * type:
17741
+ * referenceId:
17741
17742
  * type: string
17742
- * enum:
17743
- * - url
17744
- * - manual
17745
- * - pdf
17746
- * - txt
17747
- * - ctxt
17748
- * description: The type of source for the Knowledge store
17749
- * metaData:
17750
- * type: object
17751
- * properties:
17752
- * tags:
17753
- * type: array
17754
- * items:
17755
- * type: string
17756
- * example: "tag1"
17757
- * IKnowledgeSourceDataUpdate_2_0:
17758
- * allOf:
17759
- * - type: object
17760
- * properties:
17743
+ * description: The reference id of the LargeLanguageModel
17744
+ * format: uuid
17761
17745
  * name:
17762
17746
  * type: string
17763
- * example: "mysource"
17764
- * description: The name of the KnowledgeSource
17747
+ * example: "LLM Name"
17765
17748
  * description:
17766
17749
  * type: string
17767
- * example: "mysource description"
17768
- * description: The description about what the knowledge source contains
17769
- * status:
17770
- * type: string
17771
- * enum:
17772
- * - ready
17773
- * - ingesting
17774
- * - disabled
17775
- * metaData:
17776
- * type: object
17777
- * properties:
17778
- * tags:
17779
- * type: array
17780
- * description: Array of tags to replace the existing tags
17781
- * items:
17782
- * type: string
17783
- * example: "tag1"
17784
- * IKnowledgeSourceDataTypeWebsite_2_0:
17785
- * allOf:
17786
- * - type: object
17787
- * properties:
17788
- * url:
17789
- * type: string
17790
- * example: "https://www.some-article.com"
17791
- * description: The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "url"
17792
- *
17793
- * IKnowledgeSourceData_2_0:
17794
- * allOf:
17795
- * - $ref: '#/components/schemas/IKnowledgeSourceDataCreate_2_0'
17796
- * - type: object
17797
- * properties:
17798
- * metaData:
17799
- * type: object
17800
- * chunkCount:
17801
- * type: integer
17802
- * status:
17750
+ * example: "LLM Name"
17751
+ * modeltype:
17752
+ * $ref: '#/components/schemas/TGenerativeAIModels'
17753
+ * provider:
17754
+ * $ref: '#/components/schemas/TGenerativeAIProviders'
17755
+ * connectionId:
17803
17756
  * type: string
17804
- * enum:
17805
- * - ready
17806
- * - ingesting
17807
- * - disabled
17808
- *
17809
- * IKnowledgeSourceGeneratedData_2_0:
17810
- * type: object
17811
- * properties:
17812
- * referenceId:
17813
- * type: string
17814
- * format: uuid
17815
- *
17816
- * IKnowledgeSource_2_0:
17817
- * allOf:
17818
- * - $ref: '#/components/schemas/IKnowledgeSourceData_2_0'
17819
- * - $ref: '#/components/schemas/IKnowledgeSourceGeneratedData_2_0'
17757
+ * description: The reference id of the GenerativeAI Provider Connection
17758
+ * format: uuid
17759
+ * isDefault:
17760
+ * type: boolean
17761
+ * description: Sets the LLM to default (fallback) if no other LLM is set
17762
+ * example: false
17820
17763
  * - $ref: '#/components/schemas/IEntityMeta'
17821
17764
  */
17822
- export interface IKnowledgeSource_2_0 {
17823
- _id: TMongoId;
17765
+ export interface ILargeLanguageModelIndexItem_2_0 extends IGlobalResource {
17824
17766
  referenceId: string;
17767
+ _id: TMongoId;
17825
17768
  name: string;
17826
17769
  description: string;
17827
- status: TKnowledgeSourceStatus;
17828
- type: TKnowledgeSourceType;
17829
- chunkCount: number;
17830
- metaData: IKnowledgeSourceMetaData;
17831
- data: Record<string, unknown>;
17832
- storeReference: TMongoId;
17833
- projectReference: TMongoId;
17834
- organisationReference: TMongoId;
17770
+ modelType: TGenerativeAIModels;
17771
+ provider: TGenerativeAIProviders;
17772
+ connectionId: string;
17773
+ /** Fallback LLM configuration */
17774
+ fallbacks?: ILLMFallback_2_0[];
17775
+ isDefault: boolean;
17835
17776
  createdAt: number;
17836
17777
  lastChanged: number;
17837
17778
  createdBy: TMongoId;
17838
17779
  lastChangedBy: TMongoId;
17839
17780
  }
17840
- export interface IIndexKnowledgeSourcesRestDataParams_2_0 {
17841
- knowledgeStoreId: string;
17781
+ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Pick<IGlobalResource, "resourceLevel">, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
17842
17782
  }
17843
- export interface IIndexKnowledgeSourcesRestData_2_0 extends IIndexKnowledgeSourcesRestDataParams_2_0, IRestPagination<IKnowledgeSource_2_0> {
17783
+ export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
17844
17784
  }
17845
- export interface IIndexKnowledgeSourcesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeSource_2_0> {
17785
+ export interface ICreateLargeLanguageModelRestDataBody_2_0 extends Partial<IProjectScope>, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
17846
17786
  }
17847
- export interface ICreateKnowledgeSourceRestDataParams_2_0 {
17848
- knowledgeStoreId: string;
17787
+ export interface ICreateLargeLanguageModelRestData_2_0 extends ICreateLargeLanguageModelRestDataBody_2_0 {
17849
17788
  }
17850
- export interface ICreateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "type" | "metaData">> {
17851
- url?: string;
17789
+ export interface ICreateLargeLanguageModelRestReturnValue_2_0 extends ILargeLanguageModel_2_0 {
17852
17790
  }
17853
- export interface ICreateKnowledgeSourceRestData_2_0 extends ICreateKnowledgeSourceRestDataParams_2_0, ICreateKnowledgeSourceRestDataBody_2_0 {
17791
+ export interface IReadLargeLanguageModelRestDataParams_2_0 {
17792
+ largeLanguageModelId: string;
17854
17793
  }
17855
- export interface ICreateKnowledgeSourceRestReturnValue_2_0 {
17856
- knowledgeSource?: IKnowledgeSource_2_0;
17857
- taskData?: ICreatedTask_2_0;
17794
+ export interface IReadLargeLanguageModelRestData_2_0 extends IReadLargeLanguageModelRestDataParams_2_0 {
17858
17795
  }
17859
- export interface IReadKnowledgeSourceRestDataParams_2_0 {
17860
- knowledgeStoreId: string;
17861
- sourceId: string;
17796
+ export interface IReadLargeLanguageModelRestReturnValue_2_0 extends ILargeLanguageModel_2_0 {
17862
17797
  }
17863
- export interface IReadKnowledgeSourceRestData_2_0 extends IReadKnowledgeSourceRestDataParams_2_0 {
17798
+ export interface IUpdateLargeLanguageModelRestDataBody_2_0 extends Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta | keyof IProjectScope>> {
17864
17799
  }
17865
- export interface IReadKnowledgeSourceRestReturnValue_2_0 extends IKnowledgeSource_2_0 {
17800
+ export interface IUpdateLargeLanguageModelRestDataParams_2_0 {
17801
+ largeLanguageModelId: string;
17866
17802
  }
17867
- export interface IDeleteKnowledgeSourceRestDataParams_2_0 {
17868
- knowledgeStoreId: string;
17869
- sourceId: string;
17803
+ export interface IUpdateLargeLanguageModelRestData_2_0 extends IUpdateLargeLanguageModelRestDataBody_2_0, IUpdateLargeLanguageModelRestDataParams_2_0 {
17870
17804
  }
17871
- export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSourceRestDataParams_2_0 {
17805
+ export interface IUpdateLargeLanguageModelRestReturnValue_2_0 {
17872
17806
  }
17873
- export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
17807
+ export interface IDeleteLargeLanguageModelRestQuery_2_0 {
17808
+ force?: string;
17874
17809
  }
17875
- export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
17876
- metaData?: Partial<Pick<IKnowledgeSourceMetaData, "tags">>;
17810
+ export interface IDeleteLargeLanguageModelRestDataParams_2_0 {
17811
+ largeLanguageModelId: string;
17877
17812
  }
17878
- export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
17879
- knowledgeStoreId: string;
17880
- sourceId: string;
17813
+ export interface IDeleteLargeLanguageModelRestData_2_0 extends IDeleteLargeLanguageModelRestDataParams_2_0, IDeleteLargeLanguageModelRestQuery_2_0 {
17881
17814
  }
17882
- export interface IUpdateKnowledgeSourceRestData_2_0 extends IUpdateKnowledgeSourceRestDataBody_2_0, IUpdateKnowledgeSourceRestDataParams_2_0 {
17815
+ export interface IDeleteLargeLanguageModelRestReturnValue_2_0 {
17883
17816
  }
17884
- export interface IUpdateKnowledgeSourceRestReturnValue_2_0 {
17817
+ export interface ICloneLargeLanguageModelRestDataParams_2_0 {
17818
+ largeLanguageModelId: string;
17885
17819
  }
17886
- export interface IUploadKnowledgeSourceFileRestDataParams_2_0 {
17887
- knowledgeStoreId: string;
17820
+ export interface ICloneLargeLanguageModelRestData_2_0 extends ICloneLargeLanguageModelRestDataParams_2_0 {
17821
+ }
17822
+ export interface ICloneLargeLanguageModelRestReturnValue_2_0 extends ILargeLanguageModel_2_0 {
17823
+ }
17824
+ export interface ITestLargeLanguageModelRestDataParams_2_0 {
17825
+ largeLanguageModelId: string;
17826
+ }
17827
+ export interface ITestLargeLanguageModelRestData_2_0 extends ITestLargeLanguageModelRestDataParams_2_0 {
17828
+ }
17829
+ export interface ITestLargeLanguageModelRestReturnValue_2_0 {
17830
+ llmProvider: TGenerativeAIProviders;
17831
+ isCredentialsValid: boolean;
17832
+ msg: string;
17833
+ msgErr?: string;
17834
+ }
17835
+ /**
17836
+ * @openapi
17837
+ * components:
17838
+ * schemas:
17839
+ * IAvailableModelItem_2_0:
17840
+ * type: object
17841
+ * properties:
17842
+ * modelName:
17843
+ * type: string
17844
+ * modelId:
17845
+ * type: string
17846
+ * providerName:
17847
+ * type: array
17848
+ *
17849
+ */
17850
+ /**
17851
+ * @openapi
17852
+ * components:
17853
+ * schemas:
17854
+ * IAvailableModelsForLLMProvider_2_0:
17855
+ * allOf:
17856
+ * - type: object
17857
+ * properties:
17858
+ * availableModels:
17859
+ * type: array
17860
+ * items:
17861
+ * $ref: '#/components/schemas/IAvailableModelItem_2_0'
17862
+ *
17863
+ */
17864
+ export interface IAvailableModelsForLLMProvider_2_0 {
17865
+ availableModels: {
17866
+ modelName: string;
17867
+ modelId: string;
17868
+ providerName: string;
17869
+ }[];
17888
17870
  }
17889
- export interface IUploadKnowledgeSourceFileRestDataBody_2_0 {
17890
- file: File | Buffer;
17891
- tags?: string[];
17871
+ export interface IGetAvailableModelsForLLMRestDataParams_2_0 {
17872
+ largeLanguageModelId: string;
17892
17873
  }
17893
- export interface IUploadKnowledgeSourceFileRestData_2_0 extends IUploadKnowledgeSourceFileRestDataParams_2_0, IUploadKnowledgeSourceFileRestDataBody_2_0 {
17874
+ export interface IGetAvailableModelsForLLMRestData_2_0 extends IGetAvailableModelsForLLMRestDataParams_2_0 {
17875
+ connectionRefId: string;
17894
17876
  }
17895
- export interface IUploadKnowledgeSourceFileRestReturnValue_2_0 extends ICreatedTask_2_0 {
17877
+ export interface IGetAvailableModelsForLLMRestReturnValue_2_0 extends IAvailableModelsForLLMProvider_2_0 {
17896
17878
  }
17897
17879
  /**
17898
17880
  * @openapi
17899
17881
  *
17900
17882
  * components:
17901
17883
  * schemas:
17902
- * IKnowledgeChunkDataCreate_2_0:
17884
+ * IKnowledgeStoreDataCreate_2_0:
17903
17885
  * allOf:
17904
17886
  * - type: object
17905
17887
  * properties:
17906
- * order:
17907
- * type: number
17908
- * example: 1
17909
- * description: The name of the KnowledgeChunk
17910
- * text:
17888
+ * name:
17911
17889
  * type: string
17912
- * example: "This is a paragraph from an article"
17913
- * description: The text that is the actual content of the chunk
17914
- * data:
17915
- * type: object
17916
- * description: The extended data of KnowledgeChunk
17890
+ * example: "mystore"
17891
+ * description: The name of the KnowledgeStore
17892
+ * description:
17893
+ * type: string
17894
+ * example: "mystore description"
17895
+ * description: The description about what the knowledge store contains
17917
17896
  *
17918
- * IKnowledgeChunkData_2_0:
17897
+ * IKnowledgeStoreData_2_0:
17919
17898
  * allOf:
17920
- * - $ref: '#/components/schemas/IKnowledgeChunkDataCreate_2_0'
17899
+ * - $ref: '#/components/schemas/IKnowledgeStoreDataCreate_2_0'
17921
17900
  * - type: object
17922
17901
  * properties:
17923
- * disabled:
17924
- * type: boolean
17902
+ * language:
17903
+ * type: string
17904
+ * example: "en-US"
17905
+ * description: The language code
17906
+ * status:
17907
+ * type: string
17925
17908
  * enum:
17926
- * - false
17927
- * - true
17928
- * description: The status to check if knowledge chunk is disabled
17909
+ * - ready
17910
+ * - warning
17911
+ * documents:
17912
+ * type: array
17913
+ * items:
17914
+ * type: string
17915
+ * example: "https://some-website.com/knowledgebase.txt"
17916
+ * description: The document url or the file name ingested for the knowledge store
17929
17917
  *
17930
- * IKnowledgeChunkGeneratedData_2_0:
17918
+ * IKnowledgeStoreGeneratedData_2_0:
17931
17919
  * type: object
17932
17920
  * properties:
17933
17921
  * referenceId:
17934
17922
  * type: string
17935
17923
  * format: uuid
17936
17924
  *
17937
- * IKnowledgeChunk_2_0:
17925
+ * IKnowledgeStore_2_0:
17938
17926
  * allOf:
17939
- * - $ref: '#/components/schemas/IKnowledgeChunkData_2_0'
17940
- * - $ref: '#/components/schemas/IKnowledgeChunkGeneratedData_2_0'
17927
+ * - $ref: '#/components/schemas/IKnowledgeStoreData_2_0'
17928
+ * - $ref: '#/components/schemas/IKnowledgeStoreGeneratedData_2_0'
17941
17929
  * - $ref: '#/components/schemas/IEntityMeta'
17942
17930
  */
17943
- export interface IKnowledgeChunk_2_0 {
17931
+ export interface IKnowledgeStore_2_0 {
17944
17932
  _id: TMongoId;
17945
17933
  referenceId: string;
17946
- order: number;
17947
- text: string;
17948
- disabled: boolean;
17949
- data: Record<string, unknown>;
17950
- storeReference: TMongoId;
17951
- sourceReference: TMongoId;
17934
+ name: string;
17935
+ description: string;
17936
+ status: TKnowledgeStoreStatus;
17937
+ language: string;
17938
+ documents: string[];
17952
17939
  projectReference: TMongoId;
17953
17940
  organisationReference: TMongoId;
17954
17941
  createdAt: number;
@@ -17956,713 +17943,809 @@ export interface IKnowledgeChunk_2_0 {
17956
17943
  createdBy: TMongoId;
17957
17944
  lastChangedBy: TMongoId;
17958
17945
  }
17959
- export interface IIndexKnowledgeChunksRestDataParams_2_0 {
17960
- knowledgeStoreId: string;
17961
- sourceId: string;
17962
- }
17963
- export interface IIndexKnowledgeChunksRestData_2_0 extends IIndexKnowledgeChunksRestDataParams_2_0, IRestPagination<IKnowledgeChunk_2_0> {
17964
- }
17965
- export interface IIndexKnowledgeChunksRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeChunk_2_0> {
17946
+ export interface IIndexKnowledgeStoresRestData_2_0 extends IRestPagination<IKnowledgeStore_2_0>, Partial<IProjectScope> {
17966
17947
  }
17967
- export interface ICreateKnowledgeChunkRestDataParams_2_0 {
17968
- knowledgeStoreId: string;
17969
- sourceId: string;
17948
+ export interface IIndexKnowledgeStoresRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeStore_2_0> {
17970
17949
  }
17971
- export interface ICreateKnowledgeChunkRestDataBody_2_0 extends Partial<Pick<IKnowledgeChunk_2_0, "text" | "order" | "data">> {
17950
+ export interface ICreateKnowledgeStoreRestDataBody_2_0 extends IProjectScope, Partial<Omit<IKnowledgeStore_2_0, keyof IEntityMeta | "documents">> {
17972
17951
  }
17973
- export interface ICreateKnowledgeChunkRestData_2_0 extends ICreateKnowledgeChunkRestDataParams_2_0, ICreateKnowledgeChunkRestDataBody_2_0 {
17952
+ export interface ICreateKnowledgeStoreRestData_2_0 extends ICreateKnowledgeStoreRestDataBody_2_0 {
17974
17953
  }
17975
- export interface ICreateKnowledgeChunkRestReturnValue_2_0 extends IKnowledgeChunk_2_0 {
17954
+ export interface ICreateKnowledgeStoreRestReturnValue_2_0 extends IKnowledgeStore_2_0 {
17976
17955
  }
17977
- export interface IReadKnowledgeChunkRestDataParams_2_0 {
17956
+ export interface IReadKnowledgeStoreRestDataParams_2_0 {
17978
17957
  knowledgeStoreId: string;
17979
- sourceId: string;
17980
- chunkId: string;
17981
17958
  }
17982
- export interface IReadKnowledgeChunkRestData_2_0 extends IReadKnowledgeChunkRestDataParams_2_0 {
17959
+ export interface IReadKnowledgeStoreRestData_2_0 extends IReadKnowledgeStoreRestDataParams_2_0 {
17983
17960
  }
17984
- export interface IReadKnowledgeChunkRestReturnValue_2_0 extends IKnowledgeChunk_2_0 {
17961
+ export interface IReadKnowledgeStoreRestReturnValue_2_0 extends IKnowledgeStore_2_0 {
17985
17962
  }
17986
- export interface IDeleteKnowledgeChunkRestDataParams_2_0 {
17963
+ export interface IDeleteKnowledgeStoreRestDataParams_2_0 {
17987
17964
  knowledgeStoreId: string;
17988
- sourceId: string;
17989
- chunkId: string;
17990
17965
  }
17991
- export interface IDeleteKnowledgeChunkRestData_2_0 extends IDeleteKnowledgeChunkRestDataParams_2_0 {
17966
+ export interface IDeleteKnowledgeStoreRestData_2_0 extends IDeleteKnowledgeStoreRestDataParams_2_0 {
17992
17967
  }
17993
- export interface IDeleteKnowledgeChunkRestReturnValue_2_0 {
17968
+ export interface IDeleteKnowledgeStoreRestReturnValue_2_0 {
17994
17969
  }
17995
- export interface IUpdateKnowledgeChunkRestDataBody_2_0 extends Partial<Pick<IKnowledgeChunk_2_0, "text" | "order" | "data" | "disabled">> {
17970
+ export interface IUpdateKnowledgeStoreRestDataBody_2_0 extends Partial<Pick<IKnowledgeStore_2_0, "name" | "description">> {
17996
17971
  }
17997
- export interface IUpdateKnowledgeChunkRestDataParams_2_0 {
17972
+ export interface IUpdateKnowledgeStoreRestDataParams_2_0 {
17998
17973
  knowledgeStoreId: string;
17999
- sourceId: string;
18000
- chunkId: string;
18001
- }
18002
- export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunkRestDataBody_2_0, IUpdateKnowledgeChunkRestDataParams_2_0 {
18003
- }
18004
- export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
18005
- }
18006
- /**
18007
- * @openapi
18008
- *
18009
- * components:
18010
- * schemas:
18011
- * IGoalIndexItem_2_0:
18012
- * allOf:
18013
- * - type: object
18014
- * properties:
18015
- * name:
18016
- * type: string
18017
- * description: The name of the goal
18018
- * example: New Goal
18019
- * - $ref: '#/components/schemas/IEntityMeta'
18020
- */
18021
- export interface IGoalIndexItem_2_0 {
18022
- _id: TMongoId;
18023
- referenceId: string;
18024
- name: string;
18025
- description?: string;
18026
- createdAt: number;
18027
- lastChanged: number;
18028
- createdBy: TMongoId;
18029
- lastChangedBy: TMongoId;
18030
17974
  }
18031
- export interface IIndexGoalsRestData_2_0 extends IRestPagination<IGoalIndexItem_2_0>, Partial<IProjectScope> {
18032
- }
18033
- export interface IIndexGoalsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IGoalIndexItem_2_0> {
17975
+ export interface IUpdateKnowledgeStoreRestData_2_0 extends IUpdateKnowledgeStoreRestDataBody_2_0, IUpdateKnowledgeStoreRestDataParams_2_0 {
18034
17976
  }
18035
- /**
18036
- * @openapi
18037
- *
18038
- * components:
18039
- * schemas:
18040
- * IGoalStepMetric_2_0:
18041
- * type: object
18042
- * properties:
18043
- * name:
18044
- * type: string
18045
- * description: The name of the metric
18046
- * example: Duration
18047
- * description:
18048
- * type: string
18049
- * description: The description of the metric
18050
- * example: Time taken to complete the step
18051
- * type:
18052
- * type: string
18053
- * description: Metric type. Available values "currency", "duration", "revenue"
18054
- * example: "duration"
18055
- * value:
18056
- * type: number
18057
- * description: Metric value
18058
- * example: 30
18059
- */
18060
- export interface IGoalStepMetric_2_0 {
18061
- name: string;
18062
- description: string;
18063
- type?: "currency" | "duration" | "revenue";
18064
- value?: number;
17977
+ export interface IUpdateKnowledgeStoreRestReturnValue_2_0 {
18065
17978
  }
18066
- /**
18067
- * @openapi
18068
- * components:
18069
- * schemas:
18070
- * IGoalStep_2_0:
18071
- * type: object
18072
- * properties:
18073
- * name:
18074
- * type: string
18075
- * description: The name of the goal step
18076
- * example: Step 1
18077
- * description:
18078
- * type: string
18079
- * description: The description of the goal step
18080
- * example: This is the first step
18081
- * order:
18082
- * type: number
18083
- * description: Step order in the goal configuration
18084
- * example: 1
18085
- * type:
18086
- * type: string
18087
- * description: Step type
18088
- * example: "start"
18089
- * metrics:
18090
- * type: array
18091
- * items:
18092
- * $ref: '#/components/schemas/IGoalStepMetric_2_0'
18093
- */
18094
- export interface IGoalStep_2_0 {
18095
- _id?: TMongoId;
18096
- name?: string;
18097
- description?: string;
18098
- order?: number;
18099
- type?: "start" | "completion";
18100
- metrics?: IGoalStepMetric_2_0[];
17979
+ declare const knowledgeSourceStatus: readonly [
17980
+ "ready",
17981
+ "ingesting",
17982
+ "disabled",
17983
+ "failure"
17984
+ ];
17985
+ export declare type TKnowledgeSourceStatus = typeof knowledgeSourceStatus[number];
17986
+ declare const knowledgeSourceType: readonly [
17987
+ "pdf",
17988
+ "txt",
17989
+ "docx",
17990
+ "pptx",
17991
+ "ctxt",
17992
+ "url",
17993
+ "manual",
17994
+ "jpeg",
17995
+ "jpg",
17996
+ "png",
17997
+ "bmp",
17998
+ "heif",
17999
+ "tiff"
18000
+ ];
18001
+ export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
18002
+ export interface IKnowledgeSourceMetaData {
18003
+ size?: number;
18004
+ fileName?: string;
18005
+ mimeType?: string;
18006
+ url?: string;
18007
+ failReason?: string;
18008
+ tags?: string[];
18009
+ extractedChunks?: number;
18101
18010
  }
18102
18011
  /**
18103
18012
  * @openapi
18104
18013
  *
18105
18014
  * components:
18106
18015
  * schemas:
18107
- * IGoalData_2_0:
18016
+ * IKnowledgeSourceDataCreate_2_0:
18017
+ * allOf:
18018
+ * - type: object
18019
+ * properties:
18020
+ * name:
18021
+ * type: string
18022
+ * example: "mysource"
18023
+ * description: The name of the KnowledgeSource
18024
+ * description:
18025
+ * type: string
18026
+ * example: "mysource description"
18027
+ * description: The description about what the knowledge source contains
18028
+ * type:
18029
+ * type: string
18030
+ * enum:
18031
+ * - url
18032
+ * - manual
18033
+ * - pdf
18034
+ * - txt
18035
+ * - ctxt
18036
+ * description: The type of source for the Knowledge store
18037
+ * metaData:
18038
+ * type: object
18039
+ * properties:
18040
+ * tags:
18041
+ * type: array
18042
+ * items:
18043
+ * type: string
18044
+ * example: "tag1"
18045
+ * IKnowledgeSourceDataUpdate_2_0:
18046
+ * allOf:
18047
+ * - type: object
18048
+ * properties:
18049
+ * name:
18050
+ * type: string
18051
+ * example: "mysource"
18052
+ * description: The name of the KnowledgeSource
18053
+ * description:
18054
+ * type: string
18055
+ * example: "mysource description"
18056
+ * description: The description about what the knowledge source contains
18057
+ * status:
18058
+ * type: string
18059
+ * enum:
18060
+ * - ready
18061
+ * - ingesting
18062
+ * - disabled
18063
+ * metaData:
18064
+ * type: object
18065
+ * properties:
18066
+ * tags:
18067
+ * type: array
18068
+ * description: Array of tags to replace the existing tags
18069
+ * items:
18070
+ * type: string
18071
+ * example: "tag1"
18072
+ * IKnowledgeSourceDataTypeWebsite_2_0:
18073
+ * allOf:
18074
+ * - type: object
18075
+ * properties:
18076
+ * url:
18077
+ * type: string
18078
+ * example: "https://www.some-article.com"
18079
+ * description: The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "url"
18080
+ *
18081
+ * IKnowledgeSourceData_2_0:
18082
+ * allOf:
18083
+ * - $ref: '#/components/schemas/IKnowledgeSourceDataCreate_2_0'
18084
+ * - type: object
18085
+ * properties:
18086
+ * metaData:
18087
+ * type: object
18088
+ * chunkCount:
18089
+ * type: integer
18090
+ * status:
18091
+ * type: string
18092
+ * enum:
18093
+ * - ready
18094
+ * - ingesting
18095
+ * - disabled
18096
+ *
18097
+ * IKnowledgeSourceGeneratedData_2_0:
18108
18098
  * type: object
18109
18099
  * properties:
18110
- * name:
18111
- * type: string
18112
- * description: The name of the Goal
18113
- * example: New Goal
18114
- * description:
18100
+ * referenceId:
18115
18101
  * type: string
18116
- * description: The description of the goal
18117
- * example: "This is a sample goal"
18118
- * steps:
18119
- * type: array
18120
- * items:
18121
- * $ref: '#/components/schemas/IGoalStep_2_0'
18102
+ * format: uuid
18122
18103
  *
18123
- * IGoal_2_0:
18104
+ * IKnowledgeSource_2_0:
18124
18105
  * allOf:
18125
- * - $ref: '#/components/schemas/IGoalData_2_0'
18106
+ * - $ref: '#/components/schemas/IKnowledgeSourceData_2_0'
18107
+ * - $ref: '#/components/schemas/IKnowledgeSourceGeneratedData_2_0'
18126
18108
  * - $ref: '#/components/schemas/IEntityMeta'
18127
- *
18128
18109
  */
18129
- export interface IGoal_2_0 {
18110
+ export interface IKnowledgeSource_2_0 {
18130
18111
  _id: TMongoId;
18131
18112
  referenceId: string;
18132
18113
  name: string;
18133
- version: string;
18114
+ description: string;
18115
+ status: TKnowledgeSourceStatus;
18116
+ type: TKnowledgeSourceType;
18117
+ chunkCount: number;
18118
+ metaData: IKnowledgeSourceMetaData;
18119
+ data: Record<string, unknown>;
18120
+ storeReference: TMongoId;
18121
+ projectReference: TMongoId;
18122
+ organisationReference: TMongoId;
18134
18123
  createdAt: number;
18135
18124
  lastChanged: number;
18136
18125
  createdBy: TMongoId;
18137
18126
  lastChangedBy: TMongoId;
18138
- description: string;
18139
- steps: IGoalStep_2_0[];
18140
18127
  }
18141
- export interface ICreateGoalRestDataBody_2_0 extends IProjectScope, Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
18128
+ export interface IIndexKnowledgeSourcesRestDataParams_2_0 {
18129
+ knowledgeStoreId: string;
18142
18130
  }
18143
- export interface ICreateGoalRestData_2_0 extends ICreateGoalRestDataBody_2_0 {
18131
+ export interface IIndexKnowledgeSourcesRestData_2_0 extends IIndexKnowledgeSourcesRestDataParams_2_0, IRestPagination<IKnowledgeSource_2_0> {
18144
18132
  }
18145
- export interface ICreateGoalRestReturnValue_2_0 extends IGoal_2_0 {
18133
+ export interface IIndexKnowledgeSourcesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeSource_2_0> {
18146
18134
  }
18147
- export interface IReadGoalRestDataParams_2_0 {
18148
- goalId: string;
18135
+ export interface ICreateKnowledgeSourceRestDataParams_2_0 {
18136
+ knowledgeStoreId: string;
18149
18137
  }
18150
- export interface IReadGoalRestData_2_0 extends IReadGoalRestDataParams_2_0 {
18138
+ export interface ICreateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "type" | "metaData">> {
18139
+ url?: string;
18151
18140
  }
18152
- export interface IReadGoalRestReturnValue_2_0 extends IGoal_2_0 {
18141
+ export interface ICreateKnowledgeSourceRestData_2_0 extends ICreateKnowledgeSourceRestDataParams_2_0, ICreateKnowledgeSourceRestDataBody_2_0 {
18153
18142
  }
18154
- export interface IUpdateGoalRestDataParams_2_0 {
18155
- goalId: string;
18143
+ export interface ICreateKnowledgeSourceRestReturnValue_2_0 {
18144
+ knowledgeSource?: IKnowledgeSource_2_0;
18145
+ taskData?: ICreatedTask_2_0;
18156
18146
  }
18157
- export interface IUpdateGoalRestDataBody_2_0 extends Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
18147
+ export interface IReadKnowledgeSourceRestDataParams_2_0 {
18148
+ knowledgeStoreId: string;
18149
+ sourceId: string;
18158
18150
  }
18159
- export interface IUpdateGoalRestData_2_0 extends IUpdateGoalRestDataBody_2_0, IUpdateGoalRestDataParams_2_0 {
18151
+ export interface IReadKnowledgeSourceRestData_2_0 extends IReadKnowledgeSourceRestDataParams_2_0 {
18160
18152
  }
18161
- export interface IUpdateGoalRestReturnValue_2_0 {
18153
+ export interface IReadKnowledgeSourceRestReturnValue_2_0 extends IKnowledgeSource_2_0 {
18162
18154
  }
18163
- export interface IDeleteGoalRestDataParams_2_0 {
18164
- goalId: string;
18155
+ export interface IDeleteKnowledgeSourceRestDataParams_2_0 {
18156
+ knowledgeStoreId: string;
18157
+ sourceId: string;
18165
18158
  }
18166
- export interface IDeleteGoalRestData_2_0 extends IDeleteGoalRestDataParams_2_0 {
18159
+ export interface IDeleteKnowledgeSourceRestData_2_0 extends IDeleteKnowledgeSourceRestDataParams_2_0 {
18167
18160
  }
18168
- export interface IDeleteGoalRestReturnValue_2_0 {
18161
+ export interface IDeleteKnowledgeSourceRestReturnValue_2_0 {
18162
+ }
18163
+ export interface IUpdateKnowledgeSourceRestDataBody_2_0 extends Partial<Pick<IKnowledgeSource_2_0, "name" | "description" | "status" | "data">> {
18164
+ metaData?: Partial<Pick<IKnowledgeSourceMetaData, "tags">>;
18165
+ }
18166
+ export interface IUpdateKnowledgeSourceRestDataParams_2_0 {
18167
+ knowledgeStoreId: string;
18168
+ sourceId: string;
18169
+ }
18170
+ export interface IUpdateKnowledgeSourceRestData_2_0 extends IUpdateKnowledgeSourceRestDataBody_2_0, IUpdateKnowledgeSourceRestDataParams_2_0 {
18171
+ }
18172
+ export interface IUpdateKnowledgeSourceRestReturnValue_2_0 {
18173
+ }
18174
+ export interface IUploadKnowledgeSourceFileRestDataParams_2_0 {
18175
+ knowledgeStoreId: string;
18176
+ }
18177
+ export interface IUploadKnowledgeSourceFileRestDataBody_2_0 {
18178
+ file: File | Buffer;
18179
+ tags?: string[];
18180
+ }
18181
+ export interface IUploadKnowledgeSourceFileRestData_2_0 extends IUploadKnowledgeSourceFileRestDataParams_2_0, IUploadKnowledgeSourceFileRestDataBody_2_0 {
18182
+ }
18183
+ export interface IUploadKnowledgeSourceFileRestReturnValue_2_0 extends ICreatedTask_2_0 {
18169
18184
  }
18170
18185
  /**
18171
18186
  * @openapi
18172
18187
  *
18173
18188
  * components:
18174
18189
  * schemas:
18175
- * IHandoverProvider_2_0:
18176
- * type: object
18177
- * properties:
18178
- * _id:
18179
- * type: string
18180
- * format: mongoId
18181
- * description: The object id of the handover provider
18182
- * referenceId:
18183
- * type: string
18184
- * description: The referenceId of the handover provider
18185
- * organisationId:
18186
- * type: string
18187
- * description: The organisation Id associated with the handover provider
18188
- * serviceId:
18189
- * type: string
18190
- * description: The id of the service
18191
- * service:
18192
- * type: string
18193
- * description: The handover provider's specified service; e.g., Live Agent, Genesys
18194
- * localeId:
18195
- * type: string
18196
- * description: The referenceId of the locale to use
18197
- * name:
18198
- * type: string
18199
- * description: The name of the handover provider resource
18200
- * createdAt:
18201
- * type: integer
18202
- * format: int64
18203
- * description: Unix-timestamp when the entity was created initially
18204
- * lastChangedAt:
18205
- * type: integer
18206
- * format: int64
18207
- * description: Unix-timestamp when the entity was last modified
18208
- * createdBy:
18209
- * type: string
18210
- * format: mongoId
18211
- * description: Id of the user who created the entity initially
18212
- * lastChangedBy:
18190
+ * IKnowledgeChunkDataCreate_2_0:
18191
+ * allOf:
18192
+ * - type: object
18193
+ * properties:
18194
+ * order:
18195
+ * type: number
18196
+ * example: 1
18197
+ * description: The name of the KnowledgeChunk
18198
+ * text:
18199
+ * type: string
18200
+ * example: "This is a paragraph from an article"
18201
+ * description: The text that is the actual content of the chunk
18202
+ * data:
18203
+ * type: object
18204
+ * description: The extended data of KnowledgeChunk
18205
+ *
18206
+ * IKnowledgeChunkData_2_0:
18207
+ * allOf:
18208
+ * - $ref: '#/components/schemas/IKnowledgeChunkDataCreate_2_0'
18209
+ * - type: object
18210
+ * properties:
18211
+ * disabled:
18212
+ * type: boolean
18213
+ * enum:
18214
+ * - false
18215
+ * - true
18216
+ * description: The status to check if knowledge chunk is disabled
18217
+ *
18218
+ * IKnowledgeChunkGeneratedData_2_0:
18219
+ * type: object
18220
+ * properties:
18221
+ * referenceId:
18213
18222
  * type: string
18214
- * format: mongoId
18215
- * description: Id of the user who made the last modification
18216
- * properties:
18217
- * type: array
18218
- * items:
18219
- * type: object
18220
- * description: Properties associated with the handover provider
18221
- * additionalProperties:
18222
- * type: string
18223
- * description: A list of properties associated with the handover provider
18224
- * settings:
18225
- * type: object
18226
- * description: Settings related to the handover provider
18227
- * additionalProperties:
18228
- * type: string
18223
+ * format: uuid
18224
+ *
18225
+ * IKnowledgeChunk_2_0:
18226
+ * allOf:
18227
+ * - $ref: '#/components/schemas/IKnowledgeChunkData_2_0'
18228
+ * - $ref: '#/components/schemas/IKnowledgeChunkGeneratedData_2_0'
18229
+ * - $ref: '#/components/schemas/IEntityMeta'
18229
18230
  */
18230
- export interface IHandoverProvider_2_0 {
18231
+ export interface IKnowledgeChunk_2_0 {
18231
18232
  _id: TMongoId;
18232
18233
  referenceId: string;
18233
- organisationId: string;
18234
- serviceId: string;
18235
- service: THandoverService;
18236
- /** The referenceId of the locale to use */
18237
- localeId: string;
18238
- /** The name of the handover provider resource */
18239
- name: string;
18234
+ order: number;
18235
+ text: string;
18236
+ disabled: boolean;
18237
+ data: Record<string, unknown>;
18238
+ storeReference: TMongoId;
18239
+ sourceReference: TMongoId;
18240
+ projectReference: TMongoId;
18241
+ organisationReference: TMongoId;
18240
18242
  createdAt: number;
18241
- lastChangedAt: number;
18243
+ lastChanged: number;
18242
18244
  createdBy: TMongoId;
18243
18245
  lastChangedBy: TMongoId;
18244
- properties: IHandoverProviderProperties[];
18245
- settings: IHandoverProviderSettings_2_0;
18246
18246
  }
18247
- export interface IHandoverProviderSettings_2_0 {
18248
- service: THandoverService;
18249
- serviceSettings?: TServiceSettings;
18247
+ export interface IIndexKnowledgeChunksRestDataParams_2_0 {
18248
+ knowledgeStoreId: string;
18249
+ sourceId: string;
18250
18250
  }
18251
- export interface IIndexHandoverProvidersRestData_2_0 extends IRestPagination<IHandoverProvider_2_0>, Partial<IProjectScope> {
18251
+ export interface IIndexKnowledgeChunksRestData_2_0 extends IIndexKnowledgeChunksRestDataParams_2_0, IRestPagination<IKnowledgeChunk_2_0> {
18252
18252
  }
18253
- export interface IIndexHandoverProvidersRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IHandoverProvider_2_0> {
18253
+ export interface IIndexKnowledgeChunksRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeChunk_2_0> {
18254
18254
  }
18255
- export interface ICreateHandoverProviderRestDataBody_2_0 extends IProjectScope, Partial<Omit<IHandoverProvider_2_0, keyof IEntityMeta | "URLToken">> {
18255
+ export interface ICreateKnowledgeChunkRestDataParams_2_0 {
18256
+ knowledgeStoreId: string;
18257
+ sourceId: string;
18256
18258
  }
18257
- export interface ICreateHandoverProviderRestDataQuery_2_0 {
18258
- resourceId?: string;
18259
+ export interface ICreateKnowledgeChunkRestDataBody_2_0 extends Partial<Pick<IKnowledgeChunk_2_0, "text" | "order" | "data">> {
18259
18260
  }
18260
- export interface ICreateHandoverProviderRestData_2_0 extends ICreateHandoverProviderRestDataBody_2_0, ICreateHandoverProviderRestDataQuery_2_0 {
18261
+ export interface ICreateKnowledgeChunkRestData_2_0 extends ICreateKnowledgeChunkRestDataParams_2_0, ICreateKnowledgeChunkRestDataBody_2_0 {
18261
18262
  }
18262
- export interface ICreateHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
18263
+ export interface ICreateKnowledgeChunkRestReturnValue_2_0 extends IKnowledgeChunk_2_0 {
18263
18264
  }
18264
- export interface IReadHandoverProviderRestDataParams_2_0 {
18265
- handoverProviderId: string;
18265
+ export interface IReadKnowledgeChunkRestDataParams_2_0 {
18266
+ knowledgeStoreId: string;
18267
+ sourceId: string;
18268
+ chunkId: string;
18266
18269
  }
18267
- export interface IReadHandoverProviderRestData_2_0 extends IReadHandoverProviderRestDataParams_2_0 {
18270
+ export interface IReadKnowledgeChunkRestData_2_0 extends IReadKnowledgeChunkRestDataParams_2_0 {
18268
18271
  }
18269
- export interface IReadHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
18272
+ export interface IReadKnowledgeChunkRestReturnValue_2_0 extends IKnowledgeChunk_2_0 {
18270
18273
  }
18271
- export interface IUpdateHandoverProviderRestDataBody_2_0 extends Partial<Omit<IHandoverProvider_2_0, keyof IEntityMeta | "URLToken">> {
18274
+ export interface IDeleteKnowledgeChunkRestDataParams_2_0 {
18275
+ knowledgeStoreId: string;
18276
+ sourceId: string;
18277
+ chunkId: string;
18272
18278
  }
18273
- export interface IUpdateHandoverProviderRestDataParams_2_0 {
18274
- handoverProviderId: string;
18275
- projectId: string;
18279
+ export interface IDeleteKnowledgeChunkRestData_2_0 extends IDeleteKnowledgeChunkRestDataParams_2_0 {
18276
18280
  }
18277
- export interface IUpdateHandoverProviderRestData_2_0 extends IUpdateHandoverProviderRestDataBody_2_0, IUpdateHandoverProviderRestDataParams_2_0 {
18281
+ export interface IDeleteKnowledgeChunkRestReturnValue_2_0 {
18278
18282
  }
18279
- export interface IUpdateHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
18283
+ export interface IUpdateKnowledgeChunkRestDataBody_2_0 extends Partial<Pick<IKnowledgeChunk_2_0, "text" | "order" | "data" | "disabled">> {
18280
18284
  }
18281
- export interface IDeleteHandoverProviderRestDataParams_2_0 {
18282
- handoverProviderId: string;
18283
- projectId: string;
18285
+ export interface IUpdateKnowledgeChunkRestDataParams_2_0 {
18286
+ knowledgeStoreId: string;
18287
+ sourceId: string;
18288
+ chunkId: string;
18284
18289
  }
18285
- export interface IDeleteHandoverProviderRestData_2_0 extends IDeleteHandoverProviderRestDataParams_2_0 {
18290
+ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunkRestDataBody_2_0, IUpdateKnowledgeChunkRestDataParams_2_0 {
18286
18291
  }
18287
- export interface IDeleteHandoverProviderRestReturnValue_2_0 {
18292
+ export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
18288
18293
  }
18289
18294
  /**
18290
18295
  * @openapi
18291
18296
  *
18292
18297
  * components:
18293
18298
  * schemas:
18294
- * IHandoverService_2_0:
18299
+ * IGoalIndexItem_2_0:
18300
+ * allOf:
18301
+ * - type: object
18302
+ * properties:
18303
+ * name:
18304
+ * type: string
18305
+ * description: The name of the goal
18306
+ * example: New Goal
18307
+ * - $ref: '#/components/schemas/IEntityMeta'
18308
+ */
18309
+ export interface IGoalIndexItem_2_0 {
18310
+ _id: TMongoId;
18311
+ referenceId: string;
18312
+ name: string;
18313
+ description?: string;
18314
+ createdAt: number;
18315
+ lastChanged: number;
18316
+ createdBy: TMongoId;
18317
+ lastChangedBy: TMongoId;
18318
+ }
18319
+ export interface IIndexGoalsRestData_2_0 extends IRestPagination<IGoalIndexItem_2_0>, Partial<IProjectScope> {
18320
+ }
18321
+ export interface IIndexGoalsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IGoalIndexItem_2_0> {
18322
+ }
18323
+ /**
18324
+ * @openapi
18325
+ *
18326
+ * components:
18327
+ * schemas:
18328
+ * IGoalStepMetric_2_0:
18295
18329
  * type: object
18296
18330
  * properties:
18297
- * _id:
18331
+ * name:
18298
18332
  * type: string
18299
- * format: mongoId
18300
- * description: The object id of the handover service
18301
- * referenceId:
18333
+ * description: The name of the metric
18334
+ * example: Duration
18335
+ * description:
18302
18336
  * type: string
18303
- * format: uuid
18304
- * description: The referenceId of the handover service
18305
- * version:
18337
+ * description: The description of the metric
18338
+ * example: Time taken to complete the step
18339
+ * type:
18306
18340
  * type: string
18307
- * description: The version of the handover service
18341
+ * description: Metric type. Available values "currency", "duration", "revenue"
18342
+ * example: "duration"
18343
+ * value:
18344
+ * type: number
18345
+ * description: Metric value
18346
+ * example: 30
18347
+ */
18348
+ export interface IGoalStepMetric_2_0 {
18349
+ name: string;
18350
+ description: string;
18351
+ type?: "currency" | "duration" | "revenue";
18352
+ value?: number;
18353
+ }
18354
+ /**
18355
+ * @openapi
18356
+ * components:
18357
+ * schemas:
18358
+ * IGoalStep_2_0:
18359
+ * type: object
18360
+ * properties:
18308
18361
  * name:
18309
18362
  * type: string
18310
- * description: The name of the handover service
18311
- * serviceUrl:
18363
+ * description: The name of the goal step
18364
+ * example: Step 1
18365
+ * description:
18312
18366
  * type: string
18313
- * format: uri
18314
- * description: The service URL of the handover service
18315
- * logoUrl:
18367
+ * description: The description of the goal step
18368
+ * example: This is the first step
18369
+ * order:
18370
+ * type: number
18371
+ * description: Step order in the goal configuration
18372
+ * example: 1
18373
+ * type:
18316
18374
  * type: string
18317
- * format: uri
18318
- * description: The logo URL of the handover service
18319
- * properties:
18375
+ * description: Step type
18376
+ * example: "start"
18377
+ * metrics:
18320
18378
  * type: array
18321
18379
  * items:
18322
- * type: object
18323
- * description: Properties associated with the handover service
18324
- * additionalProperties:
18325
- * type: string
18326
- * description: A list of properties for the handover service
18380
+ * $ref: '#/components/schemas/IGoalStepMetric_2_0'
18327
18381
  */
18328
- export interface IHandoverService_2_0 {
18329
- _id: TMongoId;
18330
- referenceId: string;
18331
- version: string;
18332
- name: string;
18333
- serviceUrl: string;
18334
- logoUrl: string;
18335
- properties: IHandoverServiceProperties[];
18336
- }
18337
- export interface IIndexHandoverServicesRestData_2_0 extends IRestPagination<IHandoverService_2_0>, Partial<IProjectScope> {
18338
- }
18339
- export interface IIndexHandoverServicesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IHandoverService_2_0> {
18340
- }
18341
- declare const uploadResumableTypes: readonly [
18342
- "snapshots",
18343
- "packages"
18344
- ];
18345
- export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
18346
- export interface HttpRequest {
18347
- getMethod(): string;
18348
- getURL(): string;
18349
- setHeader(header: string, value: string): void;
18350
- getHeader(header: string): string;
18351
- setProgressHandler(handler: (bytesSent: number) => void): void;
18352
- send(body: any): Promise<HttpResponse>;
18353
- abort(): Promise<void>;
18354
- getUnderlyingObject(): any;
18355
- }
18356
- export interface HttpResponse {
18357
- getStatus(): number;
18358
- getHeader(header: string): string;
18359
- getBody(): string;
18360
- getUnderlyingObject(): any;
18361
- }
18362
- export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
18363
- file: Buffer | File;
18364
- onError?: ((error: Error) => void) | null;
18365
- onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
18366
- onSuccess?: (() => void) | null;
18367
- onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
18368
- onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
18369
- onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
18370
- onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
18371
- }
18372
- export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
18373
- uploadType: TUploadResumableTypes;
18374
- }
18375
- export interface IUploadResumableRestReturnValue_2_0 {
18376
- fileName: string;
18377
- url: string;
18378
- uploadId: string;
18382
+ export interface IGoalStep_2_0 {
18383
+ _id?: TMongoId;
18384
+ name?: string;
18385
+ description?: string;
18386
+ order?: number;
18387
+ type?: "start" | "completion";
18388
+ metrics?: IGoalStepMetric_2_0[];
18379
18389
  }
18380
18390
  /**
18381
18391
  * @openapi
18382
18392
  *
18383
18393
  * components:
18384
18394
  * schemas:
18385
- * IGenerateNluScoreData_2_0:
18386
- * type: object
18387
- * required:
18388
- * - flowReferenceId
18389
- * - localeReferenceId
18390
- * - sentence
18391
- * properties:
18392
- * flowReferenceId:
18393
- * type: string
18394
- * format: uuid
18395
- * description: UUID of the flow reference.
18396
- * localeReferenceId:
18397
- * type: string
18398
- * format: uuid
18399
- * description: UUID of the locale reference.
18400
- * sentence:
18401
- * type: string
18402
- * description: Sentence to analyze for NLU scoring.
18403
- *
18404
- * IGeneratedNluScore_2_0:
18395
+ * IGoalData_2_0:
18405
18396
  * type: object
18406
18397
  * properties:
18407
- * id:
18408
- * type: string
18409
- * description: Unique identifier of the score.
18410
18398
  * name:
18411
18399
  * type: string
18412
- * description: Name of the score type.
18413
- * score:
18414
- * type: number
18415
- * description: Numerical value of the score.
18416
- * negated:
18417
- * type: boolean
18418
- * description: Indicates if the score is negated.
18419
- * confirmationSentence:
18400
+ * description: The name of the Goal
18401
+ * example: New Goal
18402
+ * description:
18420
18403
  * type: string
18421
- * description: Sentence used to confirm the score.
18422
- * confirmationSentences:
18404
+ * description: The description of the goal
18405
+ * example: "This is a sample goal"
18406
+ * steps:
18423
18407
  * type: array
18424
18408
  * items:
18425
- * type: string
18426
- * description: Multiple sentences for confirmation if applicable.
18427
- * disambiguationSentence:
18428
- * type: string
18429
- * description: Sentence used for disambiguation.
18430
- * flow:
18431
- * type: string
18432
- * description: UUID of the flow associated with the score.
18433
- */
18434
- export interface IGenerateNluScoresRestDataParams_2_0 {
18435
- projectId: string;
18409
+ * $ref: '#/components/schemas/IGoalStep_2_0'
18410
+ *
18411
+ * IGoal_2_0:
18412
+ * allOf:
18413
+ * - $ref: '#/components/schemas/IGoalData_2_0'
18414
+ * - $ref: '#/components/schemas/IEntityMeta'
18415
+ *
18416
+ */
18417
+ export interface IGoal_2_0 {
18418
+ _id: TMongoId;
18419
+ referenceId: string;
18420
+ name: string;
18421
+ version: string;
18422
+ createdAt: number;
18423
+ lastChanged: number;
18424
+ createdBy: TMongoId;
18425
+ lastChangedBy: TMongoId;
18426
+ description: string;
18427
+ steps: IGoalStep_2_0[];
18436
18428
  }
18437
- export interface IGenerateNluScoresRestDataBody_2_0 {
18438
- flowReferenceId: string;
18439
- localeReferenceId: string;
18440
- sentence: string;
18429
+ export interface ICreateGoalRestDataBody_2_0 extends IProjectScope, Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
18441
18430
  }
18442
- export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
18431
+ export interface ICreateGoalRestData_2_0 extends ICreateGoalRestDataBody_2_0 {
18443
18432
  }
18444
- export interface IGenerateNluScoresRestReturnValue_2_0 {
18433
+ export interface ICreateGoalRestReturnValue_2_0 extends IGoal_2_0 {
18434
+ }
18435
+ export interface IReadGoalRestDataParams_2_0 {
18436
+ goalId: string;
18437
+ }
18438
+ export interface IReadGoalRestData_2_0 extends IReadGoalRestDataParams_2_0 {
18439
+ }
18440
+ export interface IReadGoalRestReturnValue_2_0 extends IGoal_2_0 {
18441
+ }
18442
+ export interface IUpdateGoalRestDataParams_2_0 {
18443
+ goalId: string;
18444
+ }
18445
+ export interface IUpdateGoalRestDataBody_2_0 extends Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
18446
+ }
18447
+ export interface IUpdateGoalRestData_2_0 extends IUpdateGoalRestDataBody_2_0, IUpdateGoalRestDataParams_2_0 {
18448
+ }
18449
+ export interface IUpdateGoalRestReturnValue_2_0 {
18450
+ }
18451
+ export interface IDeleteGoalRestDataParams_2_0 {
18452
+ goalId: string;
18453
+ }
18454
+ export interface IDeleteGoalRestData_2_0 extends IDeleteGoalRestDataParams_2_0 {
18455
+ }
18456
+ export interface IDeleteGoalRestReturnValue_2_0 {
18445
18457
  }
18446
18458
  /**
18447
18459
  * @openapi
18448
18460
  *
18449
18461
  * components:
18450
18462
  * schemas:
18451
- * IAiAgentData_2_0:
18463
+ * IHandoverProvider_2_0:
18452
18464
  * type: object
18453
18465
  * properties:
18454
- * name:
18466
+ * _id:
18455
18467
  * type: string
18456
- * example: "Cognigy AI Agent"
18457
- * image:
18468
+ * format: mongoId
18469
+ * description: The object id of the handover provider
18470
+ * referenceId:
18458
18471
  * type: string
18459
- * description: Avatar of the AI Agent.
18460
- * example: "https://cognigy.com/ai-agent.png"
18461
- * imageOptimizedFormat:
18462
- * type: boolean
18463
- * description: Whether the optimized image format defined by Cognigy is used.
18464
- * example: true
18465
- * knowledgeReferenceId:
18472
+ * description: The referenceId of the handover provider
18473
+ * organisationId:
18466
18474
  * type: string
18467
- * format: uuid
18468
- * description: A referenceId of a Knowledge Store this Agent will use as base knowledge.
18469
- * example: "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
18470
- * description:
18475
+ * description: The organisation Id associated with the handover provider
18476
+ * serviceId:
18471
18477
  * type: string
18472
- * maxLength: 1000
18473
- * description: A short description of the AI Agent, up to 1000 characters.
18474
- * example: "I am a virtual assistant that can help you with your questions."
18475
- * speakingStyle:
18476
- * type: object
18477
- * properties:
18478
- * completeness:
18479
- * type: string
18480
- * formality:
18481
- * type: string
18482
- * example: { "completeness": "concise", "formality": "formal" }
18483
- * voiceConfigs:
18484
- * type: object
18485
- * properties:
18486
- * ttsVoice:
18487
- * type: string
18488
- * ttsLanguage:
18489
- * type: string
18490
- * ttsVendor:
18491
- * enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
18492
- * type: string
18493
- * ttsModel:
18494
- * type: string
18495
- * ttsLabel:
18496
- * type: string
18497
- * ttsDisableCache:
18498
- * type: boolean
18499
- * example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false }
18500
- * enableVoiceConfigs:
18501
- * type: boolean
18502
- * description: Enables the use of voice configuration.
18503
- * example: false
18504
- * safetySettings:
18505
- * type: object
18506
- * properties:
18507
- * avoidHarmfulContent:
18508
- * type: boolean
18509
- * avoidUngroundedContent:
18510
- * type: boolean
18511
- * avoidCopyrightInfringements:
18512
- * type: boolean
18513
- * preventJailbreakAndManipulation:
18514
- * type: boolean
18515
- * contactProfilesOption:
18478
+ * description: The id of the service
18479
+ * service:
18516
18480
  * type: string
18517
- * enum:
18518
- * - "none"
18519
- * - "selectedProfileFields"
18520
- * - "completeProfile"
18521
- * - "profileMemoriesOnly"
18522
- * description: Option to enable or customize Contact profiles selection for the AI Agent.
18523
- * example: "selectedProfileFields"
18524
- * contactProfilesSelected:
18481
+ * description: The handover provider's specified service; e.g., Live Agent, Genesys
18482
+ * localeId:
18483
+ * type: string
18484
+ * description: The referenceId of the locale to use
18485
+ * name:
18486
+ * type: string
18487
+ * description: The name of the handover provider resource
18488
+ * createdAt:
18489
+ * type: integer
18490
+ * format: int64
18491
+ * description: Unix-timestamp when the entity was created initially
18492
+ * lastChangedAt:
18493
+ * type: integer
18494
+ * format: int64
18495
+ * description: Unix-timestamp when the entity was last modified
18496
+ * createdBy:
18497
+ * type: string
18498
+ * format: mongoId
18499
+ * description: Id of the user who created the entity initially
18500
+ * lastChangedBy:
18501
+ * type: string
18502
+ * format: mongoId
18503
+ * description: Id of the user who made the last modification
18504
+ * properties:
18525
18505
  * type: array
18526
18506
  * items:
18507
+ * type: object
18508
+ * description: Properties associated with the handover provider
18509
+ * additionalProperties:
18510
+ * type: string
18511
+ * description: A list of properties associated with the handover provider
18512
+ * settings:
18513
+ * type: object
18514
+ * description: Settings related to the handover provider
18515
+ * additionalProperties:
18527
18516
  * type: string
18528
- * description: Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
18529
- * example: ["name", "email"]
18530
- * instructions:
18531
- * type: string
18532
- * description: Instructions for the AI Agent.
18533
- * example: "I can help you with your questions, provide information and much more."
18534
- * maxLength: 1000
18535
- * IAiAgent_2_0:
18536
- * allOf:
18537
- * - $ref: '#/components/schemas/IAiAgentData_2_0'
18538
- * - $ref: '#/components/schemas/IEntityMeta'
18539
18517
  */
18540
- export interface IAiAgent_2_0 {
18518
+ export interface IHandoverProvider_2_0 {
18541
18519
  _id: TMongoId;
18542
- name: string;
18543
18520
  referenceId: string;
18544
- image: string;
18545
- imageOptimizedFormat: boolean;
18546
- instructions: string;
18547
- knowledgeReferenceId: string;
18548
- description: string;
18549
- speakingStyle: ISpeakingStyle;
18550
- voiceConfigs: IVoiceConfigParams;
18551
- enableVoiceConfigs: boolean;
18552
- safetySettings: ISafetySettings;
18553
- contactProfilesOption: TContactProfileOptions;
18554
- contactProfilesSelected: string[];
18555
- projectReference: TMongoId;
18556
- organisationReference: TMongoId;
18521
+ organisationId: string;
18522
+ serviceId: string;
18523
+ service: THandoverService;
18524
+ /** The referenceId of the locale to use */
18525
+ localeId: string;
18526
+ /** The name of the handover provider resource */
18527
+ name: string;
18557
18528
  createdAt: number;
18558
- lastChanged: number;
18529
+ lastChangedAt: number;
18559
18530
  createdBy: TMongoId;
18560
18531
  lastChangedBy: TMongoId;
18532
+ properties: IHandoverProviderProperties[];
18533
+ settings: IHandoverProviderSettings_2_0;
18534
+ }
18535
+ export interface IHandoverProviderSettings_2_0 {
18536
+ service: THandoverService;
18537
+ serviceSettings?: TServiceSettings;
18538
+ }
18539
+ export interface IIndexHandoverProvidersRestData_2_0 extends IRestPagination<IHandoverProvider_2_0>, Partial<IProjectScope> {
18561
18540
  }
18562
- export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
18541
+ export interface IIndexHandoverProvidersRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IHandoverProvider_2_0> {
18563
18542
  }
18564
- export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
18543
+ export interface ICreateHandoverProviderRestDataBody_2_0 extends IProjectScope, Partial<Omit<IHandoverProvider_2_0, keyof IEntityMeta | "URLToken">> {
18565
18544
  }
18566
- export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
18545
+ export interface ICreateHandoverProviderRestDataQuery_2_0 {
18546
+ resourceId?: string;
18567
18547
  }
18568
- export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
18548
+ export interface ICreateHandoverProviderRestData_2_0 extends ICreateHandoverProviderRestDataBody_2_0, ICreateHandoverProviderRestDataQuery_2_0 {
18569
18549
  }
18570
- export interface IUpdateAiAgentRestDataParams_2_0 {
18571
- aiAgentId: string;
18550
+ export interface ICreateHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
18572
18551
  }
18573
- export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
18552
+ export interface IReadHandoverProviderRestDataParams_2_0 {
18553
+ handoverProviderId: string;
18574
18554
  }
18575
- export interface IUpdateAiAgentRestReturnValue_2_0 {
18555
+ export interface IReadHandoverProviderRestData_2_0 extends IReadHandoverProviderRestDataParams_2_0 {
18576
18556
  }
18577
- export interface IReadAiAgentRestDataParams_2_0 {
18578
- aiAgentId: string;
18557
+ export interface IReadHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
18579
18558
  }
18580
- export interface IReadAiAgentRestData_2_0 extends IReadAiAgentRestDataParams_2_0 {
18559
+ export interface IUpdateHandoverProviderRestDataBody_2_0 extends Partial<Omit<IHandoverProvider_2_0, keyof IEntityMeta | "URLToken">> {
18581
18560
  }
18582
- export interface IReadAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
18561
+ export interface IUpdateHandoverProviderRestDataParams_2_0 {
18562
+ handoverProviderId: string;
18563
+ projectId: string;
18583
18564
  }
18584
- export interface IIndexAiAgentsRestData_2_0 extends IRestPagination<IAiAgent_2_0>, IProjectScope {
18565
+ export interface IUpdateHandoverProviderRestData_2_0 extends IUpdateHandoverProviderRestDataBody_2_0, IUpdateHandoverProviderRestDataParams_2_0 {
18585
18566
  }
18586
- export interface IIndexAiAgentsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAiAgent_2_0> {
18567
+ export interface IUpdateHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
18587
18568
  }
18588
- export interface IDeleteAiAgentRestDataParams_2_0 {
18589
- aiAgentId: string;
18569
+ export interface IDeleteHandoverProviderRestDataParams_2_0 {
18570
+ handoverProviderId: string;
18571
+ projectId: string;
18590
18572
  }
18591
- export interface IDeleteAiAgentRestData_2_0 extends IDeleteAiAgentRestDataParams_2_0 {
18573
+ export interface IDeleteHandoverProviderRestData_2_0 extends IDeleteHandoverProviderRestDataParams_2_0 {
18592
18574
  }
18593
- export interface IDeleteAiAgentRestReturnValue_2_0 {
18575
+ export interface IDeleteHandoverProviderRestReturnValue_2_0 {
18594
18576
  }
18595
18577
  /**
18596
18578
  * @openapi
18579
+ *
18597
18580
  * components:
18598
18581
  * schemas:
18599
- * IAiAgentHiringTemplate_2_0:
18582
+ * IHandoverService_2_0:
18600
18583
  * type: object
18601
18584
  * properties:
18602
- * templateId:
18585
+ * _id:
18603
18586
  * type: string
18604
- * description: The ID of the AI Agent template to hire.
18605
- * example: RetailAssistant-Rita
18606
- * aiAgentName:
18587
+ * format: mongoId
18588
+ * description: The object id of the handover service
18589
+ * referenceId:
18607
18590
  * type: string
18608
- * description: The name of the AI Agent.
18609
- * example: Rita
18610
- * aiAgentFileName:
18591
+ * format: uuid
18592
+ * description: The referenceId of the handover service
18593
+ * version:
18611
18594
  * type: string
18612
- * description: The file name of the AI Agent.
18613
- * example: Rita.tar
18614
- * aiAgentImage:
18595
+ * description: The version of the handover service
18596
+ * name:
18615
18597
  * type: string
18616
- * description: The image of the AI Agent.
18617
- * example: https://cognigy.com/rita.png
18618
- * aiAgentDescription:
18598
+ * description: The name of the handover service
18599
+ * serviceUrl:
18619
18600
  * type: string
18620
- * description: A short description of the AI Agent, up to 1000 characters.
18621
- * example: "I am a virtual assistant that can help you with your questions."
18622
- *
18601
+ * format: uri
18602
+ * description: The service URL of the handover service
18603
+ * logoUrl:
18604
+ * type: string
18605
+ * format: uri
18606
+ * description: The logo URL of the handover service
18607
+ * properties:
18608
+ * type: array
18609
+ * items:
18610
+ * type: object
18611
+ * description: Properties associated with the handover service
18612
+ * additionalProperties:
18613
+ * type: string
18614
+ * description: A list of properties for the handover service
18623
18615
  */
18624
- export interface IAiAgentHiringTemplate_2_0 {
18625
- templateId: string;
18626
- aiAgentName: string;
18627
- aiAgentFileName: string;
18628
- aiAgentImage: string;
18629
- aiAgentDescription: string;
18616
+ export interface IHandoverService_2_0 {
18617
+ _id: TMongoId;
18618
+ referenceId: string;
18619
+ version: string;
18620
+ name: string;
18621
+ serviceUrl: string;
18622
+ logoUrl: string;
18623
+ properties: IHandoverServiceProperties[];
18630
18624
  }
18631
- export interface IGetAiAgentHiringTemplatesRestData_2_0 {
18625
+ export interface IIndexHandoverServicesRestData_2_0 extends IRestPagination<IHandoverService_2_0>, Partial<IProjectScope> {
18632
18626
  }
18633
- export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
18634
- templates: IAiAgentHiringTemplate_2_0[];
18627
+ export interface IIndexHandoverServicesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IHandoverService_2_0> {
18628
+ }
18629
+ declare const uploadResumableTypes: readonly [
18630
+ "snapshots",
18631
+ "packages"
18632
+ ];
18633
+ export declare type TUploadResumableTypes = typeof uploadResumableTypes[number];
18634
+ export interface HttpRequest {
18635
+ getMethod(): string;
18636
+ getURL(): string;
18637
+ setHeader(header: string, value: string): void;
18638
+ getHeader(header: string): string;
18639
+ setProgressHandler(handler: (bytesSent: number) => void): void;
18640
+ send(body: any): Promise<HttpResponse>;
18641
+ abort(): Promise<void>;
18642
+ getUnderlyingObject(): any;
18643
+ }
18644
+ export interface HttpResponse {
18645
+ getStatus(): number;
18646
+ getHeader(header: string): string;
18647
+ getBody(): string;
18648
+ getUnderlyingObject(): any;
18649
+ }
18650
+ export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
18651
+ file: Buffer | File;
18652
+ onError?: ((error: Error) => void) | null;
18653
+ onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
18654
+ onSuccess?: (() => void) | null;
18655
+ onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
18656
+ onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
18657
+ onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
18658
+ onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
18659
+ }
18660
+ export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
18661
+ uploadType: TUploadResumableTypes;
18662
+ }
18663
+ export interface IUploadResumableRestReturnValue_2_0 {
18664
+ fileName: string;
18665
+ url: string;
18666
+ uploadId: string;
18635
18667
  }
18636
18668
  /**
18637
18669
  * @openapi
18670
+ *
18638
18671
  * components:
18639
18672
  * schemas:
18640
- * IAiAgentTemplateId_2_0:
18673
+ * IGenerateNluScoreData_2_0:
18641
18674
  * type: object
18675
+ * required:
18676
+ * - flowReferenceId
18677
+ * - localeReferenceId
18678
+ * - sentence
18642
18679
  * properties:
18643
- * templateId:
18680
+ * flowReferenceId:
18644
18681
  * type: string
18645
- * description: The ID of the AI Agent template to hire.
18646
- * example: insurance-agent-olivia
18647
- * overrideAiAgentReferenceId:
18682
+ * format: uuid
18683
+ * description: UUID of the flow reference.
18684
+ * localeReferenceId:
18648
18685
  * type: string
18649
- * description: The reference ID of the AI Agent to override the AI Agent from the hired package.
18650
- * example: 5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b
18651
- */
18652
- export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
18653
- templateId: string;
18654
- overrideAiAgentReferenceId?: string;
18686
+ * format: uuid
18687
+ * description: UUID of the locale reference.
18688
+ * sentence:
18689
+ * type: string
18690
+ * description: Sentence to analyze for NLU scoring.
18691
+ *
18692
+ * IGeneratedNluScore_2_0:
18693
+ * type: object
18694
+ * properties:
18695
+ * id:
18696
+ * type: string
18697
+ * description: Unique identifier of the score.
18698
+ * name:
18699
+ * type: string
18700
+ * description: Name of the score type.
18701
+ * score:
18702
+ * type: number
18703
+ * description: Numerical value of the score.
18704
+ * negated:
18705
+ * type: boolean
18706
+ * description: Indicates if the score is negated.
18707
+ * confirmationSentence:
18708
+ * type: string
18709
+ * description: Sentence used to confirm the score.
18710
+ * confirmationSentences:
18711
+ * type: array
18712
+ * items:
18713
+ * type: string
18714
+ * description: Multiple sentences for confirmation if applicable.
18715
+ * disambiguationSentence:
18716
+ * type: string
18717
+ * description: Sentence used for disambiguation.
18718
+ * flow:
18719
+ * type: string
18720
+ * description: UUID of the flow associated with the score.
18721
+ */
18722
+ export interface IGenerateNluScoresRestDataParams_2_0 {
18723
+ projectId: string;
18655
18724
  }
18656
- export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
18725
+ export interface IGenerateNluScoresRestDataBody_2_0 {
18726
+ flowReferenceId: string;
18727
+ localeReferenceId: string;
18728
+ sentence: string;
18657
18729
  }
18658
- export interface IHireAiAgentRestReturnValue_2_0 {
18730
+ export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
18659
18731
  }
18660
- export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
18661
- name: string;
18732
+ export interface IGenerateNluScoresRestReturnValue_2_0 {
18662
18733
  }
18663
- export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
18734
+ export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
18735
+ useCase: string;
18736
+ params?: Record<string, string>;
18737
+ messages?: {
18738
+ role: "user" | "assistant";
18739
+ content: string;
18740
+ }[];
18664
18741
  }
18665
- export interface IValidateAiAgentNameRestReturnValue_2_0 {
18742
+ export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
18743
+ projectId: string;
18744
+ }
18745
+ export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
18746
+ }
18747
+ export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
18748
+ output: string;
18666
18749
  }
18667
18750
  export interface ResourcesAPIGroup_2_0 {
18668
18751
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
@@ -18914,6 +18997,14 @@ export interface ResourcesAPIGroup_2_0 {
18914
18997
  updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
18915
18998
  uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
18916
18999
  generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
19000
+ generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
19001
+ readFlowChartAiAgents: TRestAPIOperation<{
19002
+ flowId: string;
19003
+ preferredLocaleId?: string;
19004
+ }, {
19005
+ items: any[];
19006
+ total: number;
19007
+ }>;
18917
19008
  }
18918
19009
  declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
18919
19010
  /**
@@ -22770,7 +22861,7 @@ export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
22770
22861
  }
22771
22862
  export interface IIndexSimulationsRestDataQuery_2_0 {
22772
22863
  projectId?: string;
22773
- filter?: number;
22864
+ filter?: string;
22774
22865
  limit?: number;
22775
22866
  skip?: number;
22776
22867
  sort?: string;
@@ -22904,7 +22995,7 @@ export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
22904
22995
  }
22905
22996
  export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
22906
22997
  projectId: string;
22907
- filter?: number;
22998
+ filter?: string;
22908
22999
  limit?: number;
22909
23000
  skip?: number;
22910
23001
  sort?: string;
@@ -22975,7 +23066,7 @@ export interface ISimulationRunRest_2_0 {
22975
23066
  }
22976
23067
  export interface IIndexSimulationRunsRestDataQuery_2_0 {
22977
23068
  projectId: string;
22978
- filter?: number;
23069
+ filter?: string;
22979
23070
  limit?: number;
22980
23071
  skip?: number;
22981
23072
  sort?: string;
@@ -23000,6 +23091,78 @@ export interface IReadSimulationRunRestData_2_0 extends IReadSimulationRunRestDa
23000
23091
  export interface IReadSimulationRunRestReturnValue_2_0 {
23001
23092
  simulationRun: ISimulationRunRest_2_0;
23002
23093
  }
23094
+ export interface IGetPersonaOptionsRestData_2_0 {
23095
+ flowId: string;
23096
+ projectReference: string;
23097
+ aiagentReferenceId?: string;
23098
+ }
23099
+ export interface IMissionType_2_0 {
23100
+ name: string;
23101
+ description: string;
23102
+ }
23103
+ export interface IPersonaType_2_0 {
23104
+ name: string;
23105
+ description: string;
23106
+ }
23107
+ export interface IGetPersonaOptionsRestReturnValue_2_0 {
23108
+ missionTypes: IMissionType_2_0[];
23109
+ personaTypes: IPersonaType_2_0[];
23110
+ }
23111
+ export interface IGeneratePersonaRestData_2_0 {
23112
+ flowReferenceId: string;
23113
+ projectReference: string;
23114
+ selectedMissionType: IMissionType_2_0;
23115
+ selectedPersonaType: IPersonaType_2_0;
23116
+ numberOfSuccessCriteria: number;
23117
+ requestedPackages: number;
23118
+ }
23119
+ export interface ISuccessCriteriaParams_2_0 {
23120
+ name: string;
23121
+ text: string;
23122
+ }
23123
+ export interface ISuccessCriteria_2_0 {
23124
+ type: string;
23125
+ params: ISuccessCriteriaParams_2_0;
23126
+ }
23127
+ export interface IPersonaPackage_2_0 {
23128
+ simulationName: string;
23129
+ personaName: string;
23130
+ personaDescription: string;
23131
+ mission: string;
23132
+ successCriteria: ISuccessCriteria_2_0[];
23133
+ }
23134
+ export interface IGeneratePersonaMetadata_2_0 {
23135
+ requestId: string;
23136
+ processedAt: string;
23137
+ model: string;
23138
+ }
23139
+ export interface IGeneratePersonaRestReturnValue_2_0 {
23140
+ success: boolean;
23141
+ personaPackages: IPersonaPackage_2_0[];
23142
+ metadata: IGeneratePersonaMetadata_2_0;
23143
+ }
23144
+ export interface IRegeneratePersonaFieldRestData_2_0 {
23145
+ projectReference: string;
23146
+ fieldToRegenerate: string;
23147
+ successCriteriaIndex?: number;
23148
+ simulationName: string;
23149
+ personaName: string;
23150
+ personaDescription: string;
23151
+ mission: string;
23152
+ successCriteria: ISuccessCriteria_2_0[];
23153
+ }
23154
+ export interface IRegeneratePersonaFieldMetadata_2_0 {
23155
+ requestId: string;
23156
+ processedAt: string;
23157
+ model: string;
23158
+ regeneratedField: string;
23159
+ regeneratedIndex?: number;
23160
+ }
23161
+ export interface IRegeneratePersonaFieldRestReturnValue_2_0 {
23162
+ success: boolean;
23163
+ personaPackage: IPersonaPackage_2_0;
23164
+ metadata: IRegeneratePersonaFieldMetadata_2_0;
23165
+ }
23003
23166
  export interface SimulationAPIGroup_2_0 {
23004
23167
  indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
23005
23168
  createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
@@ -23012,6 +23175,9 @@ export interface SimulationAPIGroup_2_0 {
23012
23175
  readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
23013
23176
  indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
23014
23177
  readSimulationRun: TRestAPIOperation<IReadSimulationRunRestData_2_0, IReadSimulationRunRestReturnValue_2_0>;
23178
+ getPersonaOptions: TRestAPIOperation<IGetPersonaOptionsRestData_2_0, IGetPersonaOptionsRestReturnValue_2_0>;
23179
+ generatePersona: TRestAPIOperation<IGeneratePersonaRestData_2_0, IGeneratePersonaRestReturnValue_2_0>;
23180
+ regeneratePersonaField: TRestAPIOperation<IRegeneratePersonaFieldRestData_2_0, IRegeneratePersonaFieldRestReturnValue_2_0>;
23015
23181
  }
23016
23182
  declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
23017
23183
  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>;