@botpress/client 0.24.0 → 0.24.2

package/dist/index.d.ts

@@ -1384,6 +1384,9 @@ interface GetStateResponse {
             [k: string]: any;
         };
     };
+    meta: {
+        cached: boolean;
+    };
 }
 
 interface SetStateRequestHeaders {
@@ -1520,6 +1523,9 @@ interface GetOrSetStateResponse {
             [k: string]: any;
         };
     };
+    meta: {
+        cached: boolean;
+    };
 }
 
 interface PatchStateRequestHeaders {
@@ -1612,6 +1618,9 @@ interface CallActionResponse {
     output: {
         [k: string]: any;
     };
+    meta: {
+        cached: boolean;
+    };
 }
 
 interface ConfigureIntegrationRequestHeaders {
@@ -7727,7 +7736,7 @@ interface UpsertFileRequestBody {
      */
     size: number;
     /**
-     * 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.
+     * 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.
      */
     index?: boolean;
     /**
@@ -8099,6 +8108,23 @@ interface SearchFilesResponse {
          * The score indicating the similarity of the passage to the query. A higher score indicates higher similarity.
          */
         score: number;
+        /**
+         * The passage metadata
+         */
+        meta: {
+            /**
+             * The type of passage
+             */
+            type?: "chunk";
+            /**
+             * The subtype of passage, if any.
+             */
+            subtype?: "title" | "subtitle" | "paragraph" | "list" | "note";
+            /**
+             * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
+             */
+            pageNumber?: number;
+        };
         file: {
             /**
              * File ID
@@ -8186,7 +8212,7 @@ interface ListTablesResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -8197,9 +8223,9 @@ interface ListTablesResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -8302,7 +8328,7 @@ interface GetTableResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -8313,9 +8339,9 @@ interface GetTableResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -8454,7 +8480,7 @@ interface GetOrCreateTableResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -8465,9 +8491,9 @@ interface GetOrCreateTableResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -8613,7 +8639,7 @@ interface CreateTableResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -8624,9 +8650,9 @@ interface CreateTableResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -8738,7 +8764,7 @@ interface DuplicateTableResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -8749,9 +8775,9 @@ interface DuplicateTableResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -8882,7 +8908,7 @@ interface UpdateTableResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -8893,9 +8919,9 @@ interface UpdateTableResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -9010,7 +9036,7 @@ interface RenameTableColumnResponse {
                          */
                         width?: number;
                         computed?: {
-                            action: "ai" | "code";
+                            action: "ai" | "workflow";
                             dependencies?: string[];
                             /**
                              * Prompt when action is "ai"
@@ -9021,9 +9047,9 @@ interface RenameTableColumnResponse {
                              */
                             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";
                             /**
-                             * Code to execute when action is "code"
+                             * ID of Workflow to execute when action is "workflow"
                              */
-                            code?: string;
+                            workflowId?: string;
                             enabled?: boolean;
                         };
                         /**
@@ -10147,6 +10173,15 @@ interface Workspace {
     isPublic?: boolean;
     handle?: string;
 }
+interface WorkspaceMember {
+    id: string;
+    userId?: string;
+    email: string;
+    createdAt: string;
+    role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
+    profilePicture?: string;
+    displayName?: string;
+}
 interface Account {
     id: string;
     email: string;
@@ -10397,6 +10432,186 @@ interface State {
         [k: string]: any;
     };
 }
+interface Table {
+    /**
+     * Unique identifier for the table
+     */
+    id: string;
+    /**
+     * Required. This name is used to identify your table.
+     */
+    name: string;
+    /**
+     * The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
+     */
+    factor?: number;
+    /**
+     * A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
+     */
+    frozen?: boolean;
+    schema: {
+        $schema: string;
+        /**
+         * List of keys/columns in the table.
+         */
+        properties: {
+            [k: string]: {
+                type: "string" | "number" | "boolean" | "object" | "null";
+                format?: "date-time";
+                description?: string;
+                nullable?: boolean;
+                "x-zui": {
+                    index: number;
+                    /**
+                     * [deprecated] ID of the column.
+                     */
+                    id?: string;
+                    /**
+                     * Indicates if the column is vectorized and searchable.
+                     */
+                    searchable?: boolean;
+                    /**
+                     * Indicates if the field is hidden in the UI
+                     */
+                    hidden?: boolean;
+                    /**
+                     * Order of the column in the UI
+                     */
+                    order?: number;
+                    /**
+                     * Width of the column in the UI
+                     */
+                    width?: number;
+                    computed?: {
+                        action: "ai" | "workflow";
+                        dependencies?: string[];
+                        /**
+                         * Prompt when action is "ai"
+                         */
+                        prompt?: string;
+                        /**
+                         * Model to use when action is "ai"
+                         */
+                        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";
+                        /**
+                         * ID of Workflow to execute when action is "workflow"
+                         */
+                        workflowId?: string;
+                        enabled?: boolean;
+                    };
+                    /**
+                     * TypeScript typings for the column. Recommended if the type is "object", ex: "\{ foo: string; bar: number \}"
+                     */
+                    typings?: string;
+                };
+            };
+        };
+        /**
+         * Additional properties can be provided, but they will be ignored if no column matches.
+         */
+        additionalProperties: true;
+        /**
+         * Array of required properties.
+         */
+        required?: string[];
+        type: "object";
+    };
+    /**
+     * Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
+     */
+    tags?: {
+        [k: string]: string;
+    };
+    /**
+     * Indicates if the table is enabled for computation.
+     */
+    isComputeEnabled?: boolean;
+    /**
+     * Timestamp of table creation.
+     */
+    createdAt?: string;
+    /**
+     * Timestamp of the last table update.
+     */
+    updatedAt?: string;
+}
+interface Column {
+    /**
+     * Unique identifier for the column.
+     */
+    id?: string;
+    /**
+     * Name of the column, must be within length limits.
+     */
+    name: string;
+    /**
+     * Optional descriptive text about the column.
+     */
+    description?: string;
+    /**
+     * Indicates if the column is vectorized and searchable.
+     */
+    searchable?: boolean;
+    /**
+     * Specifies the data type of the column. Use "object" for complex data structures.
+     */
+    type: "string" | "number" | "boolean" | "date" | "object";
+    /**
+     * TypeScript typings for the column. Recommended if the type is "object", ex: "\{ foo: string; bar: number \}"
+     */
+    typings?: string;
+    computed?: {
+        action: "ai" | "workflow";
+        dependencies?: string[];
+        /**
+         * Prompt when action is "ai"
+         */
+        prompt?: string;
+        /**
+         * Model to use when action is "ai"
+         */
+        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";
+        /**
+         * ID of Workflow to execute when action is "workflow"
+         */
+        workflowId?: string;
+        enabled?: boolean;
+    };
+    schema?: {
+        [k: string]: any;
+    };
+}
+interface Row {
+    /**
+     * Unique identifier for the row.
+     */
+    id: number;
+    /**
+     * Timestamp of row creation.
+     */
+    createdAt?: string;
+    /**
+     * Timestamp of the last row update.
+     */
+    updatedAt?: string;
+    computed: {
+        [k: string]: {
+            status: string;
+            error?: string;
+            updatedBy?: string;
+            updatedAt?: string;
+        };
+    };
+    /**
+     * [Read-only] List of stale values that are waiting to be recomputed.
+     */
+    stale?: string[];
+    /**
+     * Optional numeric value indicating similarity, when using findTableRows.
+     */
+    similarity?: number;
+    [k: string]: any;
+}
 interface File {
     /**
      * File ID
@@ -10907,4 +11122,4 @@ declare class Client extends Client$1 implements IClient {
     readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
 }
 
-export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, RuntimeError, type State, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workspace, errorFrom, isApiError };
+export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workspace, type WorkspaceMember, errorFrom, isApiError };