@botpress/cognitive 0.1.10 → 0.1.12

package/.turbo/turbo-build.log

@@ -1,19 +1,19 @@
 
-> @botpress/cognitive@0.1.10 build /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.1.12 build /home/runner/work/botpress/botpress/packages/cognitive
 > pnpm build:type && pnpm build:neutral && size-limit
 
 
-> @botpress/cognitive@0.1.10 build:type /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.1.12 build:type /home/runner/work/botpress/botpress/packages/cognitive
 > tsup --tsconfig tsconfig.build.json ./src/index.ts --dts-resolve --dts-only --clean
 
 CLI Building entry: ./src/index.ts
 CLI Using tsconfig: tsconfig.build.json
 CLI tsup v8.0.2
 DTS Build start
-DTS ⚡️ Build success in 9051ms
-DTS dist/index.d.ts 501.77 KB
+DTS ⚡️ Build success in 11385ms
+DTS dist/index.d.ts 521.56 KB
 
-> @botpress/cognitive@0.1.10 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.1.12 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
 > ts-node -T ./build.ts --neutral
 
 Done

package/dist/index.d.ts

@@ -1011,117 +1011,395 @@ declare module 'axios' {
     }
 }
 
-type Primitive = string | number | boolean;
-type Value<P extends Primitive> = P | P[] | Record<string, P>;
-type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
-type AnyQueryParams = Record<string, QueryValue>;
-type HeaderValue = string | undefined;
-type AnyHeaderParams = Record<string, HeaderValue>;
-type AnyBodyParams = Record<string, any>;
-type ParsedRequest = {
-    method: string;
-    path: string;
-    query: AnyQueryParams;
-    headers: AnyHeaderParams;
-    body: AnyBodyParams;
+type Headers = Record<string, string | string[]>;
+type RetryConfig = IAxiosRetryConfig;
+type ClientConfig = {
+    apiUrl: string;
+    headers: Headers;
+    withCredentials: boolean;
+    timeout: number;
 };
-declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig$2;
 
-interface CreateConversationRequestHeaders {
+type CommonClientProps = {
+    apiUrl?: string;
+    timeout?: number;
+    headers?: Headers;
+    retry?: RetryConfig;
+};
+type SimplifyTuple<T> = T extends [...infer A] ? {
+    [K in keyof A]: Simplify<A[K]>;
+} : never;
+type SimplifyObject<T extends object> = T extends infer O ? {
+    [K in keyof O]: Simplify<O[K]>;
+} : never;
+type Simplify<T> = T extends (...args: infer A) => infer R ? (...args: SimplifyTuple<A>) => Simplify<R> : T extends Array<infer E> ? Array<Simplify<E>> : T extends ReadonlyArray<infer E> ? ReadonlyArray<Simplify<E>> : T extends Promise<infer R> ? Promise<Simplify<R>> : T extends Buffer ? Buffer : T extends object ? SimplifyObject<T> : T;
+
+type PageLister<R> = (t: {
+    nextToken?: string;
+}) => Promise<{
+    items: R[];
+    meta: {
+        nextToken?: string;
+    };
+}>;
+declare class AsyncCollection<T> {
+    private _list;
+    constructor(_list: PageLister<T>);
+    [Symbol.asyncIterator](): AsyncGenerator<Awaited<T>, void, unknown>;
+    collect(props?: {
+        limit?: number;
+    }): Promise<T[]>;
 }
-interface CreateConversationRequestQuery {
+
+interface UpsertFileRequestHeaders$1 {
 }
-interface CreateConversationRequestParams {
+interface UpsertFileRequestQuery$1 {
 }
-interface CreateConversationRequestBody {
+interface UpsertFileRequestParams$1 {
+}
+interface UpsertFileRequestBody$1 {
     /**
-     * Channel name
+     * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
      */
-    channel: string;
+    key: string;
     /**
-     * Tags for the [Conversation](#schema_conversation)
+     * File tags as an object of key-value pairs. Tag values should be of `string` (text) type.
      */
-    tags: {
+    tags?: {
         [k: string]: string;
     };
     /**
-     * @deprecated
-     * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
+     * File size in bytes. This will count against your File Storage quota. If the `index` parameter is set to `true`, this will also count against your Vector DB Storage quota.
      */
-    integrationName?: string;
-}
-type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
-interface CreateConversationResponse {
+    size: number;
     /**
-     * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
+     * 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.
      */
-    conversation: {
+    index?: boolean;
+    indexing?: {
         /**
-         * Id of the [Conversation](#schema_conversation)
+         * Configuration to use for indexing the file, will be stored in the file's metadata for reference.
          */
-        id: string;
+        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 incur in AI Spend cost to use a vision-enabled LLM to index the PDF pages.
+                 * - This is limited to a maximum of 100 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;
+                };
+                /**
+                 * (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 100 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;
+                };
+            };
+        };
+    };
+    /**
+     * 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.
+     */
+    accessPolicies?: ("public_content" | "integrations")[];
+    /**
+     * File content type. If omitted, the content type will be inferred from the file extension (if any) specified in `key`. If a content type cannot be inferred, the default is "application/octet-stream".
+     */
+    contentType?: string;
+    /**
+     * Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 90 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored.
+     */
+    expiresAt?: string;
+    /**
+     * Use when your file has "public_content" in its access policy and you need the file\'s content to be immediately accessible through its URL after the file has been uploaded without having to wait for the upload to be processed by our system.
+     *
+     * 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$1 = UpsertFileRequestBody$1 & UpsertFileRequestHeaders$1 & UpsertFileRequestQuery$1 & UpsertFileRequestParams$1;
+interface UpsertFileResponse$1 {
+    file: {
         /**
-         * Id of the current [Task](#schema_task)
+         * File ID
          */
-        currentTaskId?: string;
+        id: string;
         /**
-         * Id of the current [Workflow](#schema_workflow)
+         * The ID of the bot the file belongs to
          */
-        currentWorkflowId?: string;
+        botId: string;
         /**
-         * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+         * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
          */
-        createdAt: string;
+        key: string;
         /**
-         * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
+         * URL to retrieve the file content. This URL will be ready to use once the file is uploaded.
+         *
+         * If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
          */
-        updatedAt: string;
+        url: string;
         /**
-         * Name of the channel where the [Conversation](#schema_conversation) is happening
+         * File size in bytes. Non-null if file upload status is "COMPLETE".
          */
-        channel: string;
+        size: number | null;
         /**
-         * Name of the integration that created the [Conversation](#schema_conversation)
+         * MIME type of the file's content
          */
-        integration: string;
+        contentType: string;
         /**
-         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
+         * The tags of the file as an object of key/value pairs
          */
         tags: {
             [k: string]: string;
         };
-    };
-}
-
-interface GetConversationRequestHeaders {
-}
-interface GetConversationRequestQuery {
-}
-interface GetConversationRequestParams {
-    id: string;
-}
-interface GetConversationRequestBody {
-}
-type GetConversationInput = GetConversationRequestBody & GetConversationRequestHeaders & GetConversationRequestQuery & GetConversationRequestParams;
-interface GetConversationResponse {
-    /**
-     * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
-     */
-    conversation: {
         /**
-         * Id of the [Conversation](#schema_conversation)
+         * Metadata of the file as an object of key/value pairs. The values can be of any type.
          */
-        id: string;
+        metadata: {
+            [k: string]: any;
+        };
         /**
-         * Id of the current [Task](#schema_task)
+         * File creation timestamp in ISO 8601 format
          */
-        currentTaskId?: string;
+        createdAt: string;
         /**
-         * Id of the current [Workflow](#schema_workflow)
+         * File last update timestamp in ISO 8601 format
          */
-        currentWorkflowId?: string;
+        updatedAt: string;
         /**
-         * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+         * Access policies configured for the file.
+         */
+        accessPolicies: ("integrations" | "public_content")[];
+        /**
+         * Whether the file was requested to be indexed for search or not.
+         */
+        index: boolean;
+        /**
+         * Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.
+         *
+         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.
+         *
+         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).
+         *
+         * Once the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field.
+         */
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
+        /**
+         * If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure.
+         */
+        failedStatusReason?: string;
+        /**
+         * File expiry timestamp in ISO 8601 format
+         */
+        expiresAt?: string;
+        /**
+         * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
+         */
+        uploadUrl: string;
+    };
+}
+
+type UploadFileInput = Simplify<Omit<UpsertFileInput$1, 'size'> & {
+    content?: ArrayBuffer | Buffer | Blob | Uint8Array | string;
+    url?: string;
+}>;
+type UploadFileOutput = UpsertFileResponse$1;
+
+type Primitive = string | number | boolean;
+type Value<P extends Primitive> = P | P[] | Record<string, P>;
+type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
+type AnyQueryParams = Record<string, QueryValue>;
+type HeaderValue = string | undefined;
+type AnyHeaderParams = Record<string, HeaderValue>;
+type AnyBodyParams = Record<string, any>;
+type ParsedRequest = {
+    method: string;
+    path: string;
+    query: AnyQueryParams;
+    headers: AnyHeaderParams;
+    body: AnyBodyParams;
+};
+declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig$2;
+
+interface CreateConversationRequestHeaders {
+}
+interface CreateConversationRequestQuery {
+}
+interface CreateConversationRequestParams {
+}
+interface CreateConversationRequestBody {
+    /**
+     * Channel name
+     */
+    channel: string;
+    /**
+     * Tags for the [Conversation](#schema_conversation)
+     */
+    tags: {
+        [k: string]: string;
+    };
+    /**
+     * @deprecated
+     * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
+     */
+    integrationName?: string;
+}
+type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
+interface CreateConversationResponse {
+    /**
+     * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
+     */
+    conversation: {
+        /**
+         * Id of the [Conversation](#schema_conversation)
+         */
+        id: string;
+        /**
+         * Id of the current [Task](#schema_task)
+         */
+        currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
+        /**
+         * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * Name of the channel where the [Conversation](#schema_conversation) is happening
+         */
+        channel: string;
+        /**
+         * Name of the integration that created the [Conversation](#schema_conversation)
+         */
+        integration: string;
+        /**
+         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    };
+}
+
+interface GetConversationRequestHeaders {
+}
+interface GetConversationRequestQuery {
+}
+interface GetConversationRequestParams {
+    id: string;
+}
+interface GetConversationRequestBody {
+}
+type GetConversationInput = GetConversationRequestBody & GetConversationRequestHeaders & GetConversationRequestQuery & GetConversationRequestParams;
+interface GetConversationResponse {
+    /**
+     * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
+     */
+    conversation: {
+        /**
+         * Id of the [Conversation](#schema_conversation)
+         */
+        id: string;
+        /**
+         * Id of the current [Task](#schema_task)
+         */
+        currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
+        /**
+         * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
          */
         createdAt: string;
         /**
@@ -1765,6 +2043,10 @@ interface CreateMessageResponse {
          * Creation date of the [Message](#schema_message) in ISO 8601 format
          */
         createdAt: string;
+        /**
+         * Update date of the [Message](#schema_message) in ISO 8601 format
+         */
+        updatedAt: string;
         /**
          * Type of the [Message](#schema_message) represents the resource type that the message is related to
          */
@@ -1859,6 +2141,10 @@ interface GetOrCreateMessageResponse {
          * Creation date of the [Message](#schema_message) in ISO 8601 format
          */
         createdAt: string;
+        /**
+         * Update date of the [Message](#schema_message) in ISO 8601 format
+         */
+        updatedAt: string;
         /**
          * Type of the [Message](#schema_message) represents the resource type that the message is related to
          */
@@ -1913,6 +2199,10 @@ interface GetMessageResponse {
          * Creation date of the [Message](#schema_message) in ISO 8601 format
          */
         createdAt: string;
+        /**
+         * Update date of the [Message](#schema_message) in ISO 8601 format
+         */
+        updatedAt: string;
         /**
          * Type of the [Message](#schema_message) represents the resource type that the message is related to
          */
@@ -1979,6 +2269,10 @@ interface UpdateMessageResponse {
          * Creation date of the [Message](#schema_message) in ISO 8601 format
          */
         createdAt: string;
+        /**
+         * Update date of the [Message](#schema_message) in ISO 8601 format
+         */
+        updatedAt: string;
         /**
          * Type of the [Message](#schema_message) represents the resource type that the message is related to
          */
@@ -2034,6 +2328,10 @@ interface ListMessagesResponse {
          * Creation date of the [Message](#schema_message) in ISO 8601 format
          */
         createdAt: string;
+        /**
+         * Update date of the [Message](#schema_message) in ISO 8601 format
+         */
+        updatedAt: string;
         /**
          * Type of the [Message](#schema_message) represents the resource type that the message is related to
          */
@@ -6408,6 +6706,51 @@ type DeployBotVersionInput = DeployBotVersionRequestBody & DeployBotVersionReque
 interface DeployBotVersionResponse {
 }
 
+interface CreateIntegrationShareableIdRequestHeaders {
+}
+interface CreateIntegrationShareableIdRequestQuery {
+}
+interface CreateIntegrationShareableIdRequestParams {
+    botId: string;
+    integrationId: string;
+}
+interface CreateIntegrationShareableIdRequestBody {
+}
+type CreateIntegrationShareableIdInput = CreateIntegrationShareableIdRequestBody & CreateIntegrationShareableIdRequestHeaders & CreateIntegrationShareableIdRequestQuery & CreateIntegrationShareableIdRequestParams;
+interface CreateIntegrationShareableIdResponse {
+    shareableId: string;
+}
+
+interface DeleteIntegrationShareableIdRequestHeaders {
+}
+interface DeleteIntegrationShareableIdRequestQuery {
+}
+interface DeleteIntegrationShareableIdRequestParams {
+    botId: string;
+    integrationId: string;
+}
+interface DeleteIntegrationShareableIdRequestBody {
+}
+type DeleteIntegrationShareableIdInput = DeleteIntegrationShareableIdRequestBody & DeleteIntegrationShareableIdRequestHeaders & DeleteIntegrationShareableIdRequestQuery & DeleteIntegrationShareableIdRequestParams;
+interface DeleteIntegrationShareableIdResponse {
+}
+
+interface GetIntegrationShareableIdRequestHeaders {
+}
+interface GetIntegrationShareableIdRequestQuery {
+}
+interface GetIntegrationShareableIdRequestParams {
+    botId: string;
+    integrationId: string;
+}
+interface GetIntegrationShareableIdRequestBody {
+}
+type GetIntegrationShareableIdInput = GetIntegrationShareableIdRequestBody & GetIntegrationShareableIdRequestHeaders & GetIntegrationShareableIdRequestQuery & GetIntegrationShareableIdRequestParams;
+interface GetIntegrationShareableIdResponse {
+    shareableId: string;
+    isExpired: boolean;
+}
+
 interface ListWorkspaceInvoicesRequestHeaders {
 }
 interface ListWorkspaceInvoicesRequestQuery {
@@ -6942,15 +7285,7 @@ interface ListWorkspaceMembersRequestBody {
 }
 type ListWorkspaceMembersInput = ListWorkspaceMembersRequestBody & ListWorkspaceMembersRequestHeaders & ListWorkspaceMembersRequestQuery & ListWorkspaceMembersRequestParams;
 interface ListWorkspaceMembersResponse {
-    members: {
-        id: string;
-        userId?: string;
-        email: string;
-        createdAt: string;
-        role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
-        profilePicture?: string;
-        displayName?: string;
-    }[];
+    members: UpdateWorkspaceMemberResponse$1[];
     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.
@@ -6958,6 +7293,15 @@ interface ListWorkspaceMembersResponse {
         nextToken?: string;
     };
 }
+interface UpdateWorkspaceMemberResponse$1 {
+    id: string;
+    userId?: string;
+    email: string;
+    createdAt: string;
+    role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
+    profilePicture?: string;
+    displayName?: string;
+}
 
 interface GetWorkspaceMemberRequestHeaders {
 }
@@ -14658,6 +15002,7 @@ interface UpsertTableRowsResponse {
 
 type ClientProps$1 = {
     toAxiosRequest: typeof toAxiosRequest;
+    toApiError: typeof toApiError;
 };
 declare class Client$1 {
     private axiosInstance;
@@ -14736,6 +15081,9 @@ declare class Client$1 {
     readonly getBotVersion: (input: GetBotVersionInput) => Promise<GetBotVersionResponse>;
     readonly createBotVersion: (input: CreateBotVersionInput) => Promise<CreateBotVersionResponse>;
     readonly deployBotVersion: (input: DeployBotVersionInput) => Promise<DeployBotVersionResponse>;
+    readonly createIntegrationShareableId: (input: CreateIntegrationShareableIdInput) => Promise<CreateIntegrationShareableIdResponse>;
+    readonly deleteIntegrationShareableId: (input: DeleteIntegrationShareableIdInput) => Promise<DeleteIntegrationShareableIdResponse>;
+    readonly getIntegrationShareableId: (input: GetIntegrationShareableIdInput) => Promise<GetIntegrationShareableIdResponse>;
     readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
     readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
     readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
@@ -14824,295 +15172,331 @@ declare class Client$1 {
     readonly updateTableRows: (input: UpdateTableRowsInput) => Promise<UpdateTableRowsResponse>;
     readonly upsertTableRows: (input: UpsertTableRowsInput) => Promise<UpsertTableRowsResponse>;
 }
+declare function toApiError(err: unknown): Error;
 
-type UploadFileInput = Omit<UpsertFileInput, 'size'> & {
-    content?: ArrayBuffer | Buffer | Blob | Uint8Array | string;
-    url?: string;
-};
-type UploadFileOutput = UpsertFileResponse;
-type Simplify<T> = T extends (...args: infer A) => infer R ? (...args: Simplify<A>) => Simplify<R> : T extends Promise<infer R> ? Promise<Simplify<R>> : T extends Buffer ? Buffer : T extends object ? T extends infer O ? {
-    [K in keyof O]: Simplify<O[K]>;
-} : never : T;
-type AsyncFunc = (...args: any[]) => Promise<any>;
 type IClient = Simplify<Client$1 & {
     uploadFile: (input: UploadFileInput) => Promise<UploadFileOutput>;
 }>;
-type Operation = Simplify<keyof {
-    [K in keyof IClient as IClient[K] extends AsyncFunc ? K : never]: IClient[K];
-}>;
-type ClientInputs = Simplify<{
-    [T in Operation]: Parameters<IClient[T]>[0];
-}>;
-type ClientOutputs = Simplify<{
-    [T in Operation]: Awaited<ReturnType<IClient[T]>>;
-}>;
-type Headers = Record<string, string | string[]>;
-type RetryConfig = IAxiosRetryConfig;
-type ClientProps = {
+type ClientProps = CommonClientProps & {
     integrationId?: string;
     workspaceId?: string;
     botId?: string;
     token?: string;
-    apiUrl?: string;
-    timeout?: number;
-    headers?: Headers;
-    retry?: RetryConfig;
-};
-type ClientConfig = {
-    apiUrl: string;
-    headers: Headers;
-    withCredentials: boolean;
-    timeout: number;
 };
-
-type ListOperation = keyof {
-    [K in Operation as ClientInputs[K] extends {
-        nextToken?: string | undefined;
-    } ? K : never]: null;
-};
-type ListInputs = {
-    [K in ListOperation]: Omit<ClientInputs[K], 'nextToken'>;
-};
-type PageLister<R> = (t: {
-    nextToken?: string;
-}) => Promise<{
-    items: R[];
-    meta: {
-        nextToken?: string;
-    };
-}>;
-declare class AsyncCollection<T> {
-    private _list;
-    constructor(_list: PageLister<T>);
-    [Symbol.asyncIterator](): AsyncGenerator<Awaited<T>, void, unknown>;
-    collect(props?: {
-        limit?: number;
-    }): Promise<T[]>;
-}
-declare class Lister {
-    private _client;
-    constructor(_client: Client$1);
-    readonly conversations: (props: ListInputs["listConversations"]) => AsyncCollection<{
-        id: string;
-        currentTaskId?: string;
-        currentWorkflowId?: string;
-        createdAt: string;
-        updatedAt: string;
-        channel: string;
-        integration: string;
-        tags: {
-            [k: string]: string;
-        };
-    }>;
-    readonly participants: (props: ListInputs["listParticipants"]) => AsyncCollection<{
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        tags: {
-            [k: string]: string;
-        };
-        name?: string;
-        pictureUrl?: string;
-    }>;
-    readonly events: (props: ListInputs["listEvents"]) => AsyncCollection<{
-        id: string;
-        createdAt: string;
-        type: string;
-        payload: {
-            [k: string]: any;
-        };
-        conversationId?: string;
-        userId?: string;
-        messageId?: string;
-        status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
-        failureReason: string | null;
-    }>;
-    readonly messages: (props: ListInputs["listMessages"]) => AsyncCollection<{
-        id: string;
-        createdAt: string;
-        type: string;
-        payload: {
-            [k: string]: any;
-        };
-        direction: "incoming" | "outgoing";
-        userId: string;
-        conversationId: string;
-        tags: {
-            [k: string]: string;
-        };
-    }>;
-    readonly users: (props: ListInputs["listUsers"]) => AsyncCollection<{
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        tags: {
-            [k: string]: string;
-        };
-        name?: string;
-        pictureUrl?: string;
-    }>;
-    readonly tasks: (props: ListInputs["listTasks"]) => AsyncCollection<{
-        id: string;
-        title: string;
-        description: string;
-        type: string;
-        data: {
-            [k: string]: any;
-        };
-        status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
-        parentTaskId?: string;
-        conversationId?: string;
-        userId?: string;
-        timeoutAt: string;
-        createdAt: string;
-        updatedAt: string;
-        failureReason?: string;
-        tags: {
-            [k: string]: string;
-        };
-    }>;
-    readonly publicIntegrations: (props: ListInputs["listPublicIntegrations"]) => AsyncCollection<{
-        id: string;
-        name: string;
-        version: string;
-        createdAt: string;
-        updatedAt: string;
-        title: string;
-        description: string;
-        iconUrl: string;
-        public: boolean;
-        verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
-        ownerWorkspace: {
+declare class Client extends Client$1 implements IClient {
+    readonly config: Readonly<ClientConfig>;
+    constructor(clientProps?: ClientProps);
+    get list(): {
+        conversations: (props: {
+            tags?: {
+                [x: string]: string;
+            } | undefined;
+            channel?: string | undefined;
+            integrationName?: string | undefined;
+            sortField?: ("createdAt" | "updatedAt") | undefined;
+            sortDirection?: ("asc" | "desc") | undefined;
+            participantIds?: string[] | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            currentTaskId?: string;
+            currentWorkflowId?: string;
+            createdAt: string;
+            updatedAt: string;
+            channel: string;
+            integration: string;
+            tags: {
+                [k: string]: string;
+            };
+        }>;
+        participants: (props: {
+            id: string;
+        }) => AsyncCollection<{
+            id: string;
+            createdAt: string;
+            updatedAt: string;
+            tags: {
+                [k: string]: string;
+            };
+            name?: string;
+            pictureUrl?: string;
+        }>;
+        events: (props: {
+            type?: string | undefined;
+            userId?: string | undefined;
+            conversationId?: string | undefined;
+            messageId?: string | undefined;
+            status?: ("pending" | "ignored" | "processed" | "failed" | "scheduled") | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            createdAt: string;
+            type: string;
+            payload: {
+                [k: string]: any;
+            };
+            conversationId?: string;
+            userId?: string;
+            messageId?: string;
+            status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
+            failureReason: string | null;
+        }>;
+        messages: (props: {
+            tags?: {
+                [x: string]: string;
+            } | undefined;
+            conversationId?: string | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            createdAt: string;
+            updatedAt: string;
+            type: string;
+            payload: {
+                [k: string]: any;
+            };
+            direction: "incoming" | "outgoing";
+            userId: string;
+            conversationId: string;
+            tags: {
+                [k: string]: string;
+            };
+        }>;
+        users: (props: {
+            tags?: {
+                [x: string]: string;
+            } | undefined;
+            conversationId?: string | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            createdAt: string;
+            updatedAt: string;
+            tags: {
+                [k: string]: string;
+            };
+            name?: string;
+            pictureUrl?: string;
+        }>;
+        tasks: (props: {
+            tags?: {
+                [x: string]: string;
+            } | undefined;
+            type?: string | undefined;
+            userId?: string | undefined;
+            conversationId?: string | undefined;
+            status?: ("pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[] | undefined;
+            parentTaskId?: string | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            title: string;
+            description: string;
+            type: string;
+            data: {
+                [k: string]: any;
+            };
+            status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
+            parentTaskId?: string;
+            conversationId?: string;
+            userId?: string;
+            timeoutAt: string;
+            createdAt: string;
+            updatedAt: string;
+            failureReason?: string;
+            tags: {
+                [k: string]: string;
+            };
+        }>;
+        publicIntegrations: (props: {
+            name?: string | undefined;
+            version?: string | undefined;
+        }) => AsyncCollection<{
             id: string;
-            handle: string | null;
             name: string;
-        };
-        meta: {
-            installs: number;
-            views: number;
-        };
-    }>;
-    readonly bots: (props: ListInputs["listBots"]) => AsyncCollection<{
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        name: string;
-        deployedAt?: string;
-        tags: {
-            [k: string]: string;
-        };
-    }>;
-    readonly botIssues: (props: ListInputs["listBotIssues"]) => AsyncCollection<{
-        id: string;
-        code: string;
-        createdAt: string;
-        lastSeenAt: string;
-        title: string;
-        description: string;
-        groupedData: {
-            [k: string]: {
-                raw: string;
-                pretty?: string;
+            version: string;
+            createdAt: string;
+            updatedAt: string;
+            title: string;
+            description: string;
+            iconUrl: string;
+            public: boolean;
+            verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
+            ownerWorkspace: {
+                id: string;
+                handle: string | null;
+                name: string;
             };
-        };
-        eventsCount: number;
-        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<{
-        id: string;
-        userId?: string;
-        email: string;
-        createdAt: string;
-        role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
-        profilePicture?: string;
-        displayName?: string;
-    }>;
-    readonly integrations: (props: ListInputs["listIntegrations"]) => AsyncCollection<{
-        id: string;
-        name: string;
-        version: string;
-        createdAt: string;
-        updatedAt: string;
-        title: string;
-        description: string;
-        iconUrl: string;
-        public: boolean;
-        verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
-        matchedOn?: {
-            name?: boolean;
-            title?: boolean;
-            description?: boolean;
-            actions?: string[];
-            interfaces?: string[];
-        };
-        ownerWorkspace?: {
+            meta: {
+                installs: number;
+                views: number;
+            };
+        }>;
+        bots: (props: {
+            tags?: {
+                [x: string]: string;
+            } | undefined;
+            sortField?: ("createdAt" | "updatedAt") | undefined;
+            sortDirection?: ("asc" | "desc") | undefined;
+            dev?: boolean | undefined;
+        }) => AsyncCollection<{
             id: string;
-            handle: string | null;
+            createdAt: string;
+            updatedAt: string;
             name: string;
-        };
-    }>;
-    readonly interfaces: (props: ListInputs["listInterfaces"]) => AsyncCollection<{
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        name: string;
-        version: string;
-    }>;
-    readonly activities: (props: ListInputs["listActivities"]) => AsyncCollection<{
-        id: string;
-        description: string;
-        taskId: string;
-        category: "unknown" | "capture" | "bot_message" | "user_message" | "agent_message" | "event" | "action" | "task_status" | "subtask_status" | "exception";
-        data: {
-            [k: string]: any;
-        };
-        createdAt: string;
-    }>;
-    readonly files: (props: ListInputs["listFiles"]) => AsyncCollection<{
-        id: string;
-        botId: string;
-        key: string;
-        url: string;
-        size: number | null;
-        contentType: string;
-        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;
-        expiresAt?: string;
-    }>;
-    readonly filePassages: (props: ListInputs["listFilePassages"]) => AsyncCollection<{
-        id: string;
-        content: string;
-        meta: {
-            type?: "chunk" | "summary" | "consolidated" | "image";
-            subtype?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "image" | "page";
-            pageNumber?: number;
-            position?: number;
-            sourceUrl?: string;
-        };
-    }>;
-}
-
-declare class Client extends Client$1 implements IClient {
-    readonly config: Readonly<ClientConfig>;
-    constructor(clientProps?: ClientProps);
-    get list(): Lister;
+            deployedAt?: string;
+            tags: {
+                [k: string]: string;
+            };
+        }>;
+        botIssues: (props: {
+            id: string;
+        }) => AsyncCollection<{
+            id: string;
+            code: string;
+            createdAt: string;
+            lastSeenAt: string;
+            title: string;
+            description: string;
+            groupedData: {
+                [k: string]: {
+                    raw: string;
+                    pretty?: string;
+                };
+            };
+            eventsCount: number;
+            category: "user_code" | "limits" | "configuration" | "other";
+            resolutionLink: string | null;
+        }>;
+        workspaces: (props: {
+            handle?: string | undefined;
+        }) => AsyncCollection<UpdateWorkspaceResponse>;
+        publicWorkspaces: (props: {
+            search?: string | undefined;
+            workspaceIds?: string[] | undefined;
+        }) => AsyncCollection<GetPublicWorkspaceResponse>;
+        workspaceMembers: (props: {}) => AsyncCollection<UpdateWorkspaceMemberResponse$1>;
+        integrations: (props: {
+            search?: string | undefined;
+            name?: string | undefined;
+            version?: string | undefined;
+            dev?: boolean | undefined;
+            limit?: number | undefined;
+            interfaceId?: string | undefined;
+            interfaceName?: string | undefined;
+            visibility?: ("public" | "private") | undefined;
+            installedByBotId?: string | undefined;
+            verificationStatus?: ("unapproved" | "pending" | "approved" | "rejected") | undefined;
+            sortBy?: ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount") | undefined;
+            direction?: ("asc" | "desc") | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            name: string;
+            version: string;
+            createdAt: string;
+            updatedAt: string;
+            title: string;
+            description: string;
+            iconUrl: string;
+            public: boolean;
+            verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
+            matchedOn?: {
+                name?: boolean;
+                title?: boolean;
+                description?: boolean;
+                actions?: string[];
+                interfaces?: string[];
+            };
+            ownerWorkspace?: {
+                id: string;
+                handle: string | null;
+                name: string;
+            };
+        }>;
+        interfaces: (props: {
+            name?: string | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            createdAt: string;
+            updatedAt: string;
+            name: string;
+            version: string;
+        }>;
+        activities: (props: {
+            botId: string;
+            taskId: string;
+        }) => AsyncCollection<{
+            id: string;
+            description: string;
+            taskId: string;
+            category: "unknown" | "capture" | "bot_message" | "user_message" | "agent_message" | "event" | "action" | "task_status" | "subtask_status" | "exception";
+            data: {
+                [k: string]: any;
+            };
+            createdAt: string;
+        }>;
+        files: (props: {
+            tags?: any;
+            sortField?: ("key" | "size" | "createdAt" | "updatedAt" | "status") | undefined;
+            sortDirection?: ("asc" | "desc") | undefined;
+            ids?: string[] | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            botId: string;
+            key: string;
+            url: string;
+            size: number | null;
+            contentType: string;
+            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;
+            expiresAt?: string;
+        }>;
+        filePassages: (props: {
+            id: string;
+            limit?: number | undefined;
+        }) => AsyncCollection<{
+            id: string;
+            content: string;
+            meta: {
+                type?: "chunk" | "summary" | "consolidated" | "image";
+                subtype?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "image" | "page";
+                pageNumber?: number;
+                position?: number;
+                sourceUrl?: string;
+            };
+        }>;
+        usageActivity: (props: {
+            type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
+            id: string;
+            timestampFrom?: string | undefined;
+            timestampUntil?: string | undefined;
+        }) => AsyncCollection<{
+            timestamp: string;
+            value: number;
+            period: string;
+            metadata: {
+                [k: string]: any | null;
+            };
+        }>;
+        usageActivityDaily: (props: {
+            type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
+            id: string;
+            dateFrom?: string | undefined;
+            dateUntil?: string | undefined;
+        }) => AsyncCollection<{
+            date: string;
+            value: number;
+        }>;
+    };
     /**
      * 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, metadata, publicContentImmediatelyAccessible, }: ClientInputs["uploadFile"]) => Promise<ClientOutputs["uploadFile"]>;
+    readonly uploadFile: (input: UploadFileInput) => Promise<UploadFileOutput>;
 }
 
 // TypeScript Version: 4.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cognitive",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "Wrapper around the Botpress Client to call LLMs",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",