@cognigy/rest-api-client 2025.13.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 (39) hide show
  1. package/CHANGELOG.md +5 -0
  2. package/build/apigroups/ResourcesAPIGroup_2_0.js +4 -1
  3. package/build/apigroups/SimulationAPIGroup_2_0.js +4 -1
  4. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
  5. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +6 -4
  6. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
  7. package/build/shared/charts/descriptors/service/GPTPrompt.js +6 -0
  8. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +58 -21
  9. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +58 -21
  10. package/build/shared/interfaces/messageAPI/handover.js +6 -0
  11. package/build/shared/interfaces/resources/ISimulation.js +9 -0
  12. package/build/shared/interfaces/resources/TResourceType.js +3 -0
  13. package/build/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +3 -0
  14. package/build/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +3 -0
  15. package/build/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +3 -0
  16. package/build/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +3 -0
  17. package/build/shared/interfaces/security/IPermission.js +2 -0
  18. package/build/shared/interfaces/security/IRole.js +2 -0
  19. package/build/shared/interfaces/security/index.js +1 -1
  20. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +4 -1
  21. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +4 -1
  22. package/dist/esm/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
  23. package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +6 -4
  24. package/dist/esm/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
  25. package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +6 -0
  26. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +58 -21
  27. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +65 -28
  28. package/dist/esm/shared/interfaces/messageAPI/handover.js +6 -0
  29. package/dist/esm/shared/interfaces/resources/ISimulation.js +6 -0
  30. package/dist/esm/shared/interfaces/resources/TResourceType.js +3 -0
  31. package/dist/esm/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +2 -0
  32. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +2 -0
  33. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +2 -0
  34. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +2 -0
  35. package/dist/esm/shared/interfaces/security/IPermission.js +2 -0
  36. package/dist/esm/shared/interfaces/security/IRole.js +2 -0
  37. package/dist/esm/shared/interfaces/security/index.js +1 -1
  38. package/package.json +1 -1
  39. package/types/index.d.ts +349 -224
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 [
@@ -1011,7 +1012,8 @@ declare const organisationWideRoles: readonly [
1011
1012
  "projectManager",
1012
1013
  "userManager",
1013
1014
  "userDetailsViewer",
1014
- "voiceGatewayUser"
1015
+ "voiceGatewayUser",
1016
+ "opsCenterUser"
1015
1017
  ];
1016
1018
  export declare type TOrganisationWideRole = typeof organisationWideRoles[number];
1017
1019
  declare const projectWideRoles: readonly [
@@ -12228,8 +12230,49 @@ export interface IHandoverProviderSettings {
12228
12230
  service: THandoverService;
12229
12231
  serviceSettings?: TServiceSettings;
12230
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
+ }
12231
12274
  export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent;
12232
- export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
12275
+ export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook | IGraphSimulation;
12233
12276
  export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
12234
12277
  /**
12235
12278
  * @openapi
@@ -13447,6 +13490,227 @@ export interface IGenerateNodeOutputRestData_2_0 extends IGenerateNodeOutputRest
13447
13490
  }
13448
13491
  export interface IGenerateNodeOutputRestReturnValue_2_0 extends IGenerateNodeOutputReturnValue {
13449
13492
  }
13493
+ /**
13494
+ * @openapi
13495
+ *
13496
+ * components:
13497
+ * schemas:
13498
+ * IAiAgentData_2_0:
13499
+ * type: object
13500
+ * properties:
13501
+ * name:
13502
+ * type: string
13503
+ * example: "Cognigy AI Agent"
13504
+ * image:
13505
+ * type: string
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:
13513
+ * type: string
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:
13518
+ * type: string
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:
13523
+ * type: object
13524
+ * properties:
13525
+ * completeness:
13526
+ * type: string
13527
+ * formality:
13528
+ * type: string
13529
+ * example: { "completeness": "concise", "formality": "formal" }
13530
+ * voiceConfigs:
13531
+ * type: object
13532
+ * properties:
13533
+ * ttsVoice:
13534
+ * type: string
13535
+ * ttsLanguage:
13536
+ * type: string
13537
+ * ttsVendor:
13538
+ * enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
13539
+ * type: string
13540
+ * ttsModel:
13541
+ * type: string
13542
+ * ttsLabel:
13543
+ * type: string
13544
+ * ttsDisableCache:
13545
+ * type: boolean
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:
13552
+ * type: object
13553
+ * properties:
13554
+ * avoidHarmfulContent:
13555
+ * type: boolean
13556
+ * avoidUngroundedContent:
13557
+ * type: boolean
13558
+ * avoidCopyrightInfringements:
13559
+ * type: boolean
13560
+ * preventJailbreakAndManipulation:
13561
+ * type: boolean
13562
+ * contactProfilesOption:
13563
+ * type: string
13564
+ * enum:
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:
13572
+ * type: array
13573
+ * items:
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'
13586
+ */
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;
13608
+ }
13609
+ export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
13610
+ }
13611
+ export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
13612
+ }
13613
+ export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
13614
+ }
13615
+ export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
13616
+ }
13617
+ export interface IUpdateAiAgentRestDataParams_2_0 {
13618
+ aiAgentId: string;
13619
+ }
13620
+ export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
13621
+ }
13622
+ export interface IUpdateAiAgentRestReturnValue_2_0 {
13623
+ }
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 {
13641
+ }
13642
+ /**
13643
+ * @openapi
13644
+ * components:
13645
+ * schemas:
13646
+ * IAiAgentHiringTemplate_2_0:
13647
+ * type: object
13648
+ * properties:
13649
+ * templateId:
13650
+ * type: string
13651
+ * description: The ID of the AI Agent template to hire.
13652
+ * example: RetailAssistant-Rita
13653
+ * aiAgentName:
13654
+ * type: string
13655
+ * description: The name of the AI Agent.
13656
+ * example: Rita
13657
+ * aiAgentFileName:
13658
+ * type: string
13659
+ * description: The file name of the AI Agent.
13660
+ * example: Rita.tar
13661
+ * aiAgentImage:
13662
+ * type: string
13663
+ * description: The image of the AI Agent.
13664
+ * example: https://cognigy.com/rita.png
13665
+ * aiAgentDescription:
13666
+ * type: string
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
+ *
13670
+ */
13671
+ export interface IAiAgentHiringTemplate_2_0 {
13672
+ templateId: string;
13673
+ aiAgentName: string;
13674
+ aiAgentFileName: string;
13675
+ aiAgentImage: string;
13676
+ aiAgentDescription: string;
13677
+ }
13678
+ export interface IGetAiAgentHiringTemplatesRestData_2_0 {
13679
+ }
13680
+ export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
13681
+ templates: IAiAgentHiringTemplate_2_0[];
13682
+ }
13683
+ /**
13684
+ * @openapi
13685
+ * components:
13686
+ * schemas:
13687
+ * IAiAgentTemplateId_2_0:
13688
+ * type: object
13689
+ * properties:
13690
+ * templateId:
13691
+ * type: string
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
13698
+ */
13699
+ export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
13700
+ templateId: string;
13701
+ overrideAiAgentReferenceId?: string;
13702
+ }
13703
+ export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
13704
+ }
13705
+ export interface IHireAiAgentRestReturnValue_2_0 {
13706
+ }
13707
+ export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
13708
+ name: string;
13709
+ }
13710
+ export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
13711
+ }
13712
+ export interface IValidateAiAgentNameRestReturnValue_2_0 {
13713
+ }
13450
13714
  /**
13451
13715
  * @openapi
13452
13716
  *
@@ -18483,227 +18747,6 @@ export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesig
18483
18747
  export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
18484
18748
  output: string;
18485
18749
  }
18486
- /**
18487
- * @openapi
18488
- *
18489
- * components:
18490
- * schemas:
18491
- * IAiAgentData_2_0:
18492
- * type: object
18493
- * properties:
18494
- * name:
18495
- * type: string
18496
- * example: "Cognigy AI Agent"
18497
- * image:
18498
- * type: string
18499
- * description: Avatar of the AI Agent.
18500
- * example: "https://cognigy.com/ai-agent.png"
18501
- * imageOptimizedFormat:
18502
- * type: boolean
18503
- * description: Whether the optimized image format defined by Cognigy is used.
18504
- * example: true
18505
- * knowledgeReferenceId:
18506
- * type: string
18507
- * format: uuid
18508
- * description: A referenceId of a Knowledge Store this Agent will use as base knowledge.
18509
- * example: "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
18510
- * description:
18511
- * type: string
18512
- * maxLength: 1000
18513
- * description: A short description of the AI Agent, up to 1000 characters.
18514
- * example: "I am a virtual assistant that can help you with your questions."
18515
- * speakingStyle:
18516
- * type: object
18517
- * properties:
18518
- * completeness:
18519
- * type: string
18520
- * formality:
18521
- * type: string
18522
- * example: { "completeness": "concise", "formality": "formal" }
18523
- * voiceConfigs:
18524
- * type: object
18525
- * properties:
18526
- * ttsVoice:
18527
- * type: string
18528
- * ttsLanguage:
18529
- * type: string
18530
- * ttsVendor:
18531
- * enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
18532
- * type: string
18533
- * ttsModel:
18534
- * type: string
18535
- * ttsLabel:
18536
- * type: string
18537
- * ttsDisableCache:
18538
- * type: boolean
18539
- * example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false }
18540
- * enableVoiceConfigs:
18541
- * type: boolean
18542
- * description: Enables the use of voice configuration.
18543
- * example: false
18544
- * safetySettings:
18545
- * type: object
18546
- * properties:
18547
- * avoidHarmfulContent:
18548
- * type: boolean
18549
- * avoidUngroundedContent:
18550
- * type: boolean
18551
- * avoidCopyrightInfringements:
18552
- * type: boolean
18553
- * preventJailbreakAndManipulation:
18554
- * type: boolean
18555
- * contactProfilesOption:
18556
- * type: string
18557
- * enum:
18558
- * - "none"
18559
- * - "selectedProfileFields"
18560
- * - "completeProfile"
18561
- * - "profileMemoriesOnly"
18562
- * description: Option to enable or customize Contact profiles selection for the AI Agent.
18563
- * example: "selectedProfileFields"
18564
- * contactProfilesSelected:
18565
- * type: array
18566
- * items:
18567
- * type: string
18568
- * description: Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
18569
- * example: ["name", "email"]
18570
- * instructions:
18571
- * type: string
18572
- * description: Instructions for the AI Agent.
18573
- * example: "I can help you with your questions, provide information and much more."
18574
- * maxLength: 1000
18575
- * IAiAgent_2_0:
18576
- * allOf:
18577
- * - $ref: '#/components/schemas/IAiAgentData_2_0'
18578
- * - $ref: '#/components/schemas/IEntityMeta'
18579
- */
18580
- export interface IAiAgent_2_0 {
18581
- _id: TMongoId;
18582
- name: string;
18583
- referenceId: string;
18584
- image: string;
18585
- imageOptimizedFormat: boolean;
18586
- instructions: string;
18587
- knowledgeReferenceId: string;
18588
- description: string;
18589
- speakingStyle: ISpeakingStyle;
18590
- voiceConfigs: IVoiceConfigParams;
18591
- enableVoiceConfigs: boolean;
18592
- safetySettings: ISafetySettings;
18593
- contactProfilesOption: TContactProfileOptions;
18594
- contactProfilesSelected: string[];
18595
- projectReference: TMongoId;
18596
- organisationReference: TMongoId;
18597
- createdAt: number;
18598
- lastChanged: number;
18599
- createdBy: TMongoId;
18600
- lastChangedBy: TMongoId;
18601
- }
18602
- export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
18603
- }
18604
- export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
18605
- }
18606
- export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
18607
- }
18608
- export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
18609
- }
18610
- export interface IUpdateAiAgentRestDataParams_2_0 {
18611
- aiAgentId: string;
18612
- }
18613
- export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
18614
- }
18615
- export interface IUpdateAiAgentRestReturnValue_2_0 {
18616
- }
18617
- export interface IReadAiAgentRestDataParams_2_0 {
18618
- aiAgentId: string;
18619
- }
18620
- export interface IReadAiAgentRestData_2_0 extends IReadAiAgentRestDataParams_2_0 {
18621
- }
18622
- export interface IReadAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
18623
- }
18624
- export interface IIndexAiAgentsRestData_2_0 extends IRestPagination<IAiAgent_2_0>, IProjectScope {
18625
- }
18626
- export interface IIndexAiAgentsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAiAgent_2_0> {
18627
- }
18628
- export interface IDeleteAiAgentRestDataParams_2_0 {
18629
- aiAgentId: string;
18630
- }
18631
- export interface IDeleteAiAgentRestData_2_0 extends IDeleteAiAgentRestDataParams_2_0 {
18632
- }
18633
- export interface IDeleteAiAgentRestReturnValue_2_0 {
18634
- }
18635
- /**
18636
- * @openapi
18637
- * components:
18638
- * schemas:
18639
- * IAiAgentHiringTemplate_2_0:
18640
- * type: object
18641
- * properties:
18642
- * templateId:
18643
- * type: string
18644
- * description: The ID of the AI Agent template to hire.
18645
- * example: RetailAssistant-Rita
18646
- * aiAgentName:
18647
- * type: string
18648
- * description: The name of the AI Agent.
18649
- * example: Rita
18650
- * aiAgentFileName:
18651
- * type: string
18652
- * description: The file name of the AI Agent.
18653
- * example: Rita.tar
18654
- * aiAgentImage:
18655
- * type: string
18656
- * description: The image of the AI Agent.
18657
- * example: https://cognigy.com/rita.png
18658
- * aiAgentDescription:
18659
- * type: string
18660
- * description: A short description of the AI Agent, up to 1000 characters.
18661
- * example: "I am a virtual assistant that can help you with your questions."
18662
- *
18663
- */
18664
- export interface IAiAgentHiringTemplate_2_0 {
18665
- templateId: string;
18666
- aiAgentName: string;
18667
- aiAgentFileName: string;
18668
- aiAgentImage: string;
18669
- aiAgentDescription: string;
18670
- }
18671
- export interface IGetAiAgentHiringTemplatesRestData_2_0 {
18672
- }
18673
- export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
18674
- templates: IAiAgentHiringTemplate_2_0[];
18675
- }
18676
- /**
18677
- * @openapi
18678
- * components:
18679
- * schemas:
18680
- * IAiAgentTemplateId_2_0:
18681
- * type: object
18682
- * properties:
18683
- * templateId:
18684
- * type: string
18685
- * description: The ID of the AI Agent template to hire.
18686
- * example: insurance-agent-olivia
18687
- * overrideAiAgentReferenceId:
18688
- * type: string
18689
- * description: The reference ID of the AI Agent to override the AI Agent from the hired package.
18690
- * example: 5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b
18691
- */
18692
- export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
18693
- templateId: string;
18694
- overrideAiAgentReferenceId?: string;
18695
- }
18696
- export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
18697
- }
18698
- export interface IHireAiAgentRestReturnValue_2_0 {
18699
- }
18700
- export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
18701
- name: string;
18702
- }
18703
- export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
18704
- }
18705
- export interface IValidateAiAgentNameRestReturnValue_2_0 {
18706
- }
18707
18750
  export interface ResourcesAPIGroup_2_0 {
18708
18751
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
18709
18752
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
@@ -18955,6 +18998,13 @@ export interface ResourcesAPIGroup_2_0 {
18955
18998
  uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
18956
18999
  generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
18957
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
+ }>;
18958
19008
  }
18959
19009
  declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
18960
19010
  /**
@@ -23041,6 +23091,78 @@ export interface IReadSimulationRunRestData_2_0 extends IReadSimulationRunRestDa
23041
23091
  export interface IReadSimulationRunRestReturnValue_2_0 {
23042
23092
  simulationRun: ISimulationRunRest_2_0;
23043
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
+ }
23044
23166
  export interface SimulationAPIGroup_2_0 {
23045
23167
  indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
23046
23168
  createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
@@ -23053,6 +23175,9 @@ export interface SimulationAPIGroup_2_0 {
23053
23175
  readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
23054
23176
  indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
23055
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>;
23056
23181
  }
23057
23182
  declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
23058
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>;