@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/src/gen/state.ts CHANGED
@@ -3089,7 +3089,8 @@ export const state = {
3089
3089
  "id": {
3090
3090
  "type": "string",
3091
3091
  "minLength": 28,
3092
- "maxLength": 36
3092
+ "maxLength": 36,
3093
+ "description": "ID of the interface"
3093
3094
  },
3094
3095
  "name": {
3095
3096
  "type": "string",
@@ -3143,6 +3144,22 @@ export const state = {
3143
3144
  ],
3144
3145
  "additionalProperties": false
3145
3146
  }
3147
+ },
3148
+ "channels": {
3149
+ "type": "object",
3150
+ "additionalProperties": {
3151
+ "type": "object",
3152
+ "properties": {
3153
+ "name": {
3154
+ "type": "string",
3155
+ "maxLength": 200
3156
+ }
3157
+ },
3158
+ "required": [
3159
+ "name"
3160
+ ],
3161
+ "additionalProperties": false
3162
+ }
3146
3163
  }
3147
3164
  },
3148
3165
  "required": [
@@ -3150,7 +3167,8 @@ export const state = {
3150
3167
  "name",
3151
3168
  "entities",
3152
3169
  "actions",
3153
- "events"
3170
+ "events",
3171
+ "channels"
3154
3172
  ],
3155
3173
  "additionalProperties": false
3156
3174
  }
@@ -3747,7 +3765,8 @@ export const state = {
3747
3765
  "id": {
3748
3766
  "type": "string",
3749
3767
  "minLength": 28,
3750
- "maxLength": 36
3768
+ "maxLength": 36,
3769
+ "description": "ID of the interface"
3751
3770
  },
3752
3771
  "name": {
3753
3772
  "type": "string",
@@ -3801,6 +3820,22 @@ export const state = {
3801
3820
  ],
3802
3821
  "additionalProperties": false
3803
3822
  }
3823
+ },
3824
+ "channels": {
3825
+ "type": "object",
3826
+ "additionalProperties": {
3827
+ "type": "object",
3828
+ "properties": {
3829
+ "name": {
3830
+ "type": "string",
3831
+ "maxLength": 200
3832
+ }
3833
+ },
3834
+ "required": [
3835
+ "name"
3836
+ ],
3837
+ "additionalProperties": false
3838
+ }
3804
3839
  }
3805
3840
  },
3806
3841
  "required": [
@@ -3808,7 +3843,8 @@ export const state = {
3808
3843
  "name",
3809
3844
  "entities",
3810
3845
  "actions",
3811
- "events"
3846
+ "events",
3847
+ "channels"
3812
3848
  ],
3813
3849
  "additionalProperties": false
3814
3850
  }
@@ -5414,6 +5450,108 @@ export const state = {
5414
5450
  "additionalProperties": {
5415
5451
  "type": "number"
5416
5452
  }
5453
+ },
5454
+ "llm": {
5455
+ "type": "object",
5456
+ "properties": {
5457
+ "calls": {
5458
+ "type": "integer"
5459
+ },
5460
+ "errors": {
5461
+ "type": "integer"
5462
+ },
5463
+ "inputTokens": {
5464
+ "type": "integer"
5465
+ },
5466
+ "outputTokens": {
5467
+ "type": "integer"
5468
+ },
5469
+ "latency": {
5470
+ "type": "object",
5471
+ "properties": {
5472
+ "mean": {
5473
+ "type": "number"
5474
+ },
5475
+ "sd": {
5476
+ "type": "number"
5477
+ },
5478
+ "min": {
5479
+ "type": "number"
5480
+ },
5481
+ "max": {
5482
+ "type": "number"
5483
+ }
5484
+ },
5485
+ "required": [
5486
+ "mean",
5487
+ "sd",
5488
+ "min",
5489
+ "max"
5490
+ ],
5491
+ "description": "The time it took for the LLM to complete its response. Values are expressed in milliseconds"
5492
+ },
5493
+ "tokensPerSecond": {
5494
+ "type": "object",
5495
+ "properties": {
5496
+ "mean": {
5497
+ "type": "number"
5498
+ },
5499
+ "sd": {
5500
+ "type": "number"
5501
+ },
5502
+ "min": {
5503
+ "type": "number"
5504
+ },
5505
+ "max": {
5506
+ "type": "number"
5507
+ }
5508
+ },
5509
+ "required": [
5510
+ "mean",
5511
+ "sd",
5512
+ "min",
5513
+ "max"
5514
+ ],
5515
+ "description": "LLM response generation speed expressed in output tokens per second."
5516
+ },
5517
+ "cost": {
5518
+ "type": "object",
5519
+ "properties": {
5520
+ "sum": {
5521
+ "type": "number"
5522
+ },
5523
+ "mean": {
5524
+ "type": "number"
5525
+ },
5526
+ "sd": {
5527
+ "type": "number"
5528
+ },
5529
+ "min": {
5530
+ "type": "number"
5531
+ },
5532
+ "max": {
5533
+ "type": "number"
5534
+ }
5535
+ },
5536
+ "required": [
5537
+ "sum",
5538
+ "mean",
5539
+ "sd",
5540
+ "min",
5541
+ "max"
5542
+ ],
5543
+ "description": "Values are expressed in U.S. dollars"
5544
+ }
5545
+ },
5546
+ "required": [
5547
+ "calls",
5548
+ "errors",
5549
+ "inputTokens",
5550
+ "outputTokens",
5551
+ "latency",
5552
+ "tokensPerSecond",
5553
+ "cost"
5554
+ ]
5417
5555
  }
5418
5556
  },
5419
5557
  "required": [
@@ -5427,7 +5565,8 @@ export const state = {
5427
5565
  "botMessages",
5428
5566
  "events",
5429
5567
  "eventTypes",
5430
- "customEvents"
5568
+ "customEvents",
5569
+ "llm"
5431
5570
  ]
5432
5571
  }
5433
5572
  }
@@ -8389,7 +8528,8 @@ export const state = {
8389
8528
  "id": {
8390
8529
  "type": "string",
8391
8530
  "minLength": 28,
8392
- "maxLength": 36
8531
+ "maxLength": 36,
8532
+ "description": "ID of the interface"
8393
8533
  },
8394
8534
  "entities": {
8395
8535
  "type": "object",
@@ -8438,13 +8578,26 @@ export const state = {
8438
8578
  ],
8439
8579
  "additionalProperties": false
8440
8580
  }
8581
+ },
8582
+ "channels": {
8583
+ "type": "object",
8584
+ "additionalProperties": {
8585
+ "type": "object",
8586
+ "properties": {
8587
+ "name": {
8588
+ "type": "string",
8589
+ "maxLength": 200
8590
+ }
8591
+ },
8592
+ "required": [
8593
+ "name"
8594
+ ],
8595
+ "additionalProperties": false
8596
+ }
8441
8597
  }
8442
8598
  },
8443
8599
  "required": [
8444
- "id",
8445
- "entities",
8446
- "actions",
8447
- "events"
8600
+ "id"
8448
8601
  ],
8449
8602
  "additionalProperties": false
8450
8603
  }
@@ -8941,7 +9094,8 @@ export const state = {
8941
9094
  "id": {
8942
9095
  "type": "string",
8943
9096
  "minLength": 28,
8944
- "maxLength": 36
9097
+ "maxLength": 36,
9098
+ "description": "ID of the interface"
8945
9099
  },
8946
9100
  "entities": {
8947
9101
  "type": "object",
@@ -8990,13 +9144,26 @@ export const state = {
8990
9144
  ],
8991
9145
  "additionalProperties": false
8992
9146
  }
9147
+ },
9148
+ "channels": {
9149
+ "type": "object",
9150
+ "additionalProperties": {
9151
+ "type": "object",
9152
+ "properties": {
9153
+ "name": {
9154
+ "type": "string",
9155
+ "maxLength": 200
9156
+ }
9157
+ },
9158
+ "required": [
9159
+ "name"
9160
+ ],
9161
+ "additionalProperties": false
9162
+ }
8993
9163
  }
8994
9164
  },
8995
9165
  "required": [
8996
- "id",
8997
- "entities",
8998
- "actions",
8999
- "events"
9166
+ "id"
9000
9167
  ],
9001
9168
  "nullable": true,
9002
9169
  "additionalProperties": false
@@ -9403,6 +9570,33 @@ export const state = {
9403
9570
  "maxLength": 200,
9404
9571
  "description": "Version of the [Interface](#schema_interface)"
9405
9572
  },
9573
+ "entities": {
9574
+ "type": "object",
9575
+ "additionalProperties": {
9576
+ "type": "object",
9577
+ "properties": {
9578
+ "title": {
9579
+ "type": "string",
9580
+ "maxLength": 64,
9581
+ "description": "Title of the entity"
9582
+ },
9583
+ "description": {
9584
+ "type": "string",
9585
+ "maxLength": 256,
9586
+ "description": "Description of the entity"
9587
+ },
9588
+ "schema": {
9589
+ "type": "object",
9590
+ "additionalProperties": true
9591
+ }
9592
+ },
9593
+ "required": [
9594
+ "schema"
9595
+ ],
9596
+ "description": "Entity definition",
9597
+ "additionalProperties": false
9598
+ }
9599
+ },
9406
9600
  "events": {
9407
9601
  "type": "object",
9408
9602
  "additionalProperties": {
@@ -9486,7 +9680,7 @@ export const state = {
9486
9680
  "additionalProperties": false
9487
9681
  }
9488
9682
  },
9489
- "entities": {
9683
+ "channels": {
9490
9684
  "type": "object",
9491
9685
  "additionalProperties": {
9492
9686
  "type": "object",
@@ -9494,22 +9688,34 @@ export const state = {
9494
9688
  "title": {
9495
9689
  "type": "string",
9496
9690
  "maxLength": 64,
9497
- "description": "Title of the entity"
9691
+ "description": "Title of the channel"
9498
9692
  },
9499
9693
  "description": {
9500
9694
  "type": "string",
9501
9695
  "maxLength": 256,
9502
- "description": "Description of the entity"
9696
+ "description": "Description of the channel"
9503
9697
  },
9504
- "schema": {
9698
+ "messages": {
9505
9699
  "type": "object",
9506
- "additionalProperties": true
9700
+ "additionalProperties": {
9701
+ "type": "object",
9702
+ "properties": {
9703
+ "schema": {
9704
+ "type": "object",
9705
+ "additionalProperties": true
9706
+ }
9707
+ },
9708
+ "required": [
9709
+ "schema"
9710
+ ],
9711
+ "description": "Message definition",
9712
+ "additionalProperties": false
9713
+ }
9507
9714
  }
9508
9715
  },
9509
9716
  "required": [
9510
- "schema"
9717
+ "messages"
9511
9718
  ],
9512
- "description": "Entity definition",
9513
9719
  "additionalProperties": false
9514
9720
  }
9515
9721
  },
@@ -9535,10 +9741,7 @@ export const state = {
9535
9741
  },
9536
9742
  "required": [
9537
9743
  "name",
9538
- "version",
9539
- "events",
9540
- "actions",
9541
- "entities"
9744
+ "version"
9542
9745
  ],
9543
9746
  "title": "createInterfaceBody",
9544
9747
  "additionalProperties": false
@@ -9644,6 +9847,34 @@ export const state = {
9644
9847
  "schema": {
9645
9848
  "type": "object",
9646
9849
  "properties": {
9850
+ "entities": {
9851
+ "type": "object",
9852
+ "additionalProperties": {
9853
+ "type": "object",
9854
+ "properties": {
9855
+ "title": {
9856
+ "type": "string",
9857
+ "maxLength": 64,
9858
+ "description": "Title of the entity"
9859
+ },
9860
+ "description": {
9861
+ "type": "string",
9862
+ "maxLength": 256,
9863
+ "description": "Description of the entity"
9864
+ },
9865
+ "schema": {
9866
+ "type": "object",
9867
+ "additionalProperties": true
9868
+ }
9869
+ },
9870
+ "required": [
9871
+ "schema"
9872
+ ],
9873
+ "description": "Entity definition",
9874
+ "nullable": true,
9875
+ "additionalProperties": false
9876
+ }
9877
+ },
9647
9878
  "events": {
9648
9879
  "type": "object",
9649
9880
  "additionalProperties": {
@@ -9729,7 +9960,7 @@ export const state = {
9729
9960
  "additionalProperties": false
9730
9961
  }
9731
9962
  },
9732
- "entities": {
9963
+ "channels": {
9733
9964
  "type": "object",
9734
9965
  "additionalProperties": {
9735
9966
  "type": "object",
@@ -9737,22 +9968,32 @@ export const state = {
9737
9968
  "title": {
9738
9969
  "type": "string",
9739
9970
  "maxLength": 64,
9740
- "description": "Title of the entity"
9971
+ "description": "Title of the channel"
9741
9972
  },
9742
9973
  "description": {
9743
9974
  "type": "string",
9744
9975
  "maxLength": 256,
9745
- "description": "Description of the entity"
9976
+ "description": "Description of the channel"
9746
9977
  },
9747
- "schema": {
9978
+ "messages": {
9748
9979
  "type": "object",
9749
- "additionalProperties": true
9980
+ "additionalProperties": {
9981
+ "type": "object",
9982
+ "properties": {
9983
+ "schema": {
9984
+ "type": "object",
9985
+ "additionalProperties": true
9986
+ }
9987
+ },
9988
+ "required": [
9989
+ "schema"
9990
+ ],
9991
+ "description": "Message definition",
9992
+ "nullable": true,
9993
+ "additionalProperties": false
9994
+ }
9750
9995
  }
9751
9996
  },
9752
- "required": [
9753
- "schema"
9754
- ],
9755
- "description": "Entity definition",
9756
9997
  "nullable": true,
9757
9998
  "additionalProperties": false
9758
9999
  }
@@ -12091,7 +12332,7 @@ export const state = {
12091
12332
  "title": "Botpress API",
12092
12333
  "description": "API for Botpress Cloud",
12093
12334
  "server": "https://api.botpress.cloud",
12094
- "version": "0.44.0",
12335
+ "version": "0.45.0",
12095
12336
  "prefix": "v1"
12096
12337
  },
12097
12338
  "errors": [
@@ -13030,7 +13271,8 @@ export const state = {
13030
13271
  "id": {
13031
13272
  "type": "string",
13032
13273
  "minLength": 28,
13033
- "maxLength": 36
13274
+ "maxLength": 36,
13275
+ "description": "ID of the interface"
13034
13276
  },
13035
13277
  "name": {
13036
13278
  "type": "string",
@@ -13084,6 +13326,22 @@ export const state = {
13084
13326
  ],
13085
13327
  "additionalProperties": false
13086
13328
  }
13329
+ },
13330
+ "channels": {
13331
+ "type": "object",
13332
+ "additionalProperties": {
13333
+ "type": "object",
13334
+ "properties": {
13335
+ "name": {
13336
+ "type": "string",
13337
+ "maxLength": 200
13338
+ }
13339
+ },
13340
+ "required": [
13341
+ "name"
13342
+ ],
13343
+ "additionalProperties": false
13344
+ }
13087
13345
  }
13088
13346
  },
13089
13347
  "required": [
@@ -13091,7 +13349,8 @@ export const state = {
13091
13349
  "name",
13092
13350
  "entities",
13093
13351
  "actions",
13094
- "events"
13352
+ "events",
13353
+ "channels"
13095
13354
  ],
13096
13355
  "additionalProperties": false
13097
13356
  }
@@ -13604,6 +13863,33 @@ export const state = {
13604
13863
  "maxLength": 200,
13605
13864
  "description": "Version of the [Interface](#schema_interface)"
13606
13865
  },
13866
+ "entities": {
13867
+ "type": "object",
13868
+ "additionalProperties": {
13869
+ "type": "object",
13870
+ "properties": {
13871
+ "title": {
13872
+ "type": "string",
13873
+ "maxLength": 64,
13874
+ "description": "Title of the entity"
13875
+ },
13876
+ "description": {
13877
+ "type": "string",
13878
+ "maxLength": 256,
13879
+ "description": "Description of the entity"
13880
+ },
13881
+ "schema": {
13882
+ "type": "object",
13883
+ "additionalProperties": true
13884
+ }
13885
+ },
13886
+ "required": [
13887
+ "schema"
13888
+ ],
13889
+ "description": "Entity definition",
13890
+ "additionalProperties": false
13891
+ }
13892
+ },
13607
13893
  "events": {
13608
13894
  "type": "object",
13609
13895
  "additionalProperties": {
@@ -13687,7 +13973,7 @@ export const state = {
13687
13973
  "additionalProperties": false
13688
13974
  }
13689
13975
  },
13690
- "entities": {
13976
+ "channels": {
13691
13977
  "type": "object",
13692
13978
  "additionalProperties": {
13693
13979
  "type": "object",
@@ -13695,22 +13981,34 @@ export const state = {
13695
13981
  "title": {
13696
13982
  "type": "string",
13697
13983
  "maxLength": 64,
13698
- "description": "Title of the entity"
13984
+ "description": "Title of the channel"
13699
13985
  },
13700
13986
  "description": {
13701
13987
  "type": "string",
13702
13988
  "maxLength": 256,
13703
- "description": "Description of the entity"
13989
+ "description": "Description of the channel"
13704
13990
  },
13705
- "schema": {
13991
+ "messages": {
13706
13992
  "type": "object",
13707
- "additionalProperties": true
13993
+ "additionalProperties": {
13994
+ "type": "object",
13995
+ "properties": {
13996
+ "schema": {
13997
+ "type": "object",
13998
+ "additionalProperties": true
13999
+ }
14000
+ },
14001
+ "required": [
14002
+ "schema"
14003
+ ],
14004
+ "description": "Message definition",
14005
+ "additionalProperties": false
14006
+ }
13708
14007
  }
13709
14008
  },
13710
14009
  "required": [
13711
- "schema"
14010
+ "messages"
13712
14011
  ],
13713
- "description": "Entity definition",
13714
14012
  "additionalProperties": false
13715
14013
  }
13716
14014
  },
@@ -13740,9 +14038,10 @@ export const state = {
13740
14038
  "updatedAt",
13741
14039
  "name",
13742
14040
  "version",
14041
+ "entities",
13743
14042
  "events",
13744
14043
  "actions",
13745
- "entities"
14044
+ "channels"
13746
14045
  ],
13747
14046
  "additionalProperties": false
13748
14047
  }