@cognigy/rest-api-client 2025.13.0 → 2025.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/build/apigroups/ResourcesAPIGroup_2_0.js +4 -1
- package/build/apigroups/SimulationAPIGroup_2_0.js +5 -1
- package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +31 -4
- package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
- package/build/shared/charts/descriptors/service/GPTPrompt.js +31 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +58 -21
- package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +58 -21
- package/build/shared/helper/BaseContext.js +3 -1
- package/build/shared/interfaces/messageAPI/handover.js +6 -0
- package/build/shared/interfaces/resources/IAiAgent.js +1 -1
- package/build/shared/interfaces/resources/IExtension.js +12 -13
- package/build/shared/interfaces/resources/IKnowledgeDescriptor.js +45 -0
- package/build/shared/interfaces/resources/ISimulation.js +9 -0
- package/build/shared/interfaces/resources/TResourceType.js +3 -0
- package/build/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/persona/IGenerateBulkPersonaRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js +6 -1
- package/build/shared/interfaces/security/IPermission.js +2 -0
- package/build/shared/interfaces/security/IRole.js +3 -0
- package/build/shared/interfaces/security/index.js +1 -1
- package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +4 -1
- package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +5 -1
- package/dist/esm/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
- package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +31 -4
- package/dist/esm/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
- package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +31 -0
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +58 -21
- package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +65 -28
- package/dist/esm/shared/helper/BaseContext.js +3 -1
- package/dist/esm/shared/interfaces/messageAPI/handover.js +6 -0
- package/dist/esm/shared/interfaces/resources/IAiAgent.js +1 -1
- package/dist/esm/shared/interfaces/resources/IExtension.js +12 -13
- package/dist/esm/shared/interfaces/resources/IKnowledgeDescriptor.js +42 -0
- package/dist/esm/shared/interfaces/resources/ISimulation.js +6 -0
- package/dist/esm/shared/interfaces/resources/TResourceType.js +3 -0
- package/dist/esm/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGenerateBulkPersonaRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js +5 -0
- package/dist/esm/shared/interfaces/security/IPermission.js +2 -0
- package/dist/esm/shared/interfaces/security/IRole.js +3 -0
- package/dist/esm/shared/interfaces/security/index.js +1 -1
- package/package.json +1 -1
- package/types/index.d.ts +776 -433
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,9 @@ declare const organisationWideRoles: readonly [
|
|
|
1011
1012
|
"projectManager",
|
|
1012
1013
|
"userManager",
|
|
1013
1014
|
"userDetailsViewer",
|
|
1014
|
-
"voiceGatewayUser"
|
|
1015
|
+
"voiceGatewayUser",
|
|
1016
|
+
"autoDialerUser",
|
|
1017
|
+
"opsCenterUser"
|
|
1015
1018
|
];
|
|
1016
1019
|
export declare type TOrganisationWideRole = typeof organisationWideRoles[number];
|
|
1017
1020
|
declare const projectWideRoles: readonly [
|
|
@@ -9599,7 +9602,7 @@ export interface IAiAgent extends IEntityMeta {
|
|
|
9599
9602
|
referenceId: string;
|
|
9600
9603
|
image: string;
|
|
9601
9604
|
imageOptimizedFormat: boolean;
|
|
9602
|
-
knowledgeReferenceId: string;
|
|
9605
|
+
knowledgeReferenceId: string | null;
|
|
9603
9606
|
description: string;
|
|
9604
9607
|
speakingStyle: ISpeakingStyle;
|
|
9605
9608
|
voiceConfigs: IVoiceConfigParams;
|
|
@@ -11364,8 +11367,12 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
11364
11367
|
getLLMTokenUsageForSession(): TSessionUsageInformation | null;
|
|
11365
11368
|
loadSessionState: () => Promise<Partial<ISessionStateWithoutMeta>>;
|
|
11366
11369
|
emitToOpsCenter: (params: {
|
|
11370
|
+
projectId?: string;
|
|
11367
11371
|
title: string;
|
|
11368
11372
|
subComponent?: string;
|
|
11373
|
+
errorCode?: string;
|
|
11374
|
+
metadata?: Record<string, unknown>;
|
|
11375
|
+
isSnapshotError?: boolean;
|
|
11369
11376
|
}) => void;
|
|
11370
11377
|
fetchMcpTools: (params: {
|
|
11371
11378
|
mcpServerUrl: string;
|
|
@@ -11706,6 +11713,139 @@ export interface IAppTemplate extends IEntityMeta {
|
|
|
11706
11713
|
projectReference: TMongoId;
|
|
11707
11714
|
organisationReference: TMongoId;
|
|
11708
11715
|
}
|
|
11716
|
+
declare const knowledgeFieldTypes: readonly [
|
|
11717
|
+
"text",
|
|
11718
|
+
"rule",
|
|
11719
|
+
"json",
|
|
11720
|
+
"checkbox",
|
|
11721
|
+
"time",
|
|
11722
|
+
"date",
|
|
11723
|
+
"datetime",
|
|
11724
|
+
"select",
|
|
11725
|
+
"xml",
|
|
11726
|
+
"textArray",
|
|
11727
|
+
"chipInput",
|
|
11728
|
+
"toggle",
|
|
11729
|
+
"slider",
|
|
11730
|
+
"number",
|
|
11731
|
+
"daterange",
|
|
11732
|
+
"connection",
|
|
11733
|
+
"condition",
|
|
11734
|
+
"description"
|
|
11735
|
+
];
|
|
11736
|
+
export declare type TKnowledgeFieldType = typeof knowledgeFieldTypes[number];
|
|
11737
|
+
export declare type IKnowledgeFieldSet = IKnowledgeField[];
|
|
11738
|
+
export interface IKnowledgeField<K extends string | number | symbol = string> {
|
|
11739
|
+
type: TKnowledgeFieldType;
|
|
11740
|
+
key: K;
|
|
11741
|
+
label: string | INodeFieldTranslations;
|
|
11742
|
+
condition?: TNodeFieldCondition;
|
|
11743
|
+
defaultValue?: any;
|
|
11744
|
+
description?: string | INodeFieldTranslations;
|
|
11745
|
+
params?: {
|
|
11746
|
+
[key: string]: any;
|
|
11747
|
+
};
|
|
11748
|
+
optionsResolver?: INodeOptionsResolver;
|
|
11749
|
+
resetOption?: IResetOption;
|
|
11750
|
+
}
|
|
11751
|
+
/**
|
|
11752
|
+
* @openapi
|
|
11753
|
+
*
|
|
11754
|
+
* components:
|
|
11755
|
+
* schemas:
|
|
11756
|
+
* IKnowledgeDescriptor:
|
|
11757
|
+
* type: object
|
|
11758
|
+
* properties:
|
|
11759
|
+
* type:
|
|
11760
|
+
* type: string
|
|
11761
|
+
* label:
|
|
11762
|
+
* oneOf:
|
|
11763
|
+
* - type: string
|
|
11764
|
+
* description: The label that should be used when a new Node of this type is created
|
|
11765
|
+
* - type: object
|
|
11766
|
+
* description: A localized version of the label that should be used when a new Node of this type is created
|
|
11767
|
+
* properties:
|
|
11768
|
+
* default:
|
|
11769
|
+
* type: string
|
|
11770
|
+
* enUS:
|
|
11771
|
+
* type: string
|
|
11772
|
+
* deDE:
|
|
11773
|
+
* type: string
|
|
11774
|
+
* esES:
|
|
11775
|
+
* type: string
|
|
11776
|
+
* jaJP:
|
|
11777
|
+
* type: string
|
|
11778
|
+
* koKR:
|
|
11779
|
+
* type: string
|
|
11780
|
+
* summary:
|
|
11781
|
+
* oneOf:
|
|
11782
|
+
* - type: string
|
|
11783
|
+
* description: A short line of text that describes what this Node is used for
|
|
11784
|
+
* - type: object
|
|
11785
|
+
* description: A localized version of a short line of text that describes what this Node is used for
|
|
11786
|
+
* properties:
|
|
11787
|
+
* default:
|
|
11788
|
+
* type: string
|
|
11789
|
+
* enUS:
|
|
11790
|
+
* type: string
|
|
11791
|
+
* deDE:
|
|
11792
|
+
* type: string
|
|
11793
|
+
* esES:
|
|
11794
|
+
* type: string
|
|
11795
|
+
* jaJP:
|
|
11796
|
+
* type: string
|
|
11797
|
+
* koKR:
|
|
11798
|
+
* type: string
|
|
11799
|
+
* fields:
|
|
11800
|
+
* type: array
|
|
11801
|
+
* items:
|
|
11802
|
+
* type: object
|
|
11803
|
+
* properties:
|
|
11804
|
+
* type:
|
|
11805
|
+
* type: string
|
|
11806
|
+
* enum:
|
|
11807
|
+
* - text
|
|
11808
|
+
* - rule
|
|
11809
|
+
* key:
|
|
11810
|
+
* type: string
|
|
11811
|
+
* label:
|
|
11812
|
+
* oneOf:
|
|
11813
|
+
* - type: string
|
|
11814
|
+
* - type: object
|
|
11815
|
+
* properties:
|
|
11816
|
+
* default:
|
|
11817
|
+
* type: string
|
|
11818
|
+
* enUS:
|
|
11819
|
+
* type: string
|
|
11820
|
+
* deDE:
|
|
11821
|
+
* type: string
|
|
11822
|
+
* esES:
|
|
11823
|
+
* type: string
|
|
11824
|
+
* jaJP:
|
|
11825
|
+
* type: string
|
|
11826
|
+
* koKR:
|
|
11827
|
+
* type: string
|
|
11828
|
+
* defaultValue:
|
|
11829
|
+
* description: The default value for that field
|
|
11830
|
+
* sections:
|
|
11831
|
+
* type: array
|
|
11832
|
+
* items:
|
|
11833
|
+
* $ref: '#/components/schemas/INodeFieldCondition_2_0'
|
|
11834
|
+
* form:
|
|
11835
|
+
* type: array
|
|
11836
|
+
* items:
|
|
11837
|
+
* $ref: '#/components/schemas/INodeFieldAndSectionFormElement_2_0'
|
|
11838
|
+
*/
|
|
11839
|
+
export interface IKnowledgeDescriptor {
|
|
11840
|
+
type: string;
|
|
11841
|
+
label: string | INodeFieldTranslations;
|
|
11842
|
+
summary?: string | INodeFieldTranslations;
|
|
11843
|
+
fields?: IKnowledgeFieldSet;
|
|
11844
|
+
/** Sections which allow to group multiple fields */
|
|
11845
|
+
sections?: INodeSection[];
|
|
11846
|
+
/** The form defines how fields and sections should be rendered in order */
|
|
11847
|
+
form?: INodeFieldAndSectionFormElement[];
|
|
11848
|
+
}
|
|
11709
11849
|
export declare type IExtensionType = "nodes";
|
|
11710
11850
|
export interface IExtension extends IExtensionData, IExtensionNodePackage {
|
|
11711
11851
|
}
|
|
@@ -11732,6 +11872,8 @@ export interface IExtensionData extends IEntityMeta {
|
|
|
11732
11872
|
pathToPackageExecutable: string;
|
|
11733
11873
|
/** A reference to a 'sub-resource'. Currently a 'node-descriptor-set' */
|
|
11734
11874
|
subResourceReference: TMongoId;
|
|
11875
|
+
/** A reference to a knowledge descriptor set */
|
|
11876
|
+
knowledge?: IKnowledgeDescriptor[];
|
|
11735
11877
|
/** A reference to the project of this extension */
|
|
11736
11878
|
projectReference: TMongoId;
|
|
11737
11879
|
/** A reference to the organisation of this extension */
|
|
@@ -11739,6 +11881,7 @@ export interface IExtensionData extends IEntityMeta {
|
|
|
11739
11881
|
}
|
|
11740
11882
|
export interface IExtensionNodePackage {
|
|
11741
11883
|
nodes: INodeDescriptor[];
|
|
11884
|
+
knowledge?: IKnowledgeDescriptor[];
|
|
11742
11885
|
connections: Pick<IConnectionSchema, "label" | "type" | "fields">[];
|
|
11743
11886
|
appTemplates: Pick<IAppTemplate, "label" | "type" | "path">[];
|
|
11744
11887
|
}
|
|
@@ -12228,8 +12371,49 @@ export interface IHandoverProviderSettings {
|
|
|
12228
12371
|
service: THandoverService;
|
|
12229
12372
|
serviceSettings?: TServiceSettings;
|
|
12230
12373
|
}
|
|
12374
|
+
declare enum SuccessCriterionType {
|
|
12375
|
+
TEXT = "text",
|
|
12376
|
+
GOAL_COMPLETED = "goalCompleted"
|
|
12377
|
+
}
|
|
12378
|
+
export interface ISuccessCriteriaTextParams {
|
|
12379
|
+
text: string;
|
|
12380
|
+
name: string;
|
|
12381
|
+
}
|
|
12382
|
+
export interface ISuccessCriteriaGoalParams {
|
|
12383
|
+
referenceId: string;
|
|
12384
|
+
name: string;
|
|
12385
|
+
}
|
|
12386
|
+
export interface ISuccessCriteria {
|
|
12387
|
+
type: SuccessCriterionType;
|
|
12388
|
+
params: ISuccessCriteriaTextParams | ISuccessCriteriaGoalParams;
|
|
12389
|
+
}
|
|
12390
|
+
export interface IProjectMetadata {
|
|
12391
|
+
projectReference: string;
|
|
12392
|
+
organisationReference: string;
|
|
12393
|
+
}
|
|
12394
|
+
export interface ISimulation extends IProjectMetadata {
|
|
12395
|
+
id: string;
|
|
12396
|
+
_id: string;
|
|
12397
|
+
referenceId: string;
|
|
12398
|
+
name: string;
|
|
12399
|
+
persona: string;
|
|
12400
|
+
personaName: string;
|
|
12401
|
+
mission: string;
|
|
12402
|
+
successCriteria: ISuccessCriteria[];
|
|
12403
|
+
maxTurns?: number;
|
|
12404
|
+
timeout?: number;
|
|
12405
|
+
createdAt?: number;
|
|
12406
|
+
createdBy: string;
|
|
12407
|
+
updatedAt?: number;
|
|
12408
|
+
updatedBy: string;
|
|
12409
|
+
lastChanged: number;
|
|
12410
|
+
lastChangedBy?: string;
|
|
12411
|
+
}
|
|
12412
|
+
export interface IGraphSimulation extends ISimulation {
|
|
12413
|
+
type: "simulation";
|
|
12414
|
+
}
|
|
12231
12415
|
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;
|
|
12416
|
+
export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook | IGraphSimulation;
|
|
12233
12417
|
export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
|
|
12234
12418
|
/**
|
|
12235
12419
|
* @openapi
|
|
@@ -13452,89 +13636,311 @@ export interface IGenerateNodeOutputRestReturnValue_2_0 extends IGenerateNodeOut
|
|
|
13452
13636
|
*
|
|
13453
13637
|
* components:
|
|
13454
13638
|
* schemas:
|
|
13455
|
-
*
|
|
13639
|
+
* IAiAgentData_2_0:
|
|
13456
13640
|
* type: object
|
|
13457
13641
|
* properties:
|
|
13458
|
-
*
|
|
13642
|
+
* name:
|
|
13459
13643
|
* type: string
|
|
13460
|
-
*
|
|
13644
|
+
* example: "Cognigy AI Agent"
|
|
13645
|
+
* image:
|
|
13461
13646
|
* type: string
|
|
13462
|
-
* description:
|
|
13463
|
-
*
|
|
13464
|
-
*
|
|
13465
|
-
*
|
|
13466
|
-
*
|
|
13467
|
-
*
|
|
13468
|
-
*
|
|
13469
|
-
* properties:
|
|
13470
|
-
* default:
|
|
13471
|
-
* type: string
|
|
13472
|
-
* enUS:
|
|
13473
|
-
* type: string
|
|
13474
|
-
* deDE:
|
|
13475
|
-
* type: string
|
|
13476
|
-
* esES:
|
|
13477
|
-
* type: string
|
|
13478
|
-
* jaJP:
|
|
13479
|
-
* type: string
|
|
13480
|
-
* koKR:
|
|
13481
|
-
* type: string
|
|
13482
|
-
* summary:
|
|
13483
|
-
* oneOf:
|
|
13484
|
-
* - type: string
|
|
13485
|
-
* description: A short line of text that describes what this Node is used for
|
|
13486
|
-
* - type: object
|
|
13487
|
-
* description: A localized version of a short line of text that describes what this Node is used for
|
|
13488
|
-
* properties:
|
|
13489
|
-
* default:
|
|
13490
|
-
* type: string
|
|
13491
|
-
* enUS:
|
|
13492
|
-
* type: string
|
|
13493
|
-
* deDE:
|
|
13494
|
-
* type: string
|
|
13495
|
-
* esES:
|
|
13496
|
-
* type: string
|
|
13497
|
-
* jaJP:
|
|
13498
|
-
* type: string
|
|
13499
|
-
* koKR:
|
|
13500
|
-
* type: string
|
|
13501
|
-
* extension:
|
|
13647
|
+
* description: Avatar of the AI Agent.
|
|
13648
|
+
* example: "https://cognigy.com/ai-agent.png"
|
|
13649
|
+
* imageOptimizedFormat:
|
|
13650
|
+
* type: boolean
|
|
13651
|
+
* description: Whether the optimized image format defined by Cognigy is used.
|
|
13652
|
+
* example: true
|
|
13653
|
+
* knowledgeReferenceId:
|
|
13502
13654
|
* type: string
|
|
13503
|
-
*
|
|
13655
|
+
* nullable: true
|
|
13656
|
+
* format: uuid
|
|
13657
|
+
* description: A referenceId of a Knowledge Store this Agent will use as base knowledge or null.
|
|
13658
|
+
* example: "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
|
|
13659
|
+
* description:
|
|
13504
13660
|
* type: string
|
|
13505
|
-
*
|
|
13661
|
+
* maxLength: 1000
|
|
13662
|
+
* description: A short description of the AI Agent, up to 1000 characters.
|
|
13663
|
+
* example: "I am a virtual assistant that can help you with your questions."
|
|
13664
|
+
* speakingStyle:
|
|
13506
13665
|
* type: object
|
|
13507
13666
|
* properties:
|
|
13508
|
-
*
|
|
13667
|
+
* completeness:
|
|
13509
13668
|
* type: string
|
|
13510
|
-
*
|
|
13669
|
+
* formality:
|
|
13511
13670
|
* type: string
|
|
13512
|
-
*
|
|
13513
|
-
*
|
|
13514
|
-
*
|
|
13515
|
-
*
|
|
13516
|
-
*
|
|
13671
|
+
* example: { "completeness": "concise", "formality": "formal" }
|
|
13672
|
+
* voiceConfigs:
|
|
13673
|
+
* type: object
|
|
13674
|
+
* properties:
|
|
13675
|
+
* ttsVoice:
|
|
13517
13676
|
* type: string
|
|
13518
|
-
*
|
|
13519
|
-
* oneOf:
|
|
13520
|
-
* - $ref: '#/components/schemas/TCSSColorName'
|
|
13521
|
-
* - $ref: '#/components/schemas/TCognigyColorName'
|
|
13522
|
-
* color:
|
|
13677
|
+
* ttsLanguage:
|
|
13523
13678
|
* type: string
|
|
13524
|
-
*
|
|
13525
|
-
*
|
|
13526
|
-
* - $ref: '#/components/schemas/TCSSColorName'
|
|
13527
|
-
* - $ref: '#/components/schemas/TCognigyColorName'
|
|
13528
|
-
* variant:
|
|
13679
|
+
* ttsVendor:
|
|
13680
|
+
* enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
|
|
13529
13681
|
* type: string
|
|
13530
|
-
*
|
|
13531
|
-
*
|
|
13532
|
-
*
|
|
13533
|
-
*
|
|
13534
|
-
*
|
|
13535
|
-
*
|
|
13536
|
-
*
|
|
13537
|
-
*
|
|
13682
|
+
* ttsModel:
|
|
13683
|
+
* type: string
|
|
13684
|
+
* ttsLabel:
|
|
13685
|
+
* type: string
|
|
13686
|
+
* ttsDisableCache:
|
|
13687
|
+
* type: boolean
|
|
13688
|
+
* example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false }
|
|
13689
|
+
* enableVoiceConfigs:
|
|
13690
|
+
* type: boolean
|
|
13691
|
+
* description: Enables the use of voice configuration.
|
|
13692
|
+
* example: false
|
|
13693
|
+
* safetySettings:
|
|
13694
|
+
* type: object
|
|
13695
|
+
* properties:
|
|
13696
|
+
* avoidHarmfulContent:
|
|
13697
|
+
* type: boolean
|
|
13698
|
+
* avoidUngroundedContent:
|
|
13699
|
+
* type: boolean
|
|
13700
|
+
* avoidCopyrightInfringements:
|
|
13701
|
+
* type: boolean
|
|
13702
|
+
* preventJailbreakAndManipulation:
|
|
13703
|
+
* type: boolean
|
|
13704
|
+
* contactProfilesOption:
|
|
13705
|
+
* type: string
|
|
13706
|
+
* enum:
|
|
13707
|
+
* - "none"
|
|
13708
|
+
* - "selectedProfileFields"
|
|
13709
|
+
* - "completeProfile"
|
|
13710
|
+
* - "profileMemoriesOnly"
|
|
13711
|
+
* description: Option to enable or customize Contact profiles selection for the AI Agent.
|
|
13712
|
+
* example: "selectedProfileFields"
|
|
13713
|
+
* contactProfilesSelected:
|
|
13714
|
+
* type: array
|
|
13715
|
+
* items:
|
|
13716
|
+
* type: string
|
|
13717
|
+
* description: Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
|
|
13718
|
+
* example: ["name", "email"]
|
|
13719
|
+
* instructions:
|
|
13720
|
+
* type: string
|
|
13721
|
+
* description: Instructions for the AI Agent.
|
|
13722
|
+
* example: "I can help you with your questions, provide information and much more."
|
|
13723
|
+
* maxLength: 1000
|
|
13724
|
+
* IAiAgent_2_0:
|
|
13725
|
+
* allOf:
|
|
13726
|
+
* - $ref: '#/components/schemas/IAiAgentData_2_0'
|
|
13727
|
+
* - $ref: '#/components/schemas/IEntityMeta'
|
|
13728
|
+
*/
|
|
13729
|
+
export interface IAiAgent_2_0 {
|
|
13730
|
+
_id: TMongoId;
|
|
13731
|
+
name: string;
|
|
13732
|
+
referenceId: string;
|
|
13733
|
+
image: string;
|
|
13734
|
+
imageOptimizedFormat: boolean;
|
|
13735
|
+
instructions: string;
|
|
13736
|
+
knowledgeReferenceId: string | null;
|
|
13737
|
+
description: string;
|
|
13738
|
+
speakingStyle: ISpeakingStyle;
|
|
13739
|
+
voiceConfigs: IVoiceConfigParams;
|
|
13740
|
+
enableVoiceConfigs: boolean;
|
|
13741
|
+
safetySettings: ISafetySettings;
|
|
13742
|
+
contactProfilesOption: TContactProfileOptions;
|
|
13743
|
+
contactProfilesSelected: string[];
|
|
13744
|
+
projectReference: TMongoId;
|
|
13745
|
+
organisationReference: TMongoId;
|
|
13746
|
+
createdAt: number;
|
|
13747
|
+
lastChanged: number;
|
|
13748
|
+
createdBy: TMongoId;
|
|
13749
|
+
lastChangedBy: TMongoId;
|
|
13750
|
+
}
|
|
13751
|
+
export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
|
|
13752
|
+
}
|
|
13753
|
+
export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
|
|
13754
|
+
}
|
|
13755
|
+
export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
|
|
13756
|
+
}
|
|
13757
|
+
export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
|
|
13758
|
+
}
|
|
13759
|
+
export interface IUpdateAiAgentRestDataParams_2_0 {
|
|
13760
|
+
aiAgentId: string;
|
|
13761
|
+
}
|
|
13762
|
+
export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
|
|
13763
|
+
}
|
|
13764
|
+
export interface IUpdateAiAgentRestReturnValue_2_0 {
|
|
13765
|
+
}
|
|
13766
|
+
export interface IReadAiAgentRestDataParams_2_0 {
|
|
13767
|
+
aiAgentId: string;
|
|
13768
|
+
}
|
|
13769
|
+
export interface IReadAiAgentRestData_2_0 extends IReadAiAgentRestDataParams_2_0 {
|
|
13770
|
+
}
|
|
13771
|
+
export interface IReadAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
|
|
13772
|
+
}
|
|
13773
|
+
export interface IIndexAiAgentsRestData_2_0 extends IRestPagination<IAiAgent_2_0>, IProjectScope {
|
|
13774
|
+
}
|
|
13775
|
+
export interface IIndexAiAgentsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAiAgent_2_0> {
|
|
13776
|
+
}
|
|
13777
|
+
export interface IDeleteAiAgentRestDataParams_2_0 {
|
|
13778
|
+
aiAgentId: string;
|
|
13779
|
+
}
|
|
13780
|
+
export interface IDeleteAiAgentRestData_2_0 extends IDeleteAiAgentRestDataParams_2_0 {
|
|
13781
|
+
}
|
|
13782
|
+
export interface IDeleteAiAgentRestReturnValue_2_0 {
|
|
13783
|
+
}
|
|
13784
|
+
/**
|
|
13785
|
+
* @openapi
|
|
13786
|
+
* components:
|
|
13787
|
+
* schemas:
|
|
13788
|
+
* IAiAgentHiringTemplate_2_0:
|
|
13789
|
+
* type: object
|
|
13790
|
+
* properties:
|
|
13791
|
+
* templateId:
|
|
13792
|
+
* type: string
|
|
13793
|
+
* description: The ID of the AI Agent template to hire.
|
|
13794
|
+
* example: RetailAssistant-Rita
|
|
13795
|
+
* aiAgentName:
|
|
13796
|
+
* type: string
|
|
13797
|
+
* description: The name of the AI Agent.
|
|
13798
|
+
* example: Rita
|
|
13799
|
+
* aiAgentFileName:
|
|
13800
|
+
* type: string
|
|
13801
|
+
* description: The file name of the AI Agent.
|
|
13802
|
+
* example: Rita.tar
|
|
13803
|
+
* aiAgentImage:
|
|
13804
|
+
* type: string
|
|
13805
|
+
* description: The image of the AI Agent.
|
|
13806
|
+
* example: https://cognigy.com/rita.png
|
|
13807
|
+
* aiAgentDescription:
|
|
13808
|
+
* type: string
|
|
13809
|
+
* description: A short description of the AI Agent, up to 1000 characters.
|
|
13810
|
+
* example: "I am a virtual assistant that can help you with your questions."
|
|
13811
|
+
*
|
|
13812
|
+
*/
|
|
13813
|
+
export interface IAiAgentHiringTemplate_2_0 {
|
|
13814
|
+
templateId: string;
|
|
13815
|
+
aiAgentName: string;
|
|
13816
|
+
aiAgentFileName: string;
|
|
13817
|
+
aiAgentImage: string;
|
|
13818
|
+
aiAgentDescription: string;
|
|
13819
|
+
}
|
|
13820
|
+
export interface IGetAiAgentHiringTemplatesRestData_2_0 {
|
|
13821
|
+
}
|
|
13822
|
+
export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
|
|
13823
|
+
templates: IAiAgentHiringTemplate_2_0[];
|
|
13824
|
+
}
|
|
13825
|
+
/**
|
|
13826
|
+
* @openapi
|
|
13827
|
+
* components:
|
|
13828
|
+
* schemas:
|
|
13829
|
+
* IAiAgentTemplateId_2_0:
|
|
13830
|
+
* type: object
|
|
13831
|
+
* properties:
|
|
13832
|
+
* templateId:
|
|
13833
|
+
* type: string
|
|
13834
|
+
* description: The ID of the AI Agent template to hire.
|
|
13835
|
+
* example: insurance-agent-olivia
|
|
13836
|
+
* overrideAiAgentReferenceId:
|
|
13837
|
+
* type: string
|
|
13838
|
+
* description: The reference ID of the AI Agent to override the AI Agent from the hired package.
|
|
13839
|
+
* example: 5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b
|
|
13840
|
+
*/
|
|
13841
|
+
export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
|
|
13842
|
+
templateId: string;
|
|
13843
|
+
overrideAiAgentReferenceId?: string;
|
|
13844
|
+
}
|
|
13845
|
+
export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
|
|
13846
|
+
}
|
|
13847
|
+
export interface IHireAiAgentRestReturnValue_2_0 {
|
|
13848
|
+
}
|
|
13849
|
+
export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
|
|
13850
|
+
name: string;
|
|
13851
|
+
}
|
|
13852
|
+
export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
|
|
13853
|
+
}
|
|
13854
|
+
export interface IValidateAiAgentNameRestReturnValue_2_0 {
|
|
13855
|
+
}
|
|
13856
|
+
/**
|
|
13857
|
+
* @openapi
|
|
13858
|
+
*
|
|
13859
|
+
* components:
|
|
13860
|
+
* schemas:
|
|
13861
|
+
* INodeDescriptor_2_0:
|
|
13862
|
+
* type: object
|
|
13863
|
+
* properties:
|
|
13864
|
+
* type:
|
|
13865
|
+
* type: string
|
|
13866
|
+
* parentType:
|
|
13867
|
+
* type: string
|
|
13868
|
+
* description: The type of the node parent, if there is one
|
|
13869
|
+
* defaultLabel:
|
|
13870
|
+
* oneOf:
|
|
13871
|
+
* - type: string
|
|
13872
|
+
* description: The label that should be used when a new Node of this type is created
|
|
13873
|
+
* - type: object
|
|
13874
|
+
* description: A localized version of the label that should be used when a new Node of this type is created
|
|
13875
|
+
* properties:
|
|
13876
|
+
* default:
|
|
13877
|
+
* type: string
|
|
13878
|
+
* enUS:
|
|
13879
|
+
* type: string
|
|
13880
|
+
* deDE:
|
|
13881
|
+
* type: string
|
|
13882
|
+
* esES:
|
|
13883
|
+
* type: string
|
|
13884
|
+
* jaJP:
|
|
13885
|
+
* type: string
|
|
13886
|
+
* koKR:
|
|
13887
|
+
* type: string
|
|
13888
|
+
* summary:
|
|
13889
|
+
* oneOf:
|
|
13890
|
+
* - type: string
|
|
13891
|
+
* description: A short line of text that describes what this Node is used for
|
|
13892
|
+
* - type: object
|
|
13893
|
+
* description: A localized version of a short line of text that describes what this Node is used for
|
|
13894
|
+
* properties:
|
|
13895
|
+
* default:
|
|
13896
|
+
* type: string
|
|
13897
|
+
* enUS:
|
|
13898
|
+
* type: string
|
|
13899
|
+
* deDE:
|
|
13900
|
+
* type: string
|
|
13901
|
+
* esES:
|
|
13902
|
+
* type: string
|
|
13903
|
+
* jaJP:
|
|
13904
|
+
* type: string
|
|
13905
|
+
* koKR:
|
|
13906
|
+
* type: string
|
|
13907
|
+
* extension:
|
|
13908
|
+
* type: string
|
|
13909
|
+
* extensionImg:
|
|
13910
|
+
* type: string
|
|
13911
|
+
* appearance:
|
|
13912
|
+
* type: object
|
|
13913
|
+
* properties:
|
|
13914
|
+
* logo:
|
|
13915
|
+
* type: string
|
|
13916
|
+
* textColor:
|
|
13917
|
+
* type: string
|
|
13918
|
+
* example: blue
|
|
13919
|
+
* oneOf:
|
|
13920
|
+
* - $ref: '#/components/schemas/TCSSColorName'
|
|
13921
|
+
* - $ref: '#/components/schemas/TCognigyColorName'
|
|
13922
|
+
* contrastTextColor:
|
|
13923
|
+
* type: string
|
|
13924
|
+
* example: blue
|
|
13925
|
+
* oneOf:
|
|
13926
|
+
* - $ref: '#/components/schemas/TCSSColorName'
|
|
13927
|
+
* - $ref: '#/components/schemas/TCognigyColorName'
|
|
13928
|
+
* color:
|
|
13929
|
+
* type: string
|
|
13930
|
+
* example: red
|
|
13931
|
+
* oneOf:
|
|
13932
|
+
* - $ref: '#/components/schemas/TCSSColorName'
|
|
13933
|
+
* - $ref: '#/components/schemas/TCognigyColorName'
|
|
13934
|
+
* variant:
|
|
13935
|
+
* type: string
|
|
13936
|
+
* enum:
|
|
13937
|
+
* - regular
|
|
13938
|
+
* - mini
|
|
13939
|
+
* - hexagon
|
|
13940
|
+
* behavior:
|
|
13941
|
+
* type: object
|
|
13942
|
+
* properties:
|
|
13943
|
+
* stopping:
|
|
13538
13944
|
* type: boolean
|
|
13539
13945
|
* entrypoint:
|
|
13540
13946
|
* type: boolean
|
|
@@ -14806,6 +15212,8 @@ export interface IConnectionSchema_2_0 {
|
|
|
14806
15212
|
* $ref: '#/components/schemas/INodeDescriptor_2_0'
|
|
14807
15213
|
* connections:
|
|
14808
15214
|
* $ref: '#/components/schemas/IConnectionSchema_2_0'
|
|
15215
|
+
* knowledge:
|
|
15216
|
+
* $ref: '#/components/schemas/IKnowledgeDescriptor'
|
|
14809
15217
|
*
|
|
14810
15218
|
* IExtension_2_0:
|
|
14811
15219
|
* allOf:
|
|
@@ -14839,6 +15247,8 @@ export interface IExtension_2_0 {
|
|
|
14839
15247
|
nodes: INodeDescriptor_2_0[];
|
|
14840
15248
|
/** The connection schemas defined in this extension */
|
|
14841
15249
|
connections: IConnectionSchema_2_0[];
|
|
15250
|
+
/** The knowledge-descriptors within this extension */
|
|
15251
|
+
knowledge: IKnowledgeDescriptor[];
|
|
14842
15252
|
/** Unix-timestamp when the entity was created initially */
|
|
14843
15253
|
createdAt: number;
|
|
14844
15254
|
/** Unix-timestamp when the entity was changed last time */
|
|
@@ -18375,334 +18785,113 @@ export interface HttpRequest {
|
|
|
18375
18785
|
setProgressHandler(handler: (bytesSent: number) => void): void;
|
|
18376
18786
|
send(body: any): Promise<HttpResponse>;
|
|
18377
18787
|
abort(): Promise<void>;
|
|
18378
|
-
getUnderlyingObject(): any;
|
|
18379
|
-
}
|
|
18380
|
-
export interface HttpResponse {
|
|
18381
|
-
getStatus(): number;
|
|
18382
|
-
getHeader(header: string): string;
|
|
18383
|
-
getBody(): string;
|
|
18384
|
-
getUnderlyingObject(): any;
|
|
18385
|
-
}
|
|
18386
|
-
export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
|
|
18387
|
-
file: Buffer | File;
|
|
18388
|
-
onError?: ((error: Error) => void) | null;
|
|
18389
|
-
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
18390
|
-
onSuccess?: (() => void) | null;
|
|
18391
|
-
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
18392
|
-
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
18393
|
-
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
18394
|
-
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
18395
|
-
}
|
|
18396
|
-
export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
|
|
18397
|
-
uploadType: TUploadResumableTypes;
|
|
18398
|
-
}
|
|
18399
|
-
export interface IUploadResumableRestReturnValue_2_0 {
|
|
18400
|
-
fileName: string;
|
|
18401
|
-
url: string;
|
|
18402
|
-
uploadId: string;
|
|
18403
|
-
}
|
|
18404
|
-
/**
|
|
18405
|
-
* @openapi
|
|
18406
|
-
*
|
|
18407
|
-
* components:
|
|
18408
|
-
* schemas:
|
|
18409
|
-
* IGenerateNluScoreData_2_0:
|
|
18410
|
-
* type: object
|
|
18411
|
-
* required:
|
|
18412
|
-
* - flowReferenceId
|
|
18413
|
-
* - localeReferenceId
|
|
18414
|
-
* - sentence
|
|
18415
|
-
* properties:
|
|
18416
|
-
* flowReferenceId:
|
|
18417
|
-
* type: string
|
|
18418
|
-
* format: uuid
|
|
18419
|
-
* description: UUID of the flow reference.
|
|
18420
|
-
* localeReferenceId:
|
|
18421
|
-
* type: string
|
|
18422
|
-
* format: uuid
|
|
18423
|
-
* description: UUID of the locale reference.
|
|
18424
|
-
* sentence:
|
|
18425
|
-
* type: string
|
|
18426
|
-
* description: Sentence to analyze for NLU scoring.
|
|
18427
|
-
*
|
|
18428
|
-
* IGeneratedNluScore_2_0:
|
|
18429
|
-
* type: object
|
|
18430
|
-
* properties:
|
|
18431
|
-
* id:
|
|
18432
|
-
* type: string
|
|
18433
|
-
* description: Unique identifier of the score.
|
|
18434
|
-
* name:
|
|
18435
|
-
* type: string
|
|
18436
|
-
* description: Name of the score type.
|
|
18437
|
-
* score:
|
|
18438
|
-
* type: number
|
|
18439
|
-
* description: Numerical value of the score.
|
|
18440
|
-
* negated:
|
|
18441
|
-
* type: boolean
|
|
18442
|
-
* description: Indicates if the score is negated.
|
|
18443
|
-
* confirmationSentence:
|
|
18444
|
-
* type: string
|
|
18445
|
-
* description: Sentence used to confirm the score.
|
|
18446
|
-
* confirmationSentences:
|
|
18447
|
-
* type: array
|
|
18448
|
-
* items:
|
|
18449
|
-
* type: string
|
|
18450
|
-
* description: Multiple sentences for confirmation if applicable.
|
|
18451
|
-
* disambiguationSentence:
|
|
18452
|
-
* type: string
|
|
18453
|
-
* description: Sentence used for disambiguation.
|
|
18454
|
-
* flow:
|
|
18455
|
-
* type: string
|
|
18456
|
-
* description: UUID of the flow associated with the score.
|
|
18457
|
-
*/
|
|
18458
|
-
export interface IGenerateNluScoresRestDataParams_2_0 {
|
|
18459
|
-
projectId: string;
|
|
18460
|
-
}
|
|
18461
|
-
export interface IGenerateNluScoresRestDataBody_2_0 {
|
|
18462
|
-
flowReferenceId: string;
|
|
18463
|
-
localeReferenceId: string;
|
|
18464
|
-
sentence: string;
|
|
18465
|
-
}
|
|
18466
|
-
export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
|
|
18467
|
-
}
|
|
18468
|
-
export interface IGenerateNluScoresRestReturnValue_2_0 {
|
|
18469
|
-
}
|
|
18470
|
-
export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
|
|
18471
|
-
useCase: string;
|
|
18472
|
-
params?: Record<string, string>;
|
|
18473
|
-
messages?: {
|
|
18474
|
-
role: "user" | "assistant";
|
|
18475
|
-
content: string;
|
|
18476
|
-
}[];
|
|
18477
|
-
}
|
|
18478
|
-
export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
|
|
18479
|
-
projectId: string;
|
|
18480
|
-
}
|
|
18481
|
-
export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
|
|
18482
|
-
}
|
|
18483
|
-
export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
|
|
18484
|
-
output: string;
|
|
18485
|
-
}
|
|
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;
|
|
18788
|
+
getUnderlyingObject(): any;
|
|
18670
18789
|
}
|
|
18671
|
-
export interface
|
|
18790
|
+
export interface HttpResponse {
|
|
18791
|
+
getStatus(): number;
|
|
18792
|
+
getHeader(header: string): string;
|
|
18793
|
+
getBody(): string;
|
|
18794
|
+
getUnderlyingObject(): any;
|
|
18672
18795
|
}
|
|
18673
|
-
export interface
|
|
18674
|
-
|
|
18796
|
+
export interface IUploadResumableRestDataBody_2_0 extends IProjectScope {
|
|
18797
|
+
file: Buffer | File;
|
|
18798
|
+
onError?: ((error: Error) => void) | null;
|
|
18799
|
+
onProgress?: ((bytesSent: number, bytesTotal: number) => void) | null;
|
|
18800
|
+
onSuccess?: (() => void) | null;
|
|
18801
|
+
onChunkComplete?: ((chunkSize: number, bytesAccepted: number, bytesTotal: number) => void) | null;
|
|
18802
|
+
onShouldRetry?: ((error: Error, retryAttempt: number, options: unknown) => boolean) | null;
|
|
18803
|
+
onBeforeRequest?: (req: HttpRequest) => (void | Promise<void>);
|
|
18804
|
+
onAfterResponse?: (req: HttpRequest, res: HttpResponse) => (void | Promise<void>);
|
|
18805
|
+
}
|
|
18806
|
+
export interface IUploadResumableRestData_2_0 extends IUploadResumableRestDataBody_2_0 {
|
|
18807
|
+
uploadType: TUploadResumableTypes;
|
|
18808
|
+
}
|
|
18809
|
+
export interface IUploadResumableRestReturnValue_2_0 {
|
|
18810
|
+
fileName: string;
|
|
18811
|
+
url: string;
|
|
18812
|
+
uploadId: string;
|
|
18675
18813
|
}
|
|
18676
18814
|
/**
|
|
18677
18815
|
* @openapi
|
|
18816
|
+
*
|
|
18678
18817
|
* components:
|
|
18679
18818
|
* schemas:
|
|
18680
|
-
*
|
|
18819
|
+
* IGenerateNluScoreData_2_0:
|
|
18820
|
+
* type: object
|
|
18821
|
+
* required:
|
|
18822
|
+
* - flowReferenceId
|
|
18823
|
+
* - localeReferenceId
|
|
18824
|
+
* - sentence
|
|
18825
|
+
* properties:
|
|
18826
|
+
* flowReferenceId:
|
|
18827
|
+
* type: string
|
|
18828
|
+
* format: uuid
|
|
18829
|
+
* description: UUID of the flow reference.
|
|
18830
|
+
* localeReferenceId:
|
|
18831
|
+
* type: string
|
|
18832
|
+
* format: uuid
|
|
18833
|
+
* description: UUID of the locale reference.
|
|
18834
|
+
* sentence:
|
|
18835
|
+
* type: string
|
|
18836
|
+
* description: Sentence to analyze for NLU scoring.
|
|
18837
|
+
*
|
|
18838
|
+
* IGeneratedNluScore_2_0:
|
|
18681
18839
|
* type: object
|
|
18682
18840
|
* properties:
|
|
18683
|
-
*
|
|
18841
|
+
* id:
|
|
18684
18842
|
* type: string
|
|
18685
|
-
* description:
|
|
18686
|
-
*
|
|
18687
|
-
* overrideAiAgentReferenceId:
|
|
18843
|
+
* description: Unique identifier of the score.
|
|
18844
|
+
* name:
|
|
18688
18845
|
* type: string
|
|
18689
|
-
* description:
|
|
18690
|
-
*
|
|
18691
|
-
|
|
18692
|
-
|
|
18693
|
-
|
|
18694
|
-
|
|
18846
|
+
* description: Name of the score type.
|
|
18847
|
+
* score:
|
|
18848
|
+
* type: number
|
|
18849
|
+
* description: Numerical value of the score.
|
|
18850
|
+
* negated:
|
|
18851
|
+
* type: boolean
|
|
18852
|
+
* description: Indicates if the score is negated.
|
|
18853
|
+
* confirmationSentence:
|
|
18854
|
+
* type: string
|
|
18855
|
+
* description: Sentence used to confirm the score.
|
|
18856
|
+
* confirmationSentences:
|
|
18857
|
+
* type: array
|
|
18858
|
+
* items:
|
|
18859
|
+
* type: string
|
|
18860
|
+
* description: Multiple sentences for confirmation if applicable.
|
|
18861
|
+
* disambiguationSentence:
|
|
18862
|
+
* type: string
|
|
18863
|
+
* description: Sentence used for disambiguation.
|
|
18864
|
+
* flow:
|
|
18865
|
+
* type: string
|
|
18866
|
+
* description: UUID of the flow associated with the score.
|
|
18867
|
+
*/
|
|
18868
|
+
export interface IGenerateNluScoresRestDataParams_2_0 {
|
|
18869
|
+
projectId: string;
|
|
18695
18870
|
}
|
|
18696
|
-
export interface
|
|
18871
|
+
export interface IGenerateNluScoresRestDataBody_2_0 {
|
|
18872
|
+
flowReferenceId: string;
|
|
18873
|
+
localeReferenceId: string;
|
|
18874
|
+
sentence: string;
|
|
18697
18875
|
}
|
|
18698
|
-
export interface
|
|
18876
|
+
export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDataBody_2_0, IGenerateNluScoresRestDataParams_2_0 {
|
|
18699
18877
|
}
|
|
18700
|
-
export interface
|
|
18701
|
-
name: string;
|
|
18878
|
+
export interface IGenerateNluScoresRestReturnValue_2_0 {
|
|
18702
18879
|
}
|
|
18703
|
-
export interface
|
|
18880
|
+
export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
|
|
18881
|
+
useCase: string;
|
|
18882
|
+
params?: Record<string, string>;
|
|
18883
|
+
messages?: {
|
|
18884
|
+
role: "user" | "assistant";
|
|
18885
|
+
content: string;
|
|
18886
|
+
}[];
|
|
18704
18887
|
}
|
|
18705
|
-
export interface
|
|
18888
|
+
export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
|
|
18889
|
+
projectId: string;
|
|
18890
|
+
}
|
|
18891
|
+
export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
|
|
18892
|
+
}
|
|
18893
|
+
export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
|
|
18894
|
+
output: string;
|
|
18706
18895
|
}
|
|
18707
18896
|
export interface ResourcesAPIGroup_2_0 {
|
|
18708
18897
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
@@ -18955,6 +19144,13 @@ export interface ResourcesAPIGroup_2_0 {
|
|
|
18955
19144
|
uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
|
|
18956
19145
|
generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
|
|
18957
19146
|
generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
|
|
19147
|
+
readFlowChartAiAgents: TRestAPIOperation<{
|
|
19148
|
+
flowId: string;
|
|
19149
|
+
preferredLocaleId?: string;
|
|
19150
|
+
}, {
|
|
19151
|
+
items: any[];
|
|
19152
|
+
total: number;
|
|
19153
|
+
}>;
|
|
18958
19154
|
}
|
|
18959
19155
|
declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
|
|
18960
19156
|
/**
|
|
@@ -22687,6 +22883,15 @@ export interface IOpsCenterError {
|
|
|
22687
22883
|
component?: MainComponent;
|
|
22688
22884
|
subComponent?: SubComponent;
|
|
22689
22885
|
count: number;
|
|
22886
|
+
errorCode: string;
|
|
22887
|
+
isSnapshotError: boolean;
|
|
22888
|
+
params: {
|
|
22889
|
+
[key: string]: {
|
|
22890
|
+
id?: string;
|
|
22891
|
+
referenceId?: string;
|
|
22892
|
+
name?: string;
|
|
22893
|
+
};
|
|
22894
|
+
};
|
|
22690
22895
|
}
|
|
22691
22896
|
export interface IGetOpsCenterError extends Partial<IOpsCenterError> {
|
|
22692
22897
|
}
|
|
@@ -22696,6 +22901,7 @@ export interface IGetOpsCenterErrorRestDataParams_2_0 {
|
|
|
22696
22901
|
export interface IGetOpsCenterErrorRestData_2_0 extends IGetOpsCenterErrorRestDataParams_2_0 {
|
|
22697
22902
|
}
|
|
22698
22903
|
export interface IGetOpsCenterErrorRestReturnValue_2_0 extends IGetOpsCenterError {
|
|
22904
|
+
url: string;
|
|
22699
22905
|
}
|
|
22700
22906
|
export interface IIndexOpsCenterErrorsRestDataQuery_2_0 {
|
|
22701
22907
|
projectIds?: string[];
|
|
@@ -22729,7 +22935,12 @@ export interface NotificationConfig {
|
|
|
22729
22935
|
}
|
|
22730
22936
|
export interface AlertingConfig {
|
|
22731
22937
|
configuredAlerts: {
|
|
22732
|
-
[K in string]:
|
|
22938
|
+
[K in string]: {
|
|
22939
|
+
enabled: boolean;
|
|
22940
|
+
description: string;
|
|
22941
|
+
humanReadableName: string;
|
|
22942
|
+
tooltip: string;
|
|
22943
|
+
};
|
|
22733
22944
|
};
|
|
22734
22945
|
}
|
|
22735
22946
|
export interface IOpsCenterObservationConfig {
|
|
@@ -22901,12 +23112,68 @@ export interface IScheduleSimulationRestData_2_0 extends IScheduleSimulationRest
|
|
|
22901
23112
|
export interface IScheduleSimulationRestReturnValue_2_0 {
|
|
22902
23113
|
simulation: ISimulationRest_2_0;
|
|
22903
23114
|
}
|
|
23115
|
+
declare enum ETurnTypeRest_2_0 {
|
|
23116
|
+
INPUT = "input",
|
|
23117
|
+
OUTPUT = "output"
|
|
23118
|
+
}
|
|
23119
|
+
export interface ITurnRest_2_0 {
|
|
23120
|
+
type: ETurnTypeRest_2_0;
|
|
23121
|
+
text: string;
|
|
23122
|
+
data?: Record<string, unknown>;
|
|
23123
|
+
}
|
|
23124
|
+
declare enum SuccessCriterionType_2_0 {
|
|
23125
|
+
TEXT = "text",
|
|
23126
|
+
GOAL_COMPLETED = "goalCompleted"
|
|
23127
|
+
}
|
|
23128
|
+
export interface ISuccessCriteriaTextParams_2_0 {
|
|
23129
|
+
text: string;
|
|
23130
|
+
name: string;
|
|
23131
|
+
}
|
|
23132
|
+
export interface ISuccessCriteriaGoalParams_2_0 {
|
|
23133
|
+
referenceId: string;
|
|
23134
|
+
name: string;
|
|
23135
|
+
}
|
|
23136
|
+
export interface ISuccessCriteriaRest_2_0 {
|
|
23137
|
+
type: SuccessCriterionType_2_0;
|
|
23138
|
+
params: ISuccessCriteriaTextParams_2_0 | ISuccessCriteriaGoalParams_2_0;
|
|
23139
|
+
}
|
|
23140
|
+
declare enum ESentimentTypeRest_2_0 {
|
|
23141
|
+
POSITIVE = "POSITIVE",
|
|
23142
|
+
NEUTRAL = "NEUTRAL",
|
|
23143
|
+
NEGATIVE = "NEGATIVE"
|
|
23144
|
+
}
|
|
23145
|
+
export interface ISimulationRunRest_2_0 {
|
|
23146
|
+
id: string;
|
|
23147
|
+
organisationReference: string;
|
|
23148
|
+
projectReference: string;
|
|
23149
|
+
simulationReference: string;
|
|
23150
|
+
simulationRunBatchReference: string;
|
|
23151
|
+
sequence: number;
|
|
23152
|
+
largeLanguageModelReferenceId: string;
|
|
23153
|
+
turns: ITurnRest_2_0[];
|
|
23154
|
+
totalTurns: number;
|
|
23155
|
+
successCriteria: ISuccessCriteriaRest_2_0[];
|
|
23156
|
+
metrics: {
|
|
23157
|
+
sentiment: ESentimentTypeRest_2_0;
|
|
23158
|
+
outOfScope: string;
|
|
23159
|
+
efficiency: number;
|
|
23160
|
+
topic: string;
|
|
23161
|
+
success: boolean;
|
|
23162
|
+
};
|
|
23163
|
+
createdAt: number;
|
|
23164
|
+
createdBy: string;
|
|
23165
|
+
duration?: number;
|
|
23166
|
+
expiresAt?: Date;
|
|
23167
|
+
}
|
|
22904
23168
|
declare const SimulationRunBatchStatus: readonly [
|
|
22905
23169
|
"IN_PROGRESS",
|
|
22906
23170
|
"COMPLETED",
|
|
22907
23171
|
"FAILED"
|
|
22908
23172
|
];
|
|
22909
23173
|
export declare type TSimulationRunBatchStatusRest_2_0 = typeof SimulationRunBatchStatus[number];
|
|
23174
|
+
export interface IBatchSuccessCriteriaOverview_2_0 extends ISuccessCriteriaRest_2_0 {
|
|
23175
|
+
percentage: number;
|
|
23176
|
+
}
|
|
22910
23177
|
export interface ISimulationRunBatchRest_2_0 {
|
|
22911
23178
|
id: string;
|
|
22912
23179
|
name: string;
|
|
@@ -22928,6 +23195,9 @@ export interface ISimulationRunBatchRest_2_0 {
|
|
|
22928
23195
|
updatedAt?: number;
|
|
22929
23196
|
completedAt?: number;
|
|
22930
23197
|
expiresAt?: Date;
|
|
23198
|
+
batchMetrics?: {
|
|
23199
|
+
results?: IBatchSuccessCriteriaOverview_2_0[];
|
|
23200
|
+
};
|
|
22931
23201
|
}
|
|
22932
23202
|
export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
|
|
22933
23203
|
projectId: string;
|
|
@@ -22968,52 +23238,6 @@ export interface IReadSimulationRunBatchRestData_2_0 extends IReadSimulationRunB
|
|
|
22968
23238
|
export interface IReadSimulationRunBatchRestReturnValue_2_0 {
|
|
22969
23239
|
simulationRunBatch: ISimulationRunBatchRest_2_0;
|
|
22970
23240
|
}
|
|
22971
|
-
declare enum ETurnTypeRest_2_0 {
|
|
22972
|
-
INPUT = "input",
|
|
22973
|
-
OUTPUT = "output"
|
|
22974
|
-
}
|
|
22975
|
-
export interface ITurnRest_2_0 {
|
|
22976
|
-
type: ETurnTypeRest_2_0;
|
|
22977
|
-
text: string;
|
|
22978
|
-
data?: Record<string, unknown>;
|
|
22979
|
-
}
|
|
22980
|
-
declare enum ESuccessCriteriaTypeRest_2_0 {
|
|
22981
|
-
TEXT = "text"
|
|
22982
|
-
}
|
|
22983
|
-
export interface ISuccessCriteriaRest_2_0 {
|
|
22984
|
-
type: ESuccessCriteriaTypeRest_2_0;
|
|
22985
|
-
params: {
|
|
22986
|
-
text: string;
|
|
22987
|
-
};
|
|
22988
|
-
}
|
|
22989
|
-
declare enum ESentimentTypeRest_2_0 {
|
|
22990
|
-
POSITIVE = "POSITIVE",
|
|
22991
|
-
NEUTRAL = "NEUTRAL",
|
|
22992
|
-
NEGATIVE = "NEGATIVE"
|
|
22993
|
-
}
|
|
22994
|
-
export interface ISimulationRunRest_2_0 {
|
|
22995
|
-
id: string;
|
|
22996
|
-
organisationReference: string;
|
|
22997
|
-
projectReference: string;
|
|
22998
|
-
simulationReference: string;
|
|
22999
|
-
simulationRunBatchReference: string;
|
|
23000
|
-
sequence: number;
|
|
23001
|
-
largeLanguageModelReferenceId: string;
|
|
23002
|
-
turns: ITurnRest_2_0[];
|
|
23003
|
-
totalTurns: number;
|
|
23004
|
-
successCriteria: ISuccessCriteriaRest_2_0[];
|
|
23005
|
-
metrics: {
|
|
23006
|
-
sentiment: ESentimentTypeRest_2_0;
|
|
23007
|
-
outOfScope: string;
|
|
23008
|
-
efficiency: number;
|
|
23009
|
-
topic: string;
|
|
23010
|
-
success: boolean;
|
|
23011
|
-
};
|
|
23012
|
-
createdAt: number;
|
|
23013
|
-
createdBy: string;
|
|
23014
|
-
duration?: number;
|
|
23015
|
-
expiresAt?: Date;
|
|
23016
|
-
}
|
|
23017
23241
|
export interface IIndexSimulationRunsRestDataQuery_2_0 {
|
|
23018
23242
|
projectId: string;
|
|
23019
23243
|
filter?: string;
|
|
@@ -23041,6 +23265,121 @@ export interface IReadSimulationRunRestData_2_0 extends IReadSimulationRunRestDa
|
|
|
23041
23265
|
export interface IReadSimulationRunRestReturnValue_2_0 {
|
|
23042
23266
|
simulationRun: ISimulationRunRest_2_0;
|
|
23043
23267
|
}
|
|
23268
|
+
export interface IGetPersonaOptionsRestData_2_0 {
|
|
23269
|
+
flowId: string;
|
|
23270
|
+
projectReference: string;
|
|
23271
|
+
aiagentReferenceId?: string;
|
|
23272
|
+
}
|
|
23273
|
+
export interface IMissionType_2_0 {
|
|
23274
|
+
name: string;
|
|
23275
|
+
description: string;
|
|
23276
|
+
}
|
|
23277
|
+
export interface IPersonaType_2_0 {
|
|
23278
|
+
name: string;
|
|
23279
|
+
description: string;
|
|
23280
|
+
}
|
|
23281
|
+
export interface IGetPersonaOptionsRestReturnValue_2_0 {
|
|
23282
|
+
missionTypes: IMissionType_2_0[];
|
|
23283
|
+
personaTypes: IPersonaType_2_0[];
|
|
23284
|
+
}
|
|
23285
|
+
export interface IGeneratePersonaRestData_2_0 {
|
|
23286
|
+
flowReferenceId: string;
|
|
23287
|
+
projectReference: string;
|
|
23288
|
+
selectedMissionType: IMissionType_2_0;
|
|
23289
|
+
selectedPersonaType: IPersonaType_2_0;
|
|
23290
|
+
numberOfSuccessCriteria: number;
|
|
23291
|
+
requestedPackages: number;
|
|
23292
|
+
}
|
|
23293
|
+
export interface ISuccessCriteriaParams_2_0 {
|
|
23294
|
+
name: string;
|
|
23295
|
+
text: string;
|
|
23296
|
+
}
|
|
23297
|
+
export interface ISuccessCriteria_2_0 {
|
|
23298
|
+
type: string;
|
|
23299
|
+
params: ISuccessCriteriaParams_2_0;
|
|
23300
|
+
}
|
|
23301
|
+
export interface IPersonaPackage_2_0 {
|
|
23302
|
+
simulationName: string;
|
|
23303
|
+
personaName: string;
|
|
23304
|
+
personaDescription: string;
|
|
23305
|
+
mission: string;
|
|
23306
|
+
successCriteria: ISuccessCriteria_2_0[];
|
|
23307
|
+
}
|
|
23308
|
+
export interface IGeneratePersonaMetadata_2_0 {
|
|
23309
|
+
requestId: string;
|
|
23310
|
+
processedAt: string;
|
|
23311
|
+
model: string;
|
|
23312
|
+
}
|
|
23313
|
+
export interface IGeneratePersonaRestReturnValue_2_0 {
|
|
23314
|
+
success: boolean;
|
|
23315
|
+
personaPackages: IPersonaPackage_2_0[];
|
|
23316
|
+
metadata: IGeneratePersonaMetadata_2_0;
|
|
23317
|
+
}
|
|
23318
|
+
export interface IRegeneratePersonaFieldRestData_2_0 {
|
|
23319
|
+
projectReference: string;
|
|
23320
|
+
fieldToRegenerate: string;
|
|
23321
|
+
successCriteriaIndex?: number;
|
|
23322
|
+
simulationName: string;
|
|
23323
|
+
personaName: string;
|
|
23324
|
+
personaDescription: string;
|
|
23325
|
+
mission: string;
|
|
23326
|
+
successCriteria: ISuccessCriteria_2_0[];
|
|
23327
|
+
}
|
|
23328
|
+
export interface IRegeneratePersonaFieldMetadata_2_0 {
|
|
23329
|
+
requestId: string;
|
|
23330
|
+
processedAt: string;
|
|
23331
|
+
model: string;
|
|
23332
|
+
regeneratedField: string;
|
|
23333
|
+
regeneratedIndex?: number;
|
|
23334
|
+
}
|
|
23335
|
+
export interface IRegeneratePersonaFieldRestReturnValue_2_0 {
|
|
23336
|
+
success: boolean;
|
|
23337
|
+
personaPackage: IPersonaPackage_2_0;
|
|
23338
|
+
metadata: IRegeneratePersonaFieldMetadata_2_0;
|
|
23339
|
+
}
|
|
23340
|
+
export interface IGenerateBulkPersonaRestData_2_0 {
|
|
23341
|
+
flowReferenceId: string;
|
|
23342
|
+
projectReference: string;
|
|
23343
|
+
allMissionTypes: Array<{
|
|
23344
|
+
name: string;
|
|
23345
|
+
description: string;
|
|
23346
|
+
}>;
|
|
23347
|
+
allPersonaTypes: Array<{
|
|
23348
|
+
name: string;
|
|
23349
|
+
description: string;
|
|
23350
|
+
}>;
|
|
23351
|
+
numberOfSuccessCriteria: number;
|
|
23352
|
+
requestedPackages: number;
|
|
23353
|
+
}
|
|
23354
|
+
export interface IGenerateBulkPersonaRestReturnValue_2_0 {
|
|
23355
|
+
success: boolean;
|
|
23356
|
+
personas: {
|
|
23357
|
+
[personaTypeName: string]: Array<{
|
|
23358
|
+
simulationName: string;
|
|
23359
|
+
personaName: string;
|
|
23360
|
+
personaDescription: string;
|
|
23361
|
+
}>;
|
|
23362
|
+
};
|
|
23363
|
+
missions: {
|
|
23364
|
+
[missionTypeName: string]: Array<{
|
|
23365
|
+
mission: string;
|
|
23366
|
+
successCriteria: Array<{
|
|
23367
|
+
type: string;
|
|
23368
|
+
params: {
|
|
23369
|
+
text: string;
|
|
23370
|
+
name: string;
|
|
23371
|
+
};
|
|
23372
|
+
}>;
|
|
23373
|
+
}>;
|
|
23374
|
+
};
|
|
23375
|
+
metadata: {
|
|
23376
|
+
requestId: string;
|
|
23377
|
+
processedAt: string;
|
|
23378
|
+
model: string;
|
|
23379
|
+
personaTypesCount: number;
|
|
23380
|
+
missionTypesCount: number;
|
|
23381
|
+
};
|
|
23382
|
+
}
|
|
23044
23383
|
export interface SimulationAPIGroup_2_0 {
|
|
23045
23384
|
indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
|
|
23046
23385
|
createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
|
|
@@ -23053,6 +23392,10 @@ export interface SimulationAPIGroup_2_0 {
|
|
|
23053
23392
|
readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
|
|
23054
23393
|
indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
|
|
23055
23394
|
readSimulationRun: TRestAPIOperation<IReadSimulationRunRestData_2_0, IReadSimulationRunRestReturnValue_2_0>;
|
|
23395
|
+
getPersonaOptions: TRestAPIOperation<IGetPersonaOptionsRestData_2_0, IGetPersonaOptionsRestReturnValue_2_0>;
|
|
23396
|
+
generatePersona: TRestAPIOperation<IGeneratePersonaRestData_2_0, IGeneratePersonaRestReturnValue_2_0>;
|
|
23397
|
+
regeneratePersonaField: TRestAPIOperation<IRegeneratePersonaFieldRestData_2_0, IRegeneratePersonaFieldRestReturnValue_2_0>;
|
|
23398
|
+
generateBulkPersona: TRestAPIOperation<IGenerateBulkPersonaRestData_2_0, IGenerateBulkPersonaRestReturnValue_2_0>;
|
|
23056
23399
|
}
|
|
23057
23400
|
declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
|
|
23058
23401
|
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>;
|