@botpress/api 0.48.1 → 0.50.0
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.
- package/dist/index.js +134 -10
- package/dist/src/gen/state.d.ts +118 -5
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +134 -10
package/dist/index.js
CHANGED
|
@@ -292271,6 +292271,84 @@ var state = {
|
|
|
292271
292271
|
"type": "boolean",
|
|
292272
292272
|
"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."
|
|
292273
292273
|
},
|
|
292274
|
+
"indexing": {
|
|
292275
|
+
"type": "object",
|
|
292276
|
+
"properties": {
|
|
292277
|
+
"configuration": {
|
|
292278
|
+
"type": "object",
|
|
292279
|
+
"properties": {
|
|
292280
|
+
"parsing": {
|
|
292281
|
+
"default": {},
|
|
292282
|
+
"type": "object",
|
|
292283
|
+
"properties": {
|
|
292284
|
+
"minimumParagraphLength": {
|
|
292285
|
+
"default": 500,
|
|
292286
|
+
"type": "integer",
|
|
292287
|
+
"minimum": 50,
|
|
292288
|
+
"maximum": 2e3
|
|
292289
|
+
}
|
|
292290
|
+
},
|
|
292291
|
+
"additionalProperties": false
|
|
292292
|
+
},
|
|
292293
|
+
"chunking": {
|
|
292294
|
+
"default": {},
|
|
292295
|
+
"type": "object",
|
|
292296
|
+
"properties": {
|
|
292297
|
+
"maximumChunkLength": {
|
|
292298
|
+
"default": 1250,
|
|
292299
|
+
"type": "integer",
|
|
292300
|
+
"minimum": 100,
|
|
292301
|
+
"maximum": 5e3
|
|
292302
|
+
}
|
|
292303
|
+
},
|
|
292304
|
+
"additionalProperties": false
|
|
292305
|
+
},
|
|
292306
|
+
"summarization": {
|
|
292307
|
+
"default": {},
|
|
292308
|
+
"type": "object",
|
|
292309
|
+
"properties": {
|
|
292310
|
+
"enable": {
|
|
292311
|
+
"default": false,
|
|
292312
|
+
"type": "boolean"
|
|
292313
|
+
},
|
|
292314
|
+
"modelType": {
|
|
292315
|
+
"default": "balanced",
|
|
292316
|
+
"type": "string",
|
|
292317
|
+
"enum": [
|
|
292318
|
+
"inexpensive",
|
|
292319
|
+
"balanced",
|
|
292320
|
+
"accurate"
|
|
292321
|
+
]
|
|
292322
|
+
},
|
|
292323
|
+
"minimumInputLength": {
|
|
292324
|
+
"default": 3e3,
|
|
292325
|
+
"type": "integer",
|
|
292326
|
+
"minimum": 1e3,
|
|
292327
|
+
"maximum": 1e4
|
|
292328
|
+
},
|
|
292329
|
+
"outputTokenLimit": {
|
|
292330
|
+
"default": 2e3,
|
|
292331
|
+
"type": "integer",
|
|
292332
|
+
"minimum": 1e3,
|
|
292333
|
+
"maximum": 1e4
|
|
292334
|
+
},
|
|
292335
|
+
"generateMasterSummary": {
|
|
292336
|
+
"default": true,
|
|
292337
|
+
"type": "boolean"
|
|
292338
|
+
}
|
|
292339
|
+
},
|
|
292340
|
+
"additionalProperties": false
|
|
292341
|
+
}
|
|
292342
|
+
},
|
|
292343
|
+
"description": "Configuration to use for indexing the file, will be stored in the file's metadata for reference.",
|
|
292344
|
+
"additionalProperties": false
|
|
292345
|
+
}
|
|
292346
|
+
},
|
|
292347
|
+
"required": [
|
|
292348
|
+
"configuration"
|
|
292349
|
+
],
|
|
292350
|
+
"additionalProperties": false
|
|
292351
|
+
},
|
|
292274
292352
|
"accessPolicies": {
|
|
292275
292353
|
"type": "array",
|
|
292276
292354
|
"items": {
|
|
@@ -292294,6 +292372,9 @@ var state = {
|
|
|
292294
292372
|
"publicContentImmediatelyAccessible": {
|
|
292295
292373
|
"type": "boolean",
|
|
292296
292374
|
"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.'
|
|
292375
|
+
},
|
|
292376
|
+
"metadata": {
|
|
292377
|
+
"description": "Custom metadata for the file expressed as an object of key-value pairs. The values can be of any type."
|
|
292297
292378
|
}
|
|
292298
292379
|
},
|
|
292299
292380
|
"required": [
|
|
@@ -292347,6 +292428,13 @@ var state = {
|
|
|
292347
292428
|
},
|
|
292348
292429
|
"description": "The tags of the file as an object of key/value pairs"
|
|
292349
292430
|
},
|
|
292431
|
+
"metadata": {
|
|
292432
|
+
"type": "object",
|
|
292433
|
+
"additionalProperties": {
|
|
292434
|
+
"nullable": true
|
|
292435
|
+
},
|
|
292436
|
+
"description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
|
|
292437
|
+
},
|
|
292350
292438
|
"createdAt": {
|
|
292351
292439
|
"type": "string",
|
|
292352
292440
|
"description": "File creation timestamp in ISO 8601 format"
|
|
@@ -292403,6 +292491,7 @@ var state = {
|
|
|
292403
292491
|
"size",
|
|
292404
292492
|
"contentType",
|
|
292405
292493
|
"tags",
|
|
292494
|
+
"metadata",
|
|
292406
292495
|
"createdAt",
|
|
292407
292496
|
"updatedAt",
|
|
292408
292497
|
"accessPolicies",
|
|
@@ -292431,7 +292520,7 @@ var state = {
|
|
|
292431
292520
|
"parameters": {
|
|
292432
292521
|
"id": {
|
|
292433
292522
|
"type": "string",
|
|
292434
|
-
"description": "File ID",
|
|
292523
|
+
"description": "File ID or Key",
|
|
292435
292524
|
"in": "path"
|
|
292436
292525
|
}
|
|
292437
292526
|
},
|
|
@@ -292518,6 +292607,13 @@ var state = {
|
|
|
292518
292607
|
},
|
|
292519
292608
|
"description": "The tags of the file as an object of key/value pairs"
|
|
292520
292609
|
},
|
|
292610
|
+
"metadata": {
|
|
292611
|
+
"type": "object",
|
|
292612
|
+
"additionalProperties": {
|
|
292613
|
+
"nullable": true
|
|
292614
|
+
},
|
|
292615
|
+
"description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
|
|
292616
|
+
},
|
|
292521
292617
|
"createdAt": {
|
|
292522
292618
|
"type": "string",
|
|
292523
292619
|
"description": "File creation timestamp in ISO 8601 format"
|
|
@@ -292570,6 +292666,7 @@ var state = {
|
|
|
292570
292666
|
"size",
|
|
292571
292667
|
"contentType",
|
|
292572
292668
|
"tags",
|
|
292669
|
+
"metadata",
|
|
292573
292670
|
"createdAt",
|
|
292574
292671
|
"updatedAt",
|
|
292575
292672
|
"accessPolicies",
|
|
@@ -292607,7 +292704,7 @@ var state = {
|
|
|
292607
292704
|
"parameters": {
|
|
292608
292705
|
"id": {
|
|
292609
292706
|
"type": "string",
|
|
292610
|
-
"description": "File ID",
|
|
292707
|
+
"description": "File ID or Key",
|
|
292611
292708
|
"in": "path"
|
|
292612
292709
|
}
|
|
292613
292710
|
},
|
|
@@ -292652,6 +292749,13 @@ var state = {
|
|
|
292652
292749
|
},
|
|
292653
292750
|
"description": "The tags of the file as an object of key/value pairs"
|
|
292654
292751
|
},
|
|
292752
|
+
"metadata": {
|
|
292753
|
+
"type": "object",
|
|
292754
|
+
"additionalProperties": {
|
|
292755
|
+
"nullable": true
|
|
292756
|
+
},
|
|
292757
|
+
"description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
|
|
292758
|
+
},
|
|
292655
292759
|
"createdAt": {
|
|
292656
292760
|
"type": "string",
|
|
292657
292761
|
"description": "File creation timestamp in ISO 8601 format"
|
|
@@ -292704,6 +292808,7 @@ var state = {
|
|
|
292704
292808
|
"size",
|
|
292705
292809
|
"contentType",
|
|
292706
292810
|
"tags",
|
|
292811
|
+
"metadata",
|
|
292707
292812
|
"createdAt",
|
|
292708
292813
|
"updatedAt",
|
|
292709
292814
|
"accessPolicies",
|
|
@@ -292730,7 +292835,7 @@ var state = {
|
|
|
292730
292835
|
"parameters": {
|
|
292731
292836
|
"id": {
|
|
292732
292837
|
"type": "string",
|
|
292733
|
-
"description": "File ID",
|
|
292838
|
+
"description": "File ID or Key",
|
|
292734
292839
|
"in": "path"
|
|
292735
292840
|
}
|
|
292736
292841
|
},
|
|
@@ -292739,6 +292844,9 @@ var state = {
|
|
|
292739
292844
|
"schema": {
|
|
292740
292845
|
"type": "object",
|
|
292741
292846
|
"properties": {
|
|
292847
|
+
"metadata": {
|
|
292848
|
+
"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`."
|
|
292849
|
+
},
|
|
292742
292850
|
"tags": {
|
|
292743
292851
|
"type": "object",
|
|
292744
292852
|
"additionalProperties": {
|
|
@@ -292811,6 +292919,13 @@ var state = {
|
|
|
292811
292919
|
},
|
|
292812
292920
|
"description": "The tags of the file as an object of key/value pairs"
|
|
292813
292921
|
},
|
|
292922
|
+
"metadata": {
|
|
292923
|
+
"type": "object",
|
|
292924
|
+
"additionalProperties": {
|
|
292925
|
+
"nullable": true
|
|
292926
|
+
},
|
|
292927
|
+
"description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
|
|
292928
|
+
},
|
|
292814
292929
|
"createdAt": {
|
|
292815
292930
|
"type": "string",
|
|
292816
292931
|
"description": "File creation timestamp in ISO 8601 format"
|
|
@@ -292863,6 +292978,7 @@ var state = {
|
|
|
292863
292978
|
"size",
|
|
292864
292979
|
"contentType",
|
|
292865
292980
|
"tags",
|
|
292981
|
+
"metadata",
|
|
292866
292982
|
"createdAt",
|
|
292867
292983
|
"updatedAt",
|
|
292868
292984
|
"accessPolicies",
|
|
@@ -293035,7 +293151,7 @@ var state = {
|
|
|
293035
293151
|
},
|
|
293036
293152
|
"listFilePassages": {
|
|
293037
293153
|
"name": "listFilePassages",
|
|
293038
|
-
"path": "/v1/files/{
|
|
293154
|
+
"path": "/v1/files/{id}/passages",
|
|
293039
293155
|
"description": "List passages for a file",
|
|
293040
293156
|
"method": "get",
|
|
293041
293157
|
"section": "files",
|
|
@@ -293045,15 +293161,15 @@ var state = {
|
|
|
293045
293161
|
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
293046
293162
|
"type": "string"
|
|
293047
293163
|
},
|
|
293164
|
+
"id": {
|
|
293165
|
+
"type": "string",
|
|
293166
|
+
"description": "File ID or Key",
|
|
293167
|
+
"in": "path"
|
|
293168
|
+
},
|
|
293048
293169
|
"limit": {
|
|
293049
293170
|
"type": "number",
|
|
293050
293171
|
"description": "The maximum number of passages to return per request (optional, default: 20, max: 200).",
|
|
293051
293172
|
"in": "query"
|
|
293052
|
-
},
|
|
293053
|
-
"fileId": {
|
|
293054
|
-
"type": "string",
|
|
293055
|
-
"description": "File ID",
|
|
293056
|
-
"in": "path"
|
|
293057
293173
|
}
|
|
293058
293174
|
},
|
|
293059
293175
|
"response": {
|
|
@@ -294039,7 +294155,7 @@ var state = {
|
|
|
294039
294155
|
"title": "Botpress API",
|
|
294040
294156
|
"description": "API for Botpress Cloud",
|
|
294041
294157
|
"server": "https://api.botpress.cloud",
|
|
294042
|
-
"version": "0.
|
|
294158
|
+
"version": "0.50.0",
|
|
294043
294159
|
"prefix": "v1"
|
|
294044
294160
|
},
|
|
294045
294161
|
"errors": [
|
|
@@ -297165,6 +297281,13 @@ var state = {
|
|
|
297165
297281
|
},
|
|
297166
297282
|
"description": "The tags of the file as an object of key/value pairs"
|
|
297167
297283
|
},
|
|
297284
|
+
"metadata": {
|
|
297285
|
+
"type": "object",
|
|
297286
|
+
"additionalProperties": {
|
|
297287
|
+
"nullable": true
|
|
297288
|
+
},
|
|
297289
|
+
"description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
|
|
297290
|
+
},
|
|
297168
297291
|
"createdAt": {
|
|
297169
297292
|
"type": "string",
|
|
297170
297293
|
"description": "File creation timestamp in ISO 8601 format"
|
|
@@ -297217,6 +297340,7 @@ var state = {
|
|
|
297217
297340
|
"size",
|
|
297218
297341
|
"contentType",
|
|
297219
297342
|
"tags",
|
|
297343
|
+
"metadata",
|
|
297220
297344
|
"createdAt",
|
|
297221
297345
|
"updatedAt",
|
|
297222
297346
|
"accessPolicies",
|
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -9257,6 +9257,78 @@ export declare const state: {
|
|
|
9257
9257
|
type: "boolean";
|
|
9258
9258
|
description: string;
|
|
9259
9259
|
};
|
|
9260
|
+
indexing: {
|
|
9261
|
+
type: "object";
|
|
9262
|
+
properties: {
|
|
9263
|
+
configuration: {
|
|
9264
|
+
type: "object";
|
|
9265
|
+
properties: {
|
|
9266
|
+
parsing: {
|
|
9267
|
+
default: {};
|
|
9268
|
+
type: "object";
|
|
9269
|
+
properties: {
|
|
9270
|
+
minimumParagraphLength: {
|
|
9271
|
+
default: number;
|
|
9272
|
+
type: "integer";
|
|
9273
|
+
minimum: number;
|
|
9274
|
+
maximum: number;
|
|
9275
|
+
};
|
|
9276
|
+
};
|
|
9277
|
+
additionalProperties: false;
|
|
9278
|
+
};
|
|
9279
|
+
chunking: {
|
|
9280
|
+
default: {};
|
|
9281
|
+
type: "object";
|
|
9282
|
+
properties: {
|
|
9283
|
+
maximumChunkLength: {
|
|
9284
|
+
default: number;
|
|
9285
|
+
type: "integer";
|
|
9286
|
+
minimum: number;
|
|
9287
|
+
maximum: number;
|
|
9288
|
+
};
|
|
9289
|
+
};
|
|
9290
|
+
additionalProperties: false;
|
|
9291
|
+
};
|
|
9292
|
+
summarization: {
|
|
9293
|
+
default: {};
|
|
9294
|
+
type: "object";
|
|
9295
|
+
properties: {
|
|
9296
|
+
enable: {
|
|
9297
|
+
default: boolean;
|
|
9298
|
+
type: "boolean";
|
|
9299
|
+
};
|
|
9300
|
+
modelType: {
|
|
9301
|
+
default: string;
|
|
9302
|
+
type: "string";
|
|
9303
|
+
enum: string[];
|
|
9304
|
+
};
|
|
9305
|
+
minimumInputLength: {
|
|
9306
|
+
default: number;
|
|
9307
|
+
type: "integer";
|
|
9308
|
+
minimum: number;
|
|
9309
|
+
maximum: number;
|
|
9310
|
+
};
|
|
9311
|
+
outputTokenLimit: {
|
|
9312
|
+
default: number;
|
|
9313
|
+
type: "integer";
|
|
9314
|
+
minimum: number;
|
|
9315
|
+
maximum: number;
|
|
9316
|
+
};
|
|
9317
|
+
generateMasterSummary: {
|
|
9318
|
+
default: boolean;
|
|
9319
|
+
type: "boolean";
|
|
9320
|
+
};
|
|
9321
|
+
};
|
|
9322
|
+
additionalProperties: false;
|
|
9323
|
+
};
|
|
9324
|
+
};
|
|
9325
|
+
description: string;
|
|
9326
|
+
additionalProperties: false;
|
|
9327
|
+
};
|
|
9328
|
+
};
|
|
9329
|
+
required: string[];
|
|
9330
|
+
additionalProperties: false;
|
|
9331
|
+
};
|
|
9260
9332
|
accessPolicies: {
|
|
9261
9333
|
type: "array";
|
|
9262
9334
|
items: {
|
|
@@ -9278,6 +9350,9 @@ export declare const state: {
|
|
|
9278
9350
|
type: "boolean";
|
|
9279
9351
|
description: string;
|
|
9280
9352
|
};
|
|
9353
|
+
metadata: {
|
|
9354
|
+
description: string;
|
|
9355
|
+
};
|
|
9281
9356
|
};
|
|
9282
9357
|
required: string[];
|
|
9283
9358
|
title: string;
|
|
@@ -9327,6 +9402,13 @@ export declare const state: {
|
|
|
9327
9402
|
};
|
|
9328
9403
|
description: string;
|
|
9329
9404
|
};
|
|
9405
|
+
metadata: {
|
|
9406
|
+
type: "object";
|
|
9407
|
+
additionalProperties: {
|
|
9408
|
+
nullable: true;
|
|
9409
|
+
};
|
|
9410
|
+
description: string;
|
|
9411
|
+
};
|
|
9330
9412
|
createdAt: {
|
|
9331
9413
|
type: "string";
|
|
9332
9414
|
description: string;
|
|
@@ -9472,6 +9554,13 @@ export declare const state: {
|
|
|
9472
9554
|
};
|
|
9473
9555
|
description: string;
|
|
9474
9556
|
};
|
|
9557
|
+
metadata: {
|
|
9558
|
+
type: "object";
|
|
9559
|
+
additionalProperties: {
|
|
9560
|
+
nullable: true;
|
|
9561
|
+
};
|
|
9562
|
+
description: string;
|
|
9563
|
+
};
|
|
9475
9564
|
createdAt: {
|
|
9476
9565
|
type: "string";
|
|
9477
9566
|
description: string;
|
|
@@ -9580,6 +9669,13 @@ export declare const state: {
|
|
|
9580
9669
|
};
|
|
9581
9670
|
description: string;
|
|
9582
9671
|
};
|
|
9672
|
+
metadata: {
|
|
9673
|
+
type: "object";
|
|
9674
|
+
additionalProperties: {
|
|
9675
|
+
nullable: true;
|
|
9676
|
+
};
|
|
9677
|
+
description: string;
|
|
9678
|
+
};
|
|
9583
9679
|
createdAt: {
|
|
9584
9680
|
type: "string";
|
|
9585
9681
|
description: string;
|
|
@@ -9642,6 +9738,9 @@ export declare const state: {
|
|
|
9642
9738
|
schema: {
|
|
9643
9739
|
type: "object";
|
|
9644
9740
|
properties: {
|
|
9741
|
+
metadata: {
|
|
9742
|
+
description: string;
|
|
9743
|
+
};
|
|
9645
9744
|
tags: {
|
|
9646
9745
|
type: "object";
|
|
9647
9746
|
additionalProperties: {
|
|
@@ -9711,6 +9810,13 @@ export declare const state: {
|
|
|
9711
9810
|
};
|
|
9712
9811
|
description: string;
|
|
9713
9812
|
};
|
|
9813
|
+
metadata: {
|
|
9814
|
+
type: "object";
|
|
9815
|
+
additionalProperties: {
|
|
9816
|
+
nullable: true;
|
|
9817
|
+
};
|
|
9818
|
+
description: string;
|
|
9819
|
+
};
|
|
9714
9820
|
createdAt: {
|
|
9715
9821
|
type: "string";
|
|
9716
9822
|
description: string;
|
|
@@ -9894,16 +10000,16 @@ export declare const state: {
|
|
|
9894
10000
|
description: string;
|
|
9895
10001
|
type: "string";
|
|
9896
10002
|
};
|
|
10003
|
+
id: {
|
|
10004
|
+
type: "string";
|
|
10005
|
+
description: string;
|
|
10006
|
+
in: "path";
|
|
10007
|
+
};
|
|
9897
10008
|
limit: {
|
|
9898
10009
|
type: "number";
|
|
9899
10010
|
description: string;
|
|
9900
10011
|
in: "query";
|
|
9901
10012
|
};
|
|
9902
|
-
fileId: {
|
|
9903
|
-
type: "string";
|
|
9904
|
-
description: string;
|
|
9905
|
-
in: "path";
|
|
9906
|
-
};
|
|
9907
10013
|
};
|
|
9908
10014
|
response: {
|
|
9909
10015
|
description: string;
|
|
@@ -13386,6 +13492,13 @@ export declare const state: {
|
|
|
13386
13492
|
};
|
|
13387
13493
|
description: string;
|
|
13388
13494
|
};
|
|
13495
|
+
metadata: {
|
|
13496
|
+
type: "object";
|
|
13497
|
+
additionalProperties: {
|
|
13498
|
+
nullable: true;
|
|
13499
|
+
};
|
|
13500
|
+
description: string;
|
|
13501
|
+
};
|
|
13389
13502
|
createdAt: {
|
|
13390
13503
|
type: "string";
|
|
13391
13504
|
description: string;
|