@cognigy/rest-api-client 2025.15.1 → 2025.17.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 (76) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/build/apigroups/MetricsAPIGroup_2_0.js +10 -0
  3. package/build/apigroups/ResourcesAPIGroup_2_0.js +6 -0
  4. package/build/apigroups/SimulationAPIGroup_2_0.js +4 -0
  5. package/build/shared/charts/descriptors/data/debugMessage.js +13 -3
  6. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +48 -49
  7. package/build/shared/charts/descriptors/logic/if/if.js +2 -2
  8. package/build/shared/charts/descriptors/logic/switch/switch.js +30 -21
  9. package/build/shared/charts/descriptors/message/question/question.js +3 -3
  10. package/build/shared/charts/descriptors/message/question/utils/validateQuestionAnswer.js +2 -2
  11. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +31 -2
  12. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +40 -24
  13. package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +4 -4
  14. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +36 -21
  15. package/build/shared/charts/descriptors/transcripts/addTranscriptStep.js +3 -3
  16. package/build/shared/charts/descriptors/transcripts/getTranscript.js +23 -3
  17. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +3 -0
  18. package/build/shared/generativeAI/getPrompt.js +75 -0
  19. package/build/shared/generativeAI/utils/generativeAIPrompts.js +613 -0
  20. package/build/shared/generativeAI/utils/prompts/contextAwareUserQueryRephrasing.js +84 -0
  21. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +2 -0
  22. package/build/shared/interfaces/messageAPI/handover.js +6 -0
  23. package/build/shared/interfaces/resources/IGetAiAgentJobsTools.js +3 -0
  24. package/build/shared/interfaces/resources/IKnowledgeDescriptor.js +38 -5
  25. package/build/shared/interfaces/resources/ILargeLanguageModel.js +16 -1
  26. package/build/shared/interfaces/restAPI/metrics/callCounter/v3.0/ICallCounterPreAggregatedValue_3_0.js +3 -0
  27. package/build/shared/interfaces/restAPI/metrics/callCounter/v3.0/IGetCallCounterOrganisationRest_3_0.js +3 -0
  28. package/build/shared/interfaces/restAPI/metrics/callCounter/v3.0/IGetCallCounterRest_3_0.js +3 -0
  29. package/build/shared/interfaces/restAPI/metrics/callCounter/v3.0/index.js +3 -0
  30. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgentJobNodeWithTools_2_0.js +65 -0
  31. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IGetAiAgentJobAndToolsRest_2_0 .js +4 -0
  32. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IIndexKnowledgeDescriptorsRest_2_0.js +3 -0
  33. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/extension/IRunKnowledgeExtensionRest_2_0.js +3 -0
  34. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/index.js +16 -0
  35. package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IStopSimulationRunBatchRest_2_0.js +3 -0
  36. package/build/shared/interfaces/security/ICallCounterPreAggregatedValue.js +3 -0
  37. package/build/test.js +39 -0
  38. package/dist/esm/apigroups/MetricsAPIGroup_2_0.js +10 -0
  39. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +6 -0
  40. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +4 -0
  41. package/dist/esm/shared/charts/descriptors/data/debugMessage.js +13 -3
  42. package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +48 -50
  43. package/dist/esm/shared/charts/descriptors/logic/if/if.js +2 -2
  44. package/dist/esm/shared/charts/descriptors/logic/switch/switch.js +30 -21
  45. package/dist/esm/shared/charts/descriptors/message/question/question.js +3 -3
  46. package/dist/esm/shared/charts/descriptors/message/question/utils/validateQuestionAnswer.js +4 -3
  47. package/dist/esm/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +29 -1
  48. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +39 -23
  49. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +4 -4
  50. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +43 -28
  51. package/dist/esm/shared/charts/descriptors/transcripts/addTranscriptStep.js +3 -3
  52. package/dist/esm/shared/charts/descriptors/transcripts/getTranscript.js +23 -3
  53. package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +3 -0
  54. package/dist/esm/shared/generativeAI/getPrompt.js +68 -0
  55. package/dist/esm/shared/generativeAI/utils/generativeAIPrompts.js +610 -0
  56. package/dist/esm/shared/generativeAI/utils/prompts/contextAwareUserQueryRephrasing.js +81 -0
  57. package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +2 -0
  58. package/dist/esm/shared/interfaces/messageAPI/handover.js +6 -0
  59. package/dist/esm/shared/interfaces/resources/IGetAiAgentJobsTools.js +2 -0
  60. package/dist/esm/shared/interfaces/resources/IKnowledgeDescriptor.js +37 -5
  61. package/dist/esm/shared/interfaces/resources/ILargeLanguageModel.js +14 -0
  62. package/dist/esm/shared/interfaces/restAPI/management/authentication/ICreateJWTToken.js +1 -0
  63. package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/ICallCounterPreAggregatedValue_3_0.js +2 -0
  64. package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/IGetCallCounterOrganisationRest_3_0.js +2 -0
  65. package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/IGetCallCounterRest_3_0.js +2 -0
  66. package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/index.js +2 -0
  67. package/dist/esm/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgentJobNodeWithTools_2_0.js +65 -0
  68. package/dist/esm/shared/interfaces/restAPI/resources/aiAgent/v2.0/IGetAiAgentJobAndToolsRest_2_0 .js +3 -0
  69. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IIndexKnowledgeDescriptorsRest_2_0.js +2 -0
  70. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/extension/IRunKnowledgeExtensionRest_2_0.js +2 -0
  71. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/index.js +2 -1
  72. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IStopSimulationRunBatchRest_2_0.js +2 -0
  73. package/dist/esm/shared/interfaces/security/ICallCounterPreAggregatedValue.js +2 -0
  74. package/dist/esm/test.js +39 -0
  75. package/package.json +1 -1
  76. package/types/index.d.ts +299 -42
package/types/index.d.ts CHANGED
@@ -4372,6 +4372,7 @@ declare const generativeAIModels: readonly [
4372
4372
  "claude-sonnet-4-0",
4373
4373
  "text-bison@001",
4374
4374
  "custom-model",
4375
+ "custom-embedding-model",
4375
4376
  "gemini-1.0-pro",
4376
4377
  "gemini-1.5-pro",
4377
4378
  "gemini-1.5-flash",
@@ -4389,6 +4390,7 @@ declare const generativeAIModels: readonly [
4389
4390
  "pixtral-large-latest",
4390
4391
  "mistral-medium-latest",
4391
4392
  "mistral-small-latest",
4393
+ "text-davinci-003",
4392
4394
  "text-embedding-3-small",
4393
4395
  "text-embedding-3-large",
4394
4396
  "text-embedding-ada-002",
@@ -4416,11 +4418,8 @@ declare const generativeAIModels: readonly [
4416
4418
  * - claude-v1-100k
4417
4419
  * - claude-instant-v1
4418
4420
  * - claude-3-opus-20240229
4419
- * - text-bison@001
4420
4421
  * - custom-model
4421
- * - gemini-1.0-pro
4422
- * - gemini-1.5-pro
4423
- * - gemini-1.5-flash
4422
+ * - custom-embedding-model
4424
4423
  * - gemini-2.0-flash
4425
4424
  * - gemini-2.0-flash-lite
4426
4425
  * - mistral-large-2411
@@ -8759,6 +8758,7 @@ export interface IOpenAICompatibleMeta {
8759
8758
  customModel: string;
8760
8759
  baseCustomUrl: string;
8761
8760
  customAuthHeader?: string;
8761
+ embeddingVectorSize?: number;
8762
8762
  }
8763
8763
  export interface IAlephAlphaMeta {
8764
8764
  customModel?: string;
@@ -8835,7 +8835,7 @@ export interface IGraphLargeLanguageModel {
8835
8835
  _id: TMongoId;
8836
8836
  name: string;
8837
8837
  referenceId: string;
8838
- properties: Pick<ILargeLanguageModel, "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
8838
+ properties: Pick<ILargeLanguageModel, "modelType" | "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
8839
8839
  dependencies?: IGraphLargeLanguageModelDependencyAttachment[];
8840
8840
  }
8841
8841
  export interface ISystemSlots {
@@ -9916,6 +9916,22 @@ export interface INodeToExecute {
9916
9916
  };
9917
9917
  type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
9918
9918
  }
9919
+ export interface OpenAIChatMessage {
9920
+ role: "system" | "user" | "assistant";
9921
+ content: string;
9922
+ }
9923
+ export interface IGenerativeSlot {
9924
+ tag: string;
9925
+ description: string;
9926
+ value: string;
9927
+ optional?: boolean;
9928
+ validation?: {
9929
+ type: string;
9930
+ value: string;
9931
+ invalidReason: string;
9932
+ };
9933
+ invalid?: boolean;
9934
+ }
9919
9935
  export declare type TCompletionPrompt = {
9920
9936
  prompt: string;
9921
9937
  };
@@ -9927,6 +9943,8 @@ export declare type TChatMessage = {
9927
9943
  export declare type TChatPrompt = {
9928
9944
  messages: Array<TChatMessage>;
9929
9945
  };
9946
+ export declare type TALLPrompts = TCompletionPrompt | TChatPrompt | Array<OpenAIChatMessage>;
9947
+ export declare type TPromptParserFun = (originalMsg: TALLPrompts) => TALLPrompts;
9930
9948
  export declare type TSessionUsageInformation = {
9931
9949
  [key: string]: {
9932
9950
  llmDisplayName: string;
@@ -10080,11 +10098,15 @@ export declare type ValueOf<T> = T[keyof T];
10080
10098
  * @param limit: the maximum number of entries to read
10081
10099
  * @param rolesWhiteList: (optional) the roles for which the entries should be included, if not provided or empty all entries will be read
10082
10100
  * @param excludeDataOnlyMessagesFilter: (optional) the roles for which data only messages (emtpy text field) will be excluded if type is input/output
10101
+ * @param useTextAlternativeForLLM: (optional) if true, graphical outputs will be included in the transcript, either using the value from the graphical description / fallbackText field, or by converting the data where possible
10102
+ * @param includeTextAlternativeInTranscript: (optional) if true, the text alternative for LLM will be included in the transcript
10083
10103
  */
10084
10104
  export declare type TReadTranscriptOptions = {
10085
10105
  limit: number;
10086
10106
  rolesWhiteList?: TTranscriptRoles[];
10087
10107
  excludeDataOnlyMessagesFilter?: (TranscriptRole.USER | TranscriptRole.AGENT | TranscriptRole.ASSISTANT)[];
10108
+ useTextAlternativeForLLM?: boolean;
10109
+ includeTextAlternativeInTranscript?: boolean;
10088
10110
  };
10089
10111
  declare enum TranscriptRole {
10090
10112
  ASSISTANT = "assistant",
@@ -10122,6 +10144,7 @@ export declare type TTranscriptAgentOutput = {
10122
10144
  payload: {
10123
10145
  text?: string;
10124
10146
  data?: any;
10147
+ textAlternative?: string;
10125
10148
  };
10126
10149
  };
10127
10150
  export declare type TTranscriptAssistantOutput = {
@@ -10131,6 +10154,7 @@ export declare type TTranscriptAssistantOutput = {
10131
10154
  payload: {
10132
10155
  text?: string;
10133
10156
  data?: any;
10157
+ textAlternative?: string;
10134
10158
  };
10135
10159
  };
10136
10160
  export declare type TTranscriptAssistantToolCall = {
@@ -10192,22 +10216,6 @@ export interface ITool {
10192
10216
  export interface IToolParameters {
10193
10217
  [key: string]: any;
10194
10218
  }
10195
- export interface OpenAIChatMessage {
10196
- role: "system" | "user" | "assistant";
10197
- content: string;
10198
- }
10199
- export interface IGenerativeSlot {
10200
- tag: string;
10201
- description: string;
10202
- value: string;
10203
- optional?: boolean;
10204
- validation?: {
10205
- type: string;
10206
- value: string;
10207
- invalidReason: string;
10208
- };
10209
- invalid?: boolean;
10210
- }
10211
10219
  export interface IRunGenerativeAIPromptOptions {
10212
10220
  /**
10213
10221
  * @deprecated should not inject the prompt anymore, use getPrompt() instead
@@ -10234,7 +10242,7 @@ export interface IRunGenerativeAIPromptOptions {
10234
10242
  */
10235
10243
  toolChoice?: "auto" | "required" | "none";
10236
10244
  /** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
10237
- promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
10245
+ promptParser?: (rawPrompt: TALLPrompts) => TALLPrompts;
10238
10246
  /** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
10239
10247
  temperature?: number;
10240
10248
  /** model - (Optional) The OpenAI model to use. Defaults to 'gpt-4o' */
@@ -10404,10 +10412,13 @@ export declare type ISearchTagsFilterOps = "and" | "or";
10404
10412
  export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields {
10405
10413
  tokenCacheKey: string;
10406
10414
  }
10415
+ export interface ILLMProviderMeta extends IAzureOpenAIMeta {
10416
+ customAuthHeader?: string;
10417
+ }
10407
10418
  export interface ISearchLLMCredentials {
10408
10419
  provider: TGenerativeAIProviders;
10409
10420
  connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields;
10410
- providerMetaData: IAzureOpenAIMeta;
10421
+ providerMetaData: ILLMProviderMeta;
10411
10422
  }
10412
10423
  export interface ISearchTagsData {
10413
10424
  tags: string[];
@@ -10671,9 +10682,9 @@ export interface IActions {
10671
10682
  logDebugMessageWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
10672
10683
  logDebugErrorWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
10673
10684
  mergeProfile?: (contactId: string) => Promise<any>;
10674
- parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
10675
- parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
10676
- parseCognigyScriptResultLocation?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => any;
10685
+ parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => Promise<string>;
10686
+ parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => Promise<string>;
10687
+ parseCognigyScriptResultLocation?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => Promise<any>;
10677
10688
  output?: (text: string, data: any, settings?: ISayNodeSettings) => Promise<void>;
10678
10689
  outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata, settings?: ISayNodeSettings) => Promise<void>;
10679
10690
  reloadBrainFlow?: (flowReferenceId: string) => Promise<void>;
@@ -10681,6 +10692,7 @@ export interface IActions {
10681
10692
  rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
10682
10693
  rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
10683
10694
  requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
10695
+ runGenerativeAIPromptForUseCase?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, subUseCase?: string, promptParser?: TPromptParserFun, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
10684
10696
  runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
10685
10697
  resetContext?: () => object;
10686
10698
  resetFormBrain?: () => Promise<void>;
@@ -11267,10 +11279,10 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11267
11279
  setNextNode: (nodeId: string, newFlowId?: string) => void;
11268
11280
  resetNextNodes: () => void;
11269
11281
  stopExecution: () => void;
11270
- parseCognigyScriptCondition: (condition: string) => string;
11271
- parseCognigyScriptText: (text: string) => string;
11272
- parseCognigyScriptResultLocation?: (text: string) => any;
11273
- evaluateRule: (rule: IRule) => boolean;
11282
+ parseCognigyScriptCondition: (condition: string) => Promise<string>;
11283
+ parseCognigyScriptText: (text: string) => Promise<string>;
11284
+ parseCognigyScriptResultLocation?: (text: string) => Promise<any>;
11285
+ evaluateRule: (rule: IRule) => Promise<boolean>;
11274
11286
  /**
11275
11287
  * @deprecated since 4.98.0.
11276
11288
  * Use thinkV2 instead
@@ -11340,7 +11352,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11340
11352
  addToInput: (key: string, value: any) => void;
11341
11353
  resetCognigyScriptInput?: () => void;
11342
11354
  setForwardDatesOnly?: () => void;
11343
- parseCognigyScript?: (text: string, condition?: boolean) => string;
11355
+ parseCognigyScript?: (text: string, condition?: boolean) => Promise<string>;
11344
11356
  trackAnalyticsStep?: (step: string) => void;
11345
11357
  triggerFunction?: (config: ITriggerFunctionNodeParams["config"]) => Promise<boolean>;
11346
11358
  initAppSession: (params: {
@@ -11761,9 +11773,9 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
11761
11773
  * label:
11762
11774
  * oneOf:
11763
11775
  * - type: string
11764
- * description: The label that should be used when a new Node of this type is created
11776
+ * description: The label that should be used when a new Knowledge of this type is created
11765
11777
  * - type: object
11766
- * description: A localized version of the label that should be used when a new Node of this type is created
11778
+ * description: A localized version of the label that should be used when a new Knowledge of this type is created
11767
11779
  * properties:
11768
11780
  * default:
11769
11781
  * type: string
@@ -11782,7 +11794,7 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
11782
11794
  * - type: string
11783
11795
  * description: A short line of text that describes what this Node is used for
11784
11796
  * - type: object
11785
- * description: A localized version of a short line of text that describes what this Node is used for
11797
+ * description: A localized version of a short line of text that describes what this Knowledge is used for
11786
11798
  * properties:
11787
11799
  * default:
11788
11800
  * type: string
@@ -11801,11 +11813,27 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
11801
11813
  * items:
11802
11814
  * type: object
11803
11815
  * properties:
11804
- * type:
11805
- * type: string
11806
- * enum:
11807
- * - text
11808
- * - rule
11816
+ * type:
11817
+ * type: string
11818
+ * enum:
11819
+ * - text
11820
+ * - rule
11821
+ * - json
11822
+ * - checkbox
11823
+ * - time
11824
+ * - date
11825
+ * - datetime
11826
+ * - select
11827
+ * - xml
11828
+ * - textArray
11829
+ * - chipInput
11830
+ * - toggle
11831
+ * - slider
11832
+ * - number
11833
+ * - daterange
11834
+ * - connection
11835
+ * - condition
11836
+ * - description
11809
11837
  * key:
11810
11838
  * type: string
11811
11839
  * label:
@@ -11846,6 +11874,27 @@ export interface IKnowledgeDescriptor {
11846
11874
  /** The form defines how fields and sections should be rendered in order */
11847
11875
  form?: INodeFieldAndSectionFormElement[];
11848
11876
  }
11877
+ /**
11878
+ * @openapi
11879
+ *
11880
+ * components:
11881
+ * schemas:
11882
+ * IKnowledgeDescriptorAggregatedItem:
11883
+ * allOf:
11884
+ * - $ref: '#/components/schemas/IKnowledgeDescriptor'
11885
+ * - type: object
11886
+ * properties:
11887
+ * extension:
11888
+ * type: string
11889
+ * description: The extension name that this knowledge descriptor belongs to
11890
+ * extensionImg:
11891
+ * type: string
11892
+ * description: The image URL of the extension that this knowledge descriptor belongs to
11893
+ */
11894
+ export interface IKnowledgeDescriptorAggregatedItem extends IKnowledgeDescriptor {
11895
+ extension: string;
11896
+ extensionImg: string;
11897
+ }
11849
11898
  export declare type IExtensionType = "nodes";
11850
11899
  export interface IExtension extends IExtensionData, IExtensionNodePackage {
11851
11900
  }
@@ -13832,7 +13881,7 @@ export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
13832
13881
  * templateId:
13833
13882
  * type: string
13834
13883
  * description: The ID of the AI Agent template to hire.
13835
- * example: insurance-agent-olivia
13884
+ * example: airline-support-agent-en
13836
13885
  * overrideAiAgentReferenceId:
13837
13886
  * type: string
13838
13887
  * description: The reference ID of the AI Agent to override the AI Agent from the hired package.
@@ -13853,6 +13902,51 @@ export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRe
13853
13902
  }
13854
13903
  export interface IValidateAiAgentNameRestReturnValue_2_0 {
13855
13904
  }
13905
+ export interface IGetAiAgentJobAndToolsRestDataParams_2_0 {
13906
+ aiAgentId: string;
13907
+ }
13908
+ export interface IGetAiAgentJobAndToolsRestData_2_0 extends IGetAiAgentJobAndToolsRestDataParams_2_0 {
13909
+ }
13910
+ /**
13911
+ * Interface for a Tool attached to a Job node.
13912
+ * Allows future tool types without code changes.
13913
+ */
13914
+ export interface IAiAgentJobToolNode_2_0 {
13915
+ _id: string;
13916
+ referenceId: string;
13917
+ type: string;
13918
+ label: string;
13919
+ comment: string;
13920
+ commentColor: string;
13921
+ analyticsLabel: string | null;
13922
+ isDisabled: boolean;
13923
+ isEntryPoint: boolean;
13924
+ extension: string;
13925
+ config: Record<string, any>;
13926
+ }
13927
+ /**
13928
+ * Interface for a Job Node with its associated Tool nodes, as returned by the endpoint.
13929
+ */
13930
+ export interface IAiAgentJobNodeWithTools_2_0 {
13931
+ _id: string;
13932
+ referenceId: string;
13933
+ type: string;
13934
+ label: string;
13935
+ comment: string;
13936
+ commentColor: string;
13937
+ analyticsLabel: string | null;
13938
+ isDisabled: boolean;
13939
+ isEntryPoint: boolean;
13940
+ extension: string;
13941
+ chartId: string;
13942
+ flowId: string;
13943
+ config: Record<string, any>;
13944
+ tools: IAiAgentJobToolNode_2_0[];
13945
+ }
13946
+ /**
13947
+ * The main return type for the endpoint - always an array of job nodes (each with tools).
13948
+ */
13949
+ export declare type IGetAiAgentJobAndToolsRestReturnValue_2_0 = IAiAgentJobNodeWithTools_2_0[];
13856
13950
  /**
13857
13951
  * @openapi
13858
13952
  *
@@ -18122,6 +18216,13 @@ export interface IUpdateKnowledgeStoreRestData_2_0 extends IUpdateKnowledgeStore
18122
18216
  }
18123
18217
  export interface IUpdateKnowledgeStoreRestReturnValue_2_0 {
18124
18218
  }
18219
+ export interface IIndexKnowledgeDescriptorsRestDataParams_2_0 {
18220
+ knowledgeStoreId: string;
18221
+ }
18222
+ export interface IIndexKnowledgeDescriptorsRestData_2_0 extends IIndexKnowledgeDescriptorsRestDataParams_2_0 {
18223
+ }
18224
+ export interface IIndexKnowledgeDescriptorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeDescriptorAggregatedItem> {
18225
+ }
18125
18226
  declare const knowledgeSourceStatus: readonly [
18126
18227
  "ready",
18127
18228
  "ingesting",
@@ -18437,6 +18538,17 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
18437
18538
  }
18438
18539
  export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
18439
18540
  }
18541
+ export interface IRunKnowledgeExtensionRestDataParams_2_0 {
18542
+ knowledgeStoreId: string;
18543
+ }
18544
+ export interface IRunKnowledgeExtensionRestDataBody_2_0 {
18545
+ extension: string;
18546
+ type: string;
18547
+ updateKnowledge: boolean;
18548
+ config: object;
18549
+ }
18550
+ export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensionRestDataParams_2_0, IRunKnowledgeExtensionRestDataBody_2_0 {
18551
+ }
18440
18552
  /**
18441
18553
  * @openapi
18442
18554
  *
@@ -18884,6 +18996,13 @@ export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
18884
18996
  role: "user" | "assistant";
18885
18997
  content: string;
18886
18998
  }[];
18999
+ runGenerativeAIParams?: {
19000
+ responseFormat?: "json_object" | "text" | "default";
19001
+ maxTokens?: number;
19002
+ topK?: number;
19003
+ timeoutInMs?: number;
19004
+ temperature?: number;
19005
+ };
18887
19006
  }
18888
19007
  export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
18889
19008
  projectId: string;
@@ -18891,7 +19010,7 @@ export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
18891
19010
  export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
18892
19011
  }
18893
19012
  export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
18894
- output: string;
19013
+ output: string | object;
18895
19014
  }
18896
19015
  export interface ResourcesAPIGroup_2_0 {
18897
19016
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
@@ -19116,6 +19235,7 @@ export interface ResourcesAPIGroup_2_0 {
19116
19235
  validateAiAgentName: TRestAPIOperation<IValidateAiAgentNameRestData_2_0, IValidateAiAgentNameRestReturnValue_2_0>;
19117
19236
  getAiAgentHiringTemplates: TRestAPIOperation<IGetAiAgentHiringTemplatesRestData_2_0, IGetAiAgentHiringTemplatesRestReturnValue_2_0>;
19118
19237
  hireAiAgent: TRestAPIOperation<IHireAiAgentRestData_2_0, IHireAiAgentRestReturnValue_2_0>;
19238
+ getAiAgentJobsAndTools: TRestAPIOperation<IGetAiAgentJobAndToolsRestData_2_0, IGetAiAgentJobAndToolsRestReturnValue_2_0>;
19119
19239
  generateNodeOutput: TRestAPIOperation<IGenerateNodeOutputRestData_2_0, IGenerateNodeOutputRestReturnValue_2_0>;
19120
19240
  indexLargeLanguageModels: TRestAPIOperation<IIndexLargeLanguageModelsRestData_2_0, IIndexLargeLanguageModelsRestReturnValue_2_0>;
19121
19241
  createLargeLanguageModel: TRestAPIOperation<ICreateLargeLanguageModelRestData_2_0, ICreateLargeLanguageModelRestReturnValue_2_0>;
@@ -19130,6 +19250,8 @@ export interface ResourcesAPIGroup_2_0 {
19130
19250
  readKnowledgeStore: TRestAPIOperation<IReadKnowledgeStoreRestData_2_0, IReadKnowledgeStoreRestReturnValue_2_0>;
19131
19251
  deleteKnowledgeStore: TRestAPIOperation<IDeleteKnowledgeStoreRestData_2_0, IDeleteKnowledgeStoreRestReturnValue_2_0>;
19132
19252
  updateKnowledgeStore: TRestAPIOperation<IUpdateKnowledgeStoreRestData_2_0, IUpdateKnowledgeStoreRestReturnValue_2_0>;
19253
+ runKnowledgeExtension: TRestAPIOperation<IRunKnowledgeExtensionRestData_2_0, IRunKnowledgeExtensionRestDataBody_2_0>;
19254
+ indexKnowledgeDescriptors: TRestAPIOperation<IIndexKnowledgeDescriptorsRestData_2_0, IIndexKnowledgeDescriptorsRestReturnValue_2_0>;
19133
19255
  indexKnowledgeSources: TRestAPIOperation<IIndexKnowledgeSourcesRestData_2_0, IIndexKnowledgeSourcesRestReturnValue_2_0>;
19134
19256
  createKnowledgeSource: TRestAPIOperation<ICreateKnowledgeSourceRestData_2_0, ICreateKnowledgeSourceRestReturnValue_2_0>;
19135
19257
  readKnowledgeSource: TRestAPIOperation<IReadKnowledgeSourceRestData_2_0, IReadKnowledgeSourceRestReturnValue_2_0>;
@@ -20625,6 +20747,118 @@ export interface IGetKnowledgeQueryCounterOrganisationRestData_2_0 {
20625
20747
  export interface IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0 {
20626
20748
  items: IKnowledgeQueryCounterAggregatedValue_2_0[];
20627
20749
  }
20750
+ /**
20751
+ * @openapi
20752
+ *
20753
+ * components:
20754
+ * schemas:
20755
+ * IConversationCounterAggregatedValue_3_0:
20756
+ * type: object
20757
+ * properties:
20758
+ * conversations:
20759
+ * type: number
20760
+ * day:
20761
+ * type: number
20762
+ * month:
20763
+ * type: number
20764
+ * year:
20765
+ * type: number
20766
+ * perChannel:
20767
+ * type: array
20768
+ * items:
20769
+ * type: object
20770
+ * properties:
20771
+ * channel:
20772
+ * type: string
20773
+ * conversations:
20774
+ * type: number
20775
+ */
20776
+ export interface IConversationCounterPreAggregatedValue_3_0 {
20777
+ /** The number of conversations in the time-span */
20778
+ conversations: number;
20779
+ /** The day, e.g., 1 for the first day in the month */
20780
+ day: number;
20781
+ /** The month of the year, e.g., 1 for January */
20782
+ month: number;
20783
+ /** The year, e.g., 2020 */
20784
+ year: number;
20785
+ /** Details on which channels those conversations happened */
20786
+ perChannel: Array<{
20787
+ /** The channel name */
20788
+ channel: string;
20789
+ /** The number of conversations for the specific channel */
20790
+ conversations: number;
20791
+ }>;
20792
+ }
20793
+ export interface IGetConversationCounterRestDataParams_3_0 {
20794
+ projectId: string;
20795
+ }
20796
+ export interface IGetConversationCounterRestData_3_0 extends IGetConversationCounterRestDataParams_3_0 {
20797
+ year: number;
20798
+ month: number;
20799
+ }
20800
+ export interface IGetConversationCounterRestReturnValue_3_0 {
20801
+ items: IConversationCounterPreAggregatedValue_3_0[];
20802
+ }
20803
+ export interface IGetConversationCounterOrganisationRestData_3_0 {
20804
+ year: number;
20805
+ month: number;
20806
+ }
20807
+ export interface IGetConversationCounterOrganisationRestReturnValue_3_0 {
20808
+ items: IConversationCounterPreAggregatedValue_3_0[];
20809
+ }
20810
+ /**
20811
+ * @openapi
20812
+ *
20813
+ * components:
20814
+ * schemas:
20815
+ * ICallCounterAggregatedValue_3_0:
20816
+ * type: object
20817
+ * properties:
20818
+ * day:
20819
+ * type: number
20820
+ * month:
20821
+ * type: number
20822
+ * year:
20823
+ * type: number
20824
+ * maxConcurrency:
20825
+ * type: number
20826
+ * callMinutes:
20827
+ * type: number
20828
+ * processedCalls:
20829
+ * type: number
20830
+ */
20831
+ export interface ICallCounterPreAggregatedValue_3_0 {
20832
+ /** The number of calls in the time-span */
20833
+ processedCalls: number;
20834
+ /** The day, e.g., 1 for the first day in the month */
20835
+ day: number;
20836
+ /** The month of the year, e.g., 1 for January */
20837
+ month: number;
20838
+ /** The year, e.g., 2020 */
20839
+ year: number;
20840
+ /** The maximum concurrency in the time-span */
20841
+ maxConcurrency: number;
20842
+ /** The number of call minutes in the time-span */
20843
+ callMinutes: number;
20844
+ }
20845
+ export interface IGetCallCounterRestDataParams_3_0 {
20846
+ projectId: string;
20847
+ }
20848
+ export interface IGetCallCounterRestData_3_0 extends IGetCallCounterRestDataParams_3_0 {
20849
+ year: number;
20850
+ month: number;
20851
+ }
20852
+ export interface IGetCallCounterRestReturnValue_3_0 {
20853
+ items: ICallCounterPreAggregatedValue_3_0[];
20854
+ }
20855
+ export interface IGetCallCounterOrganisationRestData_3_0 {
20856
+ year: number;
20857
+ month: number;
20858
+ }
20859
+ export interface IGetCallCounterOrganisationRestReturnValue_3_0 {
20860
+ items: ICallCounterPreAggregatedValue_3_0[];
20861
+ }
20628
20862
  export interface MetricsAPIGroup_2_0 {
20629
20863
  indexTasks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexTasksRestData_2_0>, IIndexTasksRestReturnValue_2_0>;
20630
20864
  readTask: TRestAPIOperation<IReadTaskRestData_2_0, IReadTaskRestReturnValue_2_0>;
@@ -20651,6 +20885,10 @@ export interface MetricsAPIGroup_2_0 {
20651
20885
  batchTrainerRecords: TRestAPIOperation<IBatchTrainerRecordsRestData_2_0, IBatchTrainerRecordsRestReturnValue_2_0>;
20652
20886
  getConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_2_0, IGetConversationCounterRestReturnValue_2_0>;
20653
20887
  getConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_2_0, IGetConversationCounterOrganisationRestReturnValue_2_0>;
20888
+ getPreAggregatedConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_3_0, IGetConversationCounterRestReturnValue_3_0>;
20889
+ getPreAggregatedConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_3_0, IGetConversationCounterOrganisationRestReturnValue_3_0>;
20890
+ getPreAggregatedCallCounter: TRestAPIOperation<IGetCallCounterRestData_3_0, IGetCallCounterRestReturnValue_3_0>;
20891
+ getPreAggregatedCallCounterOrganisation: TRestAPIOperation<IGetCallCounterOrganisationRestData_3_0, IGetCallCounterOrganisationRestReturnValue_3_0>;
20654
20892
  getKnowledgeQueryCounter: TRestAPIOperation<IGetKnowledgeQueryCounterRestData_2_0, IGetKnowledgeQueryCounterRestReturnValue_2_0>;
20655
20893
  getKnowledgeQueryCounterOrganisation: TRestAPIOperation<IGetKnowledgeQueryCounterOrganisationRestData_2_0, IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0>;
20656
20894
  indexConversations: TRestAPIOperation<IIndexConversationsRestRestData_2_0, IIndexConversationsRestRestReturnValue_2_0>;
@@ -23098,14 +23336,16 @@ export interface IScheduleSimulationRestDataParams_2_0 {
23098
23336
  }
23099
23337
  export interface IScheduleSimulationRestDataBody_2_0 {
23100
23338
  name: string;
23101
- largeLanguageModelReferenceId: string;
23102
23339
  runConfig: {
23103
23340
  flowReferenceId: string;
23104
23341
  localeReferenceId?: string;
23105
23342
  entrypoint: string;
23343
+ largeLanguageModelReferenceId?: string;
23344
+ userId?: string;
23106
23345
  };
23107
23346
  projectReference: string;
23108
23347
  numberOfExecutions: number;
23348
+ endPointType: string;
23109
23349
  }
23110
23350
  export interface IScheduleSimulationRestData_2_0 extends IScheduleSimulationRestDataParams_2_0, IScheduleSimulationRestDataBody_2_0 {
23111
23351
  }
@@ -23273,12 +23513,18 @@ export interface IGetPersonaOptionsRestData_2_0 {
23273
23513
  export interface IMissionType_2_0 {
23274
23514
  name: string;
23275
23515
  description: string;
23516
+ successCriteria: SuccessCriteria[];
23517
+ }
23518
+ export interface SuccessCriteria {
23519
+ name: string;
23520
+ description: string;
23276
23521
  }
23277
23522
  export interface IPersonaType_2_0 {
23278
23523
  name: string;
23279
23524
  description: string;
23280
23525
  }
23281
23526
  export interface IGetPersonaOptionsRestReturnValue_2_0 {
23527
+ simulationName: string;
23282
23528
  missionTypes: IMissionType_2_0[];
23283
23529
  personaTypes: IPersonaType_2_0[];
23284
23530
  }
@@ -23380,6 +23626,16 @@ export interface IGenerateBulkPersonaRestReturnValue_2_0 {
23380
23626
  missionTypesCount: number;
23381
23627
  };
23382
23628
  }
23629
+ export interface IStopSimulationRunBatchRestDataQuery_2_0 {
23630
+ projectId: string;
23631
+ }
23632
+ export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunBatchRestDataQuery_2_0 {
23633
+ simulationReference: string;
23634
+ simulationRunBatchReference: string;
23635
+ }
23636
+ export interface IStopSimulationRunBatchRestReturnValue_2_0 {
23637
+ simulationRunBatchId: ISimulationRunBatchRest_2_0;
23638
+ }
23383
23639
  export interface SimulationAPIGroup_2_0 {
23384
23640
  indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
23385
23641
  createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
@@ -23390,6 +23646,7 @@ export interface SimulationAPIGroup_2_0 {
23390
23646
  indexSimulationRunBatches: TRestAPIOperation<IIndexSimulationRunBatchesRestData_2_0, IIndexSimulationRunBatchesRestReturnValue_2_0>;
23391
23647
  getAllSimulationRunBatches: TRestAPIOperation<IGetAllSimulationRunBatchesRestData_2_0, IGetAllSimulationRunBatchesRestReturnValue_2_0>;
23392
23648
  readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
23649
+ stopSimulationRunBatch: TRestAPIOperation<IStopSimulationRunBatchRestData_2_0, IStopSimulationRunBatchRestReturnValue_2_0>;
23393
23650
  indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
23394
23651
  readSimulationRun: TRestAPIOperation<IReadSimulationRunRestData_2_0, IReadSimulationRunRestReturnValue_2_0>;
23395
23652
  getPersonaOptions: TRestAPIOperation<IGetPersonaOptionsRestData_2_0, IGetPersonaOptionsRestReturnValue_2_0>;