@botpress/client 0.36.2 → 0.37.1

package/dist/index.d.ts

@@ -3811,6 +3811,12 @@ interface CreateBotRequestBody {
             };
         };
     };
+    /**
+     * Tags of the [Bot](#schema_bot)
+     */
+    tags?: {
+        [k: string]: string;
+    };
     /**
      * JavaScript code of the bot
      */
@@ -4093,6 +4099,12 @@ interface CreateBotResponse {
                 };
             };
         };
+        /**
+         * Tags of [Bot](#schema_bot)
+         */
+        tags: {
+            [k: string]: string;
+        };
         /**
          * Name of the [Bot](#schema_bot)
          */
@@ -4163,6 +4175,12 @@ interface UpdateBotRequestBody {
             [k: string]: any;
         };
     };
+    /**
+     * Tags of the [Bot](#schema_bot)
+     */
+    tags?: {
+        [k: string]: string;
+    };
     blocked?: boolean;
     /**
      * Indicates if the [Bot](#schema_bot) should be in always alive mode
@@ -4584,6 +4602,12 @@ interface UpdateBotResponse {
                 };
             };
         };
+        /**
+         * Tags of [Bot](#schema_bot)
+         */
+        tags: {
+            [k: string]: string;
+        };
         /**
          * Name of the [Bot](#schema_bot)
          */
@@ -4946,6 +4970,12 @@ interface GetBotResponse {
                 };
             };
         };
+        /**
+         * Tags of [Bot](#schema_bot)
+         */
+        tags: {
+            [k: string]: string;
+        };
         /**
          * Name of the [Bot](#schema_bot)
          */
@@ -9973,7 +10003,7 @@ interface UpsertFileRequestBody {
                  *
                  * Notes:
                  * - This feature is only available in Team and Enterprise plans.
-                 * - Enabling this feature will incurr in AI Spend cost to use a vision-enabled LLM to index the PDF pages.
+                 * - Enabling this feature will incur in AI Spend cost to use a vision-enabled LLM to index the PDF pages.
                  * - This is limited to a maximum of 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be transcribed using this vision feature, and will be processed using the default text-based indexing instead. If you need to transcribe the entire file using vision, please split it into smaller files.
                  * - Pages that are vision-transcribed will not be processed by the default text-based indexing to avoid duplicate content in the index.
                  * - This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred.
@@ -9981,6 +10011,26 @@ interface UpsertFileRequestBody {
                 transcribePages?: {
                     [k: string]: any;
                 };
+                /**
+                 * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to index each page of the PDF as a standalone image.
+                 *
+                 * Enabling this feature will allow Autonomous Nodes in your bot to answer visual or higher-level questions about the content in these pages that can usually not be answered correctly by the default text-based indexing or visual transcription.
+                 *
+                 * This feature is useful when a PDF has:
+                 * - Tables with complex layouts
+                 * - Charts, diagrams or infographics
+                 * - Photos or images that can be used to answer user queries
+                 *
+                 * Notes:
+                 * - This feature is only available in Team and Enterprise plans.
+                 * - Enabling this will incur in extra AI Spend cost and additional File Storage usage, in order to use a vision-enabled LLM to visually index the PDF pages and store them as standalone page images in the bot's file storage.
+                 * - Enabling this may increase the overall AI Spend cost of your bot as your bot may pass one or more indexed page images to a vision-enabled LLM for answering user queries.
+                 * - This is limited to the first 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be vision-indexed. If you need to visually index the entire file, please split it into smaller files.
+                 * - This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred.
+                 */
+                indexPages?: {
+                    [k: string]: any;
+                };
             };
         };
     };
@@ -10428,11 +10478,11 @@ interface SearchFilesResponse {
             /**
              * The type of passage
              */
-            type?: "chunk" | "summary" | "consolidated";
+            type?: "chunk" | "summary" | "consolidated" | "image";
             /**
              * The subtype of passage, if available.
              */
-            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
+            subtype?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "page";
             /**
              * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
              */
@@ -10441,6 +10491,10 @@ interface SearchFilesResponse {
              * 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;
+            /**
+             * The URL of the source file for the vector, if applicable (e.g. for image vectors).
+             */
+            sourceUrl?: string;
         };
         file: {
             /**
@@ -10502,11 +10556,11 @@ interface ListFilePassagesResponse {
             /**
              * The type of passage
              */
-            type?: "chunk" | "summary" | "consolidated";
+            type?: "chunk" | "summary" | "consolidated" | "image";
             /**
              * The subtype of passage, if available.
              */
-            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
+            subtype?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "page";
             /**
              * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
              */
@@ -10515,6 +10569,10 @@ interface ListFilePassagesResponse {
              * 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;
+            /**
+             * The URL of the source file for the vector, if applicable (e.g. for image vectors).
+             */
+            sourceUrl?: string;
         };
     }[];
     meta: {
@@ -10556,7 +10614,7 @@ interface ListTablesResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -10701,7 +10759,7 @@ interface GetTableResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -10882,7 +10940,7 @@ interface GetOrCreateTableResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -11070,7 +11128,7 @@ interface CreateTableResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -11224,7 +11282,7 @@ interface DuplicateTableResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -11344,6 +11402,87 @@ interface DuplicateTableResponse {
     rows: number;
 }
 
+interface ExportTableRequestHeaders {
+}
+interface ExportTableRequestQuery {
+    format?: "csv" | "json";
+    compress?: boolean;
+}
+interface ExportTableRequestParams {
+    table: string;
+}
+interface ExportTableRequestBody {
+}
+type ExportTableInput = ExportTableRequestBody & ExportTableRequestHeaders & ExportTableRequestQuery & ExportTableRequestParams;
+interface ExportTableResponse {
+    job: {
+        id: string;
+        botId: string;
+        tableId: string;
+        type: "export" | "import";
+        status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
+        progress?: number;
+        inputFileId: string | null;
+        outputFileId: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+}
+
+interface GetTableJobsRequestHeaders {
+}
+interface GetTableJobsRequestQuery {
+}
+interface GetTableJobsRequestParams {
+    table: string;
+}
+interface GetTableJobsRequestBody {
+}
+type GetTableJobsInput = GetTableJobsRequestBody & GetTableJobsRequestHeaders & GetTableJobsRequestQuery & GetTableJobsRequestParams;
+interface GetTableJobsResponse {
+    jobs: {
+        id: string;
+        botId: string;
+        tableId: string;
+        type: "export" | "import";
+        status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
+        progress?: number;
+        inputFileId: string | null;
+        outputFileId: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+}
+
+interface ImportTableRequestHeaders {
+}
+interface ImportTableRequestQuery {
+}
+interface ImportTableRequestParams {
+    table: string;
+}
+interface ImportTableRequestBody {
+    /**
+     * The file ID to import. It must have been uploaded to the Files API before. Supported formats: CSV, JSON (gzipped or not)
+     */
+    fileId: string;
+}
+type ImportTableInput = ImportTableRequestBody & ImportTableRequestHeaders & ImportTableRequestQuery & ImportTableRequestParams;
+interface ImportTableResponse {
+    job: {
+        id: string;
+        botId: string;
+        tableId: string;
+        type: "export" | "import";
+        status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
+        progress?: number;
+        inputFileId: string | null;
+        outputFileId: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+}
+
 interface UpdateTableRequestHeaders {
 }
 interface UpdateTableRequestQuery {
@@ -11397,7 +11536,7 @@ interface UpdateTableResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -11554,7 +11693,7 @@ interface RenameTableColumnResponse {
          */
         frozen?: boolean;
         schema: {
-            $schema: string;
+            $schema?: string;
             /**
              * List of keys/columns in the table.
              */
@@ -12326,6 +12465,12 @@ interface Bot {
             };
         };
     };
+    /**
+     * Tags of [Bot](#schema_bot)
+     */
+    tags: {
+        [k: string]: string;
+    };
     /**
      * Name of the [Bot](#schema_bot)
      */
@@ -13325,7 +13470,7 @@ interface Table {
      */
     frozen?: boolean;
     schema: {
-        $schema: string;
+        $schema?: string;
         /**
          * List of keys/columns in the table.
          */
@@ -13738,6 +13883,9 @@ declare class Client$1 {
     readonly getOrCreateTable: (input: GetOrCreateTableInput) => Promise<GetOrCreateTableResponse>;
     readonly createTable: (input: CreateTableInput) => Promise<CreateTableResponse>;
     readonly duplicateTable: (input: DuplicateTableInput) => Promise<DuplicateTableResponse>;
+    readonly exportTable: (input: ExportTableInput) => Promise<ExportTableResponse>;
+    readonly getTableJobs: (input: GetTableJobsInput) => Promise<GetTableJobsResponse>;
+    readonly importTable: (input: ImportTableInput) => Promise<ImportTableResponse>;
     readonly updateTable: (input: UpdateTableInput) => Promise<UpdateTableResponse>;
     readonly renameTableColumn: (input: RenameTableColumnInput) => Promise<RenameTableColumnResponse>;
     readonly deleteTable: (input: DeleteTableInput) => Promise<DeleteTableResponse>;
@@ -14009,51 +14157,9 @@ type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenErro
 declare const errorFrom: (err: unknown) => ApiError;
 
 declare class UploadFileError extends Error {
-    readonly innerError?: AxiosError<unknown, any> | undefined;
-    readonly file?: {
-        id: string;
-        botId: string;
-        key: string;
-        url: string;
-        size: number | null;
-        contentType: string;
-        tags: {
-            [k: string]: string;
-        };
-        metadata: {
-            [k: string]: any;
-        };
-        createdAt: string;
-        updatedAt: string;
-        accessPolicies: ("integrations" | "public_content")[];
-        index: boolean;
-        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
-        failedStatusReason?: string | undefined;
-        expiresAt?: string | undefined;
-        uploadUrl: string;
-    } | undefined;
-    constructor(message: string, innerError?: AxiosError<unknown, any> | undefined, file?: {
-        id: string;
-        botId: string;
-        key: string;
-        url: string;
-        size: number | null;
-        contentType: string;
-        tags: {
-            [k: string]: string;
-        };
-        metadata: {
-            [k: string]: any;
-        };
-        createdAt: string;
-        updatedAt: string;
-        accessPolicies: ("integrations" | "public_content")[];
-        index: boolean;
-        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
-        failedStatusReason?: string | undefined;
-        expiresAt?: string | undefined;
-        uploadUrl: string;
-    } | undefined);
+    readonly innerError?: AxiosError | undefined;
+    readonly file?: UpsertFileResponse["file"] | undefined;
+    constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
 }
 
 type ListOperation = keyof {
@@ -14083,10 +14189,10 @@ declare class AsyncCollection<T> {
 declare class Lister {
     private _client;
     constructor(_client: Client$1);
-    readonly conversations: (props: ListInputs['listConversations']) => AsyncCollection<{
+    readonly conversations: (props: ListInputs["listConversations"]) => AsyncCollection<{
         id: string;
-        currentTaskId?: string | undefined;
-        currentWorkflowId?: string | undefined;
+        currentTaskId?: string;
+        currentWorkflowId?: string;
         createdAt: string;
         updatedAt: string;
         channel: string;
@@ -14095,30 +14201,30 @@ declare class Lister {
             [k: string]: string;
         };
     }>;
-    readonly participants: (props: ListInputs['listParticipants']) => AsyncCollection<{
+    readonly participants: (props: ListInputs["listParticipants"]) => AsyncCollection<{
         id: string;
         createdAt: string;
         updatedAt: string;
         tags: {
             [k: string]: string;
         };
-        name?: string | undefined;
-        pictureUrl?: string | undefined;
+        name?: string;
+        pictureUrl?: string;
     }>;
-    readonly events: (props: ListInputs['listEvents']) => AsyncCollection<{
+    readonly events: (props: ListInputs["listEvents"]) => AsyncCollection<{
         id: string;
         createdAt: string;
         type: string;
         payload: {
             [k: string]: any;
         };
-        conversationId?: string | undefined;
-        userId?: string | undefined;
-        messageId?: string | undefined;
+        conversationId?: string;
+        userId?: string;
+        messageId?: string;
         status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
         failureReason: string | null;
     }>;
-    readonly messages: (props: ListInputs['listMessages']) => AsyncCollection<{
+    readonly messages: (props: ListInputs["listMessages"]) => AsyncCollection<{
         id: string;
         createdAt: string;
         type: string;
@@ -14132,17 +14238,17 @@ declare class Lister {
             [k: string]: string;
         };
     }>;
-    readonly users: (props: ListInputs['listUsers']) => AsyncCollection<{
+    readonly users: (props: ListInputs["listUsers"]) => AsyncCollection<{
         id: string;
         createdAt: string;
         updatedAt: string;
         tags: {
             [k: string]: string;
         };
-        name?: string | undefined;
-        pictureUrl?: string | undefined;
+        name?: string;
+        pictureUrl?: string;
     }>;
-    readonly tasks: (props: ListInputs['listTasks']) => AsyncCollection<{
+    readonly tasks: (props: ListInputs["listTasks"]) => AsyncCollection<{
         id: string;
         title: string;
         description: string;
@@ -14150,19 +14256,19 @@ declare class Lister {
         data: {
             [k: string]: any;
         };
-        status: "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
-        parentTaskId?: string | undefined;
-        conversationId?: string | undefined;
-        userId?: string | undefined;
+        status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
+        parentTaskId?: string;
+        conversationId?: string;
+        userId?: string;
         timeoutAt: string;
         createdAt: string;
         updatedAt: string;
-        failureReason?: string | undefined;
+        failureReason?: string;
         tags: {
             [k: string]: string;
         };
     }>;
-    readonly publicIntegrations: (props: ListInputs['listPublicIntegrations']) => AsyncCollection<{
+    readonly publicIntegrations: (props: ListInputs["listPublicIntegrations"]) => AsyncCollection<{
         id: string;
         name: string;
         version: string;
@@ -14172,7 +14278,7 @@ declare class Lister {
         description: string;
         iconUrl: string;
         public: boolean;
-        verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
+        verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
         ownerWorkspace: {
             id: string;
             handle: string | null;
@@ -14183,14 +14289,14 @@ declare class Lister {
             views: number;
         };
     }>;
-    readonly bots: (props: ListInputs['listBots']) => AsyncCollection<{
+    readonly bots: (props: ListInputs["listBots"]) => AsyncCollection<{
         id: string;
         createdAt: string;
         updatedAt: string;
         name: string;
-        deployedAt?: string | undefined;
+        deployedAt?: string;
     }>;
-    readonly botIssues: (props: ListInputs['listBotIssues']) => AsyncCollection<{
+    readonly botIssues: (props: ListInputs["listBotIssues"]) => AsyncCollection<{
         id: string;
         code: string;
         createdAt: string;
@@ -14200,25 +14306,25 @@ declare class Lister {
         groupedData: {
             [k: string]: {
                 raw: string;
-                pretty?: string | undefined;
+                pretty?: string;
             };
         };
         eventsCount: number;
-        category: "configuration" | "user_code" | "limits" | "other";
+        category: "user_code" | "limits" | "configuration" | "other";
         resolutionLink: string | null;
     }>;
-    readonly workspaces: (props: ListInputs['listWorkspaces']) => AsyncCollection<UpdateWorkspaceResponse>;
-    readonly publicWorkspaces: (props: ListInputs['listPublicWorkspaces']) => AsyncCollection<GetPublicWorkspaceResponse>;
-    readonly workspaceMembers: (props: ListInputs['listWorkspaceMembers']) => AsyncCollection<{
+    readonly workspaces: (props: ListInputs["listWorkspaces"]) => AsyncCollection<UpdateWorkspaceResponse>;
+    readonly publicWorkspaces: (props: ListInputs["listPublicWorkspaces"]) => AsyncCollection<GetPublicWorkspaceResponse>;
+    readonly workspaceMembers: (props: ListInputs["listWorkspaceMembers"]) => AsyncCollection<{
         id: string;
-        userId?: string | undefined;
+        userId?: string;
         email: string;
         createdAt: string;
         role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
-        profilePicture?: string | undefined;
-        displayName?: string | undefined;
+        profilePicture?: string;
+        displayName?: string;
     }>;
-    readonly integrations: (props: ListInputs['listIntegrations']) => AsyncCollection<{
+    readonly integrations: (props: ListInputs["listIntegrations"]) => AsyncCollection<{
         id: string;
         name: string;
         version: string;
@@ -14228,16 +14334,16 @@ declare class Lister {
         description: string;
         iconUrl: string;
         public: boolean;
-        verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
+        verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
     }>;
-    readonly interfaces: (props: ListInputs['listInterfaces']) => AsyncCollection<{
+    readonly interfaces: (props: ListInputs["listInterfaces"]) => AsyncCollection<{
         id: string;
         createdAt: string;
         updatedAt: string;
         name: string;
         version: string;
     }>;
-    readonly activities: (props: ListInputs['listActivities']) => AsyncCollection<{
+    readonly activities: (props: ListInputs["listActivities"]) => AsyncCollection<{
         id: string;
         description: string;
         taskId: string;
@@ -14247,7 +14353,7 @@ declare class Lister {
         };
         createdAt: string;
     }>;
-    readonly files: (props: ListInputs['listFiles']) => AsyncCollection<{
+    readonly files: (props: ListInputs["listFiles"]) => AsyncCollection<{
         id: string;
         botId: string;
         key: string;
@@ -14258,24 +14364,25 @@ declare class Lister {
             [k: string]: string;
         };
         metadata: {
-            [k: string]: any;
+            [k: string]: any | null;
         };
         createdAt: string;
         updatedAt: string;
         accessPolicies: ("integrations" | "public_content")[];
         index: boolean;
         status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
-        failedStatusReason?: string | undefined;
-        expiresAt?: string | undefined;
+        failedStatusReason?: string;
+        expiresAt?: string;
     }>;
-    readonly filePassages: (props: ListInputs['listFilePassages']) => AsyncCollection<{
+    readonly filePassages: (props: ListInputs["listFilePassages"]) => AsyncCollection<{
         id: string;
         content: string;
         meta: {
-            type?: "chunk" | "summary" | "consolidated" | undefined;
-            subtype?: "code" | "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | undefined;
-            pageNumber?: number | undefined;
-            position?: number | undefined;
+            type?: "chunk" | "summary" | "consolidated" | "image";
+            subtype?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "page";
+            pageNumber?: number;
+            position?: number;
+            sourceUrl?: string;
         };
     }>;
 }
@@ -14287,7 +14394,7 @@ declare class Client extends Client$1 implements IClient {
     /**
      * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
      */
-    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, indexing, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
+    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, indexing, expiresAt, publicContentImmediatelyAccessible, }: 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 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, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workflow, type Workspace, type WorkspaceMember, errorFrom, isApiError };