@botpress/api 0.50.1 → 0.50.2

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 CHANGED
@@ -292285,6 +292285,10 @@ var state = {
292285
292285
  "minimum": 50,
292286
292286
  "maximum": 2e3,
292287
292287
  "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."
292288
+ },
292289
+ "smartCleanup": {
292290
+ "type": "boolean",
292291
+ "description": "(Team/Enterprise plan only, charged as AI Spend) Enabling this will use a lightweight/inexpensive LLM to clean up the extracted content of PDF files before indexing them to increase the quality of the stored vectors, as PDFs often store raw text in unusual ways which when extracted may result in formatting issues (e.g. broken sentences/paragraphs, unexpected headings, garbled characters, etc.) that can affect retrieval performance for certain user queries if left untouched.\n\nNotes:\n- This feature is only available in Team and Enterprise plans.\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.\n- We recommend using this feature for PDFs that have custom layouts or design. For simple text-based PDFs like documents and books, this feature is usually not necessary.\n- The smart cleanup takes some time to perform due to the LLM calls involved, so enabling it will increase the total time it takes to index the file.\n- We take steps to prevent the original text from being fundamentally changed but due to the nature of LLMs this could theoretically still happen so it's recommended to review the passages generated for the file after indexing to ensure the content is still accurate.\n- This feature is limited to the first 30 pages or 20 KB of text in the PDF file (whichever comes first). If the file has more content than these limits then the rest of the file will be indexed as-is without any cleanup. If you need to clean up the content of the entire file, consider splitting it into smaller files."
292288
292292
  }
292289
292293
  },
292290
292294
  "additionalProperties": false
@@ -292317,7 +292321,7 @@ var state = {
292317
292321
  "enable": {
292318
292322
  "default": false,
292319
292323
  "type": "boolean",
292320
- "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."
292324
+ "description": "(Team/Enterprise plan only, charged as AI Spend) 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.\n\nPlease note that this feature is only available in Team and Enterprise plans."
292321
292325
  },
292322
292326
  "modelType": {
292323
292327
  "default": "balanced",
@@ -294164,7 +294168,7 @@ var state = {
294164
294168
  "title": "Botpress API",
294165
294169
  "description": "API for Botpress Cloud",
294166
294170
  "server": "https://api.botpress.cloud",
294167
- "version": "0.50.1",
294171
+ "version": "0.50.2",
294168
294172
  "prefix": "v1"
294169
294173
  },
294170
294174
  "errors": [
@@ -9272,6 +9272,10 @@ export declare const state: {
9272
9272
  maximum: number;
9273
9273
  description: string;
9274
9274
  };
9275
+ smartCleanup: {
9276
+ type: "boolean";
9277
+ description: string;
9278
+ };
9275
9279
  };
9276
9280
  additionalProperties: false;
9277
9281
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.50.1",
3
+ "version": "0.50.2",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {