@botpress/api 0.48.0 → 0.49.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 +128 -6
  2. package/dist/src/gen/state.d.ts +114 -5
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +128 -6
package/src/gen/state.ts CHANGED
@@ -1725,13 +1725,11 @@ export const state = {
1725
1725
  "type": "string",
1726
1726
  "maxLength": 200,
1727
1727
  "description": "Unique identifier of the integration that was installed on the bot"
1728
- },
1729
- "configuration": {
1730
- "type": "object",
1731
- "additionalProperties": true,
1732
- "description": "Configuration fields to update for the integration"
1733
1728
  }
1734
1729
  },
1730
+ "required": [
1731
+ "identifier"
1732
+ ],
1735
1733
  "title": "configureIntegrationBody",
1736
1734
  "additionalProperties": false
1737
1735
  }
@@ -10536,6 +10534,84 @@ export const state = {
10536
10534
  "type": "boolean",
10537
10535
  "description": "Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace."
10538
10536
  },
10537
+ "indexing": {
10538
+ "type": "object",
10539
+ "properties": {
10540
+ "configuration": {
10541
+ "type": "object",
10542
+ "properties": {
10543
+ "parsing": {
10544
+ "default": {},
10545
+ "type": "object",
10546
+ "properties": {
10547
+ "minimumParagraphLength": {
10548
+ "default": 500,
10549
+ "type": "integer",
10550
+ "minimum": 50,
10551
+ "maximum": 2000
10552
+ }
10553
+ },
10554
+ "additionalProperties": false
10555
+ },
10556
+ "chunking": {
10557
+ "default": {},
10558
+ "type": "object",
10559
+ "properties": {
10560
+ "maximumChunkLength": {
10561
+ "default": 1250,
10562
+ "type": "integer",
10563
+ "minimum": 100,
10564
+ "maximum": 5000
10565
+ }
10566
+ },
10567
+ "additionalProperties": false
10568
+ },
10569
+ "summarization": {
10570
+ "default": {},
10571
+ "type": "object",
10572
+ "properties": {
10573
+ "enable": {
10574
+ "default": true,
10575
+ "type": "boolean"
10576
+ },
10577
+ "modelType": {
10578
+ "default": "balanced",
10579
+ "type": "string",
10580
+ "enum": [
10581
+ "inexpensive",
10582
+ "balanced",
10583
+ "accurate"
10584
+ ]
10585
+ },
10586
+ "minimumInputLength": {
10587
+ "default": 3000,
10588
+ "type": "integer",
10589
+ "minimum": 1000,
10590
+ "maximum": 10000
10591
+ },
10592
+ "outputTokenLimit": {
10593
+ "default": 2000,
10594
+ "type": "integer",
10595
+ "minimum": 1000,
10596
+ "maximum": 10000
10597
+ },
10598
+ "generateMasterSummary": {
10599
+ "default": true,
10600
+ "type": "boolean"
10601
+ }
10602
+ },
10603
+ "additionalProperties": false
10604
+ }
10605
+ },
10606
+ "description": "Configuration to use for indexing the file, will be stored in the file's metadata for reference.",
10607
+ "additionalProperties": false
10608
+ }
10609
+ },
10610
+ "required": [
10611
+ "configuration"
10612
+ ],
10613
+ "additionalProperties": false
10614
+ },
10539
10615
  "accessPolicies": {
10540
10616
  "type": "array",
10541
10617
  "items": {
@@ -10559,6 +10635,9 @@ export const state = {
10559
10635
  "publicContentImmediatelyAccessible": {
10560
10636
  "type": "boolean",
10561
10637
  "description": "Use when your file has \"public_content\" in its access policy and you need the file\\'s content to be immediately accessible through its URL after the file has been uploaded without having to wait for the upload to be processed by our system.\n\nIf set to `true`, the `x-amz-tagging` HTTP header with a value of `public=true` will need to be sent in the HTTP PUT request to the `uploadUrl` in order for the upload request to work."
10638
+ },
10639
+ "metadata": {
10640
+ "description": "Custom metadata for the file expressed as an object of key-value pairs. The values can be of any type."
10562
10641
  }
10563
10642
  },
10564
10643
  "required": [
@@ -10612,6 +10691,13 @@ export const state = {
10612
10691
  },
10613
10692
  "description": "The tags of the file as an object of key/value pairs"
10614
10693
  },
10694
+ "metadata": {
10695
+ "type": "object",
10696
+ "additionalProperties": {
10697
+ "nullable": true
10698
+ },
10699
+ "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
10700
+ },
10615
10701
  "createdAt": {
10616
10702
  "type": "string",
10617
10703
  "description": "File creation timestamp in ISO 8601 format"
@@ -10668,6 +10754,7 @@ export const state = {
10668
10754
  "size",
10669
10755
  "contentType",
10670
10756
  "tags",
10757
+ "metadata",
10671
10758
  "createdAt",
10672
10759
  "updatedAt",
10673
10760
  "accessPolicies",
@@ -10783,6 +10870,13 @@ export const state = {
10783
10870
  },
10784
10871
  "description": "The tags of the file as an object of key/value pairs"
10785
10872
  },
10873
+ "metadata": {
10874
+ "type": "object",
10875
+ "additionalProperties": {
10876
+ "nullable": true
10877
+ },
10878
+ "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
10879
+ },
10786
10880
  "createdAt": {
10787
10881
  "type": "string",
10788
10882
  "description": "File creation timestamp in ISO 8601 format"
@@ -10835,6 +10929,7 @@ export const state = {
10835
10929
  "size",
10836
10930
  "contentType",
10837
10931
  "tags",
10932
+ "metadata",
10838
10933
  "createdAt",
10839
10934
  "updatedAt",
10840
10935
  "accessPolicies",
@@ -10917,6 +11012,13 @@ export const state = {
10917
11012
  },
10918
11013
  "description": "The tags of the file as an object of key/value pairs"
10919
11014
  },
11015
+ "metadata": {
11016
+ "type": "object",
11017
+ "additionalProperties": {
11018
+ "nullable": true
11019
+ },
11020
+ "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
11021
+ },
10920
11022
  "createdAt": {
10921
11023
  "type": "string",
10922
11024
  "description": "File creation timestamp in ISO 8601 format"
@@ -10969,6 +11071,7 @@ export const state = {
10969
11071
  "size",
10970
11072
  "contentType",
10971
11073
  "tags",
11074
+ "metadata",
10972
11075
  "createdAt",
10973
11076
  "updatedAt",
10974
11077
  "accessPolicies",
@@ -11004,6 +11107,9 @@ export const state = {
11004
11107
  "schema": {
11005
11108
  "type": "object",
11006
11109
  "properties": {
11110
+ "metadata": {
11111
+ "description": "Custom metadata for the file expressed as an object of key-value pairs. Omit to keep existing metadata intact. Any existing metadata keys not included will be preserved. New keys will be added. To delete a metadata key, set its value to `null`."
11112
+ },
11007
11113
  "tags": {
11008
11114
  "type": "object",
11009
11115
  "additionalProperties": {
@@ -11076,6 +11182,13 @@ export const state = {
11076
11182
  },
11077
11183
  "description": "The tags of the file as an object of key/value pairs"
11078
11184
  },
11185
+ "metadata": {
11186
+ "type": "object",
11187
+ "additionalProperties": {
11188
+ "nullable": true
11189
+ },
11190
+ "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
11191
+ },
11079
11192
  "createdAt": {
11080
11193
  "type": "string",
11081
11194
  "description": "File creation timestamp in ISO 8601 format"
@@ -11128,6 +11241,7 @@ export const state = {
11128
11241
  "size",
11129
11242
  "contentType",
11130
11243
  "tags",
11244
+ "metadata",
11131
11245
  "createdAt",
11132
11246
  "updatedAt",
11133
11247
  "accessPolicies",
@@ -12304,7 +12418,7 @@ export const state = {
12304
12418
  "title": "Botpress API",
12305
12419
  "description": "API for Botpress Cloud",
12306
12420
  "server": "https://api.botpress.cloud",
12307
- "version": "0.48.0",
12421
+ "version": "0.49.0",
12308
12422
  "prefix": "v1"
12309
12423
  },
12310
12424
  "errors": [
@@ -15430,6 +15544,13 @@ export const state = {
15430
15544
  },
15431
15545
  "description": "The tags of the file as an object of key/value pairs"
15432
15546
  },
15547
+ "metadata": {
15548
+ "type": "object",
15549
+ "additionalProperties": {
15550
+ "nullable": true
15551
+ },
15552
+ "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
15553
+ },
15433
15554
  "createdAt": {
15434
15555
  "type": "string",
15435
15556
  "description": "File creation timestamp in ISO 8601 format"
@@ -15482,6 +15603,7 @@ export const state = {
15482
15603
  "size",
15483
15604
  "contentType",
15484
15605
  "tags",
15606
+ "metadata",
15485
15607
  "createdAt",
15486
15608
  "updatedAt",
15487
15609
  "accessPolicies",