@botpress/api 0.48.0 → 0.49.0

package/dist/index.js

@@ -283462,13 +283462,11 @@ var state = {
               "type": "string",
               "maxLength": 200,
               "description": "Unique identifier of the integration that was installed on the bot"
-            },
-            "configuration": {
-              "type": "object",
-              "additionalProperties": true,
-              "description": "Configuration fields to update for the integration"
             }
           },
+          "required": [
+            "identifier"
+          ],
           "title": "configureIntegrationBody",
           "additionalProperties": false
         }
@@ -292273,6 +292271,84 @@ var state = {
               "type": "boolean",
               "description": "Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace."
             },
+            "indexing": {
+              "type": "object",
+              "properties": {
+                "configuration": {
+                  "type": "object",
+                  "properties": {
+                    "parsing": {
+                      "default": {},
+                      "type": "object",
+                      "properties": {
+                        "minimumParagraphLength": {
+                          "default": 500,
+                          "type": "integer",
+                          "minimum": 50,
+                          "maximum": 2e3
+                        }
+                      },
+                      "additionalProperties": false
+                    },
+                    "chunking": {
+                      "default": {},
+                      "type": "object",
+                      "properties": {
+                        "maximumChunkLength": {
+                          "default": 1250,
+                          "type": "integer",
+                          "minimum": 100,
+                          "maximum": 5e3
+                        }
+                      },
+                      "additionalProperties": false
+                    },
+                    "summarization": {
+                      "default": {},
+                      "type": "object",
+                      "properties": {
+                        "enable": {
+                          "default": true,
+                          "type": "boolean"
+                        },
+                        "modelType": {
+                          "default": "balanced",
+                          "type": "string",
+                          "enum": [
+                            "inexpensive",
+                            "balanced",
+                            "accurate"
+                          ]
+                        },
+                        "minimumInputLength": {
+                          "default": 3e3,
+                          "type": "integer",
+                          "minimum": 1e3,
+                          "maximum": 1e4
+                        },
+                        "outputTokenLimit": {
+                          "default": 2e3,
+                          "type": "integer",
+                          "minimum": 1e3,
+                          "maximum": 1e4
+                        },
+                        "generateMasterSummary": {
+                          "default": true,
+                          "type": "boolean"
+                        }
+                      },
+                      "additionalProperties": false
+                    }
+                  },
+                  "description": "Configuration to use for indexing the file, will be stored in the file's metadata for reference.",
+                  "additionalProperties": false
+                }
+              },
+              "required": [
+                "configuration"
+              ],
+              "additionalProperties": false
+            },
             "accessPolicies": {
               "type": "array",
               "items": {
@@ -292296,6 +292372,9 @@ var state = {
             "publicContentImmediatelyAccessible": {
               "type": "boolean",
               "description": 'Use when your file has "public_content" in its access policy and you need the file\\\'s content to be immediately accessible through its URL after the file has been uploaded without having to wait for the upload to be processed by our system.\n\nIf set to `true`, the `x-amz-tagging` HTTP header with a value of `public=true` will need to be sent in the HTTP PUT request to the `uploadUrl` in order for the upload request to work.'
+            },
+            "metadata": {
+              "description": "Custom metadata for the file expressed as an object of key-value pairs. The values can be of any type."
             }
           },
           "required": [
@@ -292349,6 +292428,13 @@ var state = {
                   },
                   "description": "The tags of the file as an object of key/value pairs"
                 },
+                "metadata": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "nullable": true
+                  },
+                  "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
+                },
                 "createdAt": {
                   "type": "string",
                   "description": "File creation timestamp in ISO 8601 format"
@@ -292405,6 +292491,7 @@ var state = {
                 "size",
                 "contentType",
                 "tags",
+                "metadata",
                 "createdAt",
                 "updatedAt",
                 "accessPolicies",
@@ -292520,6 +292607,13 @@ var state = {
                     },
                     "description": "The tags of the file as an object of key/value pairs"
                   },
+                  "metadata": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "nullable": true
+                    },
+                    "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
+                  },
                   "createdAt": {
                     "type": "string",
                     "description": "File creation timestamp in ISO 8601 format"
@@ -292572,6 +292666,7 @@ var state = {
                   "size",
                   "contentType",
                   "tags",
+                  "metadata",
                   "createdAt",
                   "updatedAt",
                   "accessPolicies",
@@ -292654,6 +292749,13 @@ var state = {
                   },
                   "description": "The tags of the file as an object of key/value pairs"
                 },
+                "metadata": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "nullable": true
+                  },
+                  "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
+                },
                 "createdAt": {
                   "type": "string",
                   "description": "File creation timestamp in ISO 8601 format"
@@ -292706,6 +292808,7 @@ var state = {
                 "size",
                 "contentType",
                 "tags",
+                "metadata",
                 "createdAt",
                 "updatedAt",
                 "accessPolicies",
@@ -292741,6 +292844,9 @@ var state = {
         "schema": {
           "type": "object",
           "properties": {
+            "metadata": {
+              "description": "Custom metadata for the file expressed as an object of key-value pairs. Omit to keep existing metadata intact. Any existing metadata keys not included will be preserved. New keys will be added. To delete a metadata key, set its value to `null`."
+            },
             "tags": {
               "type": "object",
               "additionalProperties": {
@@ -292813,6 +292919,13 @@ var state = {
                   },
                   "description": "The tags of the file as an object of key/value pairs"
                 },
+                "metadata": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "nullable": true
+                  },
+                  "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
+                },
                 "createdAt": {
                   "type": "string",
                   "description": "File creation timestamp in ISO 8601 format"
@@ -292865,6 +292978,7 @@ var state = {
                 "size",
                 "contentType",
                 "tags",
+                "metadata",
                 "createdAt",
                 "updatedAt",
                 "accessPolicies",
@@ -294041,7 +294155,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.48.0",
+    "version": "0.49.0",
     "prefix": "v1"
   },
   "errors": [
@@ -297167,6 +297281,13 @@ var state = {
             },
             "description": "The tags of the file as an object of key/value pairs"
           },
+          "metadata": {
+            "type": "object",
+            "additionalProperties": {
+              "nullable": true
+            },
+            "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
+          },
           "createdAt": {
             "type": "string",
             "description": "File creation timestamp in ISO 8601 format"
@@ -297219,6 +297340,7 @@ var state = {
           "size",
           "contentType",
           "tags",
+          "metadata",
           "createdAt",
           "updatedAt",
           "accessPolicies",

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

@@ -1568,12 +1568,8 @@ export declare const state: {
                             maxLength: number;
                             description: string;
                         };
-                        configuration: {
-                            type: "object";
-                            additionalProperties: true;
-                            description: string;
-                        };
                     };
+                    required: string[];
                     title: string;
                     additionalProperties: false;
                 };
@@ -9261,6 +9257,78 @@ export declare const state: {
                             type: "boolean";
                             description: string;
                         };
+                        indexing: {
+                            type: "object";
+                            properties: {
+                                configuration: {
+                                    type: "object";
+                                    properties: {
+                                        parsing: {
+                                            default: {};
+                                            type: "object";
+                                            properties: {
+                                                minimumParagraphLength: {
+                                                    default: number;
+                                                    type: "integer";
+                                                    minimum: number;
+                                                    maximum: number;
+                                                };
+                                            };
+                                            additionalProperties: false;
+                                        };
+                                        chunking: {
+                                            default: {};
+                                            type: "object";
+                                            properties: {
+                                                maximumChunkLength: {
+                                                    default: number;
+                                                    type: "integer";
+                                                    minimum: number;
+                                                    maximum: number;
+                                                };
+                                            };
+                                            additionalProperties: false;
+                                        };
+                                        summarization: {
+                                            default: {};
+                                            type: "object";
+                                            properties: {
+                                                enable: {
+                                                    default: boolean;
+                                                    type: "boolean";
+                                                };
+                                                modelType: {
+                                                    default: string;
+                                                    type: "string";
+                                                    enum: string[];
+                                                };
+                                                minimumInputLength: {
+                                                    default: number;
+                                                    type: "integer";
+                                                    minimum: number;
+                                                    maximum: number;
+                                                };
+                                                outputTokenLimit: {
+                                                    default: number;
+                                                    type: "integer";
+                                                    minimum: number;
+                                                    maximum: number;
+                                                };
+                                                generateMasterSummary: {
+                                                    default: boolean;
+                                                    type: "boolean";
+                                                };
+                                            };
+                                            additionalProperties: false;
+                                        };
+                                    };
+                                    description: string;
+                                    additionalProperties: false;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
                         accessPolicies: {
                             type: "array";
                             items: {
@@ -9282,6 +9350,9 @@ export declare const state: {
                             type: "boolean";
                             description: string;
                         };
+                        metadata: {
+                            description: string;
+                        };
                     };
                     required: string[];
                     title: string;
@@ -9331,6 +9402,13 @@ export declare const state: {
                                     };
                                     description: string;
                                 };
+                                metadata: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        nullable: true;
+                                    };
+                                    description: string;
+                                };
                                 createdAt: {
                                     type: "string";
                                     description: string;
@@ -9476,6 +9554,13 @@ export declare const state: {
                                         };
                                         description: string;
                                     };
+                                    metadata: {
+                                        type: "object";
+                                        additionalProperties: {
+                                            nullable: true;
+                                        };
+                                        description: string;
+                                    };
                                     createdAt: {
                                         type: "string";
                                         description: string;
@@ -9584,6 +9669,13 @@ export declare const state: {
                                     };
                                     description: string;
                                 };
+                                metadata: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        nullable: true;
+                                    };
+                                    description: string;
+                                };
                                 createdAt: {
                                     type: "string";
                                     description: string;
@@ -9646,6 +9738,9 @@ export declare const state: {
                 schema: {
                     type: "object";
                     properties: {
+                        metadata: {
+                            description: string;
+                        };
                         tags: {
                             type: "object";
                             additionalProperties: {
@@ -9715,6 +9810,13 @@ export declare const state: {
                                     };
                                     description: string;
                                 };
+                                metadata: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        nullable: true;
+                                    };
+                                    description: string;
+                                };
                                 createdAt: {
                                     type: "string";
                                     description: string;
@@ -13390,6 +13492,13 @@ export declare const state: {
                         };
                         description: string;
                     };
+                    metadata: {
+                        type: "object";
+                        additionalProperties: {
+                            nullable: true;
+                        };
+                        description: string;
+                    };
                     createdAt: {
                         type: "string";
                         description: string;

package/package.json

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