The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Explorations toggle for contextual interestingness (#78239)
Kevin Kelleherfaa3018ebf73
diff --git a/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.tsx b/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.tsxindex 9997fe35175..a72fcf32cc9 100644--- a/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.tsx+++ b/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.tsx@@ -16,9 +16,7 @@ import type {} from "metabase/explorations/hooks";import { isMetricBlock } from "metabase/explorations/hooks";import { useMetabotAgent } from "metabase/metabot/hooks";-import { useSelector } from "metabase/redux";import { useNavigate } from "metabase/router";-import { getApplicationName } from "metabase/selectors/whitelabel";import {Box,Button,@@ -27,7 +25,7 @@ import {Icon,Menu,Stack,- Text,+ Switch,Title,} from "metabase/ui";import * as Urls from "metabase/urls";@@ -124,15 +122,19 @@ export function NewExplorationData({ selection }: NewExplorationDataProps) {} = selection;const navigate = useNavigate();const [sendToast] = useToast();- const applicationName = useSelector(getApplicationName);const [activeModal, setActiveModal] = useState<ActiveModal>(null);const [expandedIds, setExpandedIds] = useState<Set<string>>(new Set());+ const [useContextualInterestingness, setUseContextualInterestingness] =+ useState(true);const [createExploration, { isLoading: isStarting }] =useCreateExplorationMutation();const { messages, isDoingScience } = useMetabotAgent(EXPLORATIONS_AGENT_ID);+ const hasUserPrompt = messages.some(+ (message) => message.role === "user" && message.message.trim().length > 0,+ );const canStart = blocks.some(isNonEmptyBlock);const isManualDataPickingDisabled = isDoingScience;@@ -170,10 +172,13 @@ export function NewExplorationData({ selection }: NewExplorationDataProps) {);const handleStart = useCallback(async () => {- const prompt = messages- .filter((message) => message.role === "user")- .map((message) => message.message)- .join("\n---\n");+ const prompt =+ hasUserPrompt && useContextualInterestingness+ ? messages+ .filter((message) => message.role === "user")+ .map((message) => message.message)+ .join("\n---\n")+ : "";const request = buildCreateExplorationRequest(name,prompt,@@ -196,6 +201,8 @@ export function NewExplorationData({ selection }: NewExplorationDataProps) {}, [createExploration,navigate,+ hasUserPrompt,+ useContextualInterestingness,messages,blocks,timelines,@@ -325,15 +332,17 @@ export function NewExplorationData({ selection }: NewExplorationDataProps) {</Box><Group justify="space-between" align="center" wrap="nowrap">- <Text- className={CS.alignSelfEnd}- c="text-secondary"+ <Switch+ style={!hasUserPrompt ? { visibility: "hidden" } : undefined}+ checked={useContextualInterestingness}+ onChange={(event) =>+ setUseContextualInterestingness(event.currentTarget.checked)+ }size="sm"- lh="1rem"- mb="0.5rem"- >{t`${applicationName} will automate running combinations of these pairings and then do a basic analysis of the results.`}</Text>+ label={t`Use AI to analyze and order results`}+ /><Button- className={cx(!canStart && CS.hidden)} // hide with css to make sure caption text is aligned vertically+ className={cx(!canStart && CS.hidden)}size="sm"flex="none"variant="filled"diff --git a/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.unit.spec.tsx b/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.unit.spec.tsxindex 6fe3498a337..d7b64da36af 100644--- a/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.unit.spec.tsx+++ b/frontend/src/metabase/explorations/components/NewExplorationData/NewExplorationData.unit.spec.tsx@@ -1,10 +1,12 @@import userEvent from "@testing-library/user-event";import { setupExplorationDataEndpoint } from "__support__/server-mocks/metric";-import { renderWithProviders, screen } from "__support__/ui";+import { renderWithProviders, screen, waitFor } from "__support__/ui";+import { useCreateExplorationMutation } from "metabase/api";import { trackExplorationPlanEdited } from "metabase/explorations/analytics";import type { ExplorationBlock } from "metabase/explorations/hooks";import {+ createExploration,makeMockSelection,mockDimensionBlock,mockMetricBlock,@@ -27,6 +29,11 @@ jest.mock("metabase/explorations/analytics", () => ({trackExplorationPlanEdited: jest.fn(),}));+jest.mock("metabase/api", () => ({+ ...jest.requireActual("metabase/api"),+ useCreateExplorationMutation: jest.fn(),+}));+jest.mock("metabase/metabot/hooks", () => ({...jest.requireActual("metabase/metabot/hooks"),useMetabotAgent: jest.fn(),@@ -56,15 +63,30 @@ const churnMetric = createMockMetric({dimension_ids: [dimPlan.id],}) as ExplorationMetric;+const createExplorationMock = jest.fn();+function setup({blocks = [],timelines = [],-}: { blocks?: ExplorationBlock[]; timelines?: Timeline[] } = {}) {+ messages = [],+}: {+ blocks?: ExplorationBlock[];+ timelines?: Timeline[];+ messages?: { role: string; message: string }[];+} = {}) {// Unjustified type cast. FIXMEjest.mocked(useMetabotAgent).mockReturnValue({- messages: [],+ messages,} as any);+ createExplorationMock.mockReturnValue({+ unwrap: () => Promise.resolve(createExploration()),+ });+ jest+ .mocked(useCreateExplorationMutation)+ // RTK mutation hook mock only needs trigger + isLoading from the tuple.+ .mockReturnValue([createExplorationMock, { isLoading: false }] as any);+// The Add* modals fetch this on mount even while closed.setupExplorationDataEndpoint([]);@@ -401,6 +423,69 @@ describe("NewExplorationData (Research plan)", () => {});});+ describe("contextual interestingness toggle", () => {+ const metricBlock = mockMetricBlock(revenueMetric, [dimCreatedAt]);+ const userQuestion = "What drives churn?";++ it("hides the toggle when there are no user messages", () => {+ setup({ blocks: [metricBlock] });++ expect(screen.getByRole("switch", { hidden: true })).not.toBeVisible();+ });++ it("renders the toggle on by default when there are user messages", () => {+ setup({+ blocks: [metricBlock],+ messages: [{ role: "user", message: userQuestion }],+ });++ expect(+ screen.getByRole("switch", {+ name: /Use AI to analyze and order results/,+ }),+ ).toBeChecked();+ });++ it("sends the prompt when the toggle is on", async () => {+ setup({+ blocks: [metricBlock],+ messages: [{ role: "user", message: userQuestion }],+ });++ await userEvent.click(+ screen.getByRole("button", { name: "Start research" }),+ );++ await waitFor(() => {+ expect(createExplorationMock).toHaveBeenCalledWith(+ expect.objectContaining({ prompt: userQuestion }),+ );+ });+ });++ it("omits the prompt when the toggle is off", async () => {+ setup({+ blocks: [metricBlock],+ messages: [{ role: "user", message: userQuestion }],+ });++ await userEvent.click(+ screen.getByRole("switch", {+ name: /Use AI to analyze and order results/,+ }),+ );+ await userEvent.click(+ screen.getByRole("button", { name: "Start research" }),+ );++ await waitFor(() => {+ expect(createExplorationMock).toHaveBeenCalledWith(+ expect.objectContaining({ prompt: null }),+ );+ });+ });+ });+describe("mixed Research plan", () => {it("renders metric and dimension blocks each with their own controls and enables Start research", () => {setup({diff --git a/resources/migrations/instance_analytics_views/ai_usage_log/v5/h2-ai_usage_log.sql b/resources/migrations/instance_analytics_views/ai_usage_log/v5/h2-ai_usage_log.sqlindex 832ae2b2ee8..e03beb6d7b4 100644--- a/resources/migrations/instance_analytics_views/ai_usage_log/v5/h2-ai_usage_log.sql+++ b/resources/migrations/instance_analytics_views/ai_usage_log/v5/h2-ai_usage_log.sql@@ -8,8 +8,8 @@ SELECTCASE a.sourceWHEN 'metabot_agent' THEN 'Metabot'WHEN 'agent' THEN 'Metabot'- WHEN 'contextual_interestingness' THEN 'Contextual Interestingness'- WHEN 'exploration' THEN 'Explorations'+ WHEN 'contextual_interestingness' THEN 'Research'+ WHEN 'exploration' THEN 'Research'WHEN 'document_generate_content' THEN 'Documents'WHEN 'example_question_generation_batch' THEN 'Suggested Prompts'WHEN 'slack' THEN 'Slackbot'diff --git a/resources/migrations/instance_analytics_views/ai_usage_log/v5/mysql-ai_usage_log.sql b/resources/migrations/instance_analytics_views/ai_usage_log/v5/mysql-ai_usage_log.sqlindex 398039894f8..5f63daa4d26 100644--- a/resources/migrations/instance_analytics_views/ai_usage_log/v5/mysql-ai_usage_log.sql+++ b/resources/migrations/instance_analytics_views/ai_usage_log/v5/mysql-ai_usage_log.sql@@ -8,8 +8,8 @@ SELECTCASE a.sourceWHEN 'metabot_agent' THEN 'Metabot'WHEN 'agent' THEN 'Metabot'- WHEN 'contextual_interestingness' THEN 'Contextual Interestingness'- WHEN 'exploration' THEN 'Explorations'+ WHEN 'contextual_interestingness' THEN 'Research'+ WHEN 'exploration' THEN 'Research'WHEN 'document_generate_content' THEN 'Documents'WHEN 'example_question_generation_batch' THEN 'Suggested Prompts'WHEN 'slack' THEN 'Slackbot'diff --git a/resources/migrations/instance_analytics_views/ai_usage_log/v5/postgres-ai_usage_log.sql b/resources/migrations/instance_analytics_views/ai_usage_log/v5/postgres-ai_usage_log.sqlindex 832ae2b2ee8..e03beb6d7b4 100644--- a/resources/migrations/instance_analytics_views/ai_usage_log/v5/postgres-ai_usage_log.sql+++ b/resources/migrations/instance_analytics_views/ai_usage_log/v5/postgres-ai_usage_log.sql@@ -8,8 +8,8 @@ SELECTCASE a.sourceWHEN 'metabot_agent' THEN 'Metabot'WHEN 'agent' THEN 'Metabot'- WHEN 'contextual_interestingness' THEN 'Contextual Interestingness'- WHEN 'exploration' THEN 'Explorations'+ WHEN 'contextual_interestingness' THEN 'Research'+ WHEN 'exploration' THEN 'Research'WHEN 'document_generate_content' THEN 'Documents'WHEN 'example_question_generation_batch' THEN 'Suggested Prompts'WHEN 'slack' THEN 'Slackbot'diff --git a/resources/migrations/instance_analytics_views/metabot_conversations/v7/h2-metabot_conversations.sql b/resources/migrations/instance_analytics_views/metabot_conversations/v7/h2-metabot_conversations.sqlindex 06e40a05851..0d17d176efb 100644--- a/resources/migrations/instance_analytics_views/metabot_conversations/v7/h2-metabot_conversations.sql+++ b/resources/migrations/instance_analytics_views/metabot_conversations/v7/h2-metabot_conversations.sql@@ -29,7 +29,7 @@ SELECTWHEN 'slackbot' THEN 'Slackbot'WHEN 'transforms_codegen' THEN 'Transforms codegen'WHEN 'document-generate-content' THEN 'Documents'- WHEN 'explorations' THEN 'Explorations'+ WHEN 'explorations' THEN 'Research'ELSE mm.profile_idENDFROM metabot_message mm@@ -59,8 +59,8 @@ SELECTWHEN 'oss-sql-gen' THEN 'SQL'WHEN 'sql-gen' THEN 'SQL'WHEN 'unknown' THEN 'Unknown'- WHEN 'contextual_interestingness' THEN 'Contextual Interestingness'- WHEN 'exploration' THEN 'Explorations'+ WHEN 'contextual_interestingness' THEN 'Research'+ WHEN 'exploration' THEN 'Research'ELSE aul.sourceENDFROM ai_usage_log auldiff --git a/resources/migrations/instance_analytics_views/metabot_conversations/v7/mysql-metabot_conversations.sql b/resources/migrations/instance_analytics_views/metabot_conversations/v7/mysql-metabot_conversations.sqlindex dfc630d7565..047eb1ed679 100644--- a/resources/migrations/instance_analytics_views/metabot_conversations/v7/mysql-metabot_conversations.sql+++ b/resources/migrations/instance_analytics_views/metabot_conversations/v7/mysql-metabot_conversations.sql@@ -29,7 +29,7 @@ SELECTWHEN 'slackbot' THEN 'Slackbot'WHEN 'transforms_codegen' THEN 'Transforms codegen'WHEN 'document-generate-content' THEN 'Documents'- WHEN 'explorations' THEN 'Explorations'+ WHEN 'explorations' THEN 'Research'ELSE mm.profile_idENDFROM metabot_message mm@@ -59,8 +59,8 @@ SELECTWHEN 'oss-sql-gen' THEN 'SQL'WHEN 'sql-gen' THEN 'SQL'WHEN 'unknown' THEN 'Unknown'- WHEN 'contextual_interestingness' THEN 'Contextual Interestingness'- WHEN 'exploration' THEN 'Explorations'+ WHEN 'contextual_interestingness' THEN 'Research'+ WHEN 'exploration' THEN 'Research'ELSE aul.sourceENDFROM ai_usage_log auldiff --git a/resources/migrations/instance_analytics_views/metabot_conversations/v7/postgres-metabot_conversations.sql b/resources/migrations/instance_analytics_views/metabot_conversations/v7/postgres-metabot_conversations.sqlindex 9dd4fb8317e..c0b6d01a1eb 100644--- a/resources/migrations/instance_analytics_views/metabot_conversations/v7/postgres-metabot_conversations.sql+++ b/resources/migrations/instance_analytics_views/metabot_conversations/v7/postgres-metabot_conversations.sql@@ -29,7 +29,7 @@ SELECTWHEN 'slackbot' THEN 'Slackbot'WHEN 'transforms_codegen' THEN 'Transforms codegen'WHEN 'document-generate-content' THEN 'Documents'- WHEN 'explorations' THEN 'Explorations'+ WHEN 'explorations' THEN 'Research'ELSE mm.profile_idENDFROM metabot_message mm@@ -59,8 +59,8 @@ SELECTWHEN 'oss-sql-gen' THEN 'SQL'WHEN 'sql-gen' THEN 'SQL'WHEN 'unknown' THEN 'Unknown'- WHEN 'contextual_interestingness' THEN 'Contextual Interestingness'- WHEN 'exploration' THEN 'Explorations'+ WHEN 'contextual_interestingness' THEN 'Research'+ WHEN 'exploration' THEN 'Research'ELSE aul.sourceENDFROM ai_usage_log aul