@sermas/api-client 1.0.0-alpha.61 → 1.0.0-alpha.63

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/index.d.cts CHANGED
@@ -214,6 +214,118 @@ type AppUserDto = {
214
214
  attributes: Record<string, unknown>;
215
215
  appId?: string;
216
216
  };
217
+ /**
218
+ * parameter type (one of string,number,boolean,object)
219
+ */
220
+ type ToolsParameterSchemaTypes = 'string' | 'number' | 'boolean' | 'object';
221
+ declare const ToolsParameterSchemaTypesEnum: {
222
+ readonly STRING: "string";
223
+ readonly NUMBER: "number";
224
+ readonly BOOLEAN: "boolean";
225
+ readonly OBJECT: "object";
226
+ };
227
+ type ToolsParameterSchema = {
228
+ /**
229
+ * function parameter name
230
+ */
231
+ parameter: string;
232
+ type: ToolsParameterSchemaTypes;
233
+ /**
234
+ * description for the parameter, useful to give an hint while matching from the user input
235
+ */
236
+ description: string;
237
+ /**
238
+ * flag as required
239
+ */
240
+ ignore?: boolean;
241
+ /**
242
+ * provide a predefined value, useful to fill data otherwise missing from the context
243
+ */
244
+ value?: string | number | boolean;
245
+ };
246
+ type ToolsRequestSchemaAuthBasic = {
247
+ username?: string;
248
+ password: string;
249
+ };
250
+ type ToolsRequestSchemaAuthBearer = {
251
+ /**
252
+ * Supported options are "client_credentials" or "password".
253
+ */
254
+ clientType?: string;
255
+ /**
256
+ * Required for client type "client_credentials"
257
+ */
258
+ clientId?: string;
259
+ /**
260
+ * Required for client type "client_credentials"
261
+ */
262
+ clientSecret?: string;
263
+ /**
264
+ * Required for client type "password"
265
+ */
266
+ username?: string;
267
+ /**
268
+ * Required for client type "password"
269
+ */
270
+ password?: string;
271
+ audience?: string;
272
+ tokenUrl: string;
273
+ refreshUrl?: string;
274
+ };
275
+ type ToolsRequestSchema = {
276
+ /**
277
+ * Supported options are basic, bearer and module. Defaults to module if not specified.
278
+ */
279
+ auth?: string;
280
+ /**
281
+ * Used for "basic" auth type
282
+ */
283
+ basic?: ToolsRequestSchemaAuthBasic;
284
+ /**
285
+ * Used for "bearer" auth type
286
+ */
287
+ bearer?: ToolsRequestSchemaAuthBearer;
288
+ /**
289
+ * Reference to one of the modules (or clients) available in the app
290
+ */
291
+ moduleId: string;
292
+ /**
293
+ * Url to call with a JSON POST. Leave empty to skip API calling
294
+ */
295
+ url: string;
296
+ headers?: Record<string, unknown>;
297
+ };
298
+ type AppToolsDTO = {
299
+ /**
300
+ * Tool name used in the LLM, a descriptive name may help in identifying it correctly
301
+ */
302
+ name: string;
303
+ /**
304
+ * Tool description used in the LLM, this is key to correctly match the user intent
305
+ */
306
+ description: string;
307
+ /**
308
+ * List of parameters of the tool
309
+ */
310
+ schema?: Array<ToolsParameterSchema>;
311
+ /**
312
+ * Provide details to trigger an HTTP API call on tool match
313
+ */
314
+ request?: ToolsRequestSchema;
315
+ /**
316
+ * Internal event emitted on match
317
+ */
318
+ emitter?: string;
319
+ returnDirect?: boolean;
320
+ /**
321
+ * Ignore the LLM response when the tool matches
322
+ */
323
+ skipResponse?: boolean;
324
+ /**
325
+ * API url to call on tool match, defaults to unauthenticated POST if no `request` are provided.
326
+ */
327
+ url?: string;
328
+ };
217
329
  type ModuleResourceDto = {
218
330
  /**
219
331
  * Resource of the module operation
@@ -315,117 +427,179 @@ type AppSettingsDto = {
315
427
  interactionStart?: InteractionStartTypes;
316
428
  theme?: Record<string, unknown>;
317
429
  };
430
+ type TaskIntentDto = {
431
+ /**
432
+ * Intent name used as identifier
433
+ */
434
+ name: string;
435
+ /**
436
+ * Intent description used to match with user input
437
+ */
438
+ description?: string;
439
+ };
318
440
  /**
319
- * parameter type (one of string,number,boolean,object)
441
+ * Type of event to trigger
320
442
  */
321
- type ToolsParameterSchemaTypes = 'string' | 'number' | 'boolean' | 'object';
322
- declare const ToolsParameterSchemaTypesEnum: {
323
- readonly STRING: "string";
324
- readonly NUMBER: "number";
325
- readonly BOOLEAN: "boolean";
326
- readonly OBJECT: "object";
443
+ type TaskEventType = 'started' | 'completed';
444
+ declare const TaskEventTypeEnum: {
445
+ readonly STARTED: "started";
446
+ readonly COMPLETED: "completed";
327
447
  };
328
- type ToolsParameterSchema = {
448
+ type TaskEventTriggerDto = {
329
449
  /**
330
- * function parameter name
450
+ * Tool to trigger
331
451
  */
332
- parameter: string;
333
- type: ToolsParameterSchemaTypes;
452
+ name?: string;
334
453
  /**
335
- * description for the parameter, useful to give an hint while matching from the user input
454
+ * Tool values passed to the tool handlers
336
455
  */
337
- description: string;
456
+ values?: Record<string, unknown>;
338
457
  /**
339
- * flag as required
458
+ * Evalute the condition based on values. {key} is replaced with its value.
340
459
  */
341
- ignore?: boolean;
460
+ condition?: string;
461
+ };
462
+ type TaskEventDto = {
463
+ type: TaskEventType;
342
464
  /**
343
- * provide a predefined value, useful to fill data otherwise missing from the context
465
+ * Chat message to send to the user
344
466
  */
345
- value?: string | number | boolean;
467
+ message?: string;
468
+ /**
469
+ * Trigger a tool
470
+ */
471
+ trigger?: Array<TaskEventTriggerDto>;
346
472
  };
347
- type ToolsRequestSchemaAuthBasic = {
348
- username?: string;
349
- password: string;
473
+ /**
474
+ * Data type
475
+ */
476
+ type TaskSchemaDataType = 'text' | 'boolean' | 'date' | 'select' | 'eval' | 'external';
477
+ declare const TaskSchemaDataTypeEnum: {
478
+ readonly TEXT: "text";
479
+ readonly BOOLEAN: "boolean";
480
+ readonly DATE: "date";
481
+ readonly SELECT: "select";
482
+ readonly EVAL: "eval";
483
+ readonly EXTERNAL: "external";
350
484
  };
351
- type ToolsRequestSchemaAuthBearer = {
485
+ type OptionSelection = {
352
486
  /**
353
- * Supported options are "client_credentials" or "password".
487
+ * Selection value
354
488
  */
355
- clientType?: string;
489
+ value: string;
356
490
  /**
357
- * Required for client type "client_credentials"
491
+ * Selection label (value is used if not provided)
358
492
  */
359
- clientId?: string;
493
+ label?: string;
494
+ };
495
+ type TaskFieldDto = {
360
496
  /**
361
- * Required for client type "client_credentials"
497
+ * Name of the field
362
498
  */
363
- clientSecret?: string;
499
+ name: string;
364
500
  /**
365
- * Required for client type "password"
501
+ * Label of the field
366
502
  */
367
- username?: string;
503
+ label?: string;
368
504
  /**
369
- * Required for client type "password"
505
+ * Priority order (lower first)
370
506
  */
371
- password?: string;
372
- audience?: string;
373
- tokenUrl: string;
374
- refreshUrl?: string;
507
+ order?: number;
508
+ type: TaskSchemaDataType;
509
+ /**
510
+ * Indicate if the field is required
511
+ */
512
+ required?: boolean;
513
+ /**
514
+ * A prompt to validate and transform the input
515
+ */
516
+ validation?: string;
517
+ /**
518
+ * Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.
519
+ */
520
+ condition?: string;
521
+ /**
522
+ * Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.
523
+ */
524
+ prompt?: string;
525
+ /**
526
+ * Provde an handler for type=external to delegate the field handling to an external service
527
+ */
528
+ handler?: string;
529
+ /**
530
+ * Allow to select multiple options
531
+ */
532
+ multiple?: boolean;
533
+ /**
534
+ * List of valid options
535
+ */
536
+ options?: Array<OptionSelection>;
375
537
  };
376
- type ToolsRequestSchema = {
538
+ type DialogueToolsRepositoryOptionsDto = {
377
539
  /**
378
- * Supported options are basic, bearer and module. Defaults to module if not specified.
540
+ * Trigger one of the tools in the list once, then remove the tools.
379
541
  */
380
- auth?: string;
542
+ triggerOnce?: boolean;
381
543
  /**
382
- * Used for "basic" auth type
544
+ * Alter the normal chat flow, assuming one of the available tools will provide an answer.
383
545
  */
384
- basic?: ToolsRequestSchemaAuthBasic;
546
+ exclusive?: boolean;
547
+ };
548
+ type TaskOptionsDto = {
385
549
  /**
386
- * Used for "bearer" auth type
550
+ * Trigger this task once, then remove it
387
551
  */
388
- bearer?: ToolsRequestSchemaAuthBearer;
552
+ triggerOnce?: boolean;
389
553
  /**
390
- * Reference to one of the modules (or clients) available in the app
554
+ * Enable this task as tool, allowing users to invoke it directly
391
555
  */
392
- moduleId: string;
556
+ enableTool?: boolean;
393
557
  /**
394
- * Url to call with a JSON POST. Leave empty to skip API calling
558
+ * Additional tool options configuration
395
559
  */
396
- url: string;
397
- headers?: Record<string, unknown>;
560
+ toolOptions?: DialogueToolsRepositoryOptionsDto;
561
+ /**
562
+ * ID of the tool repository to add the tool to
563
+ */
564
+ repositoryId?: string;
398
565
  };
399
- type AppToolsDTO = {
566
+ type DialogueTaskDto = {
400
567
  /**
401
- * Tool name used in the LLM, a descriptive name may help in identifying it correctly
568
+ * Task ID
402
569
  */
403
- name: string;
570
+ taskId: string;
404
571
  /**
405
- * Tool description used in the LLM, this is key to correctly match the user intent
572
+ * Application ID references
406
573
  */
407
- description: string;
574
+ appId: string;
408
575
  /**
409
- * List of parameters of the tool
576
+ * Session ID references
410
577
  */
411
- schema?: Array<ToolsParameterSchema>;
578
+ sessionId?: string;
412
579
  /**
413
- * Provide details to trigger an HTTP API call on tool match
580
+ * Task name
414
581
  */
415
- request?: ToolsRequestSchema;
582
+ name: string;
416
583
  /**
417
- * Internal event emitted on match
584
+ * Task description
418
585
  */
419
- emitter?: string;
420
- returnDirect?: boolean;
586
+ description?: string;
421
587
  /**
422
- * Ignore the LLM response when the tool matches
588
+ * A list of intents to evaluate when the user interacts with the agent
423
589
  */
424
- skipResponse?: boolean;
590
+ intents?: Array<TaskIntentDto>;
425
591
  /**
426
- * API url to call on tool match, defaults to unauthenticated POST if no `request` are provided.
592
+ * Map task events
427
593
  */
428
- url?: string;
594
+ events?: Array<TaskEventDto>;
595
+ /**
596
+ * Task fields
597
+ */
598
+ fields: Array<TaskFieldDto>;
599
+ /**
600
+ * Task options
601
+ */
602
+ options?: TaskOptionsDto;
429
603
  };
430
604
  type PlatformAppDto = {
431
605
  appId: string;
@@ -442,7 +616,14 @@ type PlatformAppDto = {
442
616
  settings?: AppSettingsDto;
443
617
  createdAt?: string;
444
618
  updatedAt?: string;
619
+ /**
620
+ * Application tools offered by the application
621
+ */
445
622
  tools?: Array<AppToolsDTO>;
623
+ /**
624
+ * Structured tasks offered by the application
625
+ */
626
+ tasks?: Array<DialogueTaskDto>;
446
627
  };
447
628
  type CreatePlatformAppDto = {
448
629
  public?: boolean;
@@ -456,7 +637,14 @@ type CreatePlatformAppDto = {
456
637
  repository: RepositoryConfigDto;
457
638
  clients: Array<AppClientDto>;
458
639
  settings?: AppSettingsDto;
640
+ /**
641
+ * Application tools offered by the application
642
+ */
459
643
  tools?: Array<AppToolsDTO>;
644
+ /**
645
+ * Structured tasks offered by the application
646
+ */
647
+ tasks?: Array<DialogueTaskDto>;
460
648
  };
461
649
  type PlatformAppExportFilterDto = {
462
650
  name?: string;
@@ -781,15 +969,32 @@ type DialogueMessageDto = {
781
969
  */
782
970
  chunkId?: string;
783
971
  };
784
- type DialogueToolsRepositoryOptionsDto = {
972
+ type DialogueMemoryMessageDto = {
973
+ content: string;
974
+ role: Record<string, unknown>;
975
+ name: string;
976
+ };
977
+ type DialogueTaskRecordDto = {
785
978
  /**
786
- * Trigger one of the tools in the list once, then remove the tools.
979
+ * Record ID
787
980
  */
788
- triggerOnce?: boolean;
981
+ recordId: string;
789
982
  /**
790
- * Alter the normal chat flow, assuming one of the available tools will provide an answer.
983
+ * Task ID
791
984
  */
792
- exclusive?: boolean;
985
+ taskId: string;
986
+ /**
987
+ * Application ID reference
988
+ */
989
+ appId: string;
990
+ /**
991
+ * Session ID reference
992
+ */
993
+ sessionId: string;
994
+ /**
995
+ * Stored values
996
+ */
997
+ values: Record<string, unknown>;
793
998
  };
794
999
  type DialogueToolsRepositoryDto = {
795
1000
  appId: string;
@@ -820,7 +1025,7 @@ type DialogueToolsRepositoryDto = {
820
1025
  /**
821
1026
  * Tools list
822
1027
  */
823
- tools: Array<AppToolsDTO>;
1028
+ tools: Array<unknown[]>;
824
1029
  };
825
1030
  type SessionProperties = {
826
1031
  /**
@@ -1093,7 +1298,13 @@ type ImageUIContentDto = {
1093
1298
  sessionId?: string;
1094
1299
  contentType: SupportedContentTypes;
1095
1300
  content: ImageContentDto;
1301
+ /**
1302
+ * Provides metadata for the content
1303
+ */
1096
1304
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1305
+ /**
1306
+ * Provides configuration options for the content
1307
+ */
1097
1308
  options?: UIContentOptionsDto & Record<string, unknown>;
1098
1309
  /**
1099
1310
  * Unique sortable ID used to group and sort messages
@@ -1133,7 +1344,13 @@ type VideoUIContentDto = {
1133
1344
  sessionId?: string;
1134
1345
  contentType: SupportedContentTypes;
1135
1346
  content: VideoContentDto;
1347
+ /**
1348
+ * Provides metadata for the content
1349
+ */
1136
1350
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1351
+ /**
1352
+ * Provides configuration options for the content
1353
+ */
1137
1354
  options?: UIContentOptionsDto & Record<string, unknown>;
1138
1355
  /**
1139
1356
  * Unique sortable ID used to group and sort messages
@@ -1167,7 +1384,13 @@ type PdfUIContentDto = {
1167
1384
  sessionId?: string;
1168
1385
  contentType: SupportedContentTypes;
1169
1386
  content: PdfContentDto;
1387
+ /**
1388
+ * Provides metadata for the content
1389
+ */
1170
1390
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1391
+ /**
1392
+ * Provides configuration options for the content
1393
+ */
1171
1394
  options?: UIContentOptionsDto & Record<string, unknown>;
1172
1395
  /**
1173
1396
  * Unique sortable ID used to group and sort messages
@@ -1201,7 +1424,13 @@ type WebpageUIContentDto = {
1201
1424
  sessionId?: string;
1202
1425
  contentType: SupportedContentTypes;
1203
1426
  content: WebpageContentDto;
1427
+ /**
1428
+ * Provides metadata for the content
1429
+ */
1204
1430
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1431
+ /**
1432
+ * Provides configuration options for the content
1433
+ */
1205
1434
  options?: UIContentOptionsDto & Record<string, unknown>;
1206
1435
  /**
1207
1436
  * Unique sortable ID used to group and sort messages
@@ -1235,7 +1464,13 @@ type ObjectUIContentDto = {
1235
1464
  sessionId?: string;
1236
1465
  contentType: SupportedContentTypes;
1237
1466
  content: ObjectContentDto;
1467
+ /**
1468
+ * Provides metadata for the content
1469
+ */
1238
1470
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1471
+ /**
1472
+ * Provides configuration options for the content
1473
+ */
1239
1474
  options?: UIContentOptionsDto & Record<string, unknown>;
1240
1475
  /**
1241
1476
  * Unique sortable ID used to group and sort messages
@@ -1269,7 +1504,13 @@ type TextUIContentDto = {
1269
1504
  sessionId?: string;
1270
1505
  contentType: SupportedContentTypes;
1271
1506
  content: TextContentDto;
1507
+ /**
1508
+ * Provides metadata for the content
1509
+ */
1272
1510
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1511
+ /**
1512
+ * Provides configuration options for the content
1513
+ */
1273
1514
  options?: UIContentOptionsDto & Record<string, unknown>;
1274
1515
  /**
1275
1516
  * Unique sortable ID used to group and sort messages
@@ -1309,7 +1550,13 @@ type QuizUIContentDto = {
1309
1550
  sessionId?: string;
1310
1551
  contentType: SupportedContentTypes;
1311
1552
  content: QuizContentDto;
1553
+ /**
1554
+ * Provides metadata for the content
1555
+ */
1312
1556
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1557
+ /**
1558
+ * Provides configuration options for the content
1559
+ */
1313
1560
  options?: UIContentOptionsDto & Record<string, unknown>;
1314
1561
  /**
1315
1562
  * Unique sortable ID used to group and sort messages
@@ -1340,7 +1587,13 @@ type ClearUIContentDto = {
1340
1587
  sessionId?: string;
1341
1588
  contentType: SupportedContentTypes;
1342
1589
  content: Record<string, unknown>;
1590
+ /**
1591
+ * Provides metadata for the content
1592
+ */
1343
1593
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1594
+ /**
1595
+ * Provides configuration options for the content
1596
+ */
1344
1597
  options?: UIContentOptionsDto & Record<string, unknown>;
1345
1598
  /**
1346
1599
  * Unique sortable ID used to group and sort messages
@@ -1371,7 +1624,13 @@ type ClearScreenDto = {
1371
1624
  sessionId?: string;
1372
1625
  contentType: SupportedContentTypes;
1373
1626
  content: Record<string, unknown>;
1627
+ /**
1628
+ * Provides metadata for the content
1629
+ */
1374
1630
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1631
+ /**
1632
+ * Provides configuration options for the content
1633
+ */
1375
1634
  options?: UIContentOptionsDto & Record<string, unknown>;
1376
1635
  /**
1377
1636
  * Unique sortable ID used to group and sort messages
@@ -1413,7 +1672,13 @@ type ButtonsUIContentDto = {
1413
1672
  sessionId?: string;
1414
1673
  contentType: SupportedContentTypes;
1415
1674
  content: ButtonsContentDto;
1675
+ /**
1676
+ * Provides metadata for the content
1677
+ */
1416
1678
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1679
+ /**
1680
+ * Provides configuration options for the content
1681
+ */
1417
1682
  options?: UIContentOptionsDto & Record<string, unknown>;
1418
1683
  /**
1419
1684
  * Unique sortable ID used to group and sort messages
@@ -1444,7 +1709,13 @@ type DialogueMessageUIContentDto = {
1444
1709
  sessionId?: string;
1445
1710
  contentType: SupportedContentTypes;
1446
1711
  content: DialogueMessageDto;
1712
+ /**
1713
+ * Provides metadata for the content
1714
+ */
1447
1715
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1716
+ /**
1717
+ * Provides configuration options for the content
1718
+ */
1448
1719
  options?: UIContentOptionsDto & Record<string, unknown>;
1449
1720
  /**
1450
1721
  * Unique sortable ID used to group and sort messages
@@ -1479,7 +1750,13 @@ type LinkUIContentDto = {
1479
1750
  sessionId?: string;
1480
1751
  contentType: SupportedContentTypes;
1481
1752
  content: LinkContentDto;
1753
+ /**
1754
+ * Provides metadata for the content
1755
+ */
1482
1756
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1757
+ /**
1758
+ * Provides configuration options for the content
1759
+ */
1483
1760
  options?: UIContentOptionsDto & Record<string, unknown>;
1484
1761
  /**
1485
1762
  * Unique sortable ID used to group and sort messages
@@ -1513,7 +1790,13 @@ type HtmlUIContentDto = {
1513
1790
  sessionId?: string;
1514
1791
  contentType: SupportedContentTypes;
1515
1792
  content: HtmlContentDto;
1793
+ /**
1794
+ * Provides metadata for the content
1795
+ */
1516
1796
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1797
+ /**
1798
+ * Provides configuration options for the content
1799
+ */
1517
1800
  options?: UIContentOptionsDto & Record<string, unknown>;
1518
1801
  /**
1519
1802
  * Unique sortable ID used to group and sort messages
@@ -1548,7 +1831,13 @@ type EmailUIContentDto = {
1548
1831
  sessionId?: string;
1549
1832
  contentType: SupportedContentTypes;
1550
1833
  content: EmailContentDto;
1834
+ /**
1835
+ * Provides metadata for the content
1836
+ */
1551
1837
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1838
+ /**
1839
+ * Provides configuration options for the content
1840
+ */
1552
1841
  options?: UIContentOptionsDto & Record<string, unknown>;
1553
1842
  /**
1554
1843
  * Unique sortable ID used to group and sort messages
@@ -1589,7 +1878,13 @@ type UIContentDto = {
1589
1878
  sessionId?: string;
1590
1879
  contentType: SupportedContentTypes;
1591
1880
  content: Record<string, unknown>;
1881
+ /**
1882
+ * Provides metadata for the content
1883
+ */
1592
1884
  metadata?: UIContentMetadataDto & Record<string, unknown>;
1885
+ /**
1886
+ * Provides configuration options for the content
1887
+ */
1593
1888
  options?: UIContentOptionsDto & Record<string, unknown>;
1594
1889
  /**
1595
1890
  * Unique sortable ID used to group and sort messages
@@ -2054,6 +2349,12 @@ type TDataStopAgentSpeech = {
2054
2349
  appId: string;
2055
2350
  sessionId: string;
2056
2351
  };
2352
+ type TDataGetChatHistory = {
2353
+ sessionId: string;
2354
+ };
2355
+ type TDataNextStep = {
2356
+ requestBody: DialogueTaskRecordDto;
2357
+ };
2057
2358
  type TDataSetTools = {
2058
2359
  repositoryId: string;
2059
2360
  requestBody: DialogueToolsRepositoryDto;
@@ -2123,6 +2424,18 @@ declare class DialogueService {
2123
2424
  * @throws ApiError
2124
2425
  */
2125
2426
  listModels(): CancelablePromise<any>;
2427
+ /**
2428
+ * Get a session chat history
2429
+ * @returns DialogueMemoryMessageDto
2430
+ * @throws ApiError
2431
+ */
2432
+ getChatHistory(data: TDataGetChatHistory): CancelablePromise<Array<DialogueMemoryMessageDto>>;
2433
+ /**
2434
+ * Set the tools, overriding existing ones
2435
+ * @returns any
2436
+ * @throws ApiError
2437
+ */
2438
+ nextStep(data: TDataNextStep): CancelablePromise<any>;
2126
2439
  /**
2127
2440
  * Save tools, overwriting existing ones.
2128
2441
  * @returns any
@@ -2855,6 +3168,16 @@ interface anonymous_schema_104 {
2855
3168
  tokenUrl: string;
2856
3169
  refreshUrl?: string;
2857
3170
  }
3171
+ interface anonymous_schema_149 {
3172
+ triggerOnce?: boolean;
3173
+ enableTool?: boolean;
3174
+ toolOptions?: anonymous_schema_152;
3175
+ repositoryId?: string;
3176
+ }
3177
+ interface anonymous_schema_152 {
3178
+ triggerOnce?: boolean;
3179
+ exclusive?: boolean;
3180
+ }
2858
3181
  interface PlatformAppClientChangedDto {
2859
3182
  appId: string;
2860
3183
  clientId?: string;
@@ -2912,7 +3235,7 @@ interface StringInferenceValue {
2912
3235
  probability: number;
2913
3236
  value: string;
2914
3237
  }
2915
- type anonymous_schema_174 = 'start' | 'stop';
3238
+ type anonymous_schema_210 = 'start' | 'stop';
2916
3239
  interface UserCharacterizationEventDto {
2917
3240
  appId: string;
2918
3241
  clientId?: string;
@@ -2985,6 +3308,70 @@ interface SermasSessionDto {
2985
3308
  ts?: string;
2986
3309
  sessionId?: string;
2987
3310
  }
3311
+ interface DialogueTaskChangedDto {
3312
+ appId: string;
3313
+ clientId?: string;
3314
+ userId?: string;
3315
+ ts?: string;
3316
+ operation: string;
3317
+ sessionId?: string;
3318
+ record: DialogueTaskDto;
3319
+ }
3320
+ interface DialogueTaskProgressDto {
3321
+ type: TaskEventType;
3322
+ task: anonymous_schema_279;
3323
+ record: anonymous_schema_280;
3324
+ }
3325
+ interface anonymous_schema_279 {
3326
+ taskId: string;
3327
+ appId: string;
3328
+ sessionId?: string;
3329
+ name: string;
3330
+ description?: string;
3331
+ intents?: TaskIntentDto[];
3332
+ events?: TaskEventDto[];
3333
+ fields: TaskFieldDto[];
3334
+ options?: anonymous_schema_149;
3335
+ }
3336
+ interface anonymous_schema_280 {
3337
+ recordId: string;
3338
+ taskId: string;
3339
+ appId: string;
3340
+ sessionId: string;
3341
+ values: Record<string, any>;
3342
+ }
3343
+ interface DialogueTaskRecordChangedDto {
3344
+ appId: string;
3345
+ clientId?: string;
3346
+ userId?: string;
3347
+ ts?: string;
3348
+ operation: string;
3349
+ sessionId?: string;
3350
+ record: DialogueTaskRecordDto;
3351
+ }
3352
+ interface DialogueTaskRecordHandlerDto {
3353
+ appId: string;
3354
+ clientId?: string;
3355
+ userId?: string;
3356
+ ts?: string;
3357
+ sessionId?: string;
3358
+ taskId: string;
3359
+ recordId: string;
3360
+ field: anonymous_schema_299;
3361
+ }
3362
+ interface anonymous_schema_299 {
3363
+ name: string;
3364
+ label?: string;
3365
+ order?: number;
3366
+ type: TaskSchemaDataType;
3367
+ required?: boolean;
3368
+ validation?: string;
3369
+ condition?: string;
3370
+ prompt?: string;
3371
+ handler?: string;
3372
+ multiple?: boolean;
3373
+ options?: OptionSelection[];
3374
+ }
2988
3375
  interface DialogueToolTriggeredEventDto {
2989
3376
  appId: string;
2990
3377
  clientId?: string;
@@ -3010,10 +3397,10 @@ interface DialogueToolsRepositoryRecordDto {
3010
3397
  ts?: string;
3011
3398
  sessionId?: string;
3012
3399
  repositoryId?: string;
3013
- options?: anonymous_schema_255;
3014
- tools: AppToolsDTO[];
3400
+ options?: anonymous_schema_318;
3401
+ tools: any[][];
3015
3402
  }
3016
- interface anonymous_schema_255 {
3403
+ interface anonymous_schema_318 {
3017
3404
  triggerOnce?: boolean;
3018
3405
  exclusive?: boolean;
3019
3406
  }
@@ -3073,11 +3460,11 @@ interface UIAssetChangedDto {
3073
3460
  sessionId?: string;
3074
3461
  record: UIAssetDto;
3075
3462
  }
3076
- interface anonymous_schema_331 {
3463
+ interface anonymous_schema_393 {
3077
3464
  repositoryId?: string;
3078
3465
  additionalProperties?: Record<string, any>;
3079
3466
  }
3080
- interface anonymous_schema_334 {
3467
+ interface anonymous_schema_396 {
3081
3468
  clearScreen?: boolean;
3082
3469
  ttsEnabled?: boolean;
3083
3470
  stopSpeech?: boolean;
@@ -3261,6 +3648,36 @@ declare class Dialogue {
3261
3648
  appId?: string;
3262
3649
  sessionId?: string;
3263
3650
  }): Promise<() => void>;
3651
+ taskChanged(event: DialogueTaskChangedDto, params?: {
3652
+ appId?: string;
3653
+ taskId?: string;
3654
+ }): Promise<boolean>;
3655
+ onTaskChanged(fn: (event: DialogueTaskChangedDto) => void | Promise<void>, params?: {
3656
+ appId?: string;
3657
+ taskId?: string;
3658
+ }): Promise<() => void>;
3659
+ taskProgress(event: DialogueTaskProgressDto, params?: {
3660
+ appId?: string;
3661
+ taskId?: string;
3662
+ }): Promise<boolean>;
3663
+ onTaskProgress(fn: (event: DialogueTaskProgressDto) => void | Promise<void>, params?: {
3664
+ appId?: string;
3665
+ taskId?: string;
3666
+ }): Promise<() => void>;
3667
+ recordChanged(event: DialogueTaskRecordChangedDto, params?: {
3668
+ appId?: string;
3669
+ taskId?: string;
3670
+ }): Promise<boolean>;
3671
+ onRecordChanged(fn: (event: DialogueTaskRecordChangedDto) => void | Promise<void>, params?: {
3672
+ appId?: string;
3673
+ taskId?: string;
3674
+ }): Promise<() => void>;
3675
+ fieldHandler(event: DialogueTaskRecordHandlerDto, params?: {
3676
+ appId?: string;
3677
+ }): Promise<boolean>;
3678
+ onFieldHandler(fn: (event: DialogueTaskRecordHandlerDto) => void | Promise<void>, params?: {
3679
+ appId?: string;
3680
+ }): Promise<() => void>;
3264
3681
  toolTriggered(event: DialogueToolTriggeredEventDto, params?: {
3265
3682
  appId?: string;
3266
3683
  name?: string;
@@ -3506,4 +3923,4 @@ declare class SermasApiClient {
3506
3923
  login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
3507
3924
  }
3508
3925
 
3509
- export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentEvaluatePromptDto, type AgentEvaluatePromptFormat, AgentEvaluatePromptFormatEnum, type AgentEvaluatePromptOptionsDto, type AgentEvaluatePromptResponseDto, type AgentHeartBeatEventDto, type AgentStatus, AgentStatusEnum, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, type DialogueToolTriggeredEventDto, type DialogueToolsRepositoryChanged, type DialogueToolsRepositoryDto, type DialogueToolsRepositoryOptionsDto, type DialogueToolsRepositoryRecordDto, type DialogueUrlDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type InteractionStartTypes, InteractionStartTypesEnum, InteractionTypeEnum, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LLMProvider, LLMProviderEnum, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, Logger, type LoggerService, type LoginRequestDto, type LoginResponseDto, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAnimationDto, type RepositoryAssetMetadataDto, type RepositoryAssetTypes, RepositoryAssetTypesEnum, type RepositoryAvatarDto, type RepositoryBackgroundDto, type RepositoryBackgroundMetadataDto, type RepositoryConfigDto, type RepositoryDocumentDto, type RepositoryRobotModelDto, type RobotMapDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionProperties, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, TypeEnum, type UIAssetChangedDto, type UIAssetDto, type UIContentDto, type UIContentMetadataDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UiInteractionButtonDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_101, type anonymous_schema_104, type anonymous_schema_174, type anonymous_schema_255, type anonymous_schema_331, type anonymous_schema_334, type anonymous_schema_99, sleep };
3926
+ export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentEvaluatePromptDto, type AgentEvaluatePromptFormat, AgentEvaluatePromptFormatEnum, type AgentEvaluatePromptOptionsDto, type AgentEvaluatePromptResponseDto, type AgentHeartBeatEventDto, type AgentStatus, AgentStatusEnum, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTaskChangedDto, type DialogueTaskDto, type DialogueTaskProgressDto, type DialogueTaskRecordChangedDto, type DialogueTaskRecordDto, type DialogueTaskRecordHandlerDto, type DialogueTextToSpeechDto, type DialogueToolTriggeredEventDto, type DialogueToolsRepositoryChanged, type DialogueToolsRepositoryDto, type DialogueToolsRepositoryOptionsDto, type DialogueToolsRepositoryRecordDto, type DialogueUrlDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type InteractionStartTypes, InteractionStartTypesEnum, InteractionTypeEnum, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LLMProvider, LLMProviderEnum, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, Logger, type LoggerService, type LoginRequestDto, type LoginResponseDto, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, type OptionSelection, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAnimationDto, type RepositoryAssetMetadataDto, type RepositoryAssetTypes, RepositoryAssetTypesEnum, type RepositoryAvatarDto, type RepositoryBackgroundDto, type RepositoryBackgroundMetadataDto, type RepositoryConfigDto, type RepositoryDocumentDto, type RepositoryRobotModelDto, type RobotMapDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionProperties, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TaskEventDto, type TaskEventTriggerDto, type TaskEventType, TaskEventTypeEnum, type TaskFieldDto, type TaskIntentDto, type TaskOptionsDto, type TaskSchemaDataType, TaskSchemaDataTypeEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, TypeEnum, type UIAssetChangedDto, type UIAssetDto, type UIContentDto, type UIContentMetadataDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UiInteractionButtonDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_101, type anonymous_schema_104, type anonymous_schema_149, type anonymous_schema_152, type anonymous_schema_210, type anonymous_schema_279, type anonymous_schema_280, type anonymous_schema_299, type anonymous_schema_318, type anonymous_schema_393, type anonymous_schema_396, type anonymous_schema_99, sleep };