@lightdash/common 0.2012.0 → 0.2013.0

package/dist/esm/ee/AiAgent/schemas/tools/toolImproveContext.js

@@ -0,0 +1,73 @@
+import { z } from 'zod';
+import { AiResultType } from '../../types';
+import { createToolSchema } from '../toolSchemaBuilder';
+export const TOOL_IMPROVE_CONTEXT_DESCRIPTION = `
+
+  - **When to use the Improve Context Tool:**
+    - User guides table/explore selection: "You can use the main_table for summary queries - you don't need the detailed table"
+    - User shares business methodology: "Generally we use higher-level categories to have fewer groupings"
+    - User clarifies where to find data: "Use the dimension table to get category details"
+    - User corrects field usage: "Filter by order_number not order_id"
+    - User corrects terminology: "Actually, 'total revenue' means revenue_after_tax"
+    - User provides better formatting/structure: "I'd structure the examples like this: Category: X, Feedback: Y"
+    - User clarifies business rules: "Customer count should exclude test accounts"
+    - Your confidence this is a learnable correction (not just a new request) is above 0.7
+
+ - **Learning Categories and Examples:**
+
+    Category: explore_selection
+    Feedback: "Use the sales_data explore instead of the orders table for revenue analysis"
+    Generated instruction: "For revenue analysis queries, use the sales_data explore instead of the orders table"
+
+    Category: field_selection
+    Feedback1: "No, use net_revenue instead of gross_revenue"
+    Generated instruction1: "When users ask for revenue, use the net_revenue field instead of gross_revenue"
+    Feedback2: "Actually, 'total revenue' should always refer to the revenue_after_tax field"
+    Generated instruction2: "When users mention 'total revenue', they mean the revenue_after_tax field"
+
+    Category: filter_logic
+    Feedback: "The customer_count should exclude test accounts"
+    Generated instruction: "When calculating customer_count, always exclude test accounts using the filter is_test_account = false"
+
+    Category: calculation
+    Feedback: "Conversion rate should be conversions divided by total visits, not unique visitors"
+    Generated instruction: "When calculating conversion rate, use conversions / total_visits instead of conversions / unique_visitors"
+
+    Category: other
+    Feedback1: "Always show results in descending order by default"
+    Generated instruction1: "When showing metric results, default to descending order unless explicitly requested otherwise"
+    Feedback2: "We prefer to analyze by region rather than individual store locations"
+    Generated instruction2: "When analyzing geographic data, use region-level aggregations instead of individual store locations"
+
+ `;
+export const toolImproveContextArgsSchema = createToolSchema(AiResultType.IMPROVE_CONTEXT, TOOL_IMPROVE_CONTEXT_DESCRIPTION)
+    .extend({
+    originalQuery: z
+        .string()
+        .describe('The original user query that led to incorrect results'),
+    incorrectResponse: z
+        .string()
+        .describe('What the AI incorrectly suggested or returned'),
+    correctResponse: z
+        .string()
+        .describe('What the user corrected or clarified'),
+    category: z
+        .enum([
+        'explore_selection',
+        'field_selection',
+        'filter_logic',
+        'calculation',
+        'other',
+    ])
+        .describe('Category of the learning'),
+    confidence: z
+        .number()
+        .min(0)
+        .max(1)
+        .describe('Confidence score that this is a learnable learning or more context is needed'),
+    suggestedInstruction: z
+        .string()
+        .describe('The instruction to append to agent settings'),
+})
+    .build();
+//# sourceMappingURL=toolImproveContext.js.map

package/dist/esm/ee/AiAgent/schemas/tools/toolImproveContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolImproveContext.js","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tools/toolImproveContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,MAAM,CAAC,MAAM,gCAAgC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsC9C,CAAC;AAEH,MAAM,CAAC,MAAM,4BAA4B,GAAG,gBAAgB,CACxD,YAAY,CAAC,eAAe,EAC5B,gCAAgC,CACnC;KACI,MAAM,CAAC;IACJ,aAAa,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,CAAC,uDAAuD,CAAC;IACtE,iBAAiB,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,CAAC,+CAA+C,CAAC;IAC9D,eAAe,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,CAAC,sCAAsC,CAAC;IACrD,QAAQ,EAAE,CAAC;SACN,IAAI,CAAC;QACF,mBAAmB;QACnB,iBAAiB;QACjB,cAAc;QACd,aAAa;QACb,OAAO;KACV,CAAC;SACD,QAAQ,CAAC,0BAA0B,CAAC;IACzC,UAAU,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACL,8EAA8E,CACjF;IACL,oBAAoB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CAAC,6CAA6C,CAAC;CAC/D,CAAC;KACD,KAAK,EAAE,CAAC"}

package/dist/esm/ee/AiAgent/schemas/visualizations/index.d.ts

@@ -2,11 +2,11 @@ import { z } from 'zod';
 export * from './tableViz';
 export * from './timeSeriesViz';
 export * from './verticalBarViz';
-export declare const ToolNameSchema: z.ZodEnum<["generateBarVizConfig", "generateTableVizConfig", "generateTimeSeriesVizConfig", "generateDashboard", "findExplores", "findFields", "findDashboards", "findCharts"]>;
+export declare const ToolNameSchema: z.ZodEnum<["generateBarVizConfig", "generateTableVizConfig", "generateTimeSeriesVizConfig", "generateDashboard", "findExplores", "findFields", "findDashboards", "findCharts", "improveContext"]>;
 export type ToolName = z.infer<typeof ToolNameSchema>;
 export declare const isToolName: (toolName: string) => toolName is ToolName;
-export declare const ToolDisplayMessagesSchema: z.ZodRecord<z.ZodEnum<["generateBarVizConfig", "generateTableVizConfig", "generateTimeSeriesVizConfig", "generateDashboard", "findExplores", "findFields", "findDashboards", "findCharts"]>, z.ZodString>;
-export declare const TOOL_DISPLAY_MESSAGES: Partial<Record<"generateBarVizConfig" | "generateTableVizConfig" | "generateTimeSeriesVizConfig" | "generateDashboard" | "findExplores" | "findFields" | "findDashboards" | "findCharts", string>>;
-export declare const TOOL_DISPLAY_MESSAGES_AFTER_TOOL_CALL: Partial<Record<"generateBarVizConfig" | "generateTableVizConfig" | "generateTimeSeriesVizConfig" | "generateDashboard" | "findExplores" | "findFields" | "findDashboards" | "findCharts", string>>;
+export declare const ToolDisplayMessagesSchema: z.ZodRecord<z.ZodEnum<["generateBarVizConfig", "generateTableVizConfig", "generateTimeSeriesVizConfig", "generateDashboard", "findExplores", "findFields", "findDashboards", "findCharts", "improveContext"]>, z.ZodString>;
+export declare const TOOL_DISPLAY_MESSAGES: Partial<Record<"generateBarVizConfig" | "generateTableVizConfig" | "generateTimeSeriesVizConfig" | "generateDashboard" | "findExplores" | "findFields" | "findDashboards" | "findCharts" | "improveContext", string>>;
+export declare const TOOL_DISPLAY_MESSAGES_AFTER_TOOL_CALL: Partial<Record<"generateBarVizConfig" | "generateTableVizConfig" | "generateTimeSeriesVizConfig" | "generateDashboard" | "findExplores" | "findFields" | "findDashboards" | "findCharts" | "improveContext", string>>;
 export declare const AVAILABLE_VISUALIZATION_TYPES: readonly ["generateBarVizConfig", "generateTableVizConfig", "generateTimeSeriesVizConfig"];
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/ee/AiAgent/schemas/visualizations/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/visualizations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AASjC,eAAO,MAAM,cAAc,iLAOzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,eAAO,MAAM,UAAU,aAAc,MAAM,KAAG,QAAQ,IAAI,QACZ,CAAC;AAG/C,eAAO,MAAM,yBAAyB,2MAAuC,CAAC;AAE9E,eAAO,MAAM,qBAAqB,oMAShC,CAAC;AAGH,eAAO,MAAM,qCAAqC,oMAU5C,CAAC;AAEP,eAAO,MAAM,6BAA6B,4FAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/visualizations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AASjC,eAAO,MAAM,cAAc,mMAQzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,eAAO,MAAM,UAAU,aAAc,MAAM,KAAG,QAAQ,IAAI,QACZ,CAAC;AAG/C,eAAO,MAAM,yBAAyB,6NAAuC,CAAC;AAE9E,eAAO,MAAM,qBAAqB,uNAUhC,CAAC;AAGH,eAAO,MAAM,qCAAqC,uNAW5C,CAAC;AAEP,eAAO,MAAM,6BAA6B,4FAAqB,CAAC"}

package/dist/esm/ee/AiAgent/schemas/visualizations/index.js

@@ -15,6 +15,7 @@ export const ToolNameSchema = z.enum([
     'findFields',
     'findDashboards',
     'findCharts',
+    'improveContext',
 ]);
 export const isToolName = (toolName) => ToolNameSchema.safeParse(toolName).success;
 // display messages schema
@@ -28,6 +29,7 @@ export const TOOL_DISPLAY_MESSAGES = ToolDisplayMessagesSchema.parse({
     generateTimeSeriesVizConfig: 'Generating a line chart',
     generateDashboard: 'Generating a dashboard',
     findCharts: 'Finding relevant charts',
+    improveContext: 'Improving context',
 });
 // after-tool-call messages
 export const TOOL_DISPLAY_MESSAGES_AFTER_TOOL_CALL = ToolDisplayMessagesSchema.parse({
@@ -39,6 +41,7 @@ export const TOOL_DISPLAY_MESSAGES_AFTER_TOOL_CALL = ToolDisplayMessagesSchema.p
     generateTimeSeriesVizConfig: 'Generated a line chart',
     generateDashboard: 'Generated a dashboard',
     findCharts: 'Found relevant charts',
+    improveContext: 'Improved context',
 });
 export const AVAILABLE_VISUALIZATION_TYPES = VisualizationTools;
 //# sourceMappingURL=index.js.map

package/dist/esm/ee/AiAgent/schemas/visualizations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/visualizations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,MAAM,kBAAkB,GAAG;IACvB,sBAAsB;IACtB,wBAAwB;IACxB,6BAA6B;CACvB,CAAC;AAEX,oBAAoB;AACpB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC;IACjC,GAAG,kBAAkB;IACrB,mBAAmB;IACnB,cAAc;IACd,YAAY;IACZ,gBAAgB;IAChB,YAAY;CACf,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAwB,EAAE,CACjE,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;AAE/C,0BAA0B;AAC1B,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAE9E,MAAM,CAAC,MAAM,qBAAqB,GAAG,yBAAyB,CAAC,KAAK,CAAC;IACjE,YAAY,EAAE,2BAA2B;IACzC,cAAc,EAAE,6BAA6B;IAC7C,UAAU,EAAE,yBAAyB;IACrC,oBAAoB,EAAE,wBAAwB;IAC9C,sBAAsB,EAAE,oBAAoB;IAC5C,2BAA2B,EAAE,yBAAyB;IACtD,iBAAiB,EAAE,wBAAwB;IAC3C,UAAU,EAAE,yBAAyB;CACxC,CAAC,CAAC;AAEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,qCAAqC,GAC9C,yBAAyB,CAAC,KAAK,CAAC;IAC5B,YAAY,EAAE,yBAAyB;IACvC,cAAc,EAAE,2BAA2B;IAC3C,UAAU,EAAE,uBAAuB;IACnC,oBAAoB,EAAE,uBAAuB;IAC7C,sBAAsB,EAAE,mBAAmB;IAC3C,2BAA2B,EAAE,wBAAwB;IACrD,iBAAiB,EAAE,uBAAuB;IAC1C,UAAU,EAAE,uBAAuB;CACtC,CAAC,CAAC;AAEP,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/visualizations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,MAAM,kBAAkB,GAAG;IACvB,sBAAsB;IACtB,wBAAwB;IACxB,6BAA6B;CACvB,CAAC;AAEX,oBAAoB;AACpB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC;IACjC,GAAG,kBAAkB;IACrB,mBAAmB;IACnB,cAAc;IACd,YAAY;IACZ,gBAAgB;IAChB,YAAY;IACZ,gBAAgB;CACnB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAwB,EAAE,CACjE,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;AAE/C,0BAA0B;AAC1B,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAE9E,MAAM,CAAC,MAAM,qBAAqB,GAAG,yBAAyB,CAAC,KAAK,CAAC;IACjE,YAAY,EAAE,2BAA2B;IACzC,cAAc,EAAE,6BAA6B;IAC7C,UAAU,EAAE,yBAAyB;IACrC,oBAAoB,EAAE,wBAAwB;IAC9C,sBAAsB,EAAE,oBAAoB;IAC5C,2BAA2B,EAAE,yBAAyB;IACtD,iBAAiB,EAAE,wBAAwB;IAC3C,UAAU,EAAE,yBAAyB;IACrC,cAAc,EAAE,mBAAmB;CACtC,CAAC,CAAC;AAEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,qCAAqC,GAC9C,yBAAyB,CAAC,KAAK,CAAC;IAC5B,YAAY,EAAE,yBAAyB;IACvC,cAAc,EAAE,2BAA2B;IAC3C,UAAU,EAAE,uBAAuB;IACnC,oBAAoB,EAAE,uBAAuB;IAC7C,sBAAsB,EAAE,mBAAmB;IAC3C,2BAA2B,EAAE,wBAAwB;IACrD,iBAAiB,EAAE,uBAAuB;IAC1C,UAAU,EAAE,uBAAuB;IACnC,cAAc,EAAE,kBAAkB;CACrC,CAAC,CAAC;AAEP,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC"}

package/dist/esm/ee/AiAgent/types.d.ts

@@ -5,7 +5,8 @@ export declare enum AiResultType {
     TIME_SERIES_RESULT = "time_series_chart",
     VERTICAL_BAR_RESULT = "vertical_bar_chart",
     TABLE_RESULT = "table",
-    DASHBOARD_RESULT = "dashboard"
+    DASHBOARD_RESULT = "dashboard",
+    IMPROVE_CONTEXT = "improve_context"
 }
 export type AiMetricQuery = Pick<MetricQuery, 'metrics' | 'dimensions' | 'sorts' | 'limit' | 'exploreName'> & {
     additionalMetrics: Omit<AdditionalMetric, 'sql'>[];

package/dist/esm/ee/AiAgent/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/ee/AiAgent/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,KAAK,EACR,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACtB,MAAM,iBAAiB,CAAC;AAEzB,oBAAY,YAAY;IACpB,kBAAkB,sBAAsB;IACxC,mBAAmB,uBAAuB;IAC1C,YAAY,UAAU;IACtB,gBAAgB,cAAc;CACjC;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAC5B,WAAW,EACX,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,aAAa,CAC/D,GAAG;IACA,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,aAAa,GAAG;IACnD,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACtB;IACI,IAAI,EAAE,oBAAoB,CAAC;IAC3B,MAAM,EAAE,mBAAmB,CAAC;CAC/B,GACD;IACI,IAAI,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,kBAAkB,CAAC;CAC9B,GACD;IACI,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,gBAAgB,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/ee/AiAgent/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,KAAK,EACR,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACtB,MAAM,iBAAiB,CAAC;AAEzB,oBAAY,YAAY;IACpB,kBAAkB,sBAAsB;IACxC,mBAAmB,uBAAuB;IAC1C,YAAY,UAAU;IACtB,gBAAgB,cAAc;IAC9B,eAAe,oBAAoB;CACtC;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAC5B,WAAW,EACX,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,aAAa,CAC/D,GAAG;IACA,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,aAAa,GAAG;IACnD,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACtB;IACI,IAAI,EAAE,oBAAoB,CAAC;IAC3B,MAAM,EAAE,mBAAmB,CAAC;CAC/B,GACD;IACI,IAAI,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,kBAAkB,CAAC;CAC9B,GACD;IACI,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,gBAAgB,CAAC;CAC5B,CAAC"}

package/dist/esm/ee/AiAgent/types.js

@@ -4,5 +4,6 @@ export var AiResultType;
     AiResultType["VERTICAL_BAR_RESULT"] = "vertical_bar_chart";
     AiResultType["TABLE_RESULT"] = "table";
     AiResultType["DASHBOARD_RESULT"] = "dashboard";
+    AiResultType["IMPROVE_CONTEXT"] = "improve_context";
 })(AiResultType || (AiResultType = {}));
 //# sourceMappingURL=types.js.map

package/dist/esm/ee/AiAgent/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ee/AiAgent/types.ts"],"names":[],"mappings":"AAQA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,wDAAwC,CAAA;IACxC,0DAA0C,CAAA;IAC1C,sCAAsB,CAAA;IACtB,8CAA8B,CAAA;AAClC,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ee/AiAgent/types.ts"],"names":[],"mappings":"AAQA,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACpB,wDAAwC,CAAA;IACxC,0DAA0C,CAAA;IAC1C,sCAAsB,CAAA;IACtB,8CAA8B,CAAA;IAC9B,mDAAmC,CAAA;AACvC,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}