@botpress/api 0.44.0 → 0.45.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 (5) hide show
  1. package/dist/index.js +345 -46
  2. package/dist/src/gen/state.d.ts +272 -13
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +345 -46
package/dist/index.js CHANGED
@@ -285720,7 +285720,8 @@ var state = {
285720
285720
  "id": {
285721
285721
  "type": "string",
285722
285722
  "minLength": 28,
285723
- "maxLength": 36
285723
+ "maxLength": 36,
285724
+ "description": "ID of the interface"
285724
285725
  },
285725
285726
  "name": {
285726
285727
  "type": "string",
@@ -285774,6 +285775,22 @@ var state = {
285774
285775
  ],
285775
285776
  "additionalProperties": false
285776
285777
  }
285778
+ },
285779
+ "channels": {
285780
+ "type": "object",
285781
+ "additionalProperties": {
285782
+ "type": "object",
285783
+ "properties": {
285784
+ "name": {
285785
+ "type": "string",
285786
+ "maxLength": 200
285787
+ }
285788
+ },
285789
+ "required": [
285790
+ "name"
285791
+ ],
285792
+ "additionalProperties": false
285793
+ }
285777
285794
  }
285778
285795
  },
285779
285796
  "required": [
@@ -285781,7 +285798,8 @@ var state = {
285781
285798
  "name",
285782
285799
  "entities",
285783
285800
  "actions",
285784
- "events"
285801
+ "events",
285802
+ "channels"
285785
285803
  ],
285786
285804
  "additionalProperties": false
285787
285805
  }
@@ -286378,7 +286396,8 @@ var state = {
286378
286396
  "id": {
286379
286397
  "type": "string",
286380
286398
  "minLength": 28,
286381
- "maxLength": 36
286399
+ "maxLength": 36,
286400
+ "description": "ID of the interface"
286382
286401
  },
286383
286402
  "name": {
286384
286403
  "type": "string",
@@ -286432,6 +286451,22 @@ var state = {
286432
286451
  ],
286433
286452
  "additionalProperties": false
286434
286453
  }
286454
+ },
286455
+ "channels": {
286456
+ "type": "object",
286457
+ "additionalProperties": {
286458
+ "type": "object",
286459
+ "properties": {
286460
+ "name": {
286461
+ "type": "string",
286462
+ "maxLength": 200
286463
+ }
286464
+ },
286465
+ "required": [
286466
+ "name"
286467
+ ],
286468
+ "additionalProperties": false
286469
+ }
286435
286470
  }
286436
286471
  },
286437
286472
  "required": [
@@ -286439,7 +286474,8 @@ var state = {
286439
286474
  "name",
286440
286475
  "entities",
286441
286476
  "actions",
286442
- "events"
286477
+ "events",
286478
+ "channels"
286443
286479
  ],
286444
286480
  "additionalProperties": false
286445
286481
  }
@@ -288045,6 +288081,108 @@ var state = {
288045
288081
  "additionalProperties": {
288046
288082
  "type": "number"
288047
288083
  }
288084
+ },
288085
+ "llm": {
288086
+ "type": "object",
288087
+ "properties": {
288088
+ "calls": {
288089
+ "type": "integer"
288090
+ },
288091
+ "errors": {
288092
+ "type": "integer"
288093
+ },
288094
+ "inputTokens": {
288095
+ "type": "integer"
288096
+ },
288097
+ "outputTokens": {
288098
+ "type": "integer"
288099
+ },
288100
+ "latency": {
288101
+ "type": "object",
288102
+ "properties": {
288103
+ "mean": {
288104
+ "type": "number"
288105
+ },
288106
+ "sd": {
288107
+ "type": "number"
288108
+ },
288109
+ "min": {
288110
+ "type": "number"
288111
+ },
288112
+ "max": {
288113
+ "type": "number"
288114
+ }
288115
+ },
288116
+ "required": [
288117
+ "mean",
288118
+ "sd",
288119
+ "min",
288120
+ "max"
288121
+ ],
288122
+ "description": "The time it took for the LLM to complete its response. Values are expressed in milliseconds"
288123
+ },
288124
+ "tokensPerSecond": {
288125
+ "type": "object",
288126
+ "properties": {
288127
+ "mean": {
288128
+ "type": "number"
288129
+ },
288130
+ "sd": {
288131
+ "type": "number"
288132
+ },
288133
+ "min": {
288134
+ "type": "number"
288135
+ },
288136
+ "max": {
288137
+ "type": "number"
288138
+ }
288139
+ },
288140
+ "required": [
288141
+ "mean",
288142
+ "sd",
288143
+ "min",
288144
+ "max"
288145
+ ],
288146
+ "description": "LLM response generation speed expressed in output tokens per second."
288147
+ },
288148
+ "cost": {
288149
+ "type": "object",
288150
+ "properties": {
288151
+ "sum": {
288152
+ "type": "number"
288153
+ },
288154
+ "mean": {
288155
+ "type": "number"
288156
+ },
288157
+ "sd": {
288158
+ "type": "number"
288159
+ },
288160
+ "min": {
288161
+ "type": "number"
288162
+ },
288163
+ "max": {
288164
+ "type": "number"
288165
+ }
288166
+ },
288167
+ "required": [
288168
+ "sum",
288169
+ "mean",
288170
+ "sd",
288171
+ "min",
288172
+ "max"
288173
+ ],
288174
+ "description": "Values are expressed in U.S. dollars"
288175
+ }
288176
+ },
288177
+ "required": [
288178
+ "calls",
288179
+ "errors",
288180
+ "inputTokens",
288181
+ "outputTokens",
288182
+ "latency",
288183
+ "tokensPerSecond",
288184
+ "cost"
288185
+ ]
288048
288186
  }
288049
288187
  },
288050
288188
  "required": [
@@ -288058,7 +288196,8 @@ var state = {
288058
288196
  "botMessages",
288059
288197
  "events",
288060
288198
  "eventTypes",
288061
- "customEvents"
288199
+ "customEvents",
288200
+ "llm"
288062
288201
  ]
288063
288202
  }
288064
288203
  }
@@ -291020,7 +291159,8 @@ var state = {
291020
291159
  "id": {
291021
291160
  "type": "string",
291022
291161
  "minLength": 28,
291023
- "maxLength": 36
291162
+ "maxLength": 36,
291163
+ "description": "ID of the interface"
291024
291164
  },
291025
291165
  "entities": {
291026
291166
  "type": "object",
@@ -291069,13 +291209,26 @@ var state = {
291069
291209
  ],
291070
291210
  "additionalProperties": false
291071
291211
  }
291212
+ },
291213
+ "channels": {
291214
+ "type": "object",
291215
+ "additionalProperties": {
291216
+ "type": "object",
291217
+ "properties": {
291218
+ "name": {
291219
+ "type": "string",
291220
+ "maxLength": 200
291221
+ }
291222
+ },
291223
+ "required": [
291224
+ "name"
291225
+ ],
291226
+ "additionalProperties": false
291227
+ }
291072
291228
  }
291073
291229
  },
291074
291230
  "required": [
291075
- "id",
291076
- "entities",
291077
- "actions",
291078
- "events"
291231
+ "id"
291079
291232
  ],
291080
291233
  "additionalProperties": false
291081
291234
  }
@@ -291572,7 +291725,8 @@ var state = {
291572
291725
  "id": {
291573
291726
  "type": "string",
291574
291727
  "minLength": 28,
291575
- "maxLength": 36
291728
+ "maxLength": 36,
291729
+ "description": "ID of the interface"
291576
291730
  },
291577
291731
  "entities": {
291578
291732
  "type": "object",
@@ -291621,13 +291775,26 @@ var state = {
291621
291775
  ],
291622
291776
  "additionalProperties": false
291623
291777
  }
291778
+ },
291779
+ "channels": {
291780
+ "type": "object",
291781
+ "additionalProperties": {
291782
+ "type": "object",
291783
+ "properties": {
291784
+ "name": {
291785
+ "type": "string",
291786
+ "maxLength": 200
291787
+ }
291788
+ },
291789
+ "required": [
291790
+ "name"
291791
+ ],
291792
+ "additionalProperties": false
291793
+ }
291624
291794
  }
291625
291795
  },
291626
291796
  "required": [
291627
- "id",
291628
- "entities",
291629
- "actions",
291630
- "events"
291797
+ "id"
291631
291798
  ],
291632
291799
  "nullable": true,
291633
291800
  "additionalProperties": false
@@ -292034,6 +292201,33 @@ var state = {
292034
292201
  "maxLength": 200,
292035
292202
  "description": "Version of the [Interface](#schema_interface)"
292036
292203
  },
292204
+ "entities": {
292205
+ "type": "object",
292206
+ "additionalProperties": {
292207
+ "type": "object",
292208
+ "properties": {
292209
+ "title": {
292210
+ "type": "string",
292211
+ "maxLength": 64,
292212
+ "description": "Title of the entity"
292213
+ },
292214
+ "description": {
292215
+ "type": "string",
292216
+ "maxLength": 256,
292217
+ "description": "Description of the entity"
292218
+ },
292219
+ "schema": {
292220
+ "type": "object",
292221
+ "additionalProperties": true
292222
+ }
292223
+ },
292224
+ "required": [
292225
+ "schema"
292226
+ ],
292227
+ "description": "Entity definition",
292228
+ "additionalProperties": false
292229
+ }
292230
+ },
292037
292231
  "events": {
292038
292232
  "type": "object",
292039
292233
  "additionalProperties": {
@@ -292117,7 +292311,7 @@ var state = {
292117
292311
  "additionalProperties": false
292118
292312
  }
292119
292313
  },
292120
- "entities": {
292314
+ "channels": {
292121
292315
  "type": "object",
292122
292316
  "additionalProperties": {
292123
292317
  "type": "object",
@@ -292125,22 +292319,34 @@ var state = {
292125
292319
  "title": {
292126
292320
  "type": "string",
292127
292321
  "maxLength": 64,
292128
- "description": "Title of the entity"
292322
+ "description": "Title of the channel"
292129
292323
  },
292130
292324
  "description": {
292131
292325
  "type": "string",
292132
292326
  "maxLength": 256,
292133
- "description": "Description of the entity"
292327
+ "description": "Description of the channel"
292134
292328
  },
292135
- "schema": {
292329
+ "messages": {
292136
292330
  "type": "object",
292137
- "additionalProperties": true
292331
+ "additionalProperties": {
292332
+ "type": "object",
292333
+ "properties": {
292334
+ "schema": {
292335
+ "type": "object",
292336
+ "additionalProperties": true
292337
+ }
292338
+ },
292339
+ "required": [
292340
+ "schema"
292341
+ ],
292342
+ "description": "Message definition",
292343
+ "additionalProperties": false
292344
+ }
292138
292345
  }
292139
292346
  },
292140
292347
  "required": [
292141
- "schema"
292348
+ "messages"
292142
292349
  ],
292143
- "description": "Entity definition",
292144
292350
  "additionalProperties": false
292145
292351
  }
292146
292352
  },
@@ -292166,10 +292372,7 @@ var state = {
292166
292372
  },
292167
292373
  "required": [
292168
292374
  "name",
292169
- "version",
292170
- "events",
292171
- "actions",
292172
- "entities"
292375
+ "version"
292173
292376
  ],
292174
292377
  "title": "createInterfaceBody",
292175
292378
  "additionalProperties": false
@@ -292275,6 +292478,34 @@ var state = {
292275
292478
  "schema": {
292276
292479
  "type": "object",
292277
292480
  "properties": {
292481
+ "entities": {
292482
+ "type": "object",
292483
+ "additionalProperties": {
292484
+ "type": "object",
292485
+ "properties": {
292486
+ "title": {
292487
+ "type": "string",
292488
+ "maxLength": 64,
292489
+ "description": "Title of the entity"
292490
+ },
292491
+ "description": {
292492
+ "type": "string",
292493
+ "maxLength": 256,
292494
+ "description": "Description of the entity"
292495
+ },
292496
+ "schema": {
292497
+ "type": "object",
292498
+ "additionalProperties": true
292499
+ }
292500
+ },
292501
+ "required": [
292502
+ "schema"
292503
+ ],
292504
+ "description": "Entity definition",
292505
+ "nullable": true,
292506
+ "additionalProperties": false
292507
+ }
292508
+ },
292278
292509
  "events": {
292279
292510
  "type": "object",
292280
292511
  "additionalProperties": {
@@ -292360,7 +292591,7 @@ var state = {
292360
292591
  "additionalProperties": false
292361
292592
  }
292362
292593
  },
292363
- "entities": {
292594
+ "channels": {
292364
292595
  "type": "object",
292365
292596
  "additionalProperties": {
292366
292597
  "type": "object",
@@ -292368,22 +292599,32 @@ var state = {
292368
292599
  "title": {
292369
292600
  "type": "string",
292370
292601
  "maxLength": 64,
292371
- "description": "Title of the entity"
292602
+ "description": "Title of the channel"
292372
292603
  },
292373
292604
  "description": {
292374
292605
  "type": "string",
292375
292606
  "maxLength": 256,
292376
- "description": "Description of the entity"
292607
+ "description": "Description of the channel"
292377
292608
  },
292378
- "schema": {
292609
+ "messages": {
292379
292610
  "type": "object",
292380
- "additionalProperties": true
292611
+ "additionalProperties": {
292612
+ "type": "object",
292613
+ "properties": {
292614
+ "schema": {
292615
+ "type": "object",
292616
+ "additionalProperties": true
292617
+ }
292618
+ },
292619
+ "required": [
292620
+ "schema"
292621
+ ],
292622
+ "description": "Message definition",
292623
+ "nullable": true,
292624
+ "additionalProperties": false
292625
+ }
292381
292626
  }
292382
292627
  },
292383
- "required": [
292384
- "schema"
292385
- ],
292386
- "description": "Entity definition",
292387
292628
  "nullable": true,
292388
292629
  "additionalProperties": false
292389
292630
  }
@@ -294722,7 +294963,7 @@ var state = {
294722
294963
  "title": "Botpress API",
294723
294964
  "description": "API for Botpress Cloud",
294724
294965
  "server": "https://api.botpress.cloud",
294725
- "version": "0.44.0",
294966
+ "version": "0.45.0",
294726
294967
  "prefix": "v1"
294727
294968
  },
294728
294969
  "errors": [
@@ -295661,7 +295902,8 @@ var state = {
295661
295902
  "id": {
295662
295903
  "type": "string",
295663
295904
  "minLength": 28,
295664
- "maxLength": 36
295905
+ "maxLength": 36,
295906
+ "description": "ID of the interface"
295665
295907
  },
295666
295908
  "name": {
295667
295909
  "type": "string",
@@ -295715,6 +295957,22 @@ var state = {
295715
295957
  ],
295716
295958
  "additionalProperties": false
295717
295959
  }
295960
+ },
295961
+ "channels": {
295962
+ "type": "object",
295963
+ "additionalProperties": {
295964
+ "type": "object",
295965
+ "properties": {
295966
+ "name": {
295967
+ "type": "string",
295968
+ "maxLength": 200
295969
+ }
295970
+ },
295971
+ "required": [
295972
+ "name"
295973
+ ],
295974
+ "additionalProperties": false
295975
+ }
295718
295976
  }
295719
295977
  },
295720
295978
  "required": [
@@ -295722,7 +295980,8 @@ var state = {
295722
295980
  "name",
295723
295981
  "entities",
295724
295982
  "actions",
295725
- "events"
295983
+ "events",
295984
+ "channels"
295726
295985
  ],
295727
295986
  "additionalProperties": false
295728
295987
  }
@@ -296235,6 +296494,33 @@ var state = {
296235
296494
  "maxLength": 200,
296236
296495
  "description": "Version of the [Interface](#schema_interface)"
296237
296496
  },
296497
+ "entities": {
296498
+ "type": "object",
296499
+ "additionalProperties": {
296500
+ "type": "object",
296501
+ "properties": {
296502
+ "title": {
296503
+ "type": "string",
296504
+ "maxLength": 64,
296505
+ "description": "Title of the entity"
296506
+ },
296507
+ "description": {
296508
+ "type": "string",
296509
+ "maxLength": 256,
296510
+ "description": "Description of the entity"
296511
+ },
296512
+ "schema": {
296513
+ "type": "object",
296514
+ "additionalProperties": true
296515
+ }
296516
+ },
296517
+ "required": [
296518
+ "schema"
296519
+ ],
296520
+ "description": "Entity definition",
296521
+ "additionalProperties": false
296522
+ }
296523
+ },
296238
296524
  "events": {
296239
296525
  "type": "object",
296240
296526
  "additionalProperties": {
@@ -296318,7 +296604,7 @@ var state = {
296318
296604
  "additionalProperties": false
296319
296605
  }
296320
296606
  },
296321
- "entities": {
296607
+ "channels": {
296322
296608
  "type": "object",
296323
296609
  "additionalProperties": {
296324
296610
  "type": "object",
@@ -296326,22 +296612,34 @@ var state = {
296326
296612
  "title": {
296327
296613
  "type": "string",
296328
296614
  "maxLength": 64,
296329
- "description": "Title of the entity"
296615
+ "description": "Title of the channel"
296330
296616
  },
296331
296617
  "description": {
296332
296618
  "type": "string",
296333
296619
  "maxLength": 256,
296334
- "description": "Description of the entity"
296620
+ "description": "Description of the channel"
296335
296621
  },
296336
- "schema": {
296622
+ "messages": {
296337
296623
  "type": "object",
296338
- "additionalProperties": true
296624
+ "additionalProperties": {
296625
+ "type": "object",
296626
+ "properties": {
296627
+ "schema": {
296628
+ "type": "object",
296629
+ "additionalProperties": true
296630
+ }
296631
+ },
296632
+ "required": [
296633
+ "schema"
296634
+ ],
296635
+ "description": "Message definition",
296636
+ "additionalProperties": false
296637
+ }
296339
296638
  }
296340
296639
  },
296341
296640
  "required": [
296342
- "schema"
296641
+ "messages"
296343
296642
  ],
296344
- "description": "Entity definition",
296345
296643
  "additionalProperties": false
296346
296644
  }
296347
296645
  },
@@ -296371,9 +296669,10 @@ var state = {
296371
296669
  "updatedAt",
296372
296670
  "name",
296373
296671
  "version",
296672
+ "entities",
296374
296673
  "events",
296375
296674
  "actions",
296376
- "entities"
296675
+ "channels"
296377
296676
  ],
296378
296677
  "additionalProperties": false
296379
296678
  }