@botpress/api 0.48.1 → 0.50.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 +134 -10
  2. package/dist/src/gen/state.d.ts +118 -5
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +134 -10
package/src/gen/state.ts CHANGED
@@ -10534,6 +10534,84 @@ export const state = {
10534
10534
  "type": "boolean",
10535
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."
10536
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": false,
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
+ },
10537
10615
  "accessPolicies": {
10538
10616
  "type": "array",
10539
10617
  "items": {
@@ -10557,6 +10635,9 @@ export const state = {
10557
10635
  "publicContentImmediatelyAccessible": {
10558
10636
  "type": "boolean",
10559
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."
10560
10641
  }
10561
10642
  },
10562
10643
  "required": [
@@ -10610,6 +10691,13 @@ export const state = {
10610
10691
  },
10611
10692
  "description": "The tags of the file as an object of key/value pairs"
10612
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
+ },
10613
10701
  "createdAt": {
10614
10702
  "type": "string",
10615
10703
  "description": "File creation timestamp in ISO 8601 format"
@@ -10666,6 +10754,7 @@ export const state = {
10666
10754
  "size",
10667
10755
  "contentType",
10668
10756
  "tags",
10757
+ "metadata",
10669
10758
  "createdAt",
10670
10759
  "updatedAt",
10671
10760
  "accessPolicies",
@@ -10694,7 +10783,7 @@ export const state = {
10694
10783
  "parameters": {
10695
10784
  "id": {
10696
10785
  "type": "string",
10697
- "description": "File ID",
10786
+ "description": "File ID or Key",
10698
10787
  "in": "path"
10699
10788
  }
10700
10789
  },
@@ -10781,6 +10870,13 @@ export const state = {
10781
10870
  },
10782
10871
  "description": "The tags of the file as an object of key/value pairs"
10783
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
+ },
10784
10880
  "createdAt": {
10785
10881
  "type": "string",
10786
10882
  "description": "File creation timestamp in ISO 8601 format"
@@ -10833,6 +10929,7 @@ export const state = {
10833
10929
  "size",
10834
10930
  "contentType",
10835
10931
  "tags",
10932
+ "metadata",
10836
10933
  "createdAt",
10837
10934
  "updatedAt",
10838
10935
  "accessPolicies",
@@ -10870,7 +10967,7 @@ export const state = {
10870
10967
  "parameters": {
10871
10968
  "id": {
10872
10969
  "type": "string",
10873
- "description": "File ID",
10970
+ "description": "File ID or Key",
10874
10971
  "in": "path"
10875
10972
  }
10876
10973
  },
@@ -10915,6 +11012,13 @@ export const state = {
10915
11012
  },
10916
11013
  "description": "The tags of the file as an object of key/value pairs"
10917
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
+ },
10918
11022
  "createdAt": {
10919
11023
  "type": "string",
10920
11024
  "description": "File creation timestamp in ISO 8601 format"
@@ -10967,6 +11071,7 @@ export const state = {
10967
11071
  "size",
10968
11072
  "contentType",
10969
11073
  "tags",
11074
+ "metadata",
10970
11075
  "createdAt",
10971
11076
  "updatedAt",
10972
11077
  "accessPolicies",
@@ -10993,7 +11098,7 @@ export const state = {
10993
11098
  "parameters": {
10994
11099
  "id": {
10995
11100
  "type": "string",
10996
- "description": "File ID",
11101
+ "description": "File ID or Key",
10997
11102
  "in": "path"
10998
11103
  }
10999
11104
  },
@@ -11002,6 +11107,9 @@ export const state = {
11002
11107
  "schema": {
11003
11108
  "type": "object",
11004
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
+ },
11005
11113
  "tags": {
11006
11114
  "type": "object",
11007
11115
  "additionalProperties": {
@@ -11074,6 +11182,13 @@ export const state = {
11074
11182
  },
11075
11183
  "description": "The tags of the file as an object of key/value pairs"
11076
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
+ },
11077
11192
  "createdAt": {
11078
11193
  "type": "string",
11079
11194
  "description": "File creation timestamp in ISO 8601 format"
@@ -11126,6 +11241,7 @@ export const state = {
11126
11241
  "size",
11127
11242
  "contentType",
11128
11243
  "tags",
11244
+ "metadata",
11129
11245
  "createdAt",
11130
11246
  "updatedAt",
11131
11247
  "accessPolicies",
@@ -11298,7 +11414,7 @@ export const state = {
11298
11414
  },
11299
11415
  "listFilePassages": {
11300
11416
  "name": "listFilePassages",
11301
- "path": "/v1/files/{fileId}/passages",
11417
+ "path": "/v1/files/{id}/passages",
11302
11418
  "description": "List passages for a file",
11303
11419
  "method": "get",
11304
11420
  "section": "files",
@@ -11308,15 +11424,15 @@ export const state = {
11308
11424
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
11309
11425
  "type": "string"
11310
11426
  },
11427
+ "id": {
11428
+ "type": "string",
11429
+ "description": "File ID or Key",
11430
+ "in": "path"
11431
+ },
11311
11432
  "limit": {
11312
11433
  "type": "number",
11313
11434
  "description": "The maximum number of passages to return per request (optional, default: 20, max: 200).",
11314
11435
  "in": "query"
11315
- },
11316
- "fileId": {
11317
- "type": "string",
11318
- "description": "File ID",
11319
- "in": "path"
11320
11436
  }
11321
11437
  },
11322
11438
  "response": {
@@ -12302,7 +12418,7 @@ export const state = {
12302
12418
  "title": "Botpress API",
12303
12419
  "description": "API for Botpress Cloud",
12304
12420
  "server": "https://api.botpress.cloud",
12305
- "version": "0.48.1",
12421
+ "version": "0.50.0",
12306
12422
  "prefix": "v1"
12307
12423
  },
12308
12424
  "errors": [
@@ -15428,6 +15544,13 @@ export const state = {
15428
15544
  },
15429
15545
  "description": "The tags of the file as an object of key/value pairs"
15430
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
+ },
15431
15554
  "createdAt": {
15432
15555
  "type": "string",
15433
15556
  "description": "File creation timestamp in ISO 8601 format"
@@ -15480,6 +15603,7 @@ export const state = {
15480
15603
  "size",
15481
15604
  "contentType",
15482
15605
  "tags",
15606
+ "metadata",
15483
15607
  "createdAt",
15484
15608
  "updatedAt",
15485
15609
  "accessPolicies",