@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/dist/index.js CHANGED
@@ -286447,6 +286447,14 @@ var state = {
286447
286447
  },
286448
286448
  "additionalProperties": false
286449
286449
  },
286450
+ "tags": {
286451
+ "type": "object",
286452
+ "additionalProperties": {
286453
+ "type": "string",
286454
+ "maxLength": 500
286455
+ },
286456
+ "description": "Tags of the [Bot](#schema_bot)"
286457
+ },
286450
286458
  "code": {
286451
286459
  "type": "string",
286452
286460
  "description": "JavaScript code of the bot"
@@ -286551,6 +286559,14 @@ var state = {
286551
286559
  },
286552
286560
  "additionalProperties": false
286553
286561
  },
286562
+ "tags": {
286563
+ "type": "object",
286564
+ "additionalProperties": {
286565
+ "type": "string",
286566
+ "maxLength": 500
286567
+ },
286568
+ "description": "Tags of the [Bot](#schema_bot)"
286569
+ },
286554
286570
  "blocked": {
286555
286571
  "type": "boolean"
286556
286572
  },
@@ -292990,7 +293006,10 @@ var state = {
292990
293006
  "type": "object",
292991
293007
  "properties": {
292992
293008
  "transcribePages": {
292993
- "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."
293009
+ "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."
293010
+ },
293011
+ "indexPages": {
293012
+ "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."
292994
293013
  }
292995
293014
  },
292996
293015
  "additionalProperties": false
@@ -293718,7 +293737,8 @@ var state = {
293718
293737
  "enum": [
293719
293738
  "chunk",
293720
293739
  "summary",
293721
- "consolidated"
293740
+ "consolidated",
293741
+ "image"
293722
293742
  ],
293723
293743
  "description": "The type of passage"
293724
293744
  },
@@ -293728,10 +293748,11 @@ var state = {
293728
293748
  "title",
293729
293749
  "subtitle",
293730
293750
  "paragraph",
293731
- "list",
293732
293751
  "blockquote",
293752
+ "list",
293733
293753
  "table",
293734
- "code"
293754
+ "code",
293755
+ "page"
293735
293756
  ],
293736
293757
  "description": "The subtype of passage, if available."
293737
293758
  },
@@ -293742,6 +293763,11 @@ var state = {
293742
293763
  "position": {
293743
293764
  "type": "integer",
293744
293765
  "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."
293766
+ },
293767
+ "sourceUrl": {
293768
+ "type": "string",
293769
+ "format": "uri",
293770
+ "description": "The URL of the source file for the vector, if applicable (e.g. for image vectors)."
293745
293771
  }
293746
293772
  },
293747
293773
  "description": "The passage metadata."
@@ -293854,7 +293880,8 @@ var state = {
293854
293880
  "enum": [
293855
293881
  "chunk",
293856
293882
  "summary",
293857
- "consolidated"
293883
+ "consolidated",
293884
+ "image"
293858
293885
  ],
293859
293886
  "description": "The type of passage"
293860
293887
  },
@@ -293864,10 +293891,11 @@ var state = {
293864
293891
  "title",
293865
293892
  "subtitle",
293866
293893
  "paragraph",
293867
- "list",
293868
293894
  "blockquote",
293895
+ "list",
293869
293896
  "table",
293870
- "code"
293897
+ "code",
293898
+ "page"
293871
293899
  ],
293872
293900
  "description": "The subtype of passage, if available."
293873
293901
  },
@@ -293878,6 +293906,11 @@ var state = {
293878
293906
  "position": {
293879
293907
  "type": "integer",
293880
293908
  "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."
293909
+ },
293910
+ "sourceUrl": {
293911
+ "type": "string",
293912
+ "format": "uri",
293913
+ "description": "The URL of the source file for the vector, if applicable (e.g. for image vectors)."
293881
293914
  }
293882
293915
  },
293883
293916
  "description": "The passage metadata."
@@ -295121,7 +295154,7 @@ var state = {
295121
295154
  "title": "Botpress API",
295122
295155
  "description": "API for Botpress Cloud",
295123
295156
  "server": "https://api.botpress.cloud",
295124
- "version": "0.54.0",
295157
+ "version": "0.56.0",
295125
295158
  "prefix": "v1"
295126
295159
  },
295127
295160
  "errors": [
@@ -295935,6 +295968,13 @@ var state = {
295935
295968
  },
295936
295969
  "description": "Actions definition"
295937
295970
  },
295971
+ "tags": {
295972
+ "type": "object",
295973
+ "additionalProperties": {
295974
+ "type": "string"
295975
+ },
295976
+ "description": "Tags of [Bot](#schema_bot)"
295977
+ },
295938
295978
  "name": {
295939
295979
  "type": "string",
295940
295980
  "description": "Name of the [Bot](#schema_bot)"
@@ -296001,6 +296041,7 @@ var state = {
296001
296041
  "recurringEvents",
296002
296042
  "subscriptions",
296003
296043
  "actions",
296044
+ "tags",
296004
296045
  "name",
296005
296046
  "dev",
296006
296047
  "alwaysAlive",
package/dist/src/gen/state.d.ts CHANGED
@@ -4181,6 +4181,14 @@ export declare const state: {
4181
4181
  };
4182
4182
  additionalProperties: false;
4183
4183
  };
4184
+ tags: {
4185
+ type: "object";
4186
+ additionalProperties: {
4187
+ type: "string";
4188
+ maxLength: number;
4189
+ };
4190
+ description: string;
4191
+ };
4184
4192
  code: {
4185
4193
  type: "string";
4186
4194
  description: string;
@@ -4278,6 +4286,14 @@ export declare const state: {
4278
4286
  };
4279
4287
  additionalProperties: false;
4280
4288
  };
4289
+ tags: {
4290
+ type: "object";
4291
+ additionalProperties: {
4292
+ type: "string";
4293
+ maxLength: number;
4294
+ };
4295
+ description: string;
4296
+ };
4281
4297
  blocked: {
4282
4298
  type: "boolean";
4283
4299
  };
@@ -9905,6 +9921,9 @@ export declare const state: {
9905
9921
  transcribePages: {
9906
9922
  description: string;
9907
9923
  };
9924
+ indexPages: {
9925
+ description: string;
9926
+ };
9908
9927
  };
9909
9928
  additionalProperties: false;
9910
9929
  };
@@ -10527,6 +10546,11 @@ export declare const state: {
10527
10546
  type: "integer";
10528
10547
  description: string;
10529
10548
  };
10549
+ sourceUrl: {
10550
+ type: "string";
10551
+ format: string;
10552
+ description: string;
10553
+ };
10530
10554
  };
10531
10555
  description: string;
10532
10556
  };
@@ -10637,6 +10661,11 @@ export declare const state: {
10637
10661
  type: "integer";
10638
10662
  description: string;
10639
10663
  };
10664
+ sourceUrl: {
10665
+ type: "string";
10666
+ format: string;
10667
+ description: string;
10668
+ };
10640
10669
  };
10641
10670
  description: string;
10642
10671
  };
@@ -12418,6 +12447,13 @@ export declare const state: {
12418
12447
  };
12419
12448
  description: string;
12420
12449
  };
12450
+ tags: {
12451
+ type: "object";
12452
+ additionalProperties: {
12453
+ type: "string";
12454
+ };
12455
+ description: string;
12456
+ };
12421
12457
  name: {
12422
12458
  type: "string";
12423
12459
  description: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.54.0",
3
+ "version": "0.56.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {