@botpress/client 0.24.0 → 0.24.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 (7) hide show
  1. package/.turbo/turbo-build.log +7 -7
  2. package/.turbo/turbo-generate.log +1 -1
  3. package/dist/bundle.cjs.map +1 -1
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.ts +48 -22
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -1384,6 +1384,9 @@ interface GetStateResponse {
1384
1384
  [k: string]: any;
1385
1385
  };
1386
1386
  };
1387
+ meta: {
1388
+ cached: boolean;
1389
+ };
1387
1390
  }
1388
1391
 
1389
1392
  interface SetStateRequestHeaders {
@@ -1520,6 +1523,9 @@ interface GetOrSetStateResponse {
1520
1523
  [k: string]: any;
1521
1524
  };
1522
1525
  };
1526
+ meta: {
1527
+ cached: boolean;
1528
+ };
1523
1529
  }
1524
1530
 
1525
1531
  interface PatchStateRequestHeaders {
@@ -1612,6 +1618,9 @@ interface CallActionResponse {
1612
1618
  output: {
1613
1619
  [k: string]: any;
1614
1620
  };
1621
+ meta: {
1622
+ cached: boolean;
1623
+ };
1615
1624
  }
1616
1625
 
1617
1626
  interface ConfigureIntegrationRequestHeaders {
@@ -7727,7 +7736,7 @@ interface UpsertFileRequestBody {
7727
7736
  */
7728
7737
  size: number;
7729
7738
  /**
7730
- * Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. 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.
7739
+ * 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.
7731
7740
  */
7732
7741
  index?: boolean;
7733
7742
  /**
@@ -8099,6 +8108,23 @@ interface SearchFilesResponse {
8099
8108
  * The score indicating the similarity of the passage to the query. A higher score indicates higher similarity.
8100
8109
  */
8101
8110
  score: number;
8111
+ /**
8112
+ * The passage metadata
8113
+ */
8114
+ meta: {
8115
+ /**
8116
+ * The type of passage
8117
+ */
8118
+ type?: "chunk";
8119
+ /**
8120
+ * The subtype of passage, if any.
8121
+ */
8122
+ subtype?: "title" | "subtitle" | "paragraph" | "list" | "note";
8123
+ /**
8124
+ * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
8125
+ */
8126
+ pageNumber?: number;
8127
+ };
8102
8128
  file: {
8103
8129
  /**
8104
8130
  * File ID
@@ -8186,7 +8212,7 @@ interface ListTablesResponse {
8186
8212
  */
8187
8213
  width?: number;
8188
8214
  computed?: {
8189
- action: "ai" | "code";
8215
+ action: "ai" | "workflow";
8190
8216
  dependencies?: string[];
8191
8217
  /**
8192
8218
  * Prompt when action is "ai"
@@ -8197,9 +8223,9 @@ interface ListTablesResponse {
8197
8223
  */
8198
8224
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
8199
8225
  /**
8200
- * Code to execute when action is "code"
8226
+ * ID of Workflow to execute when action is "workflow"
8201
8227
  */
8202
- code?: string;
8228
+ workflowId?: string;
8203
8229
  enabled?: boolean;
8204
8230
  };
8205
8231
  /**
@@ -8302,7 +8328,7 @@ interface GetTableResponse {
8302
8328
  */
8303
8329
  width?: number;
8304
8330
  computed?: {
8305
- action: "ai" | "code";
8331
+ action: "ai" | "workflow";
8306
8332
  dependencies?: string[];
8307
8333
  /**
8308
8334
  * Prompt when action is "ai"
@@ -8313,9 +8339,9 @@ interface GetTableResponse {
8313
8339
  */
8314
8340
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
8315
8341
  /**
8316
- * Code to execute when action is "code"
8342
+ * ID of Workflow to execute when action is "workflow"
8317
8343
  */
8318
- code?: string;
8344
+ workflowId?: string;
8319
8345
  enabled?: boolean;
8320
8346
  };
8321
8347
  /**
@@ -8454,7 +8480,7 @@ interface GetOrCreateTableResponse {
8454
8480
  */
8455
8481
  width?: number;
8456
8482
  computed?: {
8457
- action: "ai" | "code";
8483
+ action: "ai" | "workflow";
8458
8484
  dependencies?: string[];
8459
8485
  /**
8460
8486
  * Prompt when action is "ai"
@@ -8465,9 +8491,9 @@ interface GetOrCreateTableResponse {
8465
8491
  */
8466
8492
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
8467
8493
  /**
8468
- * Code to execute when action is "code"
8494
+ * ID of Workflow to execute when action is "workflow"
8469
8495
  */
8470
- code?: string;
8496
+ workflowId?: string;
8471
8497
  enabled?: boolean;
8472
8498
  };
8473
8499
  /**
@@ -8613,7 +8639,7 @@ interface CreateTableResponse {
8613
8639
  */
8614
8640
  width?: number;
8615
8641
  computed?: {
8616
- action: "ai" | "code";
8642
+ action: "ai" | "workflow";
8617
8643
  dependencies?: string[];
8618
8644
  /**
8619
8645
  * Prompt when action is "ai"
@@ -8624,9 +8650,9 @@ interface CreateTableResponse {
8624
8650
  */
8625
8651
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
8626
8652
  /**
8627
- * Code to execute when action is "code"
8653
+ * ID of Workflow to execute when action is "workflow"
8628
8654
  */
8629
- code?: string;
8655
+ workflowId?: string;
8630
8656
  enabled?: boolean;
8631
8657
  };
8632
8658
  /**
@@ -8738,7 +8764,7 @@ interface DuplicateTableResponse {
8738
8764
  */
8739
8765
  width?: number;
8740
8766
  computed?: {
8741
- action: "ai" | "code";
8767
+ action: "ai" | "workflow";
8742
8768
  dependencies?: string[];
8743
8769
  /**
8744
8770
  * Prompt when action is "ai"
@@ -8749,9 +8775,9 @@ interface DuplicateTableResponse {
8749
8775
  */
8750
8776
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
8751
8777
  /**
8752
- * Code to execute when action is "code"
8778
+ * ID of Workflow to execute when action is "workflow"
8753
8779
  */
8754
- code?: string;
8780
+ workflowId?: string;
8755
8781
  enabled?: boolean;
8756
8782
  };
8757
8783
  /**
@@ -8882,7 +8908,7 @@ interface UpdateTableResponse {
8882
8908
  */
8883
8909
  width?: number;
8884
8910
  computed?: {
8885
- action: "ai" | "code";
8911
+ action: "ai" | "workflow";
8886
8912
  dependencies?: string[];
8887
8913
  /**
8888
8914
  * Prompt when action is "ai"
@@ -8893,9 +8919,9 @@ interface UpdateTableResponse {
8893
8919
  */
8894
8920
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
8895
8921
  /**
8896
- * Code to execute when action is "code"
8922
+ * ID of Workflow to execute when action is "workflow"
8897
8923
  */
8898
- code?: string;
8924
+ workflowId?: string;
8899
8925
  enabled?: boolean;
8900
8926
  };
8901
8927
  /**
@@ -9010,7 +9036,7 @@ interface RenameTableColumnResponse {
9010
9036
  */
9011
9037
  width?: number;
9012
9038
  computed?: {
9013
- action: "ai" | "code";
9039
+ action: "ai" | "workflow";
9014
9040
  dependencies?: string[];
9015
9041
  /**
9016
9042
  * Prompt when action is "ai"
@@ -9021,9 +9047,9 @@ interface RenameTableColumnResponse {
9021
9047
  */
9022
9048
  model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
9023
9049
  /**
9024
- * Code to execute when action is "code"
9050
+ * ID of Workflow to execute when action is "workflow"
9025
9051
  */
9026
- code?: string;
9052
+ workflowId?: string;
9027
9053
  enabled?: boolean;
9028
9054
  };
9029
9055
  /**