@botpress/api 0.41.3 → 0.42.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 +67 -4
  2. package/dist/src/gen/state.d.ts +42 -0
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +67 -4
package/dist/index.js CHANGED
@@ -292975,10 +292975,15 @@ var state = {
292975
292975
  "type": "integer",
292976
292976
  "description": "The maximum number of passages to return."
292977
292977
  },
292978
+ "consolidate": {
292979
+ "in": "query",
292980
+ "type": "boolean",
292981
+ "description": "Consolidate the results by merging matching passages from the same file into a single passage per file. The consolidated passage will include the matching passages ordered by their original position in the file (rather than by relevance score) and include hierarchical context such as the title/subtitle to which they belong."
292982
+ },
292978
292983
  "includeBreadcrumb": {
292979
292984
  "in": "query",
292980
292985
  "type": "boolean",
292981
- "description": "Prepend a breadcrumb to each passage, containing the title and subtitle(s) the passage belongs to in the file."
292986
+ "description": "Prepend a breadcrumb to each passage, containing the title and subtitle(s) the passage belongs to in the file. This option is ignored when the `consolidate` option is set to `true`."
292982
292987
  }
292983
292988
  },
292984
292989
  "response": {
@@ -293006,7 +293011,8 @@ var state = {
293006
293011
  "type": "string",
293007
293012
  "enum": [
293008
293013
  "chunk",
293009
- "summary"
293014
+ "summary",
293015
+ "consolidated"
293010
293016
  ],
293011
293017
  "description": "The type of passage"
293012
293018
  },
@@ -293141,7 +293147,8 @@ var state = {
293141
293147
  "type": "string",
293142
293148
  "enum": [
293143
293149
  "chunk",
293144
- "summary"
293150
+ "summary",
293151
+ "consolidated"
293145
293152
  ],
293146
293153
  "description": "The type of passage"
293147
293154
  },
@@ -294098,7 +294105,7 @@ var state = {
294098
294105
  "title": "Botpress API",
294099
294106
  "description": "API for Botpress Cloud",
294100
294107
  "server": "https://api.botpress.cloud",
294101
- "version": "0.41.3",
294108
+ "version": "0.42.1",
294102
294109
  "prefix": "v1"
294103
294110
  },
294104
294111
  "errors": [
@@ -296600,6 +296607,7 @@ var state = {
296600
296607
  "number",
296601
296608
  "boolean",
296602
296609
  "object",
296610
+ "array",
296603
296611
  "null"
296604
296612
  ]
296605
296613
  },
@@ -296612,10 +296620,65 @@ var state = {
296612
296620
  "description": {
296613
296621
  "type": "string"
296614
296622
  },
296623
+ "pattern": {
296624
+ "type": "string",
296625
+ "description": "String properties must match this pattern"
296626
+ },
296627
+ "enum": {
296628
+ "type": "array",
296629
+ "items": {
296630
+ "type": "string"
296631
+ },
296632
+ "description": "String properties must be one of these values"
296633
+ },
296634
+ "items": {
296635
+ "type": "object",
296636
+ "properties": {
296637
+ "type": {
296638
+ "type": "string",
296639
+ "enum": [
296640
+ "string",
296641
+ "number",
296642
+ "boolean",
296643
+ "object",
296644
+ "array",
296645
+ "null"
296646
+ ]
296647
+ }
296648
+ },
296649
+ "required": [
296650
+ "type"
296651
+ ],
296652
+ "additionalProperties": true,
296653
+ "description": "Defines the shape of items in an array"
296654
+ },
296615
296655
  "nullable": {
296616
296656
  "default": true,
296617
296657
  "type": "boolean"
296618
296658
  },
296659
+ "properties": {
296660
+ "type": "object",
296661
+ "additionalProperties": {
296662
+ "type": "object",
296663
+ "properties": {
296664
+ "type": {
296665
+ "type": "string",
296666
+ "enum": [
296667
+ "string",
296668
+ "number",
296669
+ "boolean",
296670
+ "object",
296671
+ "array",
296672
+ "null"
296673
+ ]
296674
+ }
296675
+ },
296676
+ "required": [
296677
+ "type"
296678
+ ],
296679
+ "additionalProperties": true
296680
+ }
296681
+ },
296619
296682
  "x-zui": {
296620
296683
  "type": "object",
296621
296684
  "properties": {
package/dist/src/gen/state.d.ts CHANGED
@@ -9150,6 +9150,11 @@ export declare const state: {
9150
9150
  type: "integer";
9151
9151
  description: string;
9152
9152
  };
9153
+ consolidate: {
9154
+ in: "query";
9155
+ type: "boolean";
9156
+ description: string;
9157
+ };
9153
9158
  includeBreadcrumb: {
9154
9159
  in: "query";
9155
9160
  type: "boolean";
@@ -12232,10 +12237,47 @@ export declare const state: {
12232
12237
  description: {
12233
12238
  type: "string";
12234
12239
  };
12240
+ pattern: {
12241
+ type: "string";
12242
+ description: string;
12243
+ };
12244
+ enum: {
12245
+ type: "array";
12246
+ items: {
12247
+ type: "string";
12248
+ };
12249
+ description: string;
12250
+ };
12251
+ items: {
12252
+ type: "object";
12253
+ properties: {
12254
+ type: {
12255
+ type: "string";
12256
+ enum: string[];
12257
+ };
12258
+ };
12259
+ required: string[];
12260
+ additionalProperties: true;
12261
+ description: string;
12262
+ };
12235
12263
  nullable: {
12236
12264
  default: boolean;
12237
12265
  type: "boolean";
12238
12266
  };
12267
+ properties: {
12268
+ type: "object";
12269
+ additionalProperties: {
12270
+ type: "object";
12271
+ properties: {
12272
+ type: {
12273
+ type: "string";
12274
+ enum: string[];
12275
+ };
12276
+ };
12277
+ required: string[];
12278
+ additionalProperties: true;
12279
+ };
12280
+ };
12239
12281
  "x-zui": {
12240
12282
  type: "object";
12241
12283
  properties: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.41.3",
3
+ "version": "0.42.1",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {