@n8n/telemetry 1.9.0 → 1.10.0

package/dist/events/instance-ai.d.ts

@@ -1,9 +1,19 @@
 import { z } from 'zod/v4';
+export declare const ASSISTANT_MENTION_QUERY_TEXT_MAX_LENGTH = 100;
 export declare const INSTANCE_AI_TELEMETRY: {
     readonly SETUP_PANEL_STATE_OBSERVED: {
         readonly name: "AI Assistant setup panel state observed";
         readonly description: "The setup panel observed a new requirement snapshot. Also fires when no setup is needed, including workflows whose credentials were already connected.";
         readonly properties: z.ZodObject<{
+            session_id: z.ZodOptional<z.ZodString>;
+            variant: z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
+            '$feature/118_instance_ai_setup_overhaul': z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
             workflow_id: z.ZodString;
             thread_id: z.ZodString;
             credential_count: z.ZodNumber;
@@ -18,6 +28,15 @@ export declare const INSTANCE_AI_TELEMETRY: {
         readonly name: "AI Assistant setup panel item shown";
         readonly description: "A setup checklist row became visible. Reopening the same row within the mounted panel does not emit another event.";
         readonly properties: z.ZodObject<{
+            session_id: z.ZodOptional<z.ZodString>;
+            variant: z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
+            '$feature/118_instance_ai_setup_overhaul': z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
             workflow_id: z.ZodString;
             thread_id: z.ZodString;
             kind: z.ZodEnum<{
@@ -27,6 +46,16 @@ export declare const INSTANCE_AI_TELEMETRY: {
             }>;
             credential_type: z.ZodOptional<z.ZodString>;
             parameter_count: z.ZodNumber;
+            items: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                node_id: z.ZodString;
+                node_type: z.ZodOptional<z.ZodString>;
+                kind: z.ZodEnum<{
+                    credential: "credential";
+                    parameter: "parameter";
+                }>;
+                credential_type: z.ZodOptional<z.ZodString>;
+                parameter_name: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
         }, z.core.$strip>;
     } & import("../define").TelemetryEventInput & {
         readonly getValidationError: (properties: unknown) => string | null;
@@ -35,6 +64,15 @@ export declare const INSTANCE_AI_TELEMETRY: {
         readonly name: "AI Assistant setup panel dismissed";
         readonly description: "A visible setup panel closed. The reason separates navigation and removed requirements from a finished execution or an explicit dismissal.";
         readonly properties: z.ZodObject<{
+            session_id: z.ZodOptional<z.ZodString>;
+            variant: z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
+            '$feature/118_instance_ai_setup_overhaul': z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
             workflow_id: z.ZodString;
             thread_id: z.ZodString;
             reason: z.ZodEnum<{
@@ -285,8 +323,15 @@ export declare const INSTANCE_AI_TELEMETRY: {
     };
     readonly USER_RECEIVED_AI_ASSISTANT_RESPONSE: {
         readonly name: "User received AI Assistant response";
-        readonly description: "The initial foreground AI Assistant reply was rendered after a user submitted a chat message. Starts before attachment processing and first-thread creation, then fires once when the initial run completes or pauses for user input. Automated follow-up runs do not create another sample.";
+        readonly description: "The initial foreground AI Assistant reply was rendered after a user submitted a chat message. Starts before attachment processing and first-thread creation, then fires once when the initial run completes or pauses for user input. Automated follow-up runs do not create another sample. Repeats the mention and attachment counts of the message that started the run, so outcome cuts by context need no join back to \"User sent builder message\".";
         readonly properties: z.ZodObject<{
+            mention_counts: z.ZodObject<{
+                total: z.ZodNumber;
+                workflow: z.ZodNumber;
+                node: z.ZodNumber;
+                group: z.ZodNumber;
+            }, z.core.$strip>;
+            attachment_count: z.ZodNumber;
             instance_id: z.ZodString;
             thread_id: z.ZodString;
             run_id: z.ZodString;
@@ -306,6 +351,7 @@ export declare const INSTANCE_AI_TELEMETRY: {
                 credentials_list: "credentials_list";
                 evals: "evals";
                 node_error_view: "node_error_view";
+                onboarding: "onboarding";
                 playwright: "playwright";
                 "template-view": "template-view";
                 unknown: "unknown";
@@ -526,10 +572,131 @@ export declare const INSTANCE_AI_TELEMETRY: {
     } & import("../define").TelemetryEventInput & {
         readonly getValidationError: (properties: unknown) => string | null;
     };
+    readonly USER_OPENED_AI_ASSISTANT_MENTION_PICKER: {
+        readonly name: "User opened AI Assistant mention picker";
+        readonly description: "The user opened the n8n Assistant mention picker by typing an at sign or selecting the composer button. Every open ends in exactly one \"User selected AI Assistant mention\" or one \"User dismissed AI Assistant mention picker\", so the two together give the pick rate per open.";
+        readonly properties: z.ZodObject<{
+            thread_id: z.ZodNullable<z.ZodString>;
+            source: z.ZodEnum<{
+                button: "button";
+                typed: "typed";
+            }>;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly USER_DISMISSED_AI_ASSISTANT_MENTION_PICKER: {
+        readonly name: "User dismissed AI Assistant mention picker";
+        readonly description: "The n8n Assistant mention picker closed without a selection. The list properties describe what was on screen at that moment: a search with result_count 0 is a resource the user could not find, a non-zero ambiguous_result_count is a list the user could not tell apart. Carries interaction metadata but no query text or resource names; the query text of an empty search is on \"User searched AI Assistant mentions without results\".";
+        readonly properties: z.ZodObject<{
+            thread_id: z.ZodNullable<z.ZodString>;
+            source: z.ZodEnum<{
+                button: "button";
+                typed: "typed";
+            }>;
+            reason: z.ZodEnum<{
+                closed_menu: "closed_menu";
+                deleted_trigger: "deleted_trigger";
+                moved_caret: "moved_caret";
+                unavailable: "unavailable";
+            }>;
+            mode: z.ZodEnum<{
+                browse: "browse";
+                search: "search";
+            }>;
+            query_length: z.ZodNumber;
+            result_count: z.ZodNumber;
+            ambiguous_result_count: z.ZodNumber;
+            submenu_open_count: z.ZodNumber;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly USER_SEARCHED_AI_ASSISTANT_MENTIONS_WITHOUT_RESULTS: {
+        readonly name: "User searched AI Assistant mentions without results";
+        readonly description: "The n8n Assistant mention picker showed its empty state for a search query the user let settle for about a second, or closed the picker on. Fires once per distinct settled query within one picker open, so typing straight through a prefix chain like \"S\", \"Sl\", \"Slack\" reports \"Slack\" once. The one mention event that carries the query text, to learn what users try to mention and cannot.";
+        readonly properties: z.ZodObject<{
+            thread_id: z.ZodNullable<z.ZodString>;
+            source: z.ZodEnum<{
+                button: "button";
+                typed: "typed";
+            }>;
+            query: z.ZodString;
+            query_length: z.ZodNumber;
+            matched_node_type: z.ZodNullable<z.ZodString>;
+            artifact_count: z.ZodNumber;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly USER_SELECTED_AI_ASSISTANT_MENTION: {
+        readonly name: "User selected AI Assistant mention";
+        readonly description: "The user selected a workflow, node, or canvas group from the n8n Assistant mention picker. A pick of a mention that is already staged also counts, so every open ends in this event or in \"User dismissed AI Assistant mention picker\". The event contains interaction metadata but no resource names or IDs.";
+        readonly properties: z.ZodObject<{
+            thread_id: z.ZodNullable<z.ZodString>;
+            kind: z.ZodEnum<{
+                group: "group";
+                node: "node";
+                workflow: "workflow";
+            }>;
+            mode: z.ZodEnum<{
+                browse: "browse";
+                search: "search";
+            }>;
+            source: z.ZodEnum<{
+                artifacts: "artifacts";
+                workflows: "workflows";
+            }>;
+            result_position: z.ZodNumber;
+            query_length: z.ZodNumber;
+            already_artifact: z.ZodBoolean;
+            artifact_origin: z.ZodNullable<z.ZodEnum<{
+                attached: "attached";
+                built: "built";
+                fetched: "fetched";
+                mentioned: "mentioned";
+            }>>;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly USER_REMOVED_AI_ASSISTANT_MENTION: {
+        readonly name: "User removed AI Assistant mention";
+        readonly description: "The user removed workflow, node, or canvas group context that they added through the n8n Assistant mention picker.";
+        readonly properties: z.ZodObject<{
+            thread_id: z.ZodNullable<z.ZodString>;
+            kind: z.ZodEnum<{
+                group: "group";
+                node: "node";
+                workflow: "workflow";
+            }>;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
     readonly USER_SENT_BUILDER_MESSAGE: {
         readonly name: "User sent builder message";
         readonly description: "The user sent a message to the n8n Assistant. Fires once per message on the optimistic send, before the request is admitted, so a refused send still counts as an attempt. Carries who wrote the text: a pre-fill is an opener n8n composed (a failed execution, a credential modal, a template card, a suggestion chip) that the user accepted or edited, so pre-fill share must be read from prefill_type rather than matched against the message body.";
         readonly properties: z.ZodObject<{
+            session_id: z.ZodOptional<z.ZodString>;
+            variant: z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
+            '$feature/118_instance_ai_setup_overhaul': z.ZodOptional<z.ZodEnum<{
+                control: "control";
+                variant: "variant";
+            }>>;
+            mention_counts: z.ZodObject<{
+                total: z.ZodNumber;
+                workflow: z.ZodNumber;
+                node: z.ZodNumber;
+                group: z.ZodNumber;
+            }, z.core.$strip>;
+            attachment_count: z.ZodNumber;
+            workflow_id: z.ZodOptional<z.ZodString>;
+            pending_credential_count: z.ZodOptional<z.ZodNumber>;
+            pending_parameter_count: z.ZodOptional<z.ZodNumber>;
             thread_id: z.ZodString;
             instance_id: z.ZodString;
             is_first_message: z.ZodBoolean;
@@ -543,6 +710,7 @@ export declare const INSTANCE_AI_TELEMETRY: {
                 credentials_list: "credentials_list";
                 evals: "evals";
                 node_error_view: "node_error_view";
+                onboarding: "onboarding";
                 playwright: "playwright";
                 "template-view": "template-view";
                 unknown: "unknown";
@@ -602,4 +770,142 @@ export declare const INSTANCE_AI_TELEMETRY: {
     } & import("../define").TelemetryEventInput & {
         readonly getValidationError: (properties: unknown) => string | null;
     };
+    readonly USER_STARTED_AI_ASSISTANT_ONBOARDING: {
+        readonly name: "User started AI Assistant onboarding";
+        readonly description: "An onboarding thread was created: the user arrived from the n8n Cloud signup survey (/assistant?source=onboarding) or opened the onboarding by hand. Fires once per thread, from the backend, when the seeded greeting and question card are stored.";
+        readonly properties: z.ZodObject<{
+            user_id: z.ZodString;
+            thread_id: z.ZodString;
+            team: z.ZodNullable<z.ZodString>;
+            team_source: z.ZodNullable<z.ZodEnum<{
+                cloud: "cloud";
+                url: "url";
+            }>>;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly USER_ANSWERED_AI_ASSISTANT_ONBOARDING_CARD: {
+        readonly name: "User answered AI Assistant onboarding card";
+        readonly description: "The user settled the question card an onboarding thread opens with. Fires once per thread, from the backend, when the answers are stored. Carries the picked apps and the free text as typed.";
+        readonly properties: z.ZodObject<{
+            user_id: z.ZodString;
+            thread_id: z.ZodString;
+            team: z.ZodNullable<z.ZodString>;
+            team_source: z.ZodNullable<z.ZodEnum<{
+                card: "card";
+                cloud: "cloud";
+                url: "url";
+            }>>;
+            apps: z.ZodArray<z.ZodString>;
+            custom_text: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly AI_ASSISTANT_ONBOARDING_ENDED: {
+        readonly name: "AI Assistant onboarding ended";
+        readonly description: "The onboarding flow of a thread ended and the normal chat came back. Fires once per thread, from the browser, on the first build, when the agent calls `leave-onboarding`, or when a run fails.";
+        readonly properties: z.ZodObject<{
+            thread_id: z.ZodString;
+            instance_id: z.ZodString;
+            outcome: z.ZodEnum<{
+                build: "build";
+                left: "left";
+                run_failed: "run_failed";
+            }>;
+            leave_reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
+    readonly INSTANCE_CONTEXT_TURN: {
+        readonly name: "Instance AI instance-context turn completed";
+        readonly description: "One context result per turn segment, including turns without a block. Group by run_id. Count distinct runs, sum segment tokens, and count a question if any segment asked one.";
+        readonly properties: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            surface: z.ZodEnum<{
+                aia: "aia";
+                mcp: "mcp";
+            }>;
+            user_id: z.ZodString;
+            thread_id: z.ZodOptional<z.ZodString>;
+            run_id: z.ZodString;
+            segment: z.ZodEnum<{
+                resumed: "resumed";
+                suspended: "suspended";
+                whole: "whole";
+            }>;
+            instance_context_enabled: z.ZodBoolean;
+            node_usage_enabled: z.ZodBoolean;
+            context_depth: z.ZodNumber;
+            context_surfaces: z.ZodArray<z.ZodEnum<{
+                "activity-expand": "activity-expand";
+                "activity-list": "activity-list";
+                "node-usage": "node-usage";
+                "workflow-read": "workflow-read";
+            }>>;
+            asked_clarifying_question: z.ZodBoolean;
+            tool_calls: z.ZodNumber;
+            turn_prompt_tokens: z.ZodOptional<z.ZodNumber>;
+            turn_completion_tokens: z.ZodOptional<z.ZodNumber>;
+            turn_total_tokens: z.ZodOptional<z.ZodNumber>;
+            turn_cost_usd: z.ZodOptional<z.ZodNumber>;
+            status: z.ZodEnum<{
+                cancelled: "cancelled";
+                completed: "completed";
+                errored: "errored";
+                suspended: "suspended";
+            }>;
+            block_state: z.ZodLiteral<"absent">;
+            absence_reason: z.ZodEnum<{
+                disabled: "disabled";
+                empty: "empty";
+                failed: "failed";
+                "machine-follow-up": "machine-follow-up";
+            }>;
+        }, z.core.$strict>, z.ZodObject<{
+            surface: z.ZodEnum<{
+                aia: "aia";
+                mcp: "mcp";
+            }>;
+            user_id: z.ZodString;
+            thread_id: z.ZodOptional<z.ZodString>;
+            run_id: z.ZodString;
+            segment: z.ZodEnum<{
+                resumed: "resumed";
+                suspended: "suspended";
+                whole: "whole";
+            }>;
+            instance_context_enabled: z.ZodBoolean;
+            node_usage_enabled: z.ZodBoolean;
+            context_depth: z.ZodNumber;
+            context_surfaces: z.ZodArray<z.ZodEnum<{
+                "activity-expand": "activity-expand";
+                "activity-list": "activity-list";
+                "node-usage": "node-usage";
+                "workflow-read": "workflow-read";
+            }>>;
+            asked_clarifying_question: z.ZodBoolean;
+            tool_calls: z.ZodNumber;
+            turn_prompt_tokens: z.ZodOptional<z.ZodNumber>;
+            turn_completion_tokens: z.ZodOptional<z.ZodNumber>;
+            turn_total_tokens: z.ZodOptional<z.ZodNumber>;
+            turn_cost_usd: z.ZodOptional<z.ZodNumber>;
+            status: z.ZodEnum<{
+                cancelled: "cancelled";
+                completed: "completed";
+                errored: "errored";
+                suspended: "suspended";
+            }>;
+            block_state: z.ZodLiteral<"injected">;
+            block_is_update: z.ZodBoolean;
+            block_inventory_rows: z.ZodNumber;
+            block_event_rows: z.ZodNumber;
+            block_run_rows: z.ZodNumber;
+            block_chars: z.ZodNumber;
+            block_tokens_estimated: z.ZodNumber;
+        }, z.core.$strict>]>;
+    } & import("../define").TelemetryEventInput & {
+        readonly getValidationError: (properties: unknown) => string | null;
+    };
 };