@botpress/client 0.16.2 → 0.17.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/gen/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.13
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -750,6 +750,12 @@ export interface Column {
750
750
  * @memberof Column
751
751
  */
752
752
  'typings'?: string;
753
+ /**
754
+ *
755
+ * @type {TableSchemaPropertiesValueXZuiComputed}
756
+ * @memberof Column
757
+ */
758
+ 'computed'?: TableSchemaPropertiesValueXZuiComputed;
753
759
  /**
754
760
  *
755
761
  * @type {{ [key: string]: any; }}
@@ -1883,6 +1889,12 @@ export interface CreateTableBody {
1883
1889
  'tags'?: {
1884
1890
  [key: string]: string;
1885
1891
  };
1892
+ /**
1893
+ * Indicates if the table is enabled for computation.
1894
+ * @type {boolean}
1895
+ * @memberof CreateTableBody
1896
+ */
1897
+ 'isComputeEnabled'?: boolean;
1886
1898
  }
1887
1899
  /**
1888
1900
  *
@@ -1911,6 +1923,12 @@ export interface CreateTableRowsBody {
1911
1923
  'rows': Array<{
1912
1924
  [key: string]: any;
1913
1925
  }>;
1926
+ /**
1927
+ * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
1928
+ * @type {boolean}
1929
+ * @memberof CreateTableRowsBody
1930
+ */
1931
+ 'waitComputed'?: boolean;
1914
1932
  }
1915
1933
  /**
1916
1934
  *
@@ -3221,6 +3239,12 @@ export interface GetOrCreateTableBody {
3221
3239
  'tags'?: {
3222
3240
  [key: string]: string;
3223
3241
  };
3242
+ /**
3243
+ * Indicates if the table is enabled for computation.
3244
+ * @type {boolean}
3245
+ * @memberof GetOrCreateTableBody
3246
+ */
3247
+ 'isComputeEnabled'?: boolean;
3224
3248
  }
3225
3249
  /**
3226
3250
  *
@@ -3247,11 +3271,17 @@ export interface GetOrCreateTableResponse {
3247
3271
  */
3248
3272
  'rows': number;
3249
3273
  /**
3250
- * The number of rows pending indexing, relevant for search functionalities.
3274
+ * The number of stale rows that are waiting to be processed
3251
3275
  * @type {number}
3252
3276
  * @memberof GetOrCreateTableResponse
3253
3277
  */
3254
- 'indexingCount': number;
3278
+ 'stale': number;
3279
+ /**
3280
+ * The number of rows that are waiting to be indexed (for search)
3281
+ * @type {number}
3282
+ * @memberof GetOrCreateTableResponse
3283
+ */
3284
+ 'indexing': number;
3255
3285
  }
3256
3286
  /**
3257
3287
  *
@@ -4000,11 +4030,17 @@ export interface GetTableResponse {
4000
4030
  */
4001
4031
  'rows': number;
4002
4032
  /**
4003
- * The number of rows pending indexing, relevant for search functionalities.
4033
+ * The number of stale rows that are waiting to be processed
4034
+ * @type {number}
4035
+ * @memberof GetTableResponse
4036
+ */
4037
+ 'stale': number;
4038
+ /**
4039
+ * The number of rows that are waiting to be indexed (for search)
4004
4040
  * @type {number}
4005
4041
  * @memberof GetTableResponse
4006
4042
  */
4007
- 'indexingCount': number;
4043
+ 'indexing': number;
4008
4044
  }
4009
4045
  /**
4010
4046
  *
@@ -5854,6 +5890,20 @@ export interface Row {
5854
5890
  * @memberof Row
5855
5891
  */
5856
5892
  'updatedAt'?: string;
5893
+ /**
5894
+ *
5895
+ * @type {{ [key: string]: RowComputedValue; }}
5896
+ * @memberof Row
5897
+ */
5898
+ 'computed': {
5899
+ [key: string]: RowComputedValue;
5900
+ };
5901
+ /**
5902
+ * [Read-only] List of stale values that are waiting to be recomputed.
5903
+ * @type {Array<string>}
5904
+ * @memberof Row
5905
+ */
5906
+ 'stale'?: Array<string>;
5857
5907
  /**
5858
5908
  * Optional numeric value indicating similarity, when using findTableRows.
5859
5909
  * @type {number}
@@ -5861,6 +5911,37 @@ export interface Row {
5861
5911
  */
5862
5912
  'similarity'?: number;
5863
5913
  }
5914
+ /**
5915
+ *
5916
+ * @export
5917
+ * @interface RowComputedValue
5918
+ */
5919
+ export interface RowComputedValue {
5920
+ /**
5921
+ *
5922
+ * @type {string}
5923
+ * @memberof RowComputedValue
5924
+ */
5925
+ 'status': string;
5926
+ /**
5927
+ *
5928
+ * @type {string}
5929
+ * @memberof RowComputedValue
5930
+ */
5931
+ 'error'?: string;
5932
+ /**
5933
+ *
5934
+ * @type {string}
5935
+ * @memberof RowComputedValue
5936
+ */
5937
+ 'updatedBy'?: string;
5938
+ /**
5939
+ *
5940
+ * @type {string}
5941
+ * @memberof RowComputedValue
5942
+ */
5943
+ 'updatedAt'?: string;
5944
+ }
5864
5945
  /**
5865
5946
  *
5866
5947
  * @export
@@ -6227,6 +6308,12 @@ export interface Table {
6227
6308
  'tags'?: {
6228
6309
  [key: string]: string;
6229
6310
  };
6311
+ /**
6312
+ * Indicates if the table is enabled for computation.
6313
+ * @type {boolean}
6314
+ * @memberof Table
6315
+ */
6316
+ 'isComputeEnabled'?: boolean;
6230
6317
  /**
6231
6318
  * Timestamp of table creation.
6232
6319
  * @type {string}
@@ -6356,6 +6443,30 @@ export interface TableSchemaPropertiesValueXZui {
6356
6443
  * @memberof TableSchemaPropertiesValueXZui
6357
6444
  */
6358
6445
  'searchable'?: boolean;
6446
+ /**
6447
+ * Indicates if the field is hidden in the UI
6448
+ * @type {boolean}
6449
+ * @memberof TableSchemaPropertiesValueXZui
6450
+ */
6451
+ 'hidden'?: boolean;
6452
+ /**
6453
+ * Order of the column in the UI
6454
+ * @type {number}
6455
+ * @memberof TableSchemaPropertiesValueXZui
6456
+ */
6457
+ 'order'?: number;
6458
+ /**
6459
+ * Width of the column in the UI
6460
+ * @type {number}
6461
+ * @memberof TableSchemaPropertiesValueXZui
6462
+ */
6463
+ 'width'?: number;
6464
+ /**
6465
+ *
6466
+ * @type {TableSchemaPropertiesValueXZuiComputed}
6467
+ * @memberof TableSchemaPropertiesValueXZui
6468
+ */
6469
+ 'computed'?: TableSchemaPropertiesValueXZuiComputed;
6359
6470
  /**
6360
6471
  * TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
6361
6472
  * @type {string}
@@ -6363,6 +6474,59 @@ export interface TableSchemaPropertiesValueXZui {
6363
6474
  */
6364
6475
  'typings'?: string;
6365
6476
  }
6477
+ /**
6478
+ *
6479
+ * @export
6480
+ * @interface TableSchemaPropertiesValueXZuiComputed
6481
+ */
6482
+ export interface TableSchemaPropertiesValueXZuiComputed {
6483
+ /**
6484
+ *
6485
+ * @type {string}
6486
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6487
+ */
6488
+ 'action': TableSchemaPropertiesValueXZuiComputedActionEnum;
6489
+ /**
6490
+ *
6491
+ * @type {Array<string>}
6492
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6493
+ */
6494
+ 'dependencies'?: Array<string>;
6495
+ /**
6496
+ * Prompt when action is \"ai\"
6497
+ * @type {string}
6498
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6499
+ */
6500
+ 'prompt'?: string;
6501
+ /**
6502
+ * Model to use when action is \"ai\"
6503
+ * @type {string}
6504
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6505
+ */
6506
+ 'model'?: TableSchemaPropertiesValueXZuiComputedModelEnum;
6507
+ /**
6508
+ * Code to execute when action is \"code\"
6509
+ * @type {string}
6510
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6511
+ */
6512
+ 'code'?: string;
6513
+ /**
6514
+ *
6515
+ * @type {boolean}
6516
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6517
+ */
6518
+ 'enabled'?: boolean;
6519
+ }
6520
+ export declare const TableSchemaPropertiesValueXZuiComputedActionEnum: {
6521
+ readonly Ai: "ai";
6522
+ readonly Code: "code";
6523
+ };
6524
+ export type TableSchemaPropertiesValueXZuiComputedActionEnum = typeof TableSchemaPropertiesValueXZuiComputedActionEnum[keyof typeof TableSchemaPropertiesValueXZuiComputedActionEnum];
6525
+ export declare const TableSchemaPropertiesValueXZuiComputedModelEnum: {
6526
+ readonly _35Turbo: "gpt-3.5-turbo";
6527
+ readonly _4Turbo: "gpt-4-turbo";
6528
+ };
6529
+ export type TableSchemaPropertiesValueXZuiComputedModelEnum = typeof TableSchemaPropertiesValueXZuiComputedModelEnum[keyof typeof TableSchemaPropertiesValueXZuiComputedModelEnum];
6366
6530
  /**
6367
6531
  * Task definition
6368
6532
  * @export
@@ -7336,6 +7500,12 @@ export interface UpdateTableBody {
7336
7500
  'tags'?: {
7337
7501
  [key: string]: string;
7338
7502
  };
7503
+ /**
7504
+ * Indicates if the table is enabled for computation.
7505
+ * @type {boolean}
7506
+ * @memberof UpdateTableBody
7507
+ */
7508
+ 'isComputeEnabled'?: boolean;
7339
7509
  }
7340
7510
  /**
7341
7511
  *
@@ -7349,6 +7519,12 @@ export interface UpdateTableResponse {
7349
7519
  * @memberof UpdateTableResponse
7350
7520
  */
7351
7521
  'table': Table;
7522
+ /**
7523
+ * List of columns that have become stale following the modification.
7524
+ * @type {Array<string>}
7525
+ * @memberof UpdateTableResponse
7526
+ */
7527
+ 'staleColumns'?: Array<string>;
7352
7528
  }
7353
7529
  /**
7354
7530
  *
@@ -7362,6 +7538,12 @@ export interface UpdateTableRowsBody {
7362
7538
  * @memberof UpdateTableRowsBody
7363
7539
  */
7364
7540
  'rows': Array<UpdateTableRowsBodyRowsInner>;
7541
+ /**
7542
+ * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
7543
+ * @type {boolean}
7544
+ * @memberof UpdateTableRowsBody
7545
+ */
7546
+ 'waitComputed'?: boolean;
7365
7547
  }
7366
7548
  /**
7367
7549
  *
@@ -7922,6 +8104,12 @@ export interface UpsertTableRowsBody {
7922
8104
  * @memberof UpsertTableRowsBody
7923
8105
  */
7924
8106
  'keyColumn'?: string;
8107
+ /**
8108
+ * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
8109
+ * @type {boolean}
8110
+ * @memberof UpsertTableRowsBody
8111
+ */
8112
+ 'waitComputed'?: boolean;
7925
8113
  }
7926
8114
  /**
7927
8115
  *
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.13
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.13
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.13
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.13
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).