@botpress/api 0.54.0 → 0.56.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 +49 -8
  2. package/dist/src/gen/state.d.ts +36 -0
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +49 -8
package/src/gen/state.ts CHANGED
@@ -4710,6 +4710,14 @@ export const state = {
4710
4710
  },
4711
4711
  "additionalProperties": false
4712
4712
  },
4713
+ "tags": {
4714
+ "type": "object",
4715
+ "additionalProperties": {
4716
+ "type": "string",
4717
+ "maxLength": 500
4718
+ },
4719
+ "description": "Tags of the [Bot](#schema_bot)"
4720
+ },
4713
4721
  "code": {
4714
4722
  "type": "string",
4715
4723
  "description": "JavaScript code of the bot"
@@ -4814,6 +4822,14 @@ export const state = {
4814
4822
  },
4815
4823
  "additionalProperties": false
4816
4824
  },
4825
+ "tags": {
4826
+ "type": "object",
4827
+ "additionalProperties": {
4828
+ "type": "string",
4829
+ "maxLength": 500
4830
+ },
4831
+ "description": "Tags of the [Bot](#schema_bot)"
4832
+ },
4817
4833
  "blocked": {
4818
4834
  "type": "boolean"
4819
4835
  },
@@ -11253,7 +11269,10 @@ export const state = {
11253
11269
  "type": "object",
11254
11270
  "properties": {
11255
11271
  "transcribePages": {
11256
- "description": "(Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.\n\nThis feature is useful when a PDF file contains custom designs or layouts, or when your document has many infographics, which require visual processing in order to index the file effectively, as the default text-based indexing may not be enough to allow your bot to correctly understand the content in your PDFs.\n\nNotes:\n- This feature is only available in Team and Enterprise plans.\n- Enabling this feature will incurr in AI Spend cost to use a vision-enabled LLM to index the PDF pages.\n- This is limited to a maximum of 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be transcribed using this vision feature, and will be processed using the default text-based indexing instead. If you need to transcribe the entire file using vision, please split it into smaller files.\n- Pages that are vision-transcribed will not be processed by the default text-based indexing to avoid duplicate content in the index.\n- This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred."
11272
+ "description": "(Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.\n\nThis feature is useful when a PDF file contains custom designs or layouts, or when your document has many infographics, which require visual processing in order to index the file effectively, as the default text-based indexing may not be enough to allow your bot to correctly understand the content in your PDFs.\n\nNotes:\n- This feature is only available in Team and Enterprise plans.\n- Enabling this feature will incur in AI Spend cost to use a vision-enabled LLM to index the PDF pages.\n- This is limited to a maximum of 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be transcribed using this vision feature, and will be processed using the default text-based indexing instead. If you need to transcribe the entire file using vision, please split it into smaller files.\n- Pages that are vision-transcribed will not be processed by the default text-based indexing to avoid duplicate content in the index.\n- This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred."
11273
+ },
11274
+ "indexPages": {
11275
+ "description": "(Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to index each page of the PDF as a standalone image.\n\nEnabling this feature will allow Autonomous Nodes in your bot to answer visual or higher-level questions about the content in these pages that can usually not be answered correctly by the default text-based indexing or visual transcription.\n\nThis feature is useful when a PDF has:\n- Tables with complex layouts\n- Charts, diagrams or infographics\n- Photos or images that can be used to answer user queries\n\nNotes:\n- This feature is only available in Team and Enterprise plans.\n- Enabling this will incur in extra AI Spend cost and additional File Storage usage, in order to use a vision-enabled LLM to visually index the PDF pages and store them as standalone page images in the bot's file storage.\n- Enabling this may increase the overall AI Spend cost of your bot as your bot may pass one or more indexed page images to a vision-enabled LLM for answering user queries.\n- This is limited to the first 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be vision-indexed. If you need to visually index the entire file, please split it into smaller files.\n- This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred."
11257
11276
  }
11258
11277
  },
11259
11278
  "additionalProperties": false
@@ -11981,7 +12000,8 @@ export const state = {
11981
12000
  "enum": [
11982
12001
  "chunk",
11983
12002
  "summary",
11984
- "consolidated"
12003
+ "consolidated",
12004
+ "image"
11985
12005
  ],
11986
12006
  "description": "The type of passage"
11987
12007
  },
@@ -11991,10 +12011,11 @@ export const state = {
11991
12011
  "title",
11992
12012
  "subtitle",
11993
12013
  "paragraph",
11994
- "list",
11995
12014
  "blockquote",
12015
+ "list",
11996
12016
  "table",
11997
- "code"
12017
+ "code",
12018
+ "page"
11998
12019
  ],
11999
12020
  "description": "The subtype of passage, if available."
12000
12021
  },
@@ -12005,6 +12026,11 @@ export const state = {
12005
12026
  "position": {
12006
12027
  "type": "integer",
12007
12028
  "description": "Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file."
12029
+ },
12030
+ "sourceUrl": {
12031
+ "type": "string",
12032
+ "format": "uri",
12033
+ "description": "The URL of the source file for the vector, if applicable (e.g. for image vectors)."
12008
12034
  }
12009
12035
  },
12010
12036
  "description": "The passage metadata."
@@ -12117,7 +12143,8 @@ export const state = {
12117
12143
  "enum": [
12118
12144
  "chunk",
12119
12145
  "summary",
12120
- "consolidated"
12146
+ "consolidated",
12147
+ "image"
12121
12148
  ],
12122
12149
  "description": "The type of passage"
12123
12150
  },
@@ -12127,10 +12154,11 @@ export const state = {
12127
12154
  "title",
12128
12155
  "subtitle",
12129
12156
  "paragraph",
12130
- "list",
12131
12157
  "blockquote",
12158
+ "list",
12132
12159
  "table",
12133
- "code"
12160
+ "code",
12161
+ "page"
12134
12162
  ],
12135
12163
  "description": "The subtype of passage, if available."
12136
12164
  },
@@ -12141,6 +12169,11 @@ export const state = {
12141
12169
  "position": {
12142
12170
  "type": "integer",
12143
12171
  "description": "Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file."
12172
+ },
12173
+ "sourceUrl": {
12174
+ "type": "string",
12175
+ "format": "uri",
12176
+ "description": "The URL of the source file for the vector, if applicable (e.g. for image vectors)."
12144
12177
  }
12145
12178
  },
12146
12179
  "description": "The passage metadata."
@@ -13384,7 +13417,7 @@ export const state = {
13384
13417
  "title": "Botpress API",
13385
13418
  "description": "API for Botpress Cloud",
13386
13419
  "server": "https://api.botpress.cloud",
13387
- "version": "0.54.0",
13420
+ "version": "0.56.0",
13388
13421
  "prefix": "v1"
13389
13422
  },
13390
13423
  "errors": [
@@ -14198,6 +14231,13 @@ export const state = {
14198
14231
  },
14199
14232
  "description": "Actions definition"
14200
14233
  },
14234
+ "tags": {
14235
+ "type": "object",
14236
+ "additionalProperties": {
14237
+ "type": "string"
14238
+ },
14239
+ "description": "Tags of [Bot](#schema_bot)"
14240
+ },
14201
14241
  "name": {
14202
14242
  "type": "string",
14203
14243
  "description": "Name of the [Bot](#schema_bot)"
@@ -14264,6 +14304,7 @@ export const state = {
14264
14304
  "recurringEvents",
14265
14305
  "subscriptions",
14266
14306
  "actions",
14307
+ "tags",
14267
14308
  "name",
14268
14309
  "dev",
14269
14310
  "alwaysAlive",