@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.
Files changed (5) hide show
  1. package/dist/index.js +149 -63
  2. package/dist/src/gen/state.d.ts +91 -10
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +149 -63
package/src/gen/state.ts CHANGED
@@ -8225,8 +8225,7 @@ export const state = {
8225
8225
  "x-name": {
8226
8226
  "type": "string",
8227
8227
  "description": "File name",
8228
- "in": "header",
8229
- "required": true
8228
+ "in": "header"
8230
8229
  },
8231
8230
  "x-tags": {
8232
8231
  "type": "string",
@@ -8240,7 +8239,7 @@ export const state = {
8240
8239
  },
8241
8240
  "x-index": {
8242
8241
  "type": "boolean",
8243
- "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.",
8242
+ "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.",
8244
8243
  "in": "header"
8245
8244
  },
8246
8245
  "Content-Type": {
@@ -8265,20 +8264,26 @@ export const state = {
8265
8264
  "type": "object",
8266
8265
  "properties": {
8267
8266
  "id": {
8268
- "type": "string"
8267
+ "type": "string",
8268
+ "description": "File ID"
8269
8269
  },
8270
8270
  "botId": {
8271
- "type": "string"
8271
+ "type": "string",
8272
+ "description": "The ID of the bot the file belongs to"
8272
8273
  },
8273
8274
  "name": {
8274
- "type": "string"
8275
+ "type": "string",
8276
+ "description": "File name",
8277
+ "nullable": true
8275
8278
  },
8276
8279
  "size": {
8277
8280
  "type": "number",
8281
+ "description": "File size in bytes",
8278
8282
  "nullable": true
8279
8283
  },
8280
8284
  "contentType": {
8281
- "type": "string"
8285
+ "type": "string",
8286
+ "description": "MIME type of the file's content"
8282
8287
  },
8283
8288
  "tags": {
8284
8289
  "type": "object",
@@ -8286,19 +8291,22 @@ export const state = {
8286
8291
  "type": "string",
8287
8292
  "maxLength": 1000
8288
8293
  },
8289
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8294
+ "description": "The tags of the file as an object of key/value pairs"
8290
8295
  },
8291
8296
  "createdAt": {
8292
- "type": "string"
8297
+ "type": "string",
8298
+ "description": "File creation timestamp in ISO 8601 format"
8293
8299
  },
8294
8300
  "updatedAt": {
8295
- "type": "string"
8301
+ "type": "string",
8302
+ "description": "File last update timestamp in ISO 8601 format"
8296
8303
  },
8297
8304
  "accessPolicies": {
8298
8305
  "type": "array",
8299
8306
  "items": {
8300
8307
  "type": "string"
8301
- }
8308
+ },
8309
+ "description": "Access policies configured for the file."
8302
8310
  },
8303
8311
  "indexingStatus": {
8304
8312
  "type": "string",
@@ -8307,10 +8315,12 @@ export const state = {
8307
8315
  "IN_PROGRESS",
8308
8316
  "COMPLETE",
8309
8317
  "FAILED"
8310
- ]
8318
+ ],
8319
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
8311
8320
  },
8312
8321
  "indexingFailureReason": {
8313
- "type": "string"
8322
+ "type": "string",
8323
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8314
8324
  }
8315
8325
  },
8316
8326
  "required": [
@@ -8397,20 +8407,26 @@ export const state = {
8397
8407
  "type": "object",
8398
8408
  "properties": {
8399
8409
  "id": {
8400
- "type": "string"
8410
+ "type": "string",
8411
+ "description": "File ID"
8401
8412
  },
8402
8413
  "botId": {
8403
- "type": "string"
8414
+ "type": "string",
8415
+ "description": "The ID of the bot the file belongs to"
8404
8416
  },
8405
8417
  "name": {
8406
- "type": "string"
8418
+ "type": "string",
8419
+ "description": "File name",
8420
+ "nullable": true
8407
8421
  },
8408
8422
  "size": {
8409
8423
  "type": "number",
8424
+ "description": "File size in bytes",
8410
8425
  "nullable": true
8411
8426
  },
8412
8427
  "contentType": {
8413
- "type": "string"
8428
+ "type": "string",
8429
+ "description": "MIME type of the file's content"
8414
8430
  },
8415
8431
  "tags": {
8416
8432
  "type": "object",
@@ -8418,19 +8434,22 @@ export const state = {
8418
8434
  "type": "string",
8419
8435
  "maxLength": 1000
8420
8436
  },
8421
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8437
+ "description": "The tags of the file as an object of key/value pairs"
8422
8438
  },
8423
8439
  "createdAt": {
8424
- "type": "string"
8440
+ "type": "string",
8441
+ "description": "File creation timestamp in ISO 8601 format"
8425
8442
  },
8426
8443
  "updatedAt": {
8427
- "type": "string"
8444
+ "type": "string",
8445
+ "description": "File last update timestamp in ISO 8601 format"
8428
8446
  },
8429
8447
  "accessPolicies": {
8430
8448
  "type": "array",
8431
8449
  "items": {
8432
8450
  "type": "string"
8433
- }
8451
+ },
8452
+ "description": "Access policies configured for the file."
8434
8453
  },
8435
8454
  "indexingStatus": {
8436
8455
  "type": "string",
@@ -8439,10 +8458,12 @@ export const state = {
8439
8458
  "IN_PROGRESS",
8440
8459
  "COMPLETE",
8441
8460
  "FAILED"
8442
- ]
8461
+ ],
8462
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
8443
8463
  },
8444
8464
  "indexingFailureReason": {
8445
- "type": "string"
8465
+ "type": "string",
8466
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8446
8467
  }
8447
8468
  },
8448
8469
  "required": [
@@ -8500,20 +8521,26 @@ export const state = {
8500
8521
  "type": "object",
8501
8522
  "properties": {
8502
8523
  "id": {
8503
- "type": "string"
8524
+ "type": "string",
8525
+ "description": "File ID"
8504
8526
  },
8505
8527
  "botId": {
8506
- "type": "string"
8528
+ "type": "string",
8529
+ "description": "The ID of the bot the file belongs to"
8507
8530
  },
8508
8531
  "name": {
8509
- "type": "string"
8532
+ "type": "string",
8533
+ "description": "File name",
8534
+ "nullable": true
8510
8535
  },
8511
8536
  "size": {
8512
8537
  "type": "number",
8538
+ "description": "File size in bytes",
8513
8539
  "nullable": true
8514
8540
  },
8515
8541
  "contentType": {
8516
- "type": "string"
8542
+ "type": "string",
8543
+ "description": "MIME type of the file's content"
8517
8544
  },
8518
8545
  "tags": {
8519
8546
  "type": "object",
@@ -8521,19 +8548,22 @@ export const state = {
8521
8548
  "type": "string",
8522
8549
  "maxLength": 1000
8523
8550
  },
8524
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8551
+ "description": "The tags of the file as an object of key/value pairs"
8525
8552
  },
8526
8553
  "createdAt": {
8527
- "type": "string"
8554
+ "type": "string",
8555
+ "description": "File creation timestamp in ISO 8601 format"
8528
8556
  },
8529
8557
  "updatedAt": {
8530
- "type": "string"
8558
+ "type": "string",
8559
+ "description": "File last update timestamp in ISO 8601 format"
8531
8560
  },
8532
8561
  "accessPolicies": {
8533
8562
  "type": "array",
8534
8563
  "items": {
8535
8564
  "type": "string"
8536
- }
8565
+ },
8566
+ "description": "Access policies configured for the file."
8537
8567
  },
8538
8568
  "indexingStatus": {
8539
8569
  "type": "string",
@@ -8542,10 +8572,12 @@ export const state = {
8542
8572
  "IN_PROGRESS",
8543
8573
  "COMPLETE",
8544
8574
  "FAILED"
8545
- ]
8575
+ ],
8576
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
8546
8577
  },
8547
8578
  "indexingFailureReason": {
8548
- "type": "string"
8579
+ "type": "string",
8580
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8549
8581
  }
8550
8582
  },
8551
8583
  "required": [
@@ -8625,7 +8657,7 @@ export const state = {
8625
8657
  "type": "string",
8626
8658
  "maxLength": 1000
8627
8659
  },
8628
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8660
+ "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."
8629
8661
  }
8630
8662
  },
8631
8663
  "required": [
@@ -8646,7 +8678,7 @@ export const state = {
8646
8678
  "type": "string",
8647
8679
  "maxLength": 1000
8648
8680
  },
8649
- "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."
8681
+ "description": "The updated tags of the file."
8650
8682
  }
8651
8683
  },
8652
8684
  "required": [
@@ -8683,7 +8715,7 @@ export const state = {
8683
8715
  "query": {
8684
8716
  "in": "query",
8685
8717
  "type": "string",
8686
- "description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
8718
+ "description": "Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.",
8687
8719
  "required": true
8688
8720
  },
8689
8721
  "contextDepth": {
@@ -8698,7 +8730,7 @@ export const state = {
8698
8730
  }
8699
8731
  },
8700
8732
  "response": {
8701
- "description": "Returns the passages matching the query.",
8733
+ "description": "Returns the text passages within all indexed files that matched the query.",
8702
8734
  "schema": {
8703
8735
  "type": "object",
8704
8736
  "properties": {
@@ -8707,29 +8739,56 @@ export const state = {
8707
8739
  "items": {
8708
8740
  "type": "object",
8709
8741
  "properties": {
8710
- "fileId": {
8711
- "type": "string"
8742
+ "content": {
8743
+ "type": "string",
8744
+ "description": "The content of the matching passage in the file including surrounding context, if any."
8712
8745
  },
8713
8746
  "score": {
8714
- "type": "number"
8715
- },
8716
- "content": {
8717
- "type": "string"
8747
+ "type": "number",
8748
+ "description": "The score indicating the similarity of the passage to the query. A higher score indicates higher similarity."
8718
8749
  },
8719
- "tags": {
8750
+ "file": {
8720
8751
  "type": "object",
8721
- "additionalProperties": {
8722
- "type": "string",
8723
- "maxLength": 1000
8752
+ "properties": {
8753
+ "id": {
8754
+ "type": "string",
8755
+ "description": "File ID"
8756
+ },
8757
+ "name": {
8758
+ "type": "string",
8759
+ "description": "File name",
8760
+ "nullable": true
8761
+ },
8762
+ "tags": {
8763
+ "type": "object",
8764
+ "additionalProperties": {
8765
+ "type": "string",
8766
+ "maxLength": 1000
8767
+ },
8768
+ "description": "The tags of the file as an object of key/value pairs."
8769
+ },
8770
+ "createdAt": {
8771
+ "type": "string",
8772
+ "description": "File creation timestamp in ISO 8601 format"
8773
+ },
8774
+ "updatedAt": {
8775
+ "type": "string",
8776
+ "description": "File last update timestamp in ISO 8601 format"
8777
+ }
8724
8778
  },
8725
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8779
+ "required": [
8780
+ "id",
8781
+ "name",
8782
+ "tags",
8783
+ "createdAt",
8784
+ "updatedAt"
8785
+ ]
8726
8786
  }
8727
8787
  },
8728
8788
  "required": [
8729
- "fileId",
8730
- "score",
8731
8789
  "content",
8732
- "tags"
8790
+ "score",
8791
+ "file"
8733
8792
  ]
8734
8793
  }
8735
8794
  }
@@ -8845,6 +8904,10 @@ export const state = {
8845
8904
  "maximum": 30,
8846
8905
  "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."
8847
8906
  },
8907
+ "frozen": {
8908
+ "type": "boolean",
8909
+ "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."
8910
+ },
8848
8911
  "schema": {
8849
8912
  "type": "object",
8850
8913
  "additionalProperties": true,
@@ -8920,6 +8983,10 @@ export const state = {
8920
8983
  "maximum": 30,
8921
8984
  "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."
8922
8985
  },
8986
+ "frozen": {
8987
+ "type": "boolean",
8988
+ "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."
8989
+ },
8923
8990
  "schema": {
8924
8991
  "type": "object",
8925
8992
  "additionalProperties": true,
@@ -8973,7 +9040,7 @@ export const state = {
8973
9040
  },
8974
9041
  "method": "post",
8975
9042
  "requestBody": {
8976
- "description": "Schema defining the structure of the new table",
9043
+ "description": "Parameters for the duplication operation.",
8977
9044
  "schema": {
8978
9045
  "type": "object",
8979
9046
  "properties": {
@@ -9038,6 +9105,10 @@ export const state = {
9038
9105
  "type": "string",
9039
9106
  "minLength": 1
9040
9107
  },
9108
+ "frozen": {
9109
+ "type": "boolean",
9110
+ "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."
9111
+ },
9041
9112
  "schema": {
9042
9113
  "type": "object",
9043
9114
  "additionalProperties": true,
@@ -9583,7 +9654,7 @@ export const state = {
9583
9654
  "title": "Botpress API",
9584
9655
  "description": "API for Botpress Cloud",
9585
9656
  "server": "https://api.botpress.cloud",
9586
- "version": "0.20.3",
9657
+ "version": "0.22.0",
9587
9658
  "prefix": "v1"
9588
9659
  },
9589
9660
  "errors": [
@@ -11686,6 +11757,10 @@ export const state = {
11686
11757
  "maximum": 30,
11687
11758
  "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."
11688
11759
  },
11760
+ "frozen": {
11761
+ "type": "boolean",
11762
+ "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."
11763
+ },
11689
11764
  "schema": {
11690
11765
  "type": "object",
11691
11766
  "properties": {
@@ -11894,20 +11969,26 @@ export const state = {
11894
11969
  "type": "object",
11895
11970
  "properties": {
11896
11971
  "id": {
11897
- "type": "string"
11972
+ "type": "string",
11973
+ "description": "File ID"
11898
11974
  },
11899
11975
  "botId": {
11900
- "type": "string"
11976
+ "type": "string",
11977
+ "description": "The ID of the bot the file belongs to"
11901
11978
  },
11902
11979
  "name": {
11903
- "type": "string"
11980
+ "type": "string",
11981
+ "description": "File name",
11982
+ "nullable": true
11904
11983
  },
11905
11984
  "size": {
11906
11985
  "type": "number",
11986
+ "description": "File size in bytes",
11907
11987
  "nullable": true
11908
11988
  },
11909
11989
  "contentType": {
11910
- "type": "string"
11990
+ "type": "string",
11991
+ "description": "MIME type of the file's content"
11911
11992
  },
11912
11993
  "tags": {
11913
11994
  "type": "object",
@@ -11915,19 +11996,22 @@ export const state = {
11915
11996
  "type": "string",
11916
11997
  "maxLength": 1000
11917
11998
  },
11918
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
11999
+ "description": "The tags of the file as an object of key/value pairs"
11919
12000
  },
11920
12001
  "createdAt": {
11921
- "type": "string"
12002
+ "type": "string",
12003
+ "description": "File creation timestamp in ISO 8601 format"
11922
12004
  },
11923
12005
  "updatedAt": {
11924
- "type": "string"
12006
+ "type": "string",
12007
+ "description": "File last update timestamp in ISO 8601 format"
11925
12008
  },
11926
12009
  "accessPolicies": {
11927
12010
  "type": "array",
11928
12011
  "items": {
11929
12012
  "type": "string"
11930
- }
12013
+ },
12014
+ "description": "Access policies configured for the file."
11931
12015
  },
11932
12016
  "indexingStatus": {
11933
12017
  "type": "string",
@@ -11936,10 +12020,12 @@ export const state = {
11936
12020
  "IN_PROGRESS",
11937
12021
  "COMPLETE",
11938
12022
  "FAILED"
11939
- ]
12023
+ ],
12024
+ "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
11940
12025
  },
11941
12026
  "indexingFailureReason": {
11942
- "type": "string"
12027
+ "type": "string",
12028
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
11943
12029
  }
11944
12030
  },
11945
12031
  "required": [