@botpress/cognitive 0.1.48 → 0.1.50

package/dist/index.d.ts

@@ -3977,6 +3977,10 @@ interface GetOrCreateWorkflowRequestBody {
      * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
      */
     discriminateByTags?: string[];
+    /**
+     * When provided, will only match workflows whose status corresponds to the status group.
+     */
+    discriminateByStatusGroup?: "active" | "finished";
 }
 type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
 interface GetOrCreateWorkflowResponse {
@@ -6615,9 +6619,20 @@ interface CreateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -7108,6 +7123,23 @@ interface UpdateBotRequestBody {
             interfaces?: {
                 [k: string]: {
                     integrationId: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration corresponding to this alias. If not provided, the first integration matching the integrationId will be used.
+                     */
+                    integrationAlias?: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration interface corresponding to this alias.
+                     */
+                    integrationInterfaceAlias?: string;
+                };
+            };
+            /**
+             * A mapping of plugin integration aliases to their backing integrations
+             */
+            integrations?: {
+                [k: string]: {
+                    integrationId: string;
+                    integrationAlias: string;
                 };
             };
         } | null;
@@ -7246,9 +7278,20 @@ interface UpdateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -7709,9 +7752,20 @@ interface GetBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -8374,6 +8428,7 @@ interface DeployBotVersionResponse {
 interface CreateIntegrationShareableIdRequestHeaders {
 }
 interface CreateIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface CreateIntegrationShareableIdRequestParams {
     botId: string;
@@ -8389,6 +8444,7 @@ interface CreateIntegrationShareableIdResponse {
 interface DeleteIntegrationShareableIdRequestHeaders {
 }
 interface DeleteIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface DeleteIntegrationShareableIdRequestParams {
     botId: string;
@@ -8403,6 +8459,7 @@ interface DeleteIntegrationShareableIdResponse {
 interface GetIntegrationShareableIdRequestHeaders {
 }
 interface GetIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface GetIntegrationShareableIdRequestParams {
     botId: string;
@@ -8419,6 +8476,7 @@ interface GetIntegrationShareableIdResponse {
 interface UnlinkSandboxedConversationsRequestHeaders {
 }
 interface UnlinkSandboxedConversationsRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface UnlinkSandboxedConversationsRequestParams {
     botId: string;
@@ -8689,6 +8747,7 @@ interface CreateWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface GetPublicWorkspaceRequestHeaders {
@@ -8742,6 +8801,7 @@ interface GetWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListWorkspaceUsagesRequestHeaders {
@@ -8913,6 +8973,7 @@ interface UpdateWorkspaceResponse$1 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface CheckHandleAvailabilityRequestHeaders {
@@ -8969,6 +9030,7 @@ interface UpdateWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListPublicWorkspacesRequestHeaders {
@@ -9038,7 +9100,7 @@ interface GetAuditRecordsResponse {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
     }[];
     meta: {
         /**
@@ -17519,6 +17581,10 @@ interface FindTableRowsRequestBody {
      * Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.
      */
     search?: string;
+    /**
+     * Specify which columns to return in the response. Supports both top-level columns (e.g., "name") and nested attributes using dot notation (e.g., "attributes.price"). System columns (id, createdAt, updatedAt, etc.) are always included. If omitted, all columns are returned.
+     */
+    select?: string[];
     /**
      * Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt
      */
@@ -18984,7 +19050,7 @@ declare class Cognitive {
     private _generateContent;
 }
 
-type Models = 'auto' | 'best' | 'fast' | 'anthropic:claude-3-5-haiku-20241022' | 'anthropic:claude-3-5-sonnet-20240620' | 'anthropic:claude-3-5-sonnet-20241022' | 'anthropic:claude-3-7-sonnet-20250219' | 'anthropic:claude-3-haiku-20240307' | 'anthropic:claude-sonnet-4-20250514' | 'anthropic:claude-sonnet-4-5-20250929' | 'cerebras:gpt-oss-120b' | 'cerebras:llama-4-scout-17b-16e-instruct' | 'cerebras:llama3.1-8b' | 'cerebras:llama3.3-70b' | 'cerebras:qwen-3-32b' | 'fireworks-ai:deepseek-r1-0528' | 'fireworks-ai:deepseek-v3-0324' | 'fireworks-ai:gpt-oss-120b' | 'fireworks-ai:gpt-oss-20b' | 'fireworks-ai:llama-v3p1-8b-instruct' | 'fireworks-ai:llama-v3p3-70b-instruct' | 'fireworks-ai:llama4-maverick-instruct-basic' | 'fireworks-ai:llama4-scout-instruct-basic' | 'fireworks-ai:mixtral-8x7b-instruct' | 'fireworks-ai:mythomax-l2-13b' | 'google-ai:gemini-2.0-flash' | 'google-ai:gemini-2.5-flash' | 'google-ai:gemini-2.5-pro' | 'groq:deepseek-r1-distill-llama-70b' | 'groq:gemma2-9b-it' | 'groq:gpt-oss-120b' | 'groq:gpt-oss-20b' | 'groq:llama-3.1-8b-instant' | 'groq:llama-3.3-70b-versatile' | 'openai:gpt-4.1-2025-04-14' | 'openai:gpt-4.1-mini-2025-04-14' | 'openai:gpt-4.1-nano-2025-04-14' | 'openai:gpt-4o-2024-11-20' | 'openai:gpt-4o-mini-2024-07-18' | 'openai:gpt-5-2025-08-07' | 'openai:gpt-5-mini-2025-08-07' | 'openai:gpt-5-nano-2025-08-07' | 'openai:o1-2024-12-17' | 'openai:o1-mini-2024-09-12' | 'openai:o3-2025-04-16' | 'openai:o3-mini-2025-01-31' | 'openai:o4-mini-2025-04-16' | 'openrouter:gpt-oss-120b' | 'xai:grok-3' | 'xai:grok-3-mini' | 'xai:grok-4-0709' | 'xai:grok-4-fast-non-reasoning' | 'xai:grok-4-fast-reasoning' | 'xai:grok-code-fast-1' | 'openai:gpt-5' | 'openai:gpt-5-mini' | 'openai:gpt-5-nano' | 'openai:o4-mini' | 'openai:o3' | 'openai:gpt-4.1' | 'openai:gpt-4.1-mini' | 'openai:gpt-4.1-nano' | 'openai:o3-mini' | 'openai:o1-mini' | 'openai:gpt-4o-mini' | 'openai:gpt-4o' | 'anthropic:claude-sonnet-4-5' | 'anthropic:claude-sonnet-4' | 'anthropic:claude-sonnet-4-reasoning' | 'google-ai:models/gemini-2.0-flash' | 'groq:openai/gpt-oss-20b' | 'groq:openai/gpt-oss-120b' | 'fireworks-ai:accounts/fireworks/models/gpt-oss-20b' | 'fireworks-ai:accounts/fireworks/models/gpt-oss-120b' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1-0528' | 'fireworks-ai:accounts/fireworks/models/deepseek-v3-0324' | 'fireworks-ai:accounts/fireworks/models/llama4-maverick-instruct-basic' | 'fireworks-ai:accounts/fireworks/models/llama4-scout-instruct-basic' | 'fireworks-ai:accounts/fireworks/models/llama-v3p3-70b-instruct' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1-basic' | 'fireworks-ai:accounts/fireworks/models/deepseek-v3' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-405b-instruct' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-70b-instruct' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-8b-instruct' | 'fireworks-ai:accounts/fireworks/models/mixtral-8x22b-instruct' | 'fireworks-ai:accounts/fireworks/models/mixtral-8x7b-instruct' | 'fireworks-ai:accounts/fireworks/models/mythomax-l2-13b' | 'fireworks-ai:accounts/fireworks/models/gemma2-9b-it' | ({} & string);
+type Models = 'auto' | 'best' | 'fast' | 'anthropic:claude-3-5-haiku-20241022' | 'anthropic:claude-3-5-sonnet-20240620' | 'anthropic:claude-3-5-sonnet-20241022' | 'anthropic:claude-3-7-sonnet-20250219' | 'anthropic:claude-3-haiku-20240307' | 'anthropic:claude-sonnet-4-20250514' | 'anthropic:claude-sonnet-4-5-20250929' | 'cerebras:gpt-oss-120b' | 'cerebras:llama-4-scout-17b-16e-instruct' | 'cerebras:llama3.1-8b' | 'cerebras:llama3.3-70b' | 'cerebras:qwen-3-32b' | 'fireworks-ai:deepseek-r1-0528' | 'fireworks-ai:deepseek-v3-0324' | 'fireworks-ai:gpt-oss-120b' | 'fireworks-ai:gpt-oss-20b' | 'fireworks-ai:llama-v3p1-8b-instruct' | 'fireworks-ai:llama-v3p3-70b-instruct' | 'fireworks-ai:llama4-maverick-instruct-basic' | 'fireworks-ai:llama4-scout-instruct-basic' | 'fireworks-ai:mixtral-8x7b-instruct' | 'fireworks-ai:mythomax-l2-13b' | 'google-ai:gemini-2.0-flash' | 'google-ai:gemini-2.5-flash' | 'google-ai:gemini-2.5-pro' | 'groq:gpt-oss-120b' | 'groq:gpt-oss-20b' | 'groq:llama-3.1-8b-instant' | 'groq:llama-3.3-70b-versatile' | 'openai:gpt-4.1-2025-04-14' | 'openai:gpt-4.1-mini-2025-04-14' | 'openai:gpt-4.1-nano-2025-04-14' | 'openai:gpt-4o-2024-11-20' | 'openai:gpt-4o-mini-2024-07-18' | 'openai:gpt-5-2025-08-07' | 'openai:gpt-5-mini-2025-08-07' | 'openai:gpt-5-nano-2025-08-07' | 'openai:o1-2024-12-17' | 'openai:o1-mini-2024-09-12' | 'openai:o3-2025-04-16' | 'openai:o3-mini-2025-01-31' | 'openai:o4-mini-2025-04-16' | 'openrouter:gpt-oss-120b' | 'xai:grok-3' | 'xai:grok-3-mini' | 'xai:grok-4-0709' | 'xai:grok-4-fast-non-reasoning' | 'xai:grok-4-fast-reasoning' | 'xai:grok-code-fast-1' | 'openai:gpt-5' | 'openai:gpt-5-mini' | 'openai:gpt-5-nano' | 'openai:o4-mini' | 'openai:o3' | 'openai:gpt-4.1' | 'openai:gpt-4.1-mini' | 'openai:gpt-4.1-nano' | 'openai:o3-mini' | 'openai:o1-mini' | 'openai:gpt-4o-mini' | 'openai:gpt-4o' | 'anthropic:claude-sonnet-4-5' | 'anthropic:claude-sonnet-4' | 'anthropic:claude-sonnet-4-reasoning' | 'google-ai:models/gemini-2.0-flash' | 'groq:openai/gpt-oss-20b' | 'groq:openai/gpt-oss-120b' | 'fireworks-ai:accounts/fireworks/models/gpt-oss-20b' | 'fireworks-ai:accounts/fireworks/models/gpt-oss-120b' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1-0528' | 'fireworks-ai:accounts/fireworks/models/deepseek-v3-0324' | 'fireworks-ai:accounts/fireworks/models/llama4-maverick-instruct-basic' | 'fireworks-ai:accounts/fireworks/models/llama4-scout-instruct-basic' | 'fireworks-ai:accounts/fireworks/models/llama-v3p3-70b-instruct' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1-basic' | 'fireworks-ai:accounts/fireworks/models/deepseek-v3' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-405b-instruct' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-70b-instruct' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-8b-instruct' | 'fireworks-ai:accounts/fireworks/models/mixtral-8x22b-instruct' | 'fireworks-ai:accounts/fireworks/models/mixtral-8x7b-instruct' | 'fireworks-ai:accounts/fireworks/models/mythomax-l2-13b' | 'fireworks-ai:accounts/fireworks/models/gemma2-9b-it' | ({} & string);
 type CognitiveRequest = {
     /**
      * @minItems 1
@@ -19004,13 +19070,33 @@ type CognitiveRequest = {
      * Model to query. Additional models are used as fallback if the main model is unavailable
      */
     model?: Models | Models[];
-    systemPrompt?: string;
     temperature?: number;
+    /**
+     * DEPRECATED: Use a message with role "system"
+     */
+    systemPrompt?: string;
     maxTokens?: number;
     stopSequences?: string | string[];
     stream?: boolean;
+    /**
+     * json_object is deprecated, use json
+     */
     responseFormat?: 'text' | 'json' | 'json_object';
     reasoningEffort?: 'low' | 'medium' | 'high' | 'dynamic' | 'none';
+    options?: {
+        /**
+         * Debug mode include additional metadata in the response
+         */
+        debug?: boolean;
+        /**
+         * Bypass the cache and force a new request
+         */
+        skipCache?: boolean;
+        /**
+         * Maximum time to wait for the first token before falling back to the next provider
+         */
+        maxTimeToFirstToken?: number;
+    };
     meta?: {
         /**
          * Source of the prompt, e.g. agent/:id/:version cards/ai-generate, cards/ai-task, nodes/autonomous, etc.
@@ -19032,16 +19118,24 @@ type CognitiveStreamChunk = {
         model?: string;
         usage: {
             inputTokens: number;
+            inputCost: number;
             outputTokens: number;
-            reasoningTokens?: number;
+            outputCost: number;
         };
-        cost?: number;
+        cost: number;
         cached?: boolean;
+        /**
+         * Time it took for the provider to respond to the LLM query
+         */
         latency?: number;
-        stopReason?: string;
+        /**
+         * Time it took for the first token to be received from the provider
+         */
+        ttft?: number;
+        stopReason?: 'stop' | 'max_tokens' | 'content_filter' | 'tool_calls' | 'other';
         reasoningEffort?: string;
         warnings?: {
-            type: 'parameter_ignored' | 'provider_limitation' | 'deprecated_model' | 'fallback_used';
+            type: 'parameter_ignored' | 'provider_limitation' | 'deprecated_model' | 'discontinued_model' | 'fallback_used';
             message: string;
         }[];
         /**
@@ -19049,8 +19143,8 @@ type CognitiveStreamChunk = {
          */
         fallbackPath?: string[];
         debug?: {
-            [k: string]: string;
-        };
+            type: 'models_to_try' | 'provider_request' | 'provider_response';
+        }[];
     };
 };
 type CognitiveResponse = {
@@ -19065,13 +19159,17 @@ type CognitiveResponse = {
             outputTokens: number;
             outputCost: number;
         };
-        cost?: number;
+        cost: number;
         cached?: boolean;
         /**
          * Time it took for the provider to respond to the LLM query
          */
         latency?: number;
-        stopReason?: 'stop' | 'length' | 'content_filter' | 'error';
+        /**
+         * Time it took for the first token to be received from the provider
+         */
+        ttft?: number;
+        stopReason?: 'stop' | 'max_tokens' | 'content_filter' | 'tool_calls' | 'other';
         reasoningEffort?: string;
         warnings?: {
             type: 'parameter_ignored' | 'provider_limitation' | 'deprecated_model' | 'discontinued_model' | 'fallback_used';
@@ -19082,8 +19180,9 @@ type CognitiveResponse = {
          */
         fallbackPath?: string[];
         debug?: {
-            [k: string]: string;
-        };
+            type: 'models_to_try' | 'provider_request' | 'provider_response';
+            data?: any | null;
+        }[];
     };
     error?: string;
 };
@@ -19113,7 +19212,7 @@ type Model = {
     /**
      * The lifecycle state of the model. Deprecated models are still available, but a warning will be shown to the user. Discontinued models will be directed to a replacement model.
      */
-    lifecycle: 'live' | 'beta' | 'deprecated' | 'discontinued';
+    lifecycle: 'production' | 'preview' | 'deprecated' | 'discontinued';
 };
 
 type ClientProps = {
@@ -19123,7 +19222,7 @@ type ClientProps = {
     token?: string;
     withCredentials?: boolean;
     debug?: boolean;
-    headers?: Record<string, string>;
+    headers?: Record<string, string | string[]>;
 };
 type RequestOptions = {
     signal?: AbortSignal;