@botpress/api 0.53.0 → 0.55.0

package/src/gen/state.ts

@@ -11253,7 +11253,10 @@ export const state = {
                       "type": "object",
                       "properties": {
                         "transcribePages": {
-                          "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."
+                          "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."
+                        },
+                        "indexPages": {
+                          "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."
                         }
                       },
                       "additionalProperties": false
@@ -11981,7 +11984,8 @@ export const state = {
                         "enum": [
                           "chunk",
                           "summary",
-                          "consolidated"
+                          "consolidated",
+                          "image"
                         ],
                         "description": "The type of passage"
                       },
@@ -11991,10 +11995,11 @@ export const state = {
                           "title",
                           "subtitle",
                           "paragraph",
-                          "list",
                           "blockquote",
+                          "list",
                           "table",
-                          "code"
+                          "code",
+                          "page"
                         ],
                         "description": "The subtype of passage, if available."
                       },
@@ -12005,6 +12010,11 @@ export const state = {
                       "position": {
                         "type": "integer",
                         "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."
+                      },
+                      "sourceUrl": {
+                        "type": "string",
+                        "format": "uri",
+                        "description": "The URL of the source file for the vector, if applicable (e.g. for image vectors)."
                       }
                     },
                     "description": "The passage metadata."
@@ -12117,7 +12127,8 @@ export const state = {
                         "enum": [
                           "chunk",
                           "summary",
-                          "consolidated"
+                          "consolidated",
+                          "image"
                         ],
                         "description": "The type of passage"
                       },
@@ -12127,10 +12138,11 @@ export const state = {
                           "title",
                           "subtitle",
                           "paragraph",
-                          "list",
                           "blockquote",
+                          "list",
                           "table",
-                          "code"
+                          "code",
+                          "page"
                         ],
                         "description": "The subtype of passage, if available."
                       },
@@ -12141,6 +12153,11 @@ export const state = {
                       "position": {
                         "type": "integer",
                         "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."
+                      },
+                      "sourceUrl": {
+                        "type": "string",
+                        "format": "uri",
+                        "description": "The URL of the source file for the vector, if applicable (e.g. for image vectors)."
                       }
                     },
                     "description": "The passage metadata."
@@ -12473,6 +12490,316 @@ export const state = {
         }
       }
     },
+    "exportTable": {
+      "name": "exportTable",
+      "path": "/v1/tables/{table}/export",
+      "description": "Starts an export job for the table",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's unique identifier",
+          "in": "path"
+        },
+        "format": {
+          "in": "query",
+          "type": "object",
+          "description": "The format of the exported file. CSV includes only the data while JSON includes the schema.",
+          "schema": {
+            "type": "string",
+            "enum": [
+              "csv",
+              "json"
+            ]
+          }
+        },
+        "compress": {
+          "in": "query",
+          "type": "object",
+          "description": "Whether or not the export is compressed (gzipped).",
+          "schema": {
+            "default": true,
+            "type": "boolean"
+          }
+        }
+      },
+      "method": "get",
+      "section": "tables",
+      "response": {
+        "description": "The export job",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "job": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "botId": {
+                  "type": "string"
+                },
+                "tableId": {
+                  "type": "string"
+                },
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "export",
+                    "import"
+                  ]
+                },
+                "status": {
+                  "type": "string",
+                  "enum": [
+                    "pending",
+                    "in_progress",
+                    "finalizing",
+                    "completed",
+                    "failed"
+                  ]
+                },
+                "progress": {
+                  "default": 0,
+                  "type": "number"
+                },
+                "inputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "outputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "createdAt": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "updatedAt": {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "tableId",
+                "type",
+                "status",
+                "inputFileId",
+                "outputFileId",
+                "createdAt",
+                "updatedAt"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "job"
+          ],
+          "title": "exportTableResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "getTableJobs": {
+      "name": "getTableJobs",
+      "path": "/v1/tables/{table}/jobs",
+      "description": "Returns a list of recent jobs for the table (export/import operations)",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's unique identifier",
+          "in": "path"
+        }
+      },
+      "method": "get",
+      "section": "tables",
+      "response": {
+        "description": "The most recent jobs",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "jobs": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "botId": {
+                    "type": "string"
+                  },
+                  "tableId": {
+                    "type": "string"
+                  },
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "export",
+                      "import"
+                    ]
+                  },
+                  "status": {
+                    "type": "string",
+                    "enum": [
+                      "pending",
+                      "in_progress",
+                      "finalizing",
+                      "completed",
+                      "failed"
+                    ]
+                  },
+                  "progress": {
+                    "default": 0,
+                    "type": "number"
+                  },
+                  "inputFileId": {
+                    "type": "string",
+                    "nullable": true
+                  },
+                  "outputFileId": {
+                    "type": "string",
+                    "nullable": true
+                  },
+                  "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                  },
+                  "updatedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "id",
+                  "botId",
+                  "tableId",
+                  "type",
+                  "status",
+                  "inputFileId",
+                  "outputFileId",
+                  "createdAt",
+                  "updatedAt"
+                ]
+              }
+            }
+          },
+          "required": [
+            "jobs"
+          ],
+          "title": "getTableJobsResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "importTable": {
+      "name": "importTable",
+      "path": "/v1/tables/{table}/import",
+      "description": "Import the content of a file into a table. The table must already have been created with the correct schema. Data already in the table will be kept.",
+      "method": "post",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's name or unique identifier for targeting specific table operations.",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Content to import",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "fileId": {
+              "type": "string",
+              "description": "The file ID to import. It must have been uploaded to the Files API before. Supported formats: CSV, JSON (gzipped or not)"
+            }
+          },
+          "required": [
+            "fileId"
+          ],
+          "title": "importTableBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "tables",
+      "response": {
+        "description": "The import job",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "job": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "botId": {
+                  "type": "string"
+                },
+                "tableId": {
+                  "type": "string"
+                },
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "export",
+                    "import"
+                  ]
+                },
+                "status": {
+                  "type": "string",
+                  "enum": [
+                    "pending",
+                    "in_progress",
+                    "finalizing",
+                    "completed",
+                    "failed"
+                  ]
+                },
+                "progress": {
+                  "default": 0,
+                  "type": "number"
+                },
+                "inputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "outputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "createdAt": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "updatedAt": {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "tableId",
+                "type",
+                "status",
+                "inputFileId",
+                "outputFileId",
+                "createdAt",
+                "updatedAt"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "job"
+          ],
+          "title": "importTableResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "updateTable": {
       "name": "updateTable",
       "path": "/v1/tables/{table}",
@@ -13074,7 +13401,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.53.0",
+    "version": "0.55.0",
     "prefix": "v1"
   },
   "errors": [
@@ -13255,6 +13582,7 @@ export const state = {
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
+      "importTableBody": true,
       "updateTableBody": true,
       "renameTableColumnBody": true,
       "findTableRowsBody": true,
@@ -13400,6 +13728,9 @@ export const state = {
       "getOrCreateTableResponse": true,
       "createTableResponse": true,
       "duplicateTableResponse": true,
+      "exportTableResponse": true,
+      "getTableJobsResponse": true,
+      "importTableResponse": true,
       "updateTableResponse": true,
       "renameTableColumnResponse": true,
       "deleteTableResponse": true,
@@ -16206,7 +16537,6 @@ export const state = {
               }
             },
             "required": [
-              "$schema",
               "properties",
               "additionalProperties",
               "type"
@@ -16795,6 +17125,9 @@ export const state = {
         "getOrCreateTable",
         "createTable",
         "duplicateTable",
+        "exportTable",
+        "getTableJobs",
+        "importTable",
         "updateTable",
         "renameTableColumn",
         "deleteTable",