@botpress/api 0.49.0 → 0.50.1

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.
Files changed (5) hide show
  1. package/dist/index.js +35 -26
  2. package/dist/src/gen/state.d.ts +22 -13
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +35 -26
package/dist/index.js CHANGED
@@ -292278,38 +292278,46 @@ var state = {
292278
292278
  "type": "object",
292279
292279
  "properties": {
292280
292280
  "parsing": {
292281
- "default": {},
292282
292281
  "type": "object",
292283
292282
  "properties": {
292284
292283
  "minimumParagraphLength": {
292285
- "default": 500,
292286
292284
  "type": "integer",
292287
292285
  "minimum": 50,
292288
- "maximum": 2e3
292286
+ "maximum": 2e3,
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."
292289
292288
  }
292290
292289
  },
292291
292290
  "additionalProperties": false
292292
292291
  },
292293
292292
  "chunking": {
292294
- "default": {},
292295
292293
  "type": "object",
292296
292294
  "properties": {
292297
292295
  "maximumChunkLength": {
292298
- "default": 1250,
292299
292296
  "type": "integer",
292300
292297
  "minimum": 100,
292301
- "maximum": 5e3
292298
+ "maximum": 5e3,
292299
+ "description": "The maximum length of a chunk in characters."
292300
+ },
292301
+ "embeddedContextLevels": {
292302
+ "type": "integer",
292303
+ "minimum": 0,
292304
+ "maximum": 3,
292305
+ "description": "The number of surrounding context levels to include in the vector embedding of the chunk."
292306
+ },
292307
+ "embedBreadcrumb": {
292308
+ "type": "boolean",
292309
+ "description": "Include the breadcrumb of the chunk in the vector embedding."
292302
292310
  }
292303
292311
  },
292304
292312
  "additionalProperties": false
292305
292313
  },
292306
292314
  "summarization": {
292307
- "default": {},
292308
292315
  "type": "object",
292309
292316
  "properties": {
292310
292317
  "enable": {
292311
- "default": true,
292312
- "type": "boolean"
292318
+ "default": false,
292319
+ "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."
292313
292321
  },
292314
292322
  "modelType": {
292315
292323
  "default": "balanced",
@@ -292318,23 +292326,24 @@ var state = {
292318
292326
  "inexpensive",
292319
292327
  "balanced",
292320
292328
  "accurate"
292321
- ]
292329
+ ],
292330
+ "description": "The model type to use for summarization."
292322
292331
  },
292323
292332
  "minimumInputLength": {
292324
- "default": 3e3,
292325
292333
  "type": "integer",
292326
292334
  "minimum": 1e3,
292327
- "maximum": 1e4
292335
+ "maximum": 1e4,
292336
+ "description": "The minimum length a section of the file should have to create a summary of it."
292328
292337
  },
292329
292338
  "outputTokenLimit": {
292330
- "default": 2e3,
292331
292339
  "type": "integer",
292332
292340
  "minimum": 1e3,
292333
- "maximum": 1e4
292341
+ "maximum": 1e4,
292342
+ "description": "The maximum length of a summary (in tokens)."
292334
292343
  },
292335
292344
  "generateMasterSummary": {
292336
- "default": true,
292337
- "type": "boolean"
292345
+ "type": "boolean",
292346
+ "description": "Generate a summary of the entire file and index it as a standalone vector."
292338
292347
  }
292339
292348
  },
292340
292349
  "additionalProperties": false
@@ -292520,7 +292529,7 @@ var state = {
292520
292529
  "parameters": {
292521
292530
  "id": {
292522
292531
  "type": "string",
292523
- "description": "File ID",
292532
+ "description": "File ID or Key",
292524
292533
  "in": "path"
292525
292534
  }
292526
292535
  },
@@ -292704,7 +292713,7 @@ var state = {
292704
292713
  "parameters": {
292705
292714
  "id": {
292706
292715
  "type": "string",
292707
- "description": "File ID",
292716
+ "description": "File ID or Key",
292708
292717
  "in": "path"
292709
292718
  }
292710
292719
  },
@@ -292835,7 +292844,7 @@ var state = {
292835
292844
  "parameters": {
292836
292845
  "id": {
292837
292846
  "type": "string",
292838
- "description": "File ID",
292847
+ "description": "File ID or Key",
292839
292848
  "in": "path"
292840
292849
  }
292841
292850
  },
@@ -293151,7 +293160,7 @@ var state = {
293151
293160
  },
293152
293161
  "listFilePassages": {
293153
293162
  "name": "listFilePassages",
293154
- "path": "/v1/files/{fileId}/passages",
293163
+ "path": "/v1/files/{id}/passages",
293155
293164
  "description": "List passages for a file",
293156
293165
  "method": "get",
293157
293166
  "section": "files",
@@ -293161,15 +293170,15 @@ var state = {
293161
293170
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
293162
293171
  "type": "string"
293163
293172
  },
293173
+ "id": {
293174
+ "type": "string",
293175
+ "description": "File ID or Key",
293176
+ "in": "path"
293177
+ },
293164
293178
  "limit": {
293165
293179
  "type": "number",
293166
293180
  "description": "The maximum number of passages to return per request (optional, default: 20, max: 200).",
293167
293181
  "in": "query"
293168
- },
293169
- "fileId": {
293170
- "type": "string",
293171
- "description": "File ID",
293172
- "in": "path"
293173
293182
  }
293174
293183
  },
293175
293184
  "response": {
@@ -294155,7 +294164,7 @@ var state = {
294155
294164
  "title": "Botpress API",
294156
294165
  "description": "API for Botpress Cloud",
294157
294166
  "server": "https://api.botpress.cloud",
294158
- "version": "0.49.0",
294167
+ "version": "0.50.1",
294159
294168
  "prefix": "v1"
294160
294169
  },
294161
294170
  "errors": [
package/dist/src/gen/state.d.ts CHANGED
@@ -9264,59 +9264,68 @@ export declare const state: {
9264
9264
  type: "object";
9265
9265
  properties: {
9266
9266
  parsing: {
9267
- default: {};
9268
9267
  type: "object";
9269
9268
  properties: {
9270
9269
  minimumParagraphLength: {
9271
- default: number;
9272
9270
  type: "integer";
9273
9271
  minimum: number;
9274
9272
  maximum: number;
9273
+ description: string;
9275
9274
  };
9276
9275
  };
9277
9276
  additionalProperties: false;
9278
9277
  };
9279
9278
  chunking: {
9280
- default: {};
9281
9279
  type: "object";
9282
9280
  properties: {
9283
9281
  maximumChunkLength: {
9284
- default: number;
9285
9282
  type: "integer";
9286
9283
  minimum: number;
9287
9284
  maximum: number;
9285
+ description: string;
9286
+ };
9287
+ embeddedContextLevels: {
9288
+ type: "integer";
9289
+ minimum: number;
9290
+ maximum: number;
9291
+ description: string;
9292
+ };
9293
+ embedBreadcrumb: {
9294
+ type: "boolean";
9295
+ description: string;
9288
9296
  };
9289
9297
  };
9290
9298
  additionalProperties: false;
9291
9299
  };
9292
9300
  summarization: {
9293
- default: {};
9294
9301
  type: "object";
9295
9302
  properties: {
9296
9303
  enable: {
9297
9304
  default: boolean;
9298
9305
  type: "boolean";
9306
+ description: string;
9299
9307
  };
9300
9308
  modelType: {
9301
9309
  default: string;
9302
9310
  type: "string";
9303
9311
  enum: string[];
9312
+ description: string;
9304
9313
  };
9305
9314
  minimumInputLength: {
9306
- default: number;
9307
9315
  type: "integer";
9308
9316
  minimum: number;
9309
9317
  maximum: number;
9318
+ description: string;
9310
9319
  };
9311
9320
  outputTokenLimit: {
9312
- default: number;
9313
9321
  type: "integer";
9314
9322
  minimum: number;
9315
9323
  maximum: number;
9324
+ description: string;
9316
9325
  };
9317
9326
  generateMasterSummary: {
9318
- default: boolean;
9319
9327
  type: "boolean";
9328
+ description: string;
9320
9329
  };
9321
9330
  };
9322
9331
  additionalProperties: false;
@@ -10000,16 +10009,16 @@ export declare const state: {
10000
10009
  description: string;
10001
10010
  type: "string";
10002
10011
  };
10012
+ id: {
10013
+ type: "string";
10014
+ description: string;
10015
+ in: "path";
10016
+ };
10003
10017
  limit: {
10004
10018
  type: "number";
10005
10019
  description: string;
10006
10020
  in: "query";
10007
10021
  };
10008
- fileId: {
10009
- type: "string";
10010
- description: string;
10011
- in: "path";
10012
- };
10013
10022
  };
10014
10023
  response: {
10015
10024
  description: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.49.0",
3
+ "version": "0.50.1",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {