@botpress/client 0.35.0 → 0.36.0

package/dist/index.d.ts

@@ -2955,6 +2955,10 @@ interface GetPublicIntegrationByIdResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -3326,6 +3330,10 @@ interface GetPublicIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6277,6 +6285,10 @@ interface CreateIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6931,6 +6943,10 @@ interface UpdateIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -7356,6 +7372,10 @@ interface GetIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -7740,6 +7760,10 @@ interface GetIntegrationByNameResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -8785,6 +8809,7 @@ interface ListInterfacesRequestHeaders {
 }
 interface ListInterfacesRequestQuery {
     nextToken?: string;
+    name?: string;
 }
 interface ListInterfacesRequestParams {
 }
@@ -9056,6 +9081,18 @@ interface UpsertFileRequestBody {
                  * The minimum length a standalone paragraph should have. If a paragraph is shorter than this, it will be merged with the next immediate paragraph.
                  */
                 minimumParagraphLength?: number;
+                /**
+                 * (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.
+                 *
+                 * Notes:
+                 * - This feature is only available in Team and Enterprise plans.
+                 * - 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.
+                 * - 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.
+                 * - 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.
+                 * - 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.
+                 * - 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.
+                 */
+                smartCleanup?: boolean;
             };
             chunking?: {
                 /**
@@ -9073,7 +9110,9 @@ interface UpsertFileRequestBody {
             };
             summarization?: {
                 /**
-                 * 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.
+                 * (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.
+                 *
+                 * Please note that this feature is only available in Team and Enterprise plans.
                  */
                 enable?: boolean;
                 /**
@@ -9093,6 +9132,23 @@ interface UpsertFileRequestBody {
                  */
                 generateMasterSummary?: boolean;
             };
+            vision?: {
+                /**
+                 * (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.
+                 *
+                 * This 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.
+                 *
+                 * Notes:
+                 * - This feature is only available in Team and Enterprise plans.
+                 * - Enabling this feature will incurr in AI Spend cost to use a vision-enabled LLM to index the PDF pages.
+                 * - 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.
+                 * - Pages that are vision-transcribed will not be processed by the default text-based indexing to avoid duplicate content in the index.
+                 * - 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.
+                 */
+                transcribePages?: {
+                    [k: string]: any;
+                };
+            };
         };
     };
     /**
@@ -11523,6 +11579,10 @@ interface Integration {
              * Name of the interface
              */
             name: string;
+            /**
+             * Version of the interface
+             */
+            version: string;
             entities: {
                 [k: string]: {
                     name: string;