Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

[Metabot] Expose finish reason from `useMetabot` hook (#82464)

Sloan Sparger87816dec1585
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx
index 5207cbd8f4c..850b891bd87 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx
@@ -62,7 +62,7 @@ export function MetabotChatHistory() {
messages={chatMessages}
size="md"
onRetryMessage={metabot.retryMessage}
- onContinueMessage={metabot.submitInput}
+ onContinueMessage={metabot.continueResponse}
isDoingScience={metabot.isDoingScience}
debug={metabot.debugMode}
conversationId={metabot.conversationId}
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.tsx b/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.tsx
index 79854e0462d..ec719fef106 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.tsx
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.tsx
@@ -10,6 +10,7 @@ import { useMetabaseProviderPropsStore } from "embedding-sdk-bundle/lib/provider
import type { MetabaseAuthConfig } from "embedding-sdk-bundle/types";
import type {
MetabotChartProps,
+ MetabotIncompleteResponse,
MetabotMessage,
MetabotErrorMessage as SdkMetabotErrorMessage,
UseMetabotResult,
@@ -81,6 +82,24 @@ export const useMetabot = (): UseMetabotResult => {
[agentRetryMessage],
);
+ const agentContinueResponse = agent.continueResponse;
+ const incompleteTurn = agent.incompleteTurn;
+ const incompleteResponse = useMemo<MetabotIncompleteResponse | null>(() => {
+ if (!incompleteTurn) {
+ return null;
+ }
+ return {
+ reason: incompleteTurn.reason,
+ message: incompleteTurn.message,
+ ...(agentContinueResponse && {
+ continueResponse: () =>
+ agentContinueResponse({ preventOpenSidebar: true }).then(
+ () => undefined,
+ ),
+ }),
+ };
+ }, [incompleteTurn, agentContinueResponse]);
+
const agentCreateNewConversation = agent.createNewConversation;
const resetConversation = useCallback(() => {
chartComponentsCache.current.clear();
@@ -130,6 +149,7 @@ export const useMetabot = (): UseMetabotResult => {
messages,
errorMessages,
+ incompleteResponse,
isProcessing: agent.isDoingScience,
contextWindowPercentUsage: agent.contextWindowPercentUsage,
isContextWindowFull: agent.isContextWindowFull,
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.unit.spec.tsx b/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.unit.spec.tsx
index be1b5458c37..0c85c5d9655 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.unit.spec.tsx
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/hooks/use-metabot.unit.spec.tsx
@@ -5,6 +5,10 @@ import { useState } from "react";
import { act, screen, waitFor } from "__support__/ui";
import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";
import type { GeneratedCard } from "metabase/api/ai-streaming/schemas";
+import type {
+ FinishReason,
+ SSEEvent,
+} from "metabase/api/ai-streaming/sse-types";
import { getMetabotState, metabotActions } from "metabase/metabot/state";
import {
createTestMetabotState,
@@ -74,8 +78,8 @@ const cardPath = (id: string, sourceTable = 1) =>
/**
* Covers `useMetabot()` non-passthrough wiring: `CurrentChart`,
- * `messages[n].Chart`, `submitMessage`, `messages` mapping. Chart mocks
- * expose `data-testid` + `data-query`; real rendering lives in the
+ * `messages[n].Chart`, `submitMessage`, `messages` mapping, `incompleteResponse`.
+ * Chart mocks expose `data-testid` + `data-query`; real rendering lives in the
* StaticQuestion/InteractiveQuestion specs. `ComponentProvider` is stubbed —
* provider init is out of scope. Pure passthroughs (retry/cancel/reset/
* errorMessages/isProcessing) skipped.
@@ -463,6 +467,189 @@ describe("useMetabot", () => {
});
});
+ describe("incompleteResponse", () => {
+ const CONTEXT_WINDOW = 1000;
+ const fullContextWindow = {
+ contextTokens: CONTEXT_WINDOW,
+ contextWindowTokens: CONTEXT_WINDOW,
+ };
+
+ let turnCount = 0;
+ const turnEndingWith = (
+ finishReason: FinishReason,
+ messageMetadata?: typeof fullContextWindow,
+ ): SSEEvent[] => [
+ { type: "start", messageId: `msg_turn_${++turnCount}` },
+ { type: "text-start", id: "t1" },
+ { type: "text-delta", id: "t1", delta: "Here is the start" },
+ { type: "text-end", id: "t1" },
+ {
+ type: "finish",
+ finishReason,
+ ...(messageMetadata && { messageMetadata }),
+ },
+ ];
+
+ const TestIncomplete = ({
+ onContinued,
+ }: {
+ onContinued?: (value: unknown) => void;
+ }) => {
+ const { submitMessage, incompleteResponse } = useMetabot();
+ const continueResponse = incompleteResponse?.continueResponse;
+ const handleContinue = async () => {
+ const result = await continueResponse?.();
+ onContinued?.(result);
+ };
+ return (
+ <div>
+ <button data-testid="submit-btn" onClick={() => submitMessage("hi")}>
+ submit
+ </button>
+ {incompleteResponse && (
+ <div data-testid="incomplete-response">
+ <span data-testid="reason">{incompleteResponse.reason}</span>
+ <span data-testid="message">{incompleteResponse.message}</span>
+ {continueResponse && (
+ <button data-testid="continue-btn" onClick={handleContinue}>
+ continue
+ </button>
+ )}
+ </div>
+ )}
+ </div>
+ );
+ };
+
+ const submit = () => userEvent.click(screen.getByTestId("submit-btn"));
+ const continueBtn = () => screen.findByTestId("continue-btn");
+ const waitForMessageCount = (
+ store: ReturnType<typeof setup>["store"],
+ count: number,
+ ) =>
+ waitFor(() =>
+ expect(
+ getMetabotState(store.getState()).conversations[conversationId]
+ ?.messages,
+ ).toHaveLength(count),
+ );
+
+ it("exposes nothing after a response that finishes with stop", async () => {
+ mockAgentEndpoint({ events: whoIsYourFavoriteResponse });
+ const { store } = setup({ ui: <TestIncomplete /> });
+
+ await submit();
+ await waitForMessageCount(store, 2);
+
+ expect(
+ screen.queryByTestId("incomplete-response"),
+ ).not.toBeInTheDocument();
+ });
+
+ it.each<{
+ finishReason: FinishReason;
+ messageMetadata?: typeof fullContextWindow;
+ reason: string;
+ continuable: boolean;
+ }>([
+ {
+ finishReason: "tool-calls",
+ reason: "step-limit",
+ continuable: true,
+ },
+ {
+ finishReason: "length",
+ reason: "max-length",
+ continuable: true,
+ },
+ {
+ finishReason: "length",
+ messageMetadata: fullContextWindow,
+ reason: "context-window-full",
+ continuable: false,
+ },
+ {
+ finishReason: "content-filter",
+ reason: "content-filter",
+ continuable: false,
+ },
+ {
+ finishReason: "other",
+ reason: "other",
+ continuable: false,
+ },
+ ])(
+ "exposes $reason for a $finishReason finish (continuable: $continuable)",
+ async ({ finishReason, messageMetadata, reason, continuable }) => {
+ mockAgentEndpoint({
+ events: turnEndingWith(finishReason, messageMetadata),
+ });
+ setup({ ui: <TestIncomplete /> });
+
+ await submit();
+
+ expect(await screen.findByTestId("reason")).toHaveTextContent(reason);
+ expect(screen.getByTestId("message")).not.toBeEmptyDOMElement();
+ expect(screen.queryByTestId("continue-btn") !== null).toBe(continuable);
+ },
+ );
+
+ it("continueResponse submits the resume prompt as a new user turn", async () => {
+ mockAgentEndpoint({ events: turnEndingWith("tool-calls") });
+ setup({ ui: <TestIncomplete /> });
+ await submit();
+
+ const continuationSpy = mockAgentEndpoint({
+ events: whoIsYourFavoriteResponse,
+ });
+ await userEvent.click(await continueBtn());
+
+ expect((await lastReqBody(continuationSpy))?.message).toBe(
+ "Continue working on my last request.",
+ );
+ });
+
+ it("continueResponse does not expose the agent's internal result to the caller", async () => {
+ mockAgentEndpoint({ events: turnEndingWith("tool-calls") });
+ const onContinued = jest.fn();
+ setup({ ui: <TestIncomplete onContinued={onContinued} /> });
+ await submit();
+
+ mockAgentEndpoint({ events: whoIsYourFavoriteResponse });
+ await userEvent.click(await continueBtn());
+
+ await waitFor(() => expect(onContinued).toHaveBeenCalledWith(undefined));
+ });
+
+ it("clears once the continued turn finishes", async () => {
+ mockAgentEndpoint({ events: turnEndingWith("tool-calls") });
+ const { store } = setup({ ui: <TestIncomplete /> });
+ await submit();
+
+ mockAgentEndpoint({ events: whoIsYourFavoriteResponse });
+ await userEvent.click(await continueBtn());
+ await waitForMessageCount(store, 4);
+
+ expect(
+ screen.queryByTestId("incomplete-response"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("re-exposes when the continued response is cut off again", async () => {
+ mockAgentEndpoint({ events: turnEndingWith("tool-calls") });
+ setup({ ui: <TestIncomplete /> });
+ await submit();
+
+ mockAgentEndpoint({ events: turnEndingWith("length") });
+ await userEvent.click(await continueBtn());
+
+ await waitFor(() =>
+ expect(screen.getByTestId("reason")).toHaveTextContent("max-length"),
+ );
+ expect(await continueBtn()).toBeInTheDocument();
+ });
+ });
+
describe("messages[n].Chart", () => {
const TestChart = ({ drills }: { drills?: true }) => {
const { messages } = useMetabot();
diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.unit.spec.tsx b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.unit.spec.tsx
index eb1b2e3c46a..1e153835ab4 100644
--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.unit.spec.tsx
+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.unit.spec.tsx
@@ -14,6 +14,7 @@ const makeMetabotResult = (
resetConversation: jest.fn(),
messages: [],
errorMessages: [],
+ incompleteResponse: null,
isProcessing: false,
contextWindowPercentUsage: 0,
isContextWindowFull: false,
diff --git a/enterprise/frontend/src/embedding-sdk-package/index.ts b/enterprise/frontend/src/embedding-sdk-package/index.ts
index 47d8d8bc412..ba8509dc4ef 100644
--- a/enterprise/frontend/src/embedding-sdk-package/index.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/index.ts
@@ -151,6 +151,7 @@ export type {
MetabotAgentTextMessage,
MetabotChartProps,
MetabotErrorMessage,
+ MetabotIncompleteResponse,
MetabotMessage,
MetabotUserTextMessage,
ParameterChangeSource,
diff --git a/frontend/src/embedding-sdk-bundle/types/metabot.ts b/frontend/src/embedding-sdk-bundle/types/metabot.ts
index df84a040ae5..9de280375e5 100644
--- a/frontend/src/embedding-sdk-bundle/types/metabot.ts
+++ b/frontend/src/embedding-sdk-bundle/types/metabot.ts
@@ -65,6 +65,21 @@ export type MetabotErrorMessage = {
message: string;
};
+/** @category useMetabot */
+export type MetabotIncompleteResponse = {
+ /** Why the latest response stopped before it finished. */
+ reason:
+ | "step-limit"
+ | "max-length"
+ | "context-window-full"
+ | "content-filter"
+ | "other";
+ /** User-friendly explanation of why the response stopped. */
+ message: string;
+ /** Resume the response where it left off. Absent when the response can't be continued. */
+ continueResponse?: () => Promise<void>;
+};
+
/** @category useMetabot */
export type UseMetabotResult = {
/** Submit a new message to the conversation. */
@@ -83,6 +98,8 @@ export type UseMetabotResult = {
messages: MetabotMessage[];
/** Errors are conversation-level, not attached to individual messages. */
errorMessages: MetabotErrorMessage[];
+ /** Set when the latest agent response stopped before it finished, e.g. at its step limit. */
+ incompleteResponse: MetabotIncompleteResponse | null;
/**
* `true` from the moment a message is submitted until the response
* completes — including success, error, or cancellation.
diff --git a/frontend/src/metabase/explorations/components/NewExplorationChat/NewExplorationChat.tsx b/frontend/src/metabase/explorations/components/NewExplorationChat/NewExplorationChat.tsx
index cb749bf5af6..0535a064ee2 100644
--- a/frontend/src/metabase/explorations/components/NewExplorationChat/NewExplorationChat.tsx
+++ b/frontend/src/metabase/explorations/components/NewExplorationChat/NewExplorationChat.tsx
@@ -92,6 +92,7 @@ export function NewExplorationChat({ selection }: NewExplorationChatProps) {
messages,
conversationId,
retryMessage,
+ continueResponse,
isDoingScience,
submitInput,
cancelRequest,
@@ -292,11 +293,13 @@ export function NewExplorationChat({ selection }: NewExplorationChatProps) {
onRetryMessage={(id) =>
retryMessage(id, { profile: "explorations" })
}
- onContinueMessage={(prompt) =>
- submitInput(prompt, {
- preventOpenSidebar: true,
- profile: "explorations",
- })
+ onContinueMessage={
+ continueResponse &&
+ (() =>
+ continueResponse({
+ preventOpenSidebar: true,
+ profile: "explorations",
+ }))
}
isDoingScience={isDoingScience}
debug={false}
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx
index fd395598c2b..6a3caed47ec 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx
@@ -206,7 +206,7 @@ export const MetabotChat = ({
<Messages
messages={metabot.messages}
onRetryMessage={metabot.retryMessage}
- onContinueMessage={metabot.submitInput}
+ onContinueMessage={metabot.continueResponse}
onRefreshConversation={() => {
metabot.setPrompt("");
metabot.reloadConversation();
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx
index 4d815105e94..b463d3a25ff 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx
@@ -14,11 +14,13 @@ import {
type MetabotAgentTurnError,
type MetabotDataPart,
type MetabotDebugToolCallMessage,
- type MetabotIncompleteFinishReason,
+ type MetabotIncompleteMessageStatus,
type MetabotMessage,
type MetabotMessagePart,
type MetabotMessageStatus,
forkConversation,
+ getIncompleteTurnMessage,
+ getIncompleteTurnReason,
isChainOfThoughtMessage,
isTextPart,
} from "metabase/metabot/state";
@@ -260,7 +262,7 @@ interface AgentMessageProps extends Omit<FlexProps, "onCopy"> {
readonly: boolean;
conversationId: string;
onRetry?: () => void;
- onContinue?: (resumePrompt: string) => void;
+ onContinue?: () => void;
onRefreshConversation?: () => void;
setFeedbackMessage?: (data: { messageId: string; positive: boolean }) => void;
submittedFeedback: "positive" | "negative" | undefined;
@@ -578,7 +580,7 @@ const MessageStatus = ({
status: MetabotMessageStatus;
debug: boolean;
onRetry?: () => void;
- onContinue?: (resumePrompt: string) => void;
+ onContinue?: () => void;
onRefreshConversation?: () => void;
}) =>
match(status)
@@ -595,12 +597,8 @@ const MessageStatus = ({
.with({ type: "aborted" }, () => (
<AbortedTurnAlert debug={debug} onRetry={onRetry} />
))
- .with({ type: "incomplete" }, (o) => (
- <IncompleteTurnAlert
- finishReason={o.finishReason}
- contextWindowFull={o.contextWindowFull}
- onContinue={onContinue}
- />
+ .with({ type: "incomplete" }, (status) => (
+ <IncompleteTurnAlert status={status} onContinue={onContinue} />
))
.with({ type: "in_progress" }, () => <MetabotResponseLoader />)
.exhaustive();
@@ -632,55 +630,27 @@ const AbortedTurnAlert = ({
);
};
-const getIncompleteTurnConfig = (
- finishReason: MetabotIncompleteFinishReason,
- metabotName: string,
-): { message: string; resumePrompt?: string } =>
- match(finishReason)
- .with("length", () => ({
- message: t`Response from ${metabotName} was cut off because it hit the maximum length`,
- resumePrompt: t`Your last response was cut off. Pick up exactly where you left off. Don't repeat anything you already wrote.`,
- }))
- .with("content-filter", () => ({
- message: t`Response from ${metabotName} was stopped by a content filter. Try rephrasing your question.`,
- }))
- .with("tool-calls", () => ({
- message: t`${metabotName} paused after reaching its step limit for this response`,
- resumePrompt: t`Continue working on my last request.`,
- }))
- .with("other", () => ({
- message: t`Response from ${metabotName} stopped before it finished`,
- }))
- .exhaustive();
-
const IncompleteTurnAlert = ({
- finishReason,
- contextWindowFull,
+ status,
onContinue,
}: {
- finishReason: MetabotIncompleteFinishReason;
- contextWindowFull?: boolean;
- onContinue?: (resumePrompt: string) => void;
+ status: MetabotIncompleteMessageStatus;
+ onContinue?: () => void;
}) => {
const metabotName = useSetting("metabot-name");
- // "length" is overloaded, occurs when context window has been met (unrecoverable)
- // or when the max_tokens has been met (recoverable)
- const { message, resumePrompt } =
- finishReason === "length" && contextWindowFull
- ? {
- message: t`This conversation has reached its maximum length and can't continue. Please start a new chat.`,
- resumePrompt: undefined,
- }
- : getIncompleteTurnConfig(finishReason, metabotName);
+ const message = getIncompleteTurnMessage(
+ getIncompleteTurnReason(status),
+ metabotName,
+ );
return (
<AgentTurnAlert
variant="info"
message={message}
cta={
- resumePrompt && onContinue ? (
+ onContinue ? (
<Button
size="sm"
- onClick={() => onContinue(resumePrompt)}
+ onClick={() => onContinue()}
data-testid="metabot-chat-message-continue"
>
{t`Continue`}
@@ -710,7 +680,7 @@ export const Messages = ({
}: {
messages: MetabotMessage[];
onRetryMessage?: (messageId: string) => void;
- onContinueMessage?: (resumePrompt: string) => void;
+ onContinueMessage?: () => void;
onRefreshConversation?: () => void;
isDoingScience: boolean;
supportsReasoning?: boolean;
diff --git a/frontend/src/metabase/metabot/hooks/use-metabot-agent.ts b/frontend/src/metabase/metabot/hooks/use-metabot-agent.ts
index 72655c029c8..cf5260c3440 100644
--- a/frontend/src/metabase/metabot/hooks/use-metabot-agent.ts
+++ b/frontend/src/metabase/metabot/hooks/use-metabot-agent.ts
@@ -1,4 +1,4 @@
-import { useCallback } from "react";
+import { useCallback, useMemo } from "react";
import { useDispatch, useSelector } from "metabase/redux";
@@ -16,6 +16,10 @@ import {
useMetabotConversation,
} from "./use-metabot-conversation";
+type AgentSubmitInputOptions = SubmitInputOptions & {
+ preventOpenSidebar?: boolean;
+};
+
export const useMetabotAgent = (agentId: MetabotAgentId = "omnibot") => {
const dispatch = useDispatch();
const conversationId = useSelector((state) =>
@@ -29,25 +33,39 @@ export const useMetabotAgent = (agentId: MetabotAgentId = "omnibot") => {
[dispatch, agentId],
);
+ const withSidebarReveal = useCallback(
+ (options?: AgentSubmitInputOptions): SubmitInputOptions => ({
+ ...options,
+ onBeforeSubmit: () => {
+ if (!visible && !options?.preventOpenSidebar) {
+ setVisible(true);
+ }
+ },
+ }),
+ [setVisible, visible],
+ );
+
const submitInput = useCallback(
(
prompt: Parameters<typeof conversation.submitInput>[0],
- options?: SubmitInputOptions & { preventOpenSidebar?: boolean },
- ) =>
- conversation.submitInput(prompt, {
- ...options,
- onBeforeSubmit: () => {
- if (!visible && !options?.preventOpenSidebar) {
- setVisible(true);
- }
- },
- }),
- [conversation, setVisible, visible],
+ options?: AgentSubmitInputOptions,
+ ) => conversation.submitInput(prompt, withSidebarReveal(options)),
+ [conversation, withSidebarReveal],
+ );
+
+ const conversationContinueResponse = conversation.continueResponse;
+ const continueResponse = useMemo(
+ () =>
+ conversationContinueResponse &&
+ ((options?: AgentSubmitInputOptions) =>
+ conversationContinueResponse(withSidebarReveal(options))),
+ [conversationContinueResponse, withSidebarReveal],
);
return {
...conversation,
submitInput,
+ continueResponse,
visible,
setVisible,
createNewConversation: useCallback(
diff --git a/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts b/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts
index 96e6991bcff..ae176ef4665 100644
--- a/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts
+++ b/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts
@@ -1,5 +1,5 @@
import { isFulfilled } from "@reduxjs/toolkit";
-import { useCallback } from "react";
+import { useCallback, useMemo } from "react";
import { useMetabotContext } from "metabase/metabot";
import { useDispatch, useSelector } from "metabase/redux";
@@ -16,6 +16,7 @@ import {
getConversationForkedFrom,
getConversationTitle,
getDebugMode,
+ getIncompleteTurn,
getIsConversationProcessing,
getLongChatNotice,
getMessages,
@@ -140,6 +141,17 @@ export const useMetabotConversation = (conversationId: string) => {
],
);
+ const incompleteTurn = useSelector((state) =>
+ getIncompleteTurn(state, conversationId),
+ );
+
+ const continueResponse = useMemo(() => {
+ const resumePrompt = incompleteTurn?.resumePrompt;
+ return resumePrompt
+ ? (options?: SubmitInputOptions) => submitInput(resumePrompt, options)
+ : undefined;
+ }, [incompleteTurn, submitInput]);
+
const cancelRequest = useCallback(() => {
dispatch(cancelInflightConversationRequests(conversationId));
}, [dispatch, conversationId]);
@@ -160,6 +172,7 @@ export const useMetabotConversation = (conversationId: string) => {
setProfileOverride,
submitInput,
retryMessage,
+ continueResponse,
cancelRequest,
reloadConversation,
metabotId: useSelector(getMetabotId),
@@ -173,6 +186,7 @@ export const useMetabotConversation = (conversationId: string) => {
getIsConversationProcessing(state, conversationId),
),
longChatNotice,
+ incompleteTurn,
isContextWindowFull: longChatNotice === "full",
contextWindowPercentUsage: useSelector((state) =>
getContextUsagePercent(state, conversationId),
diff --git a/frontend/src/metabase/metabot/state/selectors.ts b/frontend/src/metabase/metabot/state/selectors.ts
index 08c7f4e86fb..928a4b8eca9 100644
--- a/frontend/src/metabase/metabot/state/selectors.ts
+++ b/frontend/src/metabase/metabot/state/selectors.ts
@@ -2,6 +2,7 @@ import { createSelector } from "@reduxjs/toolkit";
import { isEmbedding } from "metabase/embedding/config";
import type { State } from "metabase/redux/store";
+import { getSetting } from "metabase/settings";
import * as Urls from "metabase/urls";
import {
@@ -17,10 +18,18 @@ import {
import type {
MetabotAgentId,
MetabotContextUsage,
+ MetabotIncompleteTurn,
MetabotMessage,
MetabotState,
} from "./types";
-import { hasInProgressMessage, isGeneratedCardPart, isTextPart } from "./utils";
+import {
+ getIncompleteTurnMessage,
+ getIncompleteTurnReason,
+ getIncompleteTurnResumePrompt,
+ hasInProgressMessage,
+ isGeneratedCardPart,
+ isTextPart,
+} from "./utils";
/*
* Top Level Selectors
@@ -259,6 +268,28 @@ export const getLongChatNotice = createSelector(
},
);
+const getMetabotName = (state: State) => getSetting(state, "metabot-name");
+
+// Only the latest turn can be continued; earlier incomplete turns are history.
+export const getIncompleteTurn = createSelector(
+ [getMessages, getMetabotName],
+ (messages, metabotName): MetabotIncompleteTurn | null => {
+ const lastMessage = messages.at(-1);
+ if (
+ lastMessage?.role !== "agent" ||
+ lastMessage.status.type !== "incomplete"
+ ) {
+ return null;
+ }
+ const reason = getIncompleteTurnReason(lastMessage.status);
+ return {
+ reason,
+ message: getIncompleteTurnMessage(reason, metabotName),
+ resumePrompt: getIncompleteTurnResumePrompt(reason),
+ };
+ },
+);
+
export const getMetabotReqIdOverride = createSelector(
getConversation,
(convo) => convo.experimental.metabotReqIdOverride,
diff --git a/frontend/src/metabase/metabot/state/selectors.unit.spec.ts b/frontend/src/metabase/metabot/state/selectors.unit.spec.ts
index 190060515a8..11a455f6595 100644
--- a/frontend/src/metabase/metabot/state/selectors.unit.spec.ts
+++ b/frontend/src/metabase/metabot/state/selectors.unit.spec.ts
@@ -13,6 +13,7 @@ import {
type MetabotConversationState,
type MetabotMessage,
getContextUsagePercent,
+ getIncompleteTurn,
getIsConversationInProgress,
getLastAgentMessageExternalId,
getLongChatNotice,
@@ -205,6 +206,36 @@ describe("metabot selectors", () => {
});
});
+ describe("getIncompleteTurn", () => {
+ it("returns null when the last turn finished normally", () => {
+ const state = setup([createMockMetabotMessage()]);
+ expect(getIncompleteTurn(state, "omnibot")).toBeNull();
+ });
+
+ it("ignores incomplete turns that are no longer the last message", () => {
+ const state = setup([
+ createMockMetabotMessage({
+ status: { type: "incomplete", finishReason: "tool-calls" },
+ }),
+ createMockMetabotMessage({ role: "user" }),
+ ]);
+ expect(getIncompleteTurn(state, "omnibot")).toBeNull();
+ });
+
+ it("describes the last turn when it stopped early", () => {
+ const state = setup([
+ createMockMetabotMessage({
+ status: { type: "incomplete", finishReason: "tool-calls" },
+ }),
+ ]);
+ expect(getIncompleteTurn(state, "omnibot")).toEqual({
+ reason: "step-limit",
+ message: expect.stringContaining("Metabot"),
+ resumePrompt: expect.any(String),
+ });
+ });
+ });
+
describe("getIsConversationInProgress", () => {
it("detects a mid-thread in-progress message for profiles like slackbot", () => {
const conversationId = "slackbot";
diff --git a/frontend/src/metabase/metabot/state/types.ts b/frontend/src/metabase/metabot/state/types.ts
index 304be7cfe4c..106911db225 100644
--- a/frontend/src/metabase/metabot/state/types.ts
+++ b/frontend/src/metabase/metabot/state/types.ts
@@ -109,6 +109,25 @@ export type MetabotMessageStatus =
serverStarted?: boolean;
};
+export type MetabotIncompleteMessageStatus = Extract<
+ MetabotMessageStatus,
+ { type: "incomplete" }
+>;
+
+export type MetabotIncompleteReason =
+ | "step-limit"
+ | "max-length"
+ | "context-window-full"
+ | "content-filter"
+ | "other";
+
+export type MetabotIncompleteTurn = {
+ reason: MetabotIncompleteReason;
+ message: string;
+ /** Prompt that resumes the turn; absent when the turn cannot be continued. */
+ resumePrompt?: string;
+};
+
export type MetabotMessagePart =
| MetabotUserTextChatMessage
| MetabotAgentTextChatMessage
diff --git a/frontend/src/metabase/metabot/state/utils.ts b/frontend/src/metabase/metabot/state/utils.ts
index 42b0d0ea620..069d5a0425d 100644
--- a/frontend/src/metabase/metabot/state/utils.ts
+++ b/frontend/src/metabase/metabot/state/utils.ts
@@ -1,9 +1,13 @@
import { nanoid } from "@reduxjs/toolkit";
+import { match } from "ts-pattern";
+import { t } from "ttag";
import type {
MetabotAgentChainOfThoughtMessage,
MetabotAgentTextChatMessage,
MetabotGeneratedCardPart,
+ MetabotIncompleteMessageStatus,
+ MetabotIncompleteReason,
MetabotMessage,
MetabotMessagePart,
MetabotUserTextChatMessage,
@@ -49,3 +53,62 @@ export const parseSlashCommand = (
args: args ? args.split(" ") : [],
};
};
+
+export const getIncompleteTurnReason = ({
+ finishReason,
+ contextWindowFull,
+}: MetabotIncompleteMessageStatus): MetabotIncompleteReason =>
+ match(finishReason)
+ .with("tool-calls", () => "step-limit" as const)
+ .with("length", () =>
+ contextWindowFull
+ ? ("context-window-full" as const)
+ : ("max-length" as const),
+ )
+ .with("content-filter", () => "content-filter" as const)
+ .with("other", () => "other" as const)
+ .exhaustive();
+
+export const getIncompleteTurnMessage = (
+ reason: MetabotIncompleteReason,
+ metabotName: string,
+): string =>
+ match(reason)
+ .with(
+ "step-limit",
+ () =>
+ t`${metabotName} paused after reaching its step limit for this response`,
+ )
+ .with(
+ "max-length",
+ () =>
+ t`Response from ${metabotName} was cut off because it hit the maximum length`,
+ )
+ .with(
+ "context-window-full",
+ () =>
+ t`This conversation has reached its maximum length and can't continue. Please start a new chat.`,
+ )
+ .with(
+ "content-filter",
+ () =>
+ t`Response from ${metabotName} was stopped by a content filter. Try rephrasing your question.`,
+ )
+ .with(
+ "other",
+ () => t`Response from ${metabotName} stopped before it finished`,
+ )
+ .exhaustive();
+
+export const getIncompleteTurnResumePrompt = (
+ reason: MetabotIncompleteReason,
+): string | undefined =>
+ match(reason)
+ .with("step-limit", () => t`Continue working on my last request.`)
+ .with(
+ "max-length",
+ () =>
+ t`Your last response was cut off. Pick up exactly where you left off. Don't repeat anything you already wrote.`,
+ )
+ .with("context-window-full", "content-filter", "other", () => undefined)
+ .exhaustive();
diff --git a/frontend/src/metabase/metabot/tests/chat-message-rendering.unit.spec.tsx b/frontend/src/metabase/metabot/tests/chat-message-rendering.unit.spec.tsx
index dede5df3af1..523b260740d 100644
--- a/frontend/src/metabase/metabot/tests/chat-message-rendering.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/tests/chat-message-rendering.unit.spec.tsx
@@ -398,9 +398,7 @@ describe("AgentMessage", () => {
screen.getByText(/was cut off because it hit the maximum length/),
).toBeInTheDocument();
await userEvent.click(await continueResponseButton());
- expect(onContinue).toHaveBeenCalledWith(
- expect.stringMatching(/Pick up exactly where you left off/),
- );
+ expect(onContinue).toHaveBeenCalled();
});
it("offers to continue a step-limited response", async () => {
@@ -411,40 +409,34 @@ describe("AgentMessage", () => {
screen.getByText(/paused after reaching its step limit/),
).toBeInTheDocument();
await userEvent.click(await continueResponseButton());
- expect(onContinue).toHaveBeenCalledWith(
- expect.stringMatching(/Continue working on my last request/),
- );
+ expect(onContinue).toHaveBeenCalled();
});
it("shows a terminal notice when the context window is full", () => {
- setup(
- {
- status: {
- type: "incomplete",
- finishReason: "length",
- contextWindowFull: true,
- },
+ setup({
+ status: {
+ type: "incomplete",
+ finishReason: "length",
+ contextWindowFull: true,
},
- { onContinue: jest.fn() },
- );
+ });
expect(
screen.getByText(/reached its maximum length and can't continue/),
).toBeInTheDocument();
- expect(queryContinueResponseButton()).not.toBeInTheDocument();
});
- it("explains a content-filtered response without offering to continue", () => {
- setup(
- { status: incompleteStatus("content-filter") },
- {
- onContinue: jest.fn(),
- },
- );
+ it("explains a content-filtered response", () => {
+ setup({ status: incompleteStatus("content-filter") });
expect(
screen.getByText(/was stopped by a content filter/),
).toBeInTheDocument();
+ });
+
+ it("hides the continue button without a handler", () => {
+ setup({ status: incompleteStatus("tool-calls") });
+
expect(queryContinueResponseButton()).not.toBeInTheDocument();
});
diff --git a/frontend/src/metabase/metabot/tests/message.unit.spec.tsx b/frontend/src/metabase/metabot/tests/message.unit.spec.tsx
index 6d8ad811545..efc2ba119db 100644
--- a/frontend/src/metabase/metabot/tests/message.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/tests/message.unit.spec.tsx
@@ -208,6 +208,7 @@ describe("metabot > finish reason", () => {
["agent", "I can't help with that."],
["agent", /stopped by a content filter/],
]);
+ expect(queryContinueResponseButton()).not.toBeInTheDocument();
});
it("should not show a notice for a normal stop", async () => {