@botpress/api 0.20.3 → 0.21.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 +131 -60
  2. package/dist/src/gen/state.d.ts +75 -9
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +131 -60
package/dist/index.js CHANGED
@@ -279818,20 +279818,26 @@ var state = {
279818
279818
  "type": "object",
279819
279819
  "properties": {
279820
279820
  "id": {
279821
- "type": "string"
279821
+ "type": "string",
279822
+ "description": "File ID"
279822
279823
  },
279823
279824
  "botId": {
279824
- "type": "string"
279825
+ "type": "string",
279826
+ "description": "The ID of the bot the file belongs to"
279825
279827
  },
279826
279828
  "name": {
279827
- "type": "string"
279829
+ "type": "string",
279830
+ "description": "File name",
279831
+ "nullable": true
279828
279832
  },
279829
279833
  "size": {
279830
279834
  "type": "number",
279835
+ "description": "File size in bytes",
279831
279836
  "nullable": true
279832
279837
  },
279833
279838
  "contentType": {
279834
- "type": "string"
279839
+ "type": "string",
279840
+ "description": "MIME type of the file's content"
279835
279841
  },
279836
279842
  "tags": {
279837
279843
  "type": "object",
@@ -279839,19 +279845,22 @@ var state = {
279839
279845
  "type": "string",
279840
279846
  "maxLength": 1e3
279841
279847
  },
279842
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
279848
+ "description": "The tags of the file as an object of key/value pairs"
279843
279849
  },
279844
279850
  "createdAt": {
279845
- "type": "string"
279851
+ "type": "string",
279852
+ "description": "File creation timestamp in ISO 8601 format"
279846
279853
  },
279847
279854
  "updatedAt": {
279848
- "type": "string"
279855
+ "type": "string",
279856
+ "description": "File last update timestamp in ISO 8601 format"
279849
279857
  },
279850
279858
  "accessPolicies": {
279851
279859
  "type": "array",
279852
279860
  "items": {
279853
279861
  "type": "string"
279854
- }
279862
+ },
279863
+ "description": "Access policies configured for the file."
279855
279864
  },
279856
279865
  "indexingStatus": {
279857
279866
  "type": "string",
@@ -279860,10 +279869,12 @@ var state = {
279860
279869
  "IN_PROGRESS",
279861
279870
  "COMPLETE",
279862
279871
  "FAILED"
279863
- ]
279872
+ ],
279873
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
279864
279874
  },
279865
279875
  "indexingFailureReason": {
279866
- "type": "string"
279876
+ "type": "string",
279877
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279867
279878
  }
279868
279879
  },
279869
279880
  "required": [
@@ -279950,20 +279961,26 @@ var state = {
279950
279961
  "type": "object",
279951
279962
  "properties": {
279952
279963
  "id": {
279953
- "type": "string"
279964
+ "type": "string",
279965
+ "description": "File ID"
279954
279966
  },
279955
279967
  "botId": {
279956
- "type": "string"
279968
+ "type": "string",
279969
+ "description": "The ID of the bot the file belongs to"
279957
279970
  },
279958
279971
  "name": {
279959
- "type": "string"
279972
+ "type": "string",
279973
+ "description": "File name",
279974
+ "nullable": true
279960
279975
  },
279961
279976
  "size": {
279962
279977
  "type": "number",
279978
+ "description": "File size in bytes",
279963
279979
  "nullable": true
279964
279980
  },
279965
279981
  "contentType": {
279966
- "type": "string"
279982
+ "type": "string",
279983
+ "description": "MIME type of the file's content"
279967
279984
  },
279968
279985
  "tags": {
279969
279986
  "type": "object",
@@ -279971,19 +279988,22 @@ var state = {
279971
279988
  "type": "string",
279972
279989
  "maxLength": 1e3
279973
279990
  },
279974
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
279991
+ "description": "The tags of the file as an object of key/value pairs"
279975
279992
  },
279976
279993
  "createdAt": {
279977
- "type": "string"
279994
+ "type": "string",
279995
+ "description": "File creation timestamp in ISO 8601 format"
279978
279996
  },
279979
279997
  "updatedAt": {
279980
- "type": "string"
279998
+ "type": "string",
279999
+ "description": "File last update timestamp in ISO 8601 format"
279981
280000
  },
279982
280001
  "accessPolicies": {
279983
280002
  "type": "array",
279984
280003
  "items": {
279985
280004
  "type": "string"
279986
- }
280005
+ },
280006
+ "description": "Access policies configured for the file."
279987
280007
  },
279988
280008
  "indexingStatus": {
279989
280009
  "type": "string",
@@ -279992,10 +280012,12 @@ var state = {
279992
280012
  "IN_PROGRESS",
279993
280013
  "COMPLETE",
279994
280014
  "FAILED"
279995
- ]
280015
+ ],
280016
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
279996
280017
  },
279997
280018
  "indexingFailureReason": {
279998
- "type": "string"
280019
+ "type": "string",
280020
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279999
280021
  }
280000
280022
  },
280001
280023
  "required": [
@@ -280053,20 +280075,26 @@ var state = {
280053
280075
  "type": "object",
280054
280076
  "properties": {
280055
280077
  "id": {
280056
- "type": "string"
280078
+ "type": "string",
280079
+ "description": "File ID"
280057
280080
  },
280058
280081
  "botId": {
280059
- "type": "string"
280082
+ "type": "string",
280083
+ "description": "The ID of the bot the file belongs to"
280060
280084
  },
280061
280085
  "name": {
280062
- "type": "string"
280086
+ "type": "string",
280087
+ "description": "File name",
280088
+ "nullable": true
280063
280089
  },
280064
280090
  "size": {
280065
280091
  "type": "number",
280092
+ "description": "File size in bytes",
280066
280093
  "nullable": true
280067
280094
  },
280068
280095
  "contentType": {
280069
- "type": "string"
280096
+ "type": "string",
280097
+ "description": "MIME type of the file's content"
280070
280098
  },
280071
280099
  "tags": {
280072
280100
  "type": "object",
@@ -280074,19 +280102,22 @@ var state = {
280074
280102
  "type": "string",
280075
280103
  "maxLength": 1e3
280076
280104
  },
280077
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
280105
+ "description": "The tags of the file as an object of key/value pairs"
280078
280106
  },
280079
280107
  "createdAt": {
280080
- "type": "string"
280108
+ "type": "string",
280109
+ "description": "File creation timestamp in ISO 8601 format"
280081
280110
  },
280082
280111
  "updatedAt": {
280083
- "type": "string"
280112
+ "type": "string",
280113
+ "description": "File last update timestamp in ISO 8601 format"
280084
280114
  },
280085
280115
  "accessPolicies": {
280086
280116
  "type": "array",
280087
280117
  "items": {
280088
280118
  "type": "string"
280089
- }
280119
+ },
280120
+ "description": "Access policies configured for the file."
280090
280121
  },
280091
280122
  "indexingStatus": {
280092
280123
  "type": "string",
@@ -280095,10 +280126,12 @@ var state = {
280095
280126
  "IN_PROGRESS",
280096
280127
  "COMPLETE",
280097
280128
  "FAILED"
280098
- ]
280129
+ ],
280130
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
280099
280131
  },
280100
280132
  "indexingFailureReason": {
280101
- "type": "string"
280133
+ "type": "string",
280134
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
280102
280135
  }
280103
280136
  },
280104
280137
  "required": [
@@ -280178,7 +280211,7 @@ var state = {
280178
280211
  "type": "string",
280179
280212
  "maxLength": 1e3
280180
280213
  },
280181
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
280214
+ "description": "The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it."
280182
280215
  }
280183
280216
  },
280184
280217
  "required": [
@@ -280199,7 +280232,7 @@ var state = {
280199
280232
  "type": "string",
280200
280233
  "maxLength": 1e3
280201
280234
  },
280202
- "description": "The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it."
280235
+ "description": "The updated tags of the file."
280203
280236
  }
280204
280237
  },
280205
280238
  "required": [
@@ -280236,7 +280269,7 @@ var state = {
280236
280269
  "query": {
280237
280270
  "in": "query",
280238
280271
  "type": "string",
280239
- "description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
280272
+ "description": "Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.",
280240
280273
  "required": true
280241
280274
  },
280242
280275
  "contextDepth": {
@@ -280251,7 +280284,7 @@ var state = {
280251
280284
  }
280252
280285
  },
280253
280286
  "response": {
280254
- "description": "Returns the passages matching the query.",
280287
+ "description": "Returns the text passages within all indexed files that matched the query.",
280255
280288
  "schema": {
280256
280289
  "type": "object",
280257
280290
  "properties": {
@@ -280260,29 +280293,56 @@ var state = {
280260
280293
  "items": {
280261
280294
  "type": "object",
280262
280295
  "properties": {
280263
- "fileId": {
280264
- "type": "string"
280296
+ "content": {
280297
+ "type": "string",
280298
+ "description": "The content of the matching passage in the file including surrounding context, if any."
280265
280299
  },
280266
280300
  "score": {
280267
- "type": "number"
280268
- },
280269
- "content": {
280270
- "type": "string"
280301
+ "type": "number",
280302
+ "description": "The score indicating the similarity of the passage to the query. A higher score indicates higher similarity."
280271
280303
  },
280272
- "tags": {
280304
+ "file": {
280273
280305
  "type": "object",
280274
- "additionalProperties": {
280275
- "type": "string",
280276
- "maxLength": 1e3
280306
+ "properties": {
280307
+ "id": {
280308
+ "type": "string",
280309
+ "description": "File ID"
280310
+ },
280311
+ "name": {
280312
+ "type": "string",
280313
+ "description": "File name",
280314
+ "nullable": true
280315
+ },
280316
+ "tags": {
280317
+ "type": "object",
280318
+ "additionalProperties": {
280319
+ "type": "string",
280320
+ "maxLength": 1e3
280321
+ },
280322
+ "description": "The tags of the file as an object of key/value pairs."
280323
+ },
280324
+ "createdAt": {
280325
+ "type": "string",
280326
+ "description": "File creation timestamp in ISO 8601 format"
280327
+ },
280328
+ "updatedAt": {
280329
+ "type": "string",
280330
+ "description": "File last update timestamp in ISO 8601 format"
280331
+ }
280277
280332
  },
280278
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
280333
+ "required": [
280334
+ "id",
280335
+ "name",
280336
+ "tags",
280337
+ "createdAt",
280338
+ "updatedAt"
280339
+ ]
280279
280340
  }
280280
280341
  },
280281
280342
  "required": [
280282
- "fileId",
280283
- "score",
280284
280343
  "content",
280285
- "tags"
280344
+ "score",
280345
+ "file"
280286
280346
  ]
280287
280347
  }
280288
280348
  }
@@ -280526,7 +280586,7 @@ var state = {
280526
280586
  },
280527
280587
  "method": "post",
280528
280588
  "requestBody": {
280529
- "description": "Schema defining the structure of the new table",
280589
+ "description": "Parameters for the duplication operation.",
280530
280590
  "schema": {
280531
280591
  "type": "object",
280532
280592
  "properties": {
@@ -281136,7 +281196,7 @@ var state = {
281136
281196
  "title": "Botpress API",
281137
281197
  "description": "API for Botpress Cloud",
281138
281198
  "server": "https://api.botpress.cloud",
281139
- "version": "0.20.3",
281199
+ "version": "0.21.0",
281140
281200
  "prefix": "v1"
281141
281201
  },
281142
281202
  "errors": [
@@ -283447,20 +283507,26 @@ var state = {
283447
283507
  "type": "object",
283448
283508
  "properties": {
283449
283509
  "id": {
283450
- "type": "string"
283510
+ "type": "string",
283511
+ "description": "File ID"
283451
283512
  },
283452
283513
  "botId": {
283453
- "type": "string"
283514
+ "type": "string",
283515
+ "description": "The ID of the bot the file belongs to"
283454
283516
  },
283455
283517
  "name": {
283456
- "type": "string"
283518
+ "type": "string",
283519
+ "description": "File name",
283520
+ "nullable": true
283457
283521
  },
283458
283522
  "size": {
283459
283523
  "type": "number",
283524
+ "description": "File size in bytes",
283460
283525
  "nullable": true
283461
283526
  },
283462
283527
  "contentType": {
283463
- "type": "string"
283528
+ "type": "string",
283529
+ "description": "MIME type of the file's content"
283464
283530
  },
283465
283531
  "tags": {
283466
283532
  "type": "object",
@@ -283468,19 +283534,22 @@ var state = {
283468
283534
  "type": "string",
283469
283535
  "maxLength": 1e3
283470
283536
  },
283471
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
283537
+ "description": "The tags of the file as an object of key/value pairs"
283472
283538
  },
283473
283539
  "createdAt": {
283474
- "type": "string"
283540
+ "type": "string",
283541
+ "description": "File creation timestamp in ISO 8601 format"
283475
283542
  },
283476
283543
  "updatedAt": {
283477
- "type": "string"
283544
+ "type": "string",
283545
+ "description": "File last update timestamp in ISO 8601 format"
283478
283546
  },
283479
283547
  "accessPolicies": {
283480
283548
  "type": "array",
283481
283549
  "items": {
283482
283550
  "type": "string"
283483
- }
283551
+ },
283552
+ "description": "Access policies configured for the file."
283484
283553
  },
283485
283554
  "indexingStatus": {
283486
283555
  "type": "string",
@@ -283489,10 +283558,12 @@ var state = {
283489
283558
  "IN_PROGRESS",
283490
283559
  "COMPLETE",
283491
283560
  "FAILED"
283492
- ]
283561
+ ],
283562
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
283493
283563
  },
283494
283564
  "indexingFailureReason": {
283495
- "type": "string"
283565
+ "type": "string",
283566
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
283496
283567
  }
283497
283568
  },
283498
283569
  "required": [