@botpress/client 0.34.1 → 0.36.0

package/dist/index.d.ts

@@ -2955,6 +2955,10 @@ interface GetPublicIntegrationByIdResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -3326,6 +3330,10 @@ interface GetPublicIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6277,6 +6285,10 @@ interface CreateIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6931,6 +6943,10 @@ interface UpdateIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -7356,6 +7372,10 @@ interface GetIntegrationResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -7740,6 +7760,10 @@ interface GetIntegrationByNameResponse {
                  * Name of the interface
                  */
                 name: string;
+                /**
+                 * Version of the interface
+                 */
+                version: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -8785,6 +8809,7 @@ interface ListInterfacesRequestHeaders {
 }
 interface ListInterfacesRequestQuery {
     nextToken?: string;
+    name?: string;
 }
 interface ListInterfacesRequestParams {
 }
@@ -9046,6 +9071,86 @@ interface UpsertFileRequestBody {
      * 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;
+    indexing?: {
+        /**
+         * Configuration to use for indexing the file, will be stored in the file's metadata for reference.
+         */
+        configuration: {
+            parsing?: {
+                /**
+                 * The minimum length a standalone paragraph should have. If a paragraph is shorter than this, it will be merged with the next immediate paragraph.
+                 */
+                minimumParagraphLength?: number;
+                /**
+                 * (Team/Enterprise plan only, charged as AI Spend) Enabling this will use a lightweight/inexpensive LLM to clean up the extracted content of PDF files before indexing them to increase the quality of the stored vectors, as PDFs often store raw text in unusual ways which when extracted may result in formatting issues (e.g. broken sentences/paragraphs, unexpected headings, garbled characters, etc.) that can affect retrieval performance for certain user queries if left untouched.
+                 *
+                 * Notes:
+                 * - This feature is only available in Team and Enterprise plans.
+                 * - 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.
+                 * - We recommend using this feature for PDFs that have custom layouts or design. For simple text-based PDFs like documents and books, this feature is usually not necessary.
+                 * - The smart cleanup takes some time to perform due to the LLM calls involved, so enabling it will increase the total time it takes to index the file.
+                 * - We take steps to prevent the original text from being fundamentally changed but due to the nature of LLMs this could theoretically still happen so it's recommended to review the passages generated for the file after indexing to ensure the content is still accurate.
+                 * - This feature is limited to the first 30 pages or 20 KB of text in the PDF file (whichever comes first). If the file has more content than these limits then the rest of the file will be indexed as-is without any cleanup. If you need to clean up the content of the entire file, consider splitting it into smaller files.
+                 */
+                smartCleanup?: boolean;
+            };
+            chunking?: {
+                /**
+                 * The maximum length of a chunk in characters.
+                 */
+                maximumChunkLength?: number;
+                /**
+                 * The number of surrounding context levels to include in the vector embedding of the chunk.
+                 */
+                embeddedContextLevels?: number;
+                /**
+                 * Include the breadcrumb of the chunk in the vector embedding.
+                 */
+                embedBreadcrumb?: boolean;
+            };
+            summarization?: {
+                /**
+                 * (Team/Enterprise plan only, charged as AI Spend) Create summaries for this file and index them as standalone vectors. Enabling this option will incur in AI Spend cost (charged to the workspace of the bot) to generate the summaries based on the amount of content in the file and the summarization model used.
+                 *
+                 * Please note that this feature is only available in Team and Enterprise plans.
+                 */
+                enable?: boolean;
+                /**
+                 * The model type to use for summarization.
+                 */
+                modelType?: "inexpensive" | "balanced" | "accurate";
+                /**
+                 * The minimum length a section of the file should have to create a summary of it.
+                 */
+                minimumInputLength?: number;
+                /**
+                 * The maximum length of a summary (in tokens).
+                 */
+                outputTokenLimit?: number;
+                /**
+                 * Generate a summary of the entire file and index it as a standalone vector.
+                 */
+                generateMasterSummary?: boolean;
+            };
+            vision?: {
+                /**
+                 * (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 transcribe each page of the PDF as standalone vectors and index them.
+                 *
+                 * This feature is useful when a PDF file contains custom designs or layouts, or when your document has many infographics, which require visual processing in order to index the file effectively, as the default text-based indexing may not be enough to allow your bot to correctly understand the content in your PDFs.
+                 *
+                 * 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.
+                 * - 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.
+                 */
+                transcribePages?: {
+                    [k: string]: any;
+                };
+            };
+        };
+    };
     /**
      * File access policies. Add "public_content" to allow public access to the file content. Add "integrations" to allow read, search and list operations for any integration installed in the bot.
      */
@@ -9064,6 +9169,12 @@ interface UpsertFileRequestBody {
      * If set to `true`, the `x-amz-tagging` HTTP header with a value of `public=true` will need to be sent in the HTTP PUT request to the `uploadUrl` in order for the upload request to work.
      */
     publicContentImmediatelyAccessible?: boolean;
+    /**
+     * Custom metadata for the file expressed as an object of key-value pairs. The values can be of any type.
+     */
+    metadata?: {
+        [k: string]: any;
+    };
 }
 type UpsertFileInput = UpsertFileRequestBody & UpsertFileRequestHeaders & UpsertFileRequestQuery & UpsertFileRequestParams;
 interface UpsertFileResponse {
@@ -9100,6 +9211,12 @@ interface UpsertFileResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Metadata of the file as an object of key/value pairs. The values can be of any type.
+         */
+        metadata: {
+            [k: string]: any;
+        };
         /**
          * File creation timestamp in ISO 8601 format
          */
@@ -9203,6 +9320,12 @@ interface ListFilesResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Metadata of the file as an object of key/value pairs. The values can be of any type.
+         */
+        metadata: {
+            [k: string]: any | null;
+        };
         /**
          * File creation timestamp in ISO 8601 format
          */
@@ -9290,6 +9413,12 @@ interface GetFileResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Metadata of the file as an object of key/value pairs. The values can be of any type.
+         */
+        metadata: {
+            [k: string]: any;
+        };
         /**
          * File creation timestamp in ISO 8601 format
          */
@@ -9335,6 +9464,12 @@ interface UpdateFileMetadataRequestParams {
     id: string;
 }
 interface UpdateFileMetadataRequestBody {
+    /**
+     * Custom metadata for the file expressed as an object of key-value pairs. Omit to keep existing metadata intact. Any existing metadata keys not included will be preserved. New keys will be added. To delete a metadata key, set its value to `null`.
+     */
+    metadata?: {
+        [k: string]: any;
+    };
     /**
      * The file tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
      */
@@ -9385,6 +9520,12 @@ interface UpdateFileMetadataResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Metadata of the file as an object of key/value pairs. The values can be of any type.
+         */
+        metadata: {
+            [k: string]: any;
+        };
         /**
          * File creation timestamp in ISO 8601 format
          */
@@ -9506,7 +9647,7 @@ interface ListFilePassagesRequestQuery {
     limit?: number;
 }
 interface ListFilePassagesRequestParams {
-    fileId: string;
+    id: string;
 }
 interface ListFilePassagesRequestBody {
 }
@@ -11438,6 +11579,10 @@ interface Integration {
              * Name of the interface
              */
             name: string;
+            /**
+             * Version of the interface
+             */
+            version: string;
             entities: {
                 [k: string]: {
                     name: string;
@@ -12447,6 +12592,12 @@ interface File {
     tags: {
         [k: string]: string;
     };
+    /**
+     * Metadata of the file as an object of key/value pairs. The values can be of any type.
+     */
+    metadata: {
+        [k: string]: any;
+    };
     /**
      * File creation timestamp in ISO 8601 format
      */
@@ -12891,45 +13042,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;
-        };
-        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;
-        };
-        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 {
@@ -12959,10 +13074,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;
@@ -12971,30 +13086,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;
@@ -13008,17 +13123,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;
@@ -13026,19 +13141,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;
@@ -13048,7 +13163,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;
@@ -13059,14 +13174,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;
@@ -13076,25 +13191,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;
@@ -13104,16 +13219,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;
@@ -13123,7 +13238,7 @@ declare class Lister {
         };
         createdAt: string;
     }>;
-    readonly files: (props: ListInputs['listFiles']) => AsyncCollection<{
+    readonly files: (props: ListInputs["listFiles"]) => AsyncCollection<{
         id: string;
         botId: string;
         key: string;
@@ -13133,22 +13248,25 @@ declare class Lister {
         tags: {
             [k: string]: string;
         };
+        metadata: {
+            [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";
+            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
+            pageNumber?: number;
+            position?: number;
         };
     }>;
 }
@@ -13160,7 +13278,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, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
+    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, 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, 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 };