@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/src/gen/state.ts CHANGED
@@ -8265,20 +8265,26 @@ export const state = {
8265
8265
  "type": "object",
8266
8266
  "properties": {
8267
8267
  "id": {
8268
- "type": "string"
8268
+ "type": "string",
8269
+ "description": "File ID"
8269
8270
  },
8270
8271
  "botId": {
8271
- "type": "string"
8272
+ "type": "string",
8273
+ "description": "The ID of the bot the file belongs to"
8272
8274
  },
8273
8275
  "name": {
8274
- "type": "string"
8276
+ "type": "string",
8277
+ "description": "File name",
8278
+ "nullable": true
8275
8279
  },
8276
8280
  "size": {
8277
8281
  "type": "number",
8282
+ "description": "File size in bytes",
8278
8283
  "nullable": true
8279
8284
  },
8280
8285
  "contentType": {
8281
- "type": "string"
8286
+ "type": "string",
8287
+ "description": "MIME type of the file's content"
8282
8288
  },
8283
8289
  "tags": {
8284
8290
  "type": "object",
@@ -8286,19 +8292,22 @@ export const state = {
8286
8292
  "type": "string",
8287
8293
  "maxLength": 1000
8288
8294
  },
8289
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8295
+ "description": "The tags of the file as an object of key/value pairs"
8290
8296
  },
8291
8297
  "createdAt": {
8292
- "type": "string"
8298
+ "type": "string",
8299
+ "description": "File creation timestamp in ISO 8601 format"
8293
8300
  },
8294
8301
  "updatedAt": {
8295
- "type": "string"
8302
+ "type": "string",
8303
+ "description": "File last update timestamp in ISO 8601 format"
8296
8304
  },
8297
8305
  "accessPolicies": {
8298
8306
  "type": "array",
8299
8307
  "items": {
8300
8308
  "type": "string"
8301
- }
8309
+ },
8310
+ "description": "Access policies configured for the file."
8302
8311
  },
8303
8312
  "indexingStatus": {
8304
8313
  "type": "string",
@@ -8307,10 +8316,12 @@ export const state = {
8307
8316
  "IN_PROGRESS",
8308
8317
  "COMPLETE",
8309
8318
  "FAILED"
8310
- ]
8319
+ ],
8320
+ "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
8321
  },
8312
8322
  "indexingFailureReason": {
8313
- "type": "string"
8323
+ "type": "string",
8324
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8314
8325
  }
8315
8326
  },
8316
8327
  "required": [
@@ -8397,20 +8408,26 @@ export const state = {
8397
8408
  "type": "object",
8398
8409
  "properties": {
8399
8410
  "id": {
8400
- "type": "string"
8411
+ "type": "string",
8412
+ "description": "File ID"
8401
8413
  },
8402
8414
  "botId": {
8403
- "type": "string"
8415
+ "type": "string",
8416
+ "description": "The ID of the bot the file belongs to"
8404
8417
  },
8405
8418
  "name": {
8406
- "type": "string"
8419
+ "type": "string",
8420
+ "description": "File name",
8421
+ "nullable": true
8407
8422
  },
8408
8423
  "size": {
8409
8424
  "type": "number",
8425
+ "description": "File size in bytes",
8410
8426
  "nullable": true
8411
8427
  },
8412
8428
  "contentType": {
8413
- "type": "string"
8429
+ "type": "string",
8430
+ "description": "MIME type of the file's content"
8414
8431
  },
8415
8432
  "tags": {
8416
8433
  "type": "object",
@@ -8418,19 +8435,22 @@ export const state = {
8418
8435
  "type": "string",
8419
8436
  "maxLength": 1000
8420
8437
  },
8421
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8438
+ "description": "The tags of the file as an object of key/value pairs"
8422
8439
  },
8423
8440
  "createdAt": {
8424
- "type": "string"
8441
+ "type": "string",
8442
+ "description": "File creation timestamp in ISO 8601 format"
8425
8443
  },
8426
8444
  "updatedAt": {
8427
- "type": "string"
8445
+ "type": "string",
8446
+ "description": "File last update timestamp in ISO 8601 format"
8428
8447
  },
8429
8448
  "accessPolicies": {
8430
8449
  "type": "array",
8431
8450
  "items": {
8432
8451
  "type": "string"
8433
- }
8452
+ },
8453
+ "description": "Access policies configured for the file."
8434
8454
  },
8435
8455
  "indexingStatus": {
8436
8456
  "type": "string",
@@ -8439,10 +8459,12 @@ export const state = {
8439
8459
  "IN_PROGRESS",
8440
8460
  "COMPLETE",
8441
8461
  "FAILED"
8442
- ]
8462
+ ],
8463
+ "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
8464
  },
8444
8465
  "indexingFailureReason": {
8445
- "type": "string"
8466
+ "type": "string",
8467
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8446
8468
  }
8447
8469
  },
8448
8470
  "required": [
@@ -8500,20 +8522,26 @@ export const state = {
8500
8522
  "type": "object",
8501
8523
  "properties": {
8502
8524
  "id": {
8503
- "type": "string"
8525
+ "type": "string",
8526
+ "description": "File ID"
8504
8527
  },
8505
8528
  "botId": {
8506
- "type": "string"
8529
+ "type": "string",
8530
+ "description": "The ID of the bot the file belongs to"
8507
8531
  },
8508
8532
  "name": {
8509
- "type": "string"
8533
+ "type": "string",
8534
+ "description": "File name",
8535
+ "nullable": true
8510
8536
  },
8511
8537
  "size": {
8512
8538
  "type": "number",
8539
+ "description": "File size in bytes",
8513
8540
  "nullable": true
8514
8541
  },
8515
8542
  "contentType": {
8516
- "type": "string"
8543
+ "type": "string",
8544
+ "description": "MIME type of the file's content"
8517
8545
  },
8518
8546
  "tags": {
8519
8547
  "type": "object",
@@ -8521,19 +8549,22 @@ export const state = {
8521
8549
  "type": "string",
8522
8550
  "maxLength": 1000
8523
8551
  },
8524
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8552
+ "description": "The tags of the file as an object of key/value pairs"
8525
8553
  },
8526
8554
  "createdAt": {
8527
- "type": "string"
8555
+ "type": "string",
8556
+ "description": "File creation timestamp in ISO 8601 format"
8528
8557
  },
8529
8558
  "updatedAt": {
8530
- "type": "string"
8559
+ "type": "string",
8560
+ "description": "File last update timestamp in ISO 8601 format"
8531
8561
  },
8532
8562
  "accessPolicies": {
8533
8563
  "type": "array",
8534
8564
  "items": {
8535
8565
  "type": "string"
8536
- }
8566
+ },
8567
+ "description": "Access policies configured for the file."
8537
8568
  },
8538
8569
  "indexingStatus": {
8539
8570
  "type": "string",
@@ -8542,10 +8573,12 @@ export const state = {
8542
8573
  "IN_PROGRESS",
8543
8574
  "COMPLETE",
8544
8575
  "FAILED"
8545
- ]
8576
+ ],
8577
+ "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
8578
  },
8547
8579
  "indexingFailureReason": {
8548
- "type": "string"
8580
+ "type": "string",
8581
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8549
8582
  }
8550
8583
  },
8551
8584
  "required": [
@@ -8625,7 +8658,7 @@ export const state = {
8625
8658
  "type": "string",
8626
8659
  "maxLength": 1000
8627
8660
  },
8628
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8661
+ "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
8662
  }
8630
8663
  },
8631
8664
  "required": [
@@ -8646,7 +8679,7 @@ export const state = {
8646
8679
  "type": "string",
8647
8680
  "maxLength": 1000
8648
8681
  },
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."
8682
+ "description": "The updated tags of the file."
8650
8683
  }
8651
8684
  },
8652
8685
  "required": [
@@ -8683,7 +8716,7 @@ export const state = {
8683
8716
  "query": {
8684
8717
  "in": "query",
8685
8718
  "type": "string",
8686
- "description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
8719
+ "description": "Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.",
8687
8720
  "required": true
8688
8721
  },
8689
8722
  "contextDepth": {
@@ -8698,7 +8731,7 @@ export const state = {
8698
8731
  }
8699
8732
  },
8700
8733
  "response": {
8701
- "description": "Returns the passages matching the query.",
8734
+ "description": "Returns the text passages within all indexed files that matched the query.",
8702
8735
  "schema": {
8703
8736
  "type": "object",
8704
8737
  "properties": {
@@ -8707,29 +8740,56 @@ export const state = {
8707
8740
  "items": {
8708
8741
  "type": "object",
8709
8742
  "properties": {
8710
- "fileId": {
8711
- "type": "string"
8743
+ "content": {
8744
+ "type": "string",
8745
+ "description": "The content of the matching passage in the file including surrounding context, if any."
8712
8746
  },
8713
8747
  "score": {
8714
- "type": "number"
8715
- },
8716
- "content": {
8717
- "type": "string"
8748
+ "type": "number",
8749
+ "description": "The score indicating the similarity of the passage to the query. A higher score indicates higher similarity."
8718
8750
  },
8719
- "tags": {
8751
+ "file": {
8720
8752
  "type": "object",
8721
- "additionalProperties": {
8722
- "type": "string",
8723
- "maxLength": 1000
8753
+ "properties": {
8754
+ "id": {
8755
+ "type": "string",
8756
+ "description": "File ID"
8757
+ },
8758
+ "name": {
8759
+ "type": "string",
8760
+ "description": "File name",
8761
+ "nullable": true
8762
+ },
8763
+ "tags": {
8764
+ "type": "object",
8765
+ "additionalProperties": {
8766
+ "type": "string",
8767
+ "maxLength": 1000
8768
+ },
8769
+ "description": "The tags of the file as an object of key/value pairs."
8770
+ },
8771
+ "createdAt": {
8772
+ "type": "string",
8773
+ "description": "File creation timestamp in ISO 8601 format"
8774
+ },
8775
+ "updatedAt": {
8776
+ "type": "string",
8777
+ "description": "File last update timestamp in ISO 8601 format"
8778
+ }
8724
8779
  },
8725
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
8780
+ "required": [
8781
+ "id",
8782
+ "name",
8783
+ "tags",
8784
+ "createdAt",
8785
+ "updatedAt"
8786
+ ]
8726
8787
  }
8727
8788
  },
8728
8789
  "required": [
8729
- "fileId",
8730
- "score",
8731
8790
  "content",
8732
- "tags"
8791
+ "score",
8792
+ "file"
8733
8793
  ]
8734
8794
  }
8735
8795
  }
@@ -8973,7 +9033,7 @@ export const state = {
8973
9033
  },
8974
9034
  "method": "post",
8975
9035
  "requestBody": {
8976
- "description": "Schema defining the structure of the new table",
9036
+ "description": "Parameters for the duplication operation.",
8977
9037
  "schema": {
8978
9038
  "type": "object",
8979
9039
  "properties": {
@@ -9583,7 +9643,7 @@ export const state = {
9583
9643
  "title": "Botpress API",
9584
9644
  "description": "API for Botpress Cloud",
9585
9645
  "server": "https://api.botpress.cloud",
9586
- "version": "0.20.3",
9646
+ "version": "0.21.0",
9587
9647
  "prefix": "v1"
9588
9648
  },
9589
9649
  "errors": [
@@ -11894,20 +11954,26 @@ export const state = {
11894
11954
  "type": "object",
11895
11955
  "properties": {
11896
11956
  "id": {
11897
- "type": "string"
11957
+ "type": "string",
11958
+ "description": "File ID"
11898
11959
  },
11899
11960
  "botId": {
11900
- "type": "string"
11961
+ "type": "string",
11962
+ "description": "The ID of the bot the file belongs to"
11901
11963
  },
11902
11964
  "name": {
11903
- "type": "string"
11965
+ "type": "string",
11966
+ "description": "File name",
11967
+ "nullable": true
11904
11968
  },
11905
11969
  "size": {
11906
11970
  "type": "number",
11971
+ "description": "File size in bytes",
11907
11972
  "nullable": true
11908
11973
  },
11909
11974
  "contentType": {
11910
- "type": "string"
11975
+ "type": "string",
11976
+ "description": "MIME type of the file's content"
11911
11977
  },
11912
11978
  "tags": {
11913
11979
  "type": "object",
@@ -11915,19 +11981,22 @@ export const state = {
11915
11981
  "type": "string",
11916
11982
  "maxLength": 1000
11917
11983
  },
11918
- "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
11984
+ "description": "The tags of the file as an object of key/value pairs"
11919
11985
  },
11920
11986
  "createdAt": {
11921
- "type": "string"
11987
+ "type": "string",
11988
+ "description": "File creation timestamp in ISO 8601 format"
11922
11989
  },
11923
11990
  "updatedAt": {
11924
- "type": "string"
11991
+ "type": "string",
11992
+ "description": "File last update timestamp in ISO 8601 format"
11925
11993
  },
11926
11994
  "accessPolicies": {
11927
11995
  "type": "array",
11928
11996
  "items": {
11929
11997
  "type": "string"
11930
- }
11998
+ },
11999
+ "description": "Access policies configured for the file."
11931
12000
  },
11932
12001
  "indexingStatus": {
11933
12002
  "type": "string",
@@ -11936,10 +12005,12 @@ export const state = {
11936
12005
  "IN_PROGRESS",
11937
12006
  "COMPLETE",
11938
12007
  "FAILED"
11939
- ]
12008
+ ],
12009
+ "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
12010
  },
11941
12011
  "indexingFailureReason": {
11942
- "type": "string"
12012
+ "type": "string",
12013
+ "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
11943
12014
  }
11944
12015
  },
11945
12016
  "required": [