@botpress/api 1.13.1 → 1.14.0

package/dist/index.js

@@ -284126,7 +284126,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.13.1",
+    "version": "1.14.0",
     "prefix": "v1"
   },
   "errors": [
@@ -300687,7 +300687,7 @@ var state2 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.13.1",
+    "version": "1.14.0",
     "prefix": "v1"
   },
   "errors": [
@@ -305830,6 +305830,76 @@ var state3 = {
         }
       }
     },
+    "setFilePassages": {
+      "name": "setFilePassages",
+      "path": "/v1/files/{id}/passages",
+      "description": 'Sets the indexed file passages asynchronously. All existing indexed passages will be deleted as soon as the indexing begins. This endpoint will return immediately and set the file status to "indexing_pending". Once the new passages are indexed the file status will be set to "indexing_completed", or "indexing_failed" if the passages failed to be indexed.',
+      "method": "put",
+      "section": "files",
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "File ID or Key",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "List of passages to index for the file. These will replacing all the existing passages. Indexing of the new passages will be done asynchronously in the background. You can check the file status to see when the indexing is complete.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "passages": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "content": {
+                    "type": "string",
+                    "description": "The content of the passage, supports Markdown formatting."
+                  },
+                  "type": {
+                    "default": "paragraph",
+                    "type": "string",
+                    "enum": [
+                      "title",
+                      "subtitle",
+                      "paragraph",
+                      "blockquote",
+                      "list",
+                      "table",
+                      "code",
+                      "image"
+                    ],
+                    "description": "The type should match the Markdown format used for the passage content."
+                  },
+                  "pageNumber": {
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "content"
+                ]
+              },
+              "description": "Note: The passages should appear in the array in the same order as they appear in the original document."
+            }
+          },
+          "required": [
+            "passages"
+          ],
+          "title": "setFilePassagesBody",
+          "additionalProperties": false
+        }
+      },
+      "contentType": "application/json",
+      "response": {
+        "description": "Empty response.",
+        "schema": {
+          "type": "object",
+          "title": "setFilePassagesResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listFileTags": {
       "name": "listFileTags",
       "path": "/v1/files/tags",
@@ -306133,7 +306203,7 @@ var state3 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.13.1",
+    "version": "1.14.0",
     "prefix": "v1"
   },
   "errors": [
@@ -306264,6 +306334,7 @@ var state3 = {
       "upsertFileBody": true,
       "updateFileMetadataBody": true,
       "copyFileBody": true,
+      "setFilePassagesBody": true,
       "createKnowledgeBaseBody": true,
       "updateKnowledgeBaseBody": true
     },
@@ -306276,6 +306347,7 @@ var state3 = {
       "copyFileResponse": true,
       "searchFilesResponse": true,
       "listFilePassagesResponse": true,
+      "setFilePassagesResponse": true,
       "listFileTagsResponse": true,
       "listFileTagValuesResponse": true,
       "createKnowledgeBaseResponse": true,
@@ -309787,6 +309859,7 @@ var state3 = {
         "copyFile",
         "searchFiles",
         "listFilePassages",
+        "setFilePassages",
         "listFileTags",
         "listFileTagValues",
         "createKnowledgeBase",
@@ -311020,7 +311093,7 @@ var state4 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.13.1",
+    "version": "1.14.0",
     "prefix": "v1"
   },
   "errors": [
@@ -331366,6 +331439,76 @@ var state5 = {
         }
       }
     },
+    "setFilePassages": {
+      "name": "setFilePassages",
+      "path": "/v1/files/{id}/passages",
+      "description": 'Sets the indexed file passages asynchronously. All existing indexed passages will be deleted as soon as the indexing begins. This endpoint will return immediately and set the file status to "indexing_pending". Once the new passages are indexed the file status will be set to "indexing_completed", or "indexing_failed" if the passages failed to be indexed.',
+      "method": "put",
+      "section": "files",
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "File ID or Key",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "List of passages to index for the file. These will replacing all the existing passages. Indexing of the new passages will be done asynchronously in the background. You can check the file status to see when the indexing is complete.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "passages": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "content": {
+                    "type": "string",
+                    "description": "The content of the passage, supports Markdown formatting."
+                  },
+                  "type": {
+                    "default": "paragraph",
+                    "type": "string",
+                    "enum": [
+                      "title",
+                      "subtitle",
+                      "paragraph",
+                      "blockquote",
+                      "list",
+                      "table",
+                      "code",
+                      "image"
+                    ],
+                    "description": "The type should match the Markdown format used for the passage content."
+                  },
+                  "pageNumber": {
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "content"
+                ]
+              },
+              "description": "Note: The passages should appear in the array in the same order as they appear in the original document."
+            }
+          },
+          "required": [
+            "passages"
+          ],
+          "title": "setFilePassagesBody",
+          "additionalProperties": false
+        }
+      },
+      "contentType": "application/json",
+      "response": {
+        "description": "Empty response.",
+        "schema": {
+          "type": "object",
+          "title": "setFilePassagesResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listFileTags": {
       "name": "listFileTags",
       "path": "/v1/files/tags",
@@ -332875,7 +333018,7 @@ var state5 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.13.1",
+    "version": "1.14.0",
     "prefix": "v1"
   },
   "errors": [
@@ -333058,6 +333201,7 @@ var state5 = {
       "upsertFileBody": true,
       "updateFileMetadataBody": true,
       "copyFileBody": true,
+      "setFilePassagesBody": true,
       "createKnowledgeBaseBody": true,
       "updateKnowledgeBaseBody": true,
       "getOrCreateTableBody": true,
@@ -333223,6 +333367,7 @@ var state5 = {
       "copyFileResponse": true,
       "searchFilesResponse": true,
       "listFilePassagesResponse": true,
+      "setFilePassagesResponse": true,
       "listFileTagsResponse": true,
       "listFileTagValuesResponse": true,
       "createKnowledgeBaseResponse": true,
@@ -336927,6 +337072,7 @@ var state5 = {
         "copyFile",
         "searchFiles",
         "listFilePassages",
+        "setFilePassages",
         "listFileTags",
         "listFileTagValues",
         "createKnowledgeBase",

package/dist/src/gen/files/state.d.ts

@@ -1056,6 +1056,63 @@ export declare const state: {
                 };
             };
         };
+        setFilePassages: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            section: "files";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        passages: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    content: {
+                                        type: "string";
+                                        description: string;
+                                    };
+                                    type: {
+                                        default: string;
+                                        type: "string";
+                                        enum: string[];
+                                        description: string;
+                                    };
+                                    pageNumber: {
+                                        type: "integer";
+                                    };
+                                };
+                                required: string[];
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            contentType: "application/json";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listFileTags: {
             name: string;
             path: string;
@@ -1386,6 +1443,7 @@ export declare const state: {
             upsertFileBody: true;
             updateFileMetadataBody: true;
             copyFileBody: true;
+            setFilePassagesBody: true;
             createKnowledgeBaseBody: true;
             updateKnowledgeBaseBody: true;
         };
@@ -1398,6 +1456,7 @@ export declare const state: {
             copyFileResponse: true;
             searchFilesResponse: true;
             listFilePassagesResponse: true;
+            setFilePassagesResponse: true;
             listFileTagsResponse: true;
             listFileTagValuesResponse: true;
             createKnowledgeBaseResponse: true;

package/dist/src/gen/state.d.ts

@@ -14670,6 +14670,63 @@ export declare const state: {
                 };
             };
         };
+        setFilePassages: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            section: "files";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        passages: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    content: {
+                                        type: "string";
+                                        description: string;
+                                    };
+                                    type: {
+                                        default: string;
+                                        type: "string";
+                                        enum: string[];
+                                        description: string;
+                                    };
+                                    pageNumber: {
+                                        type: "integer";
+                                    };
+                                };
+                                required: string[];
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            contentType: "application/json";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listFileTags: {
             name: string;
             path: string;
@@ -16133,6 +16190,7 @@ export declare const state: {
             upsertFileBody: true;
             updateFileMetadataBody: true;
             copyFileBody: true;
+            setFilePassagesBody: true;
             createKnowledgeBaseBody: true;
             updateKnowledgeBaseBody: true;
             getOrCreateTableBody: true;
@@ -16298,6 +16356,7 @@ export declare const state: {
             copyFileResponse: true;
             searchFilesResponse: true;
             listFilePassagesResponse: true;
+            setFilePassagesResponse: true;
             listFileTagsResponse: true;
             listFileTagValuesResponse: true;
             createKnowledgeBaseResponse: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "1.13.1",
+  "version": "1.14.0",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {