@botpress/api 0.49.0 → 0.50.1
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 +35 -26
- package/dist/src/gen/state.d.ts +22 -13
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +35 -26
package/src/gen/state.ts
CHANGED
|
@@ -10541,38 +10541,46 @@ export const state = {
|
|
|
10541
10541
|
"type": "object",
|
|
10542
10542
|
"properties": {
|
|
10543
10543
|
"parsing": {
|
|
10544
|
-
"default": {},
|
|
10545
10544
|
"type": "object",
|
|
10546
10545
|
"properties": {
|
|
10547
10546
|
"minimumParagraphLength": {
|
|
10548
|
-
"default": 500,
|
|
10549
10547
|
"type": "integer",
|
|
10550
10548
|
"minimum": 50,
|
|
10551
|
-
"maximum": 2000
|
|
10549
|
+
"maximum": 2000,
|
|
10550
|
+
"description": "The minimum length a standalone paragraph should have. If a paragraph is shorter than this, it will be merged with the next immediate paragraph."
|
|
10552
10551
|
}
|
|
10553
10552
|
},
|
|
10554
10553
|
"additionalProperties": false
|
|
10555
10554
|
},
|
|
10556
10555
|
"chunking": {
|
|
10557
|
-
"default": {},
|
|
10558
10556
|
"type": "object",
|
|
10559
10557
|
"properties": {
|
|
10560
10558
|
"maximumChunkLength": {
|
|
10561
|
-
"default": 1250,
|
|
10562
10559
|
"type": "integer",
|
|
10563
10560
|
"minimum": 100,
|
|
10564
|
-
"maximum": 5000
|
|
10561
|
+
"maximum": 5000,
|
|
10562
|
+
"description": "The maximum length of a chunk in characters."
|
|
10563
|
+
},
|
|
10564
|
+
"embeddedContextLevels": {
|
|
10565
|
+
"type": "integer",
|
|
10566
|
+
"minimum": 0,
|
|
10567
|
+
"maximum": 3,
|
|
10568
|
+
"description": "The number of surrounding context levels to include in the vector embedding of the chunk."
|
|
10569
|
+
},
|
|
10570
|
+
"embedBreadcrumb": {
|
|
10571
|
+
"type": "boolean",
|
|
10572
|
+
"description": "Include the breadcrumb of the chunk in the vector embedding."
|
|
10565
10573
|
}
|
|
10566
10574
|
},
|
|
10567
10575
|
"additionalProperties": false
|
|
10568
10576
|
},
|
|
10569
10577
|
"summarization": {
|
|
10570
|
-
"default": {},
|
|
10571
10578
|
"type": "object",
|
|
10572
10579
|
"properties": {
|
|
10573
10580
|
"enable": {
|
|
10574
|
-
"default":
|
|
10575
|
-
"type": "boolean"
|
|
10581
|
+
"default": false,
|
|
10582
|
+
"type": "boolean",
|
|
10583
|
+
"description": "Create summaries for this file and index them as standalone vectors. Enabling this option will incur in AI Spend cost (charged to the workspace of the bot) to generate the summaries based on the amount of content in the file and the summarization model used. Please note that this feature is only available in Team/Enterprise plans."
|
|
10576
10584
|
},
|
|
10577
10585
|
"modelType": {
|
|
10578
10586
|
"default": "balanced",
|
|
@@ -10581,23 +10589,24 @@ export const state = {
|
|
|
10581
10589
|
"inexpensive",
|
|
10582
10590
|
"balanced",
|
|
10583
10591
|
"accurate"
|
|
10584
|
-
]
|
|
10592
|
+
],
|
|
10593
|
+
"description": "The model type to use for summarization."
|
|
10585
10594
|
},
|
|
10586
10595
|
"minimumInputLength": {
|
|
10587
|
-
"default": 3000,
|
|
10588
10596
|
"type": "integer",
|
|
10589
10597
|
"minimum": 1000,
|
|
10590
|
-
"maximum": 10000
|
|
10598
|
+
"maximum": 10000,
|
|
10599
|
+
"description": "The minimum length a section of the file should have to create a summary of it."
|
|
10591
10600
|
},
|
|
10592
10601
|
"outputTokenLimit": {
|
|
10593
|
-
"default": 2000,
|
|
10594
10602
|
"type": "integer",
|
|
10595
10603
|
"minimum": 1000,
|
|
10596
|
-
"maximum": 10000
|
|
10604
|
+
"maximum": 10000,
|
|
10605
|
+
"description": "The maximum length of a summary (in tokens)."
|
|
10597
10606
|
},
|
|
10598
10607
|
"generateMasterSummary": {
|
|
10599
|
-
"
|
|
10600
|
-
"
|
|
10608
|
+
"type": "boolean",
|
|
10609
|
+
"description": "Generate a summary of the entire file and index it as a standalone vector."
|
|
10601
10610
|
}
|
|
10602
10611
|
},
|
|
10603
10612
|
"additionalProperties": false
|
|
@@ -10783,7 +10792,7 @@ export const state = {
|
|
|
10783
10792
|
"parameters": {
|
|
10784
10793
|
"id": {
|
|
10785
10794
|
"type": "string",
|
|
10786
|
-
"description": "File ID",
|
|
10795
|
+
"description": "File ID or Key",
|
|
10787
10796
|
"in": "path"
|
|
10788
10797
|
}
|
|
10789
10798
|
},
|
|
@@ -10967,7 +10976,7 @@ export const state = {
|
|
|
10967
10976
|
"parameters": {
|
|
10968
10977
|
"id": {
|
|
10969
10978
|
"type": "string",
|
|
10970
|
-
"description": "File ID",
|
|
10979
|
+
"description": "File ID or Key",
|
|
10971
10980
|
"in": "path"
|
|
10972
10981
|
}
|
|
10973
10982
|
},
|
|
@@ -11098,7 +11107,7 @@ export const state = {
|
|
|
11098
11107
|
"parameters": {
|
|
11099
11108
|
"id": {
|
|
11100
11109
|
"type": "string",
|
|
11101
|
-
"description": "File ID",
|
|
11110
|
+
"description": "File ID or Key",
|
|
11102
11111
|
"in": "path"
|
|
11103
11112
|
}
|
|
11104
11113
|
},
|
|
@@ -11414,7 +11423,7 @@ export const state = {
|
|
|
11414
11423
|
},
|
|
11415
11424
|
"listFilePassages": {
|
|
11416
11425
|
"name": "listFilePassages",
|
|
11417
|
-
"path": "/v1/files/{
|
|
11426
|
+
"path": "/v1/files/{id}/passages",
|
|
11418
11427
|
"description": "List passages for a file",
|
|
11419
11428
|
"method": "get",
|
|
11420
11429
|
"section": "files",
|
|
@@ -11424,15 +11433,15 @@ export const state = {
|
|
|
11424
11433
|
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
11425
11434
|
"type": "string"
|
|
11426
11435
|
},
|
|
11436
|
+
"id": {
|
|
11437
|
+
"type": "string",
|
|
11438
|
+
"description": "File ID or Key",
|
|
11439
|
+
"in": "path"
|
|
11440
|
+
},
|
|
11427
11441
|
"limit": {
|
|
11428
11442
|
"type": "number",
|
|
11429
11443
|
"description": "The maximum number of passages to return per request (optional, default: 20, max: 200).",
|
|
11430
11444
|
"in": "query"
|
|
11431
|
-
},
|
|
11432
|
-
"fileId": {
|
|
11433
|
-
"type": "string",
|
|
11434
|
-
"description": "File ID",
|
|
11435
|
-
"in": "path"
|
|
11436
11445
|
}
|
|
11437
11446
|
},
|
|
11438
11447
|
"response": {
|
|
@@ -12418,7 +12427,7 @@ export const state = {
|
|
|
12418
12427
|
"title": "Botpress API",
|
|
12419
12428
|
"description": "API for Botpress Cloud",
|
|
12420
12429
|
"server": "https://api.botpress.cloud",
|
|
12421
|
-
"version": "0.
|
|
12430
|
+
"version": "0.50.1",
|
|
12422
12431
|
"prefix": "v1"
|
|
12423
12432
|
},
|
|
12424
12433
|
"errors": [
|