@botpress/client 0.24.1 → 0.25.0

package/dist/index.d.ts

@@ -132,6 +132,8 @@ interface ListConversationsRequestHeaders {
 }
 interface ListConversationsRequestQuery {
     nextToken?: string;
+    sortField?: "createdAt" | "updatedAt";
+    sortDirection?: "asc" | "desc";
     tags?: {
         [k: string]: string;
     };
@@ -8109,7 +8111,7 @@ interface SearchFilesResponse {
          */
         score: number;
         /**
-         * The passage metadata
+         * The passage metadata.
          */
         meta: {
             /**
@@ -8117,13 +8119,17 @@ interface SearchFilesResponse {
              */
             type?: "chunk";
             /**
-             * The subtype of passage, if any.
+             * The subtype of passage, if available.
              */
-            subtype?: "title" | "subtitle" | "paragraph" | "list" | "note";
+            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
             /**
              * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
              */
             pageNumber?: number;
+            /**
+             * Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file.
+             */
+            position?: number;
         };
         file: {
             /**
@@ -8148,6 +8154,58 @@ interface SearchFilesResponse {
     }[];
 }
 
+interface ListFilePassagesRequestHeaders {
+}
+interface ListFilePassagesRequestQuery {
+    nextToken?: string;
+    limit?: number;
+}
+interface ListFilePassagesRequestParams {
+    fileId: string;
+}
+interface ListFilePassagesRequestBody {
+}
+type ListFilePassagesInput = ListFilePassagesRequestBody & ListFilePassagesRequestHeaders & ListFilePassagesRequestQuery & ListFilePassagesRequestParams;
+interface ListFilePassagesResponse {
+    passages: {
+        /**
+         * Passage ID
+         */
+        id: string;
+        /**
+         * The content of the passage.
+         */
+        content: string;
+        /**
+         * The passage metadata.
+         */
+        meta: {
+            /**
+             * The type of passage
+             */
+            type?: "chunk";
+            /**
+             * The subtype of passage, if available.
+             */
+            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
+            /**
+             * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
+             */
+            pageNumber?: number;
+            /**
+             * Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file.
+             */
+            position?: number;
+        };
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}
+
 interface ListTablesRequestHeaders {
 }
 interface ListTablesRequestQuery {
@@ -8221,7 +8279,7 @@ interface ListTablesResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8337,7 +8395,7 @@ interface GetTableResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8489,7 +8547,7 @@ interface GetOrCreateTableResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8648,7 +8706,7 @@ interface CreateTableResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8773,7 +8831,7 @@ interface DuplicateTableResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8917,7 +8975,7 @@ interface UpdateTableResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -9045,7 +9103,7 @@ interface RenameTableColumnResponse {
                             /**
                              * 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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -10173,6 +10231,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;
@@ -10423,6 +10490,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?: string;
+                        /**
+                         * 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?: string;
+        /**
+         * 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
@@ -10611,6 +10858,7 @@ declare class Client$1 {
     readonly getFile: (input: GetFileInput) => Promise<GetFileResponse>;
     readonly updateFileMetadata: (input: UpdateFileMetadataInput) => Promise<UpdateFileMetadataResponse>;
     readonly searchFiles: (input: SearchFilesInput) => Promise<SearchFilesResponse>;
+    readonly listFilePassages: (input: ListFilePassagesInput) => Promise<ListFilePassagesResponse>;
     readonly listTables: (input: ListTablesInput) => Promise<ListTablesResponse>;
     readonly getTable: (input: GetTableInput) => Promise<GetTableResponse>;
     readonly getOrCreateTable: (input: GetOrCreateTableInput) => Promise<GetOrCreateTableResponse>;
@@ -10933,4 +11181,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 };