@botpress/api 0.20.3 → 0.22.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.
package/dist/index.js CHANGED
@@ -279778,8 +279778,7 @@ var state = {
279778
279778
  "x-name": {
279779
279779
  "type": "string",
279780
279780
  "description": "File name",
279781
- "in": "header",
279782
- "required": true
279781
+ "in": "header"
279783
279782
  },
279784
279783
  "x-tags": {
279785
279784
  "type": "string",
@@ -279793,7 +279792,7 @@ var state = {
279793
279792
  },
279794
279793
  "x-index": {
279795
279794
  "type": "boolean",
279796
- "description": 'Set to a value of "true" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.',
279795
+ "description": 'Set to a value of "true" to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.',
279797
279796
  "in": "header"
279798
279797
  },
279799
279798
  "Content-Type": {
@@ -279818,20 +279817,26 @@ var state = {
279818
279817
  "type": "object",
279819
279818
  "properties": {
279820
279819
  "id": {
279821
- "type": "string"
279820
+ "type": "string",
279821
+ "description": "File ID"
279822
279822
  },
279823
279823
  "botId": {
279824
- "type": "string"
279824
+ "type": "string",
279825
+ "description": "The ID of the bot the file belongs to"
279825
279826
  },
279826
279827
  "name": {
279827
- "type": "string"
279828
+ "type": "string",
279829
+ "description": "File name",
279830
+ "nullable": true
279828
279831
  },
279829
279832
  "size": {
279830
279833
  "type": "number",
279834
+ "description": "File size in bytes",
279831
279835
  "nullable": true
279832
279836
  },
279833
279837
  "contentType": {
279834
- "type": "string"
279838
+ "type": "string",
279839
+ "description": "MIME type of the file's content"
279835
279840
  },
279836
279841
  "tags": {
279837
279842
  "type": "object",
@@ -279839,19 +279844,22 @@ var state = {
279839
279844
  "type": "string",
279840
279845
  "maxLength": 1e3
279841
279846
  },
279842
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
279847
+ "description": "The tags of the file as an object of key/value pairs"
279843
279848
  },
279844
279849
  "createdAt": {
279845
- "type": "string"
279850
+ "type": "string",
279851
+ "description": "File creation timestamp in ISO 8601 format"
279846
279852
  },
279847
279853
  "updatedAt": {
279848
- "type": "string"
279854
+ "type": "string",
279855
+ "description": "File last update timestamp in ISO 8601 format"
279849
279856
  },
279850
279857
  "accessPolicies": {
279851
279858
  "type": "array",
279852
279859
  "items": {
279853
279860
  "type": "string"
279854
- }
279861
+ },
279862
+ "description": "Access policies configured for the file."
279855
279863
  },
279856
279864
  "indexingStatus": {
279857
279865
  "type": "string",
@@ -279860,10 +279868,12 @@ var state = {
279860
279868
  "IN_PROGRESS",
279861
279869
  "COMPLETE",
279862
279870
  "FAILED"
279863
- ]
279871
+ ],
279872
+ "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
279873
  },
279865
279874
  "indexingFailureReason": {
279866
- "type": "string"
279875
+ "type": "string",
279876
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279867
279877
  }
279868
279878
  },
279869
279879
  "required": [
@@ -279950,20 +279960,26 @@ var state = {
279950
279960
  "type": "object",
279951
279961
  "properties": {
279952
279962
  "id": {
279953
- "type": "string"
279963
+ "type": "string",
279964
+ "description": "File ID"
279954
279965
  },
279955
279966
  "botId": {
279956
- "type": "string"
279967
+ "type": "string",
279968
+ "description": "The ID of the bot the file belongs to"
279957
279969
  },
279958
279970
  "name": {
279959
- "type": "string"
279971
+ "type": "string",
279972
+ "description": "File name",
279973
+ "nullable": true
279960
279974
  },
279961
279975
  "size": {
279962
279976
  "type": "number",
279977
+ "description": "File size in bytes",
279963
279978
  "nullable": true
279964
279979
  },
279965
279980
  "contentType": {
279966
- "type": "string"
279981
+ "type": "string",
279982
+ "description": "MIME type of the file's content"
279967
279983
  },
279968
279984
  "tags": {
279969
279985
  "type": "object",
@@ -279971,19 +279987,22 @@ var state = {
279971
279987
  "type": "string",
279972
279988
  "maxLength": 1e3
279973
279989
  },
279974
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
279990
+ "description": "The tags of the file as an object of key/value pairs"
279975
279991
  },
279976
279992
  "createdAt": {
279977
- "type": "string"
279993
+ "type": "string",
279994
+ "description": "File creation timestamp in ISO 8601 format"
279978
279995
  },
279979
279996
  "updatedAt": {
279980
- "type": "string"
279997
+ "type": "string",
279998
+ "description": "File last update timestamp in ISO 8601 format"
279981
279999
  },
279982
280000
  "accessPolicies": {
279983
280001
  "type": "array",
279984
280002
  "items": {
279985
280003
  "type": "string"
279986
- }
280004
+ },
280005
+ "description": "Access policies configured for the file."
279987
280006
  },
279988
280007
  "indexingStatus": {
279989
280008
  "type": "string",
@@ -279992,10 +280011,12 @@ var state = {
279992
280011
  "IN_PROGRESS",
279993
280012
  "COMPLETE",
279994
280013
  "FAILED"
279995
- ]
280014
+ ],
280015
+ "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
280016
  },
279997
280017
  "indexingFailureReason": {
279998
- "type": "string"
280018
+ "type": "string",
280019
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279999
280020
  }
280000
280021
  },
280001
280022
  "required": [
@@ -280053,20 +280074,26 @@ var state = {
280053
280074
  "type": "object",
280054
280075
  "properties": {
280055
280076
  "id": {
280056
- "type": "string"
280077
+ "type": "string",
280078
+ "description": "File ID"
280057
280079
  },
280058
280080
  "botId": {
280059
- "type": "string"
280081
+ "type": "string",
280082
+ "description": "The ID of the bot the file belongs to"
280060
280083
  },
280061
280084
  "name": {
280062
- "type": "string"
280085
+ "type": "string",
280086
+ "description": "File name",
280087
+ "nullable": true
280063
280088
  },
280064
280089
  "size": {
280065
280090
  "type": "number",
280091
+ "description": "File size in bytes",
280066
280092
  "nullable": true
280067
280093
  },
280068
280094
  "contentType": {
280069
- "type": "string"
280095
+ "type": "string",
280096
+ "description": "MIME type of the file's content"
280070
280097
  },
280071
280098
  "tags": {
280072
280099
  "type": "object",
@@ -280074,19 +280101,22 @@ var state = {
280074
280101
  "type": "string",
280075
280102
  "maxLength": 1e3
280076
280103
  },
280077
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
280104
+ "description": "The tags of the file as an object of key/value pairs"
280078
280105
  },
280079
280106
  "createdAt": {
280080
- "type": "string"
280107
+ "type": "string",
280108
+ "description": "File creation timestamp in ISO 8601 format"
280081
280109
  },
280082
280110
  "updatedAt": {
280083
- "type": "string"
280111
+ "type": "string",
280112
+ "description": "File last update timestamp in ISO 8601 format"
280084
280113
  },
280085
280114
  "accessPolicies": {
280086
280115
  "type": "array",
280087
280116
  "items": {
280088
280117
  "type": "string"
280089
- }
280118
+ },
280119
+ "description": "Access policies configured for the file."
280090
280120
  },
280091
280121
  "indexingStatus": {
280092
280122
  "type": "string",
@@ -280095,10 +280125,12 @@ var state = {
280095
280125
  "IN_PROGRESS",
280096
280126
  "COMPLETE",
280097
280127
  "FAILED"
280098
- ]
280128
+ ],
280129
+ "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
280130
  },
280100
280131
  "indexingFailureReason": {
280101
- "type": "string"
280132
+ "type": "string",
280133
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
280102
280134
  }
280103
280135
  },
280104
280136
  "required": [
@@ -280178,7 +280210,7 @@ var state = {
280178
280210
  "type": "string",
280179
280211
  "maxLength": 1e3
280180
280212
  },
280181
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
280213
+ "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
280214
  }
280183
280215
  },
280184
280216
  "required": [
@@ -280199,7 +280231,7 @@ var state = {
280199
280231
  "type": "string",
280200
280232
  "maxLength": 1e3
280201
280233
  },
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."
280234
+ "description": "The updated tags of the file."
280203
280235
  }
280204
280236
  },
280205
280237
  "required": [
@@ -280236,7 +280268,7 @@ var state = {
280236
280268
  "query": {
280237
280269
  "in": "query",
280238
280270
  "type": "string",
280239
- "description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
280271
+ "description": "Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.",
280240
280272
  "required": true
280241
280273
  },
280242
280274
  "contextDepth": {
@@ -280251,7 +280283,7 @@ var state = {
280251
280283
  }
280252
280284
  },
280253
280285
  "response": {
280254
- "description": "Returns the passages matching the query.",
280286
+ "description": "Returns the text passages within all indexed files that matched the query.",
280255
280287
  "schema": {
280256
280288
  "type": "object",
280257
280289
  "properties": {
@@ -280260,29 +280292,56 @@ var state = {
280260
280292
  "items": {
280261
280293
  "type": "object",
280262
280294
  "properties": {
280263
- "fileId": {
280264
- "type": "string"
280295
+ "content": {
280296
+ "type": "string",
280297
+ "description": "The content of the matching passage in the file including surrounding context, if any."
280265
280298
  },
280266
280299
  "score": {
280267
- "type": "number"
280268
- },
280269
- "content": {
280270
- "type": "string"
280300
+ "type": "number",
280301
+ "description": "The score indicating the similarity of the passage to the query. A higher score indicates higher similarity."
280271
280302
  },
280272
- "tags": {
280303
+ "file": {
280273
280304
  "type": "object",
280274
- "additionalProperties": {
280275
- "type": "string",
280276
- "maxLength": 1e3
280305
+ "properties": {
280306
+ "id": {
280307
+ "type": "string",
280308
+ "description": "File ID"
280309
+ },
280310
+ "name": {
280311
+ "type": "string",
280312
+ "description": "File name",
280313
+ "nullable": true
280314
+ },
280315
+ "tags": {
280316
+ "type": "object",
280317
+ "additionalProperties": {
280318
+ "type": "string",
280319
+ "maxLength": 1e3
280320
+ },
280321
+ "description": "The tags of the file as an object of key/value pairs."
280322
+ },
280323
+ "createdAt": {
280324
+ "type": "string",
280325
+ "description": "File creation timestamp in ISO 8601 format"
280326
+ },
280327
+ "updatedAt": {
280328
+ "type": "string",
280329
+ "description": "File last update timestamp in ISO 8601 format"
280330
+ }
280277
280331
  },
280278
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
280332
+ "required": [
280333
+ "id",
280334
+ "name",
280335
+ "tags",
280336
+ "createdAt",
280337
+ "updatedAt"
280338
+ ]
280279
280339
  }
280280
280340
  },
280281
280341
  "required": [
280282
- "fileId",
280283
- "score",
280284
280342
  "content",
280285
- "tags"
280343
+ "score",
280344
+ "file"
280286
280345
  ]
280287
280346
  }
280288
280347
  }
@@ -280398,6 +280457,10 @@ var state = {
280398
280457
  "maximum": 30,
280399
280458
  "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
280400
280459
  },
280460
+ "frozen": {
280461
+ "type": "boolean",
280462
+ "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
280463
+ },
280401
280464
  "schema": {
280402
280465
  "type": "object",
280403
280466
  "additionalProperties": true,
@@ -280473,6 +280536,10 @@ var state = {
280473
280536
  "maximum": 30,
280474
280537
  "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
280475
280538
  },
280539
+ "frozen": {
280540
+ "type": "boolean",
280541
+ "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
280542
+ },
280476
280543
  "schema": {
280477
280544
  "type": "object",
280478
280545
  "additionalProperties": true,
@@ -280526,7 +280593,7 @@ var state = {
280526
280593
  },
280527
280594
  "method": "post",
280528
280595
  "requestBody": {
280529
- "description": "Schema defining the structure of the new table",
280596
+ "description": "Parameters for the duplication operation.",
280530
280597
  "schema": {
280531
280598
  "type": "object",
280532
280599
  "properties": {
@@ -280591,6 +280658,10 @@ var state = {
280591
280658
  "type": "string",
280592
280659
  "minLength": 1
280593
280660
  },
280661
+ "frozen": {
280662
+ "type": "boolean",
280663
+ "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
280664
+ },
280594
280665
  "schema": {
280595
280666
  "type": "object",
280596
280667
  "additionalProperties": true,
@@ -281136,7 +281207,7 @@ var state = {
281136
281207
  "title": "Botpress API",
281137
281208
  "description": "API for Botpress Cloud",
281138
281209
  "server": "https://api.botpress.cloud",
281139
- "version": "0.20.3",
281210
+ "version": "0.22.0",
281140
281211
  "prefix": "v1"
281141
281212
  },
281142
281213
  "errors": [
@@ -283239,6 +283310,10 @@ var state = {
283239
283310
  "maximum": 30,
283240
283311
  "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
283241
283312
  },
283313
+ "frozen": {
283314
+ "type": "boolean",
283315
+ "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
283316
+ },
283242
283317
  "schema": {
283243
283318
  "type": "object",
283244
283319
  "properties": {
@@ -283447,20 +283522,26 @@ var state = {
283447
283522
  "type": "object",
283448
283523
  "properties": {
283449
283524
  "id": {
283450
- "type": "string"
283525
+ "type": "string",
283526
+ "description": "File ID"
283451
283527
  },
283452
283528
  "botId": {
283453
- "type": "string"
283529
+ "type": "string",
283530
+ "description": "The ID of the bot the file belongs to"
283454
283531
  },
283455
283532
  "name": {
283456
- "type": "string"
283533
+ "type": "string",
283534
+ "description": "File name",
283535
+ "nullable": true
283457
283536
  },
283458
283537
  "size": {
283459
283538
  "type": "number",
283539
+ "description": "File size in bytes",
283460
283540
  "nullable": true
283461
283541
  },
283462
283542
  "contentType": {
283463
- "type": "string"
283543
+ "type": "string",
283544
+ "description": "MIME type of the file's content"
283464
283545
  },
283465
283546
  "tags": {
283466
283547
  "type": "object",
@@ -283468,19 +283549,22 @@ var state = {
283468
283549
  "type": "string",
283469
283550
  "maxLength": 1e3
283470
283551
  },
283471
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
283552
+ "description": "The tags of the file as an object of key/value pairs"
283472
283553
  },
283473
283554
  "createdAt": {
283474
- "type": "string"
283555
+ "type": "string",
283556
+ "description": "File creation timestamp in ISO 8601 format"
283475
283557
  },
283476
283558
  "updatedAt": {
283477
- "type": "string"
283559
+ "type": "string",
283560
+ "description": "File last update timestamp in ISO 8601 format"
283478
283561
  },
283479
283562
  "accessPolicies": {
283480
283563
  "type": "array",
283481
283564
  "items": {
283482
283565
  "type": "string"
283483
- }
283566
+ },
283567
+ "description": "Access policies configured for the file."
283484
283568
  },
283485
283569
  "indexingStatus": {
283486
283570
  "type": "string",
@@ -283489,10 +283573,12 @@ var state = {
283489
283573
  "IN_PROGRESS",
283490
283574
  "COMPLETE",
283491
283575
  "FAILED"
283492
- ]
283576
+ ],
283577
+ "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
283578
  },
283494
283579
  "indexingFailureReason": {
283495
- "type": "string"
283580
+ "type": "string",
283581
+ "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
283496
283582
  }
283497
283583
  },
283498
283584
  "required": [