Skip to content

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

[Metabot] Handle conversation reaching max window size (#79859)

Sloan Spargerf53640862e27
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx
index 5aaf09ba37f..34725bea2a8 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.tsx
@@ -1,7 +1,7 @@
import { useEffect, useMemo, useRef } from "react";
import { Messages } from "metabase/metabot/components/MetabotChat/MetabotChatMessage";
-import { MetabotResetLongChatButton } from "metabase/metabot/components/MetabotChat/MetabotResetLongChatButton";
+import { MetabotLongChatNotice } from "metabase/metabot/components/MetabotChat/MetabotLongChatNotice";
import { useMetabotAgent } from "metabase/metabot/hooks";
import { useMetabotReactions } from "metabase/metabot/hooks/use-metabot-reactions";
import type { MetabotChatMessage } from "metabase/metabot/state";
@@ -65,9 +65,11 @@ export function MetabotChatHistory() {
onInternalLinkClick={setNavigateToPath}
/>
) : null}
- {metabot.isLongConversation && (
- <MetabotResetLongChatButton
- onResetConversation={metabot.createNewConversation}
+ {metabot.longChatNotice && !metabot.isDoingScience && (
+ <MetabotLongChatNotice
+ variant={metabot.longChatNotice}
+ className={hasMessages ? S.longChatNotice : undefined}
+ onNewChat={metabot.createNewConversation}
/>
)}
</Stack>
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.unit.spec.tsx b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.unit.spec.tsx
index 8cf6033f28e..2322e2285f5 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.unit.spec.tsx
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotChatHistory.unit.spec.tsx
@@ -1,6 +1,7 @@
import { assocIn } from "icepick";
-import { screen } from "__support__/ui";
+import { act, screen } from "__support__/ui";
+import { metabotActions } from "metabase/metabot/state";
import type { MetabotChatMessage } from "metabase/metabot/state/types";
import {
createTestMetabotState,
@@ -18,6 +19,34 @@ const makeVisibleState = (messages: MetabotChatMessage[]) =>
);
describe("MetabotChatHistory", () => {
+ it("should hide the long chat notice while the agent is responding", () => {
+ const { store } = setup({
+ ui: <MetabotChatHistory />,
+ metabotInitialState: assocIn(
+ makeVisibleState([
+ { id: "1", role: "user", type: "text", message: "hi" },
+ ]),
+ ["conversations", testConversationId("omnibot"), "lastTokenUsage"],
+ { contextTokens: 200, contextWindowTokens: 200 },
+ ),
+ });
+
+ expect(screen.getByTestId("metabot-long-chat-notice")).toBeInTheDocument();
+
+ act(() => {
+ store.dispatch(
+ metabotActions.setIsProcessing({
+ conversationId: testConversationId("omnibot"),
+ processing: true,
+ }),
+ );
+ });
+
+ expect(
+ screen.queryByTestId("metabot-long-chat-notice"),
+ ).not.toBeInTheDocument();
+ });
+
it("should not render generated_entity card data_part messages in the message list", () => {
setup({
ui: <MetabotChatHistory />,
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.module.css b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.module.css
index f25f52199e7..35c9aee8c1d 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.module.css
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.module.css
@@ -74,6 +74,10 @@
}
}
+.longChatNotice {
+ margin-top: 0.5rem;
+}
+
/* Prompt suggestions */
.promptSuggestionsContainer {
flex-shrink: 0;
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 4873cbdd2ae..b04686bd53c 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
@@ -121,6 +121,8 @@ export const useMetabot = (): UseMetabotResult => {
messages,
errorMessages,
isProcessing: agent.isDoingScience,
+ contextWindowPercentUsage: agent.contextWindowPercentUsage,
+ isContextWindowFull: agent.isContextWindowFull,
CurrentChart,
};
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 e95f0038808..eb1b2e3c46a 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
@@ -15,6 +15,8 @@ const makeMetabotResult = (
messages: [],
errorMessages: [],
isProcessing: false,
+ contextWindowPercentUsage: 0,
+ isContextWindowFull: false,
CurrentChart: null,
...overrides,
});
diff --git a/frontend/src/embedding-sdk-bundle/types/metabot.ts b/frontend/src/embedding-sdk-bundle/types/metabot.ts
index e611c168299..df84a040ae5 100644
--- a/frontend/src/embedding-sdk-bundle/types/metabot.ts
+++ b/frontend/src/embedding-sdk-bundle/types/metabot.ts
@@ -88,6 +88,10 @@ export type UseMetabotResult = {
* completes — including success, error, or cancellation.
*/
isProcessing: boolean;
+ /** How much of the model's context window the conversation occupies, 0-100. */
+ contextWindowPercentUsage: number;
+ /** Whether the conversation has consumed its entire context window. */
+ isContextWindowFull: boolean;
/**
* A pre-wired component bound to the latest chart the agent produced.
diff --git a/frontend/src/metabase/api/ai-streaming/sse-types.ts b/frontend/src/metabase/api/ai-streaming/sse-types.ts
index 055f82b5fbb..9c2f57a61a6 100644
--- a/frontend/src/metabase/api/ai-streaming/sse-types.ts
+++ b/frontend/src/metabase/api/ai-streaming/sse-types.ts
@@ -11,6 +11,10 @@ export type TokenUsage = {
export type MessageMetadata = {
usage?: TokenUsage;
usageByModel?: Record<string, TokenUsage>;
+ contextWindowTokens?: number;
+ // the turn's final LLM call (prompt + completion) — the conversation's
+ // current size, unlike `usage` which sums every call in the turn
+ contextTokens?: number;
// a typed error's code, ridden on the trailing `finish` event so the client
// can branch on it (e.g. the usage-limit upgrade prompt)
errorCode?: string;
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.module.css b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.module.css
index 51f47e97560..65a412d12a7 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.module.css
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.module.css
@@ -27,7 +27,8 @@
}
.inputContainer {
- padding: 0 0.75rem 0 0.3rem;
+ position: relative;
+ padding: 0 0.75rem 0 0.5rem;
display: flex;
align-items: center;
gap: 0.5rem;
@@ -169,16 +170,35 @@
}
}
-.textInputContainer {
+.footerContainer {
+ display: flex;
+ flex-direction: column;
padding: 0 1rem;
width: 100%;
max-width: 48rem;
margin-inline: auto;
}
-.disclaimer {
- height: 2rem;
+.textInputContainer {
display: flex;
+ flex-direction: column;
+ gap: 0.5rem;
+ width: 100%;
+}
+
+.footerRow {
+ display: grid;
+ grid-template-columns: 1fr auto 1fr;
align-items: center;
- justify-content: center;
+ min-height: 2rem;
+ padding: 0 0.25rem;
+
+ > :first-child {
+ grid-column: 2;
+ }
+}
+
+.contextUsage {
+ grid-column: 3;
+ justify-self: end;
}
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx
index efe508426ba..975c53eeb06 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChat.tsx
@@ -6,7 +6,7 @@ import { t } from "ttag";
import EmptyDashboardBot from "assets/img/dashboard-empty.svg?component";
import { AIProviderConfigurationModal } from "metabase/metabot/components/AIProviderConfigurationModal";
import { AIProviderConfigurationNotice } from "metabase/metabot/components/AIProviderConfigurationNotice";
-import { MetabotResetLongChatButton } from "metabase/metabot/components/MetabotChat/MetabotResetLongChatButton";
+import { MetabotLongChatNotice } from "metabase/metabot/components/MetabotChat/MetabotLongChatNotice";
import { useSetting } from "metabase/settings";
import { Box, Button, Flex, Paper, Stack, Text } from "metabase/ui";
@@ -18,6 +18,7 @@ import type { MetabotChatConfig } from "../Metabot";
import Styles from "./MetabotChat.module.css";
import { MetabotChatEditor } from "./MetabotChatEditor";
import { Messages } from "./MetabotChatMessage";
+import { MetabotContextUsageRing } from "./MetabotContextUsageRing";
import { useScrollManager } from "./hooks";
const defaultConfig: MetabotChatConfig = {
@@ -84,7 +85,6 @@ export const MetabotChat = ({
: t`New conversation`;
const title = hasMessages ? metabot.title || untitledLabel : undefined;
- const handleEditorSubmit = () => metabot.submitInput(metabot.prompt);
const shouldShowHeader = headerActions || title;
return (
@@ -194,47 +194,52 @@ export const MetabotChat = ({
/>
{/* filler - height gets set via ref mutation */}
<div ref={fillerRef} data-testid="metabot-message-filler" />
- {/* long convo warning */}
- {metabot.isLongConversation && onNewConversation && (
- <MetabotResetLongChatButton
- onResetConversation={onNewConversation}
- />
- )}
</Box>
)}
</Box>
</Box>
{isConfigured && (
- <Box className={Styles.textInputContainer}>
- <Paper
- className={cx(
- Styles.inputContainer,
- metabot.isDoingScience && Styles.inputContainerLoading,
+ <Box className={Styles.footerContainer}>
+ <Box className={Styles.textInputContainer}>
+ {metabot.longChatNotice && onNewConversation && (
+ <MetabotLongChatNotice
+ variant={metabot.longChatNotice}
+ onNewChat={onNewConversation}
+ />
+ )}
+ <Paper
+ className={cx(
+ Styles.inputContainer,
+ metabot.isDoingScience && Styles.inputContainerLoading,
+ )}
+ >
+ <MetabotChatEditor
+ ref={metabot.promptInputRef}
+ value={metabot.prompt}
+ autoFocus
+ isResponding={metabot.isDoingScience}
+ placeholder={t`How can I help? Type @ to mention items.`}
+ onChange={metabot.setPrompt}
+ onSubmit={() => metabot.submitInput(metabot.prompt)}
+ onStop={metabot.cancelRequest}
+ suggestionConfig={{
+ suggestionModels: config.suggestionModels,
+ }}
+ />
+ </Paper>
+ </Box>
+ <Box className={Styles.footerRow}>
+ <Text fz="sm" c="text-secondary" ta="center">
+ {t`${metabotName} isn't perfect. Double-check results.`}
+ </Text>
+ {metabot.contextWindowPercentUsage > 50 && (
+ <MetabotContextUsageRing
+ className={Styles.contextUsage}
+ percentUsage={metabot.contextWindowPercentUsage}
+ />
)}
- >
- <MetabotChatEditor
- ref={metabot.promptInputRef}
- value={metabot.prompt}
- autoFocus
- isResponding={metabot.isDoingScience}
- placeholder={t`How can I help? Type @ to mention items.`}
- onChange={metabot.setPrompt}
- onSubmit={handleEditorSubmit}
- onStop={metabot.cancelRequest}
- suggestionConfig={{
- suggestionModels: config.suggestionModels,
- }}
- />
- </Paper>
- <Text
- className={Styles.disclaimer}
- fz="sm"
- c="text-secondary"
- ta="center"
- >
- {t`${metabotName} isn't perfect. Double-check results.`}
- </Text>
+ </Box>
</Box>
)}
<AIProviderConfigurationModal
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.module.css b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.module.css
index 9a303de0e5a..5cd73d848ab 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.module.css
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.module.css
@@ -1,30 +1,28 @@
.editorContainer {
display: flex;
- align-items: flex-start;
+ align-items: center;
width: 100%;
height: 100%;
+ min-height: 46px;
}
-.iconContainer {
- padding-top: 12px;
- width: 2.375rem;
- flex: 0 0 auto;
- display: flex;
- justify-content: center;
+.contentWrapper {
+ flex: 1;
+ min-width: 0;
+ width: 100%;
+ padding-left: 0.5rem;
}
.button {
- margin-bottom: 0.625rem;
- margin-right: -0.125rem;
+ margin: 0 -0.25rem calc(0.5rem - 1px) 2px;
background: var(--mb-color-core-brand);
- border-radius: 50%;
- align-self: flex-end;
- margin-left: 2px;
- width: 1.25rem;
- height: 1.25rem;
+ border-radius: 6px;
+ width: 2rem;
+ height: 2rem;
display: flex;
justify-content: center;
align-items: center;
+ align-self: flex-end;
transition:
opacity 300ms ease,
background 150ms ease,
@@ -65,13 +63,7 @@
.stopIcon {
color: var(--mb-color-core-brand);
- width: 0.5rem;
- height: 0.5rem;
+ width: 0.7rem;
+ height: 0.7rem;
transition: color 150ms ease;
}
-
-.contentWrapper {
- flex: 1;
- min-width: 0;
- width: 100%;
-}
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx
index 211bc8d8c4f..17905c91e03 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx
@@ -2,7 +2,6 @@ import cx from "classnames";
import { forwardRef } from "react";
import type { MetabotPromptInputRef } from "metabase/metabot";
-import { MetabotIcon } from "metabase/metabot/components/MetabotIcon";
import {
MetabotPromptInput,
type MetabotPromptInputProps,
@@ -28,9 +27,6 @@ export const MetabotChatEditor = forwardRef<
>(({ isResponding = false, ...props }, ref) => {
return (
<Box className={S.editorContainer}>
- <Box className={S.iconContainer}>
- <MetabotIcon c="core-brand" />
- </Box>
<Box className={S.contentWrapper}>
<MetabotPromptInput
{...props}
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
index 9aa90c4553f..3eee95c1718 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
@@ -22,6 +22,8 @@ import {
} from "metabase-types/api/mocks";
import { createMockSearchResult } from "metabase-types/api/mocks/search";
+import { input } from "../../../tests/utils";
+
import { MetabotChatEditor } from "./MetabotChatEditor";
const defaultProps = {
@@ -78,9 +80,6 @@ const setup = (
);
};
-const getEditor = () =>
- // eslint-disable-next-line testing-library/no-node-access
- document.querySelector('[contenteditable="true"]') as HTMLElement;
const getPopup = () => screen.findByTestId("mini-picker");
describe("MetabotChatEditor", () => {
@@ -95,7 +94,7 @@ describe("MetabotChatEditor", () => {
const onChange = jest.fn();
setup({ onChange });
- await userEvent.type(getEditor(), "Hello world");
+ await userEvent.type(await input(), "Hello world");
expect(onChange).toHaveBeenCalledWith("Hello world");
});
@@ -104,7 +103,7 @@ describe("MetabotChatEditor", () => {
const onSubmit = jest.fn();
setup({ onSubmit });
- await userEvent.type(getEditor(), "Hello world{Enter}");
+ await userEvent.type(await input(), "Hello world{Enter}");
expect(onSubmit).toHaveBeenCalled();
});
@@ -112,7 +111,7 @@ describe("MetabotChatEditor", () => {
it("should support @mentions", async () => {
setup();
- await userEvent.type(getEditor(), "@");
+ await userEvent.type(await input(), "@");
expect(await getPopup()).toBeInTheDocument();
});
@@ -120,7 +119,7 @@ describe("MetabotChatEditor", () => {
it("should show browse all when @ is typed", async () => {
setup();
- await userEvent.type(getEditor(), "@");
+ await userEvent.type(await input(), "@");
const popup = await getPopup();
expect(popup).toBeInTheDocument();
@@ -141,7 +140,7 @@ describe("MetabotChatEditor", () => {
},
);
- await userEvent.type(getEditor(), "@sample");
+ await userEvent.type(await input(), "@sample");
await waitFor(() => {
expect(
@@ -172,7 +171,7 @@ describe("MetabotChatEditor", () => {
},
);
- await userEvent.type(getEditor(), "@test");
+ await userEvent.type(await input(), "@test");
await waitFor(() =>
expect(
@@ -207,7 +206,7 @@ describe("MetabotChatEditor", () => {
},
);
- await userEvent.type(getEditor(), "@test");
+ await userEvent.type(await input(), "@test");
await waitFor(() => {
expect(
@@ -229,7 +228,7 @@ describe("MetabotChatEditor", () => {
it("should handle paste events with metabase protocol links", async () => {
const onChange = jest.fn();
setup({ onChange });
- getEditor().focus();
+ (await input()).focus();
await userEvent.paste("[Test Model](metabase://model/123)");
@@ -244,7 +243,7 @@ describe("MetabotChatEditor", () => {
const onSubmit = jest.fn();
setup({ value: "", onChange, onSubmit });
- await userEvent.type(getEditor(), "Hello world{Enter}");
+ await userEvent.type(await input(), "Hello world{Enter}");
expect(onSubmit).toHaveBeenCalled();
expect(onChange).toHaveBeenCalledWith("Hello world");
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx
index 2222296888c..0493b981bb3 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatMessage.tsx
@@ -276,6 +276,7 @@ export const AgentMessage = ({
.with({ type: "turn_incomplete" }, (m) => (
<IncompleteTurnAlert
finishReason={m.finishReason}
+ contextWindowFull={m.contextWindowFull}
onContinue={onContinue}
/>
))
@@ -511,16 +512,23 @@ const getIncompleteTurnConfig = (
const IncompleteTurnAlert = ({
finishReason,
+ contextWindowFull,
onContinue,
}: {
finishReason: MetabotAgentTurnIncompleteMessage["finishReason"];
+ contextWindowFull?: boolean;
onContinue?: (resumePrompt: string) => void;
}) => {
const metabotName = useSetting("metabot-name");
- const { message, resumePrompt } = getIncompleteTurnConfig(
- finishReason,
- metabotName,
- );
+ // "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);
return (
<AgentTurnAlert
variant="info"
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotContextUsageRing.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotContextUsageRing.tsx
new file mode 100644
index 00000000000..4b5accd1782
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotContextUsageRing.tsx
@@ -0,0 +1,39 @@
+import { c, t } from "ttag";
+
+import { Center, RingProgress, Tooltip } from "metabase/ui";
+
+const SIZE = 17;
+const THICKNESS = 2.5;
+
+interface MetabotContextUsageRingProps {
+ percentUsage: number;
+ className?: string;
+}
+
+export const MetabotContextUsageRing = ({
+ percentUsage,
+ className,
+}: MetabotContextUsageRingProps) => {
+ const percent = Math.round(percentUsage);
+
+ return (
+ <Tooltip
+ label={c("{0} is a percentage").t`${percent}% context used`}
+ position="top-end"
+ >
+ <Center
+ className={className}
+ data-testid="metabot-context-usage-ring"
+ aria-label={t`${percent}% of the context window used`}
+ >
+ <RingProgress
+ size={SIZE}
+ thickness={THICKNESS}
+ transitionDuration={300}
+ rootColor="border-neutral-subtle"
+ sections={[{ value: percent, color: "brand" }]}
+ />
+ </Center>
+ </Tooltip>
+ );
+};
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotContextUsageRing.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotContextUsageRing.unit.spec.tsx
new file mode 100644
index 00000000000..25f4b46d40f
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotContextUsageRing.unit.spec.tsx
@@ -0,0 +1,26 @@
+import { renderWithProviders, screen } from "__support__/ui";
+
+import { MetabotContextUsageRing } from "./MetabotContextUsageRing";
+
+describe("MetabotContextUsageRing", () => {
+ it("draws the filled arc with flat caps", () => {
+ renderWithProviders(<MetabotContextUsageRing percentUsage={90} />);
+
+ const ring = screen.getByTestId("metabot-context-usage-ring");
+ const curves = ring.querySelectorAll("circle");
+
+ expect(curves.length).toBeGreaterThan(0);
+ curves.forEach((curve) => {
+ expect(curve).toHaveAttribute("stroke-linecap", "butt");
+ });
+ });
+
+ it("rounds the percentage it announces", () => {
+ renderWithProviders(<MetabotContextUsageRing percentUsage={90.4} />);
+
+ expect(screen.getByTestId("metabot-context-usage-ring")).toHaveAttribute(
+ "aria-label",
+ "90% of the context window used",
+ );
+ });
+});
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotLongChatNotice.module.css b/frontend/src/metabase/metabot/components/MetabotChat/MetabotLongChatNotice.module.css
new file mode 100644
index 00000000000..0c31cde08e8
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotLongChatNotice.module.css
@@ -0,0 +1,12 @@
+.notice {
+ padding: 0.125rem 0.5rem 0 1rem;
+ border: 1px solid var(--mb-color-border-neutral-subtle);
+ border-radius: 0.5rem;
+ background-color: var(--mb-color-background_surface-brand-subtle);
+ height: 3rem;
+}
+
+.term {
+ text-decoration: underline dotted;
+ text-underline-offset: 0.15em;
+}
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotLongChatNotice.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotLongChatNotice.tsx
new file mode 100644
index 00000000000..cb8a0d505b8
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotLongChatNotice.tsx
@@ -0,0 +1,78 @@
+import cx from "classnames";
+import { useState } from "react";
+import { c, t } from "ttag";
+
+import { ActionIcon, Button, Flex, Icon, Text, Tooltip } from "metabase/ui";
+
+import S from "./MetabotLongChatNotice.module.css";
+
+interface MetabotLongChatNoticeProps {
+ variant: "warning" | "full";
+ className?: string;
+ onNewChat: () => void;
+}
+
+const ContextLimitTerm = () => (
+ <Tooltip
+ label={t`Once a chat reaches the context limit, the chat will stop. Currently, you can't compact context to continue a chat. You'll need to start a new chat with a new prompt.`}
+ multiline
+ w={280}
+ >
+ <Text
+ component="span"
+ className={S.term}
+ data-testid="metabot-long-chat-context-limit"
+ >
+ {t`context limit`}
+ </Text>
+ </Tooltip>
+);
+
+export const MetabotLongChatNotice = ({
+ variant,
+ className,
+ onNewChat,
+}: MetabotLongChatNoticeProps) => {
+ const [dismissedWarning, setDismissedWarning] = useState(false);
+
+ if (variant === "warning" && dismissedWarning) {
+ return null;
+ }
+
+ const contextLimit = <ContextLimitTerm key="context-limit" />;
+
+ return (
+ <Flex
+ className={cx(S.notice, className)}
+ align="center"
+ gap="sm"
+ data-testid="metabot-long-chat-notice"
+ >
+ <Text lh="1rem" flex={1}>
+ {variant === "full"
+ ? c("{0} is the term “context limit”")
+ .jt`This chat has reached the ${contextLimit}.`
+ : c("{0} is the term “context limit”")
+ .jt`This chat is nearing the ${contextLimit}.`}
+ </Text>
+ <Button
+ variant="subtle"
+ size="compact-sm"
+ onClick={onNewChat}
+ fw="bold"
+ data-testid="metabot-long-chat-new-chat"
+ >{t`New chat`}</Button>
+ {variant === "warning" && (
+ <ActionIcon
+ size="sm"
+ c="text-secondary"
+ onClick={() => setDismissedWarning(true)}
+ aria-label={t`Dismiss`}
+ data-testid="metabot-long-chat-dismiss"
+ >
+ <Icon name="close" size={12} />
+ </ActionIcon>
+ )}
+ </Flex>
+ );
+};
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotResetLongChatButton.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotResetLongChatButton.tsx
deleted file mode 100644
index 2e268372351..00000000000
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotResetLongChatButton.tsx
+++ /dev/null
@@ -1,25 +0,0 @@
-import { c, jt } from "ttag";
-
-import { Text, UnstyledButton } from "metabase/ui";
-
-interface MetabotResetLongChatButtonProps {
- onResetConversation: () => void;
-}
-
-export const MetabotResetLongChatButton = ({
- onResetConversation,
-}: MetabotResetLongChatButtonProps) => (
- <Text lh={1} c="text-disabled" m={0} ta="center">
- {jt`This chat is getting long. You can ${(
- <UnstyledButton
- key="reset"
- data-testid="metabot-reset-long-chat"
- display="inline"
- c="core-brand"
- td="underline"
- onClick={onResetConversation}
- >{c("'it' refers to a chat with an AI agent")
- .t`clear it`}</UnstyledButton>
- )}.`}
- </Text>
-);
diff --git a/frontend/src/metabase/metabot/constants.ts b/frontend/src/metabase/metabot/constants.ts
index 5b2a163d194..a373cfd26ab 100644
--- a/frontend/src/metabase/metabot/constants.ts
+++ b/frontend/src/metabase/metabot/constants.ts
@@ -2,7 +2,7 @@ import { msgid, ngettext, t } from "ttag";
import { isEmbedding } from "metabase/embedding/config";
-export const LONG_CONVO_MSG_LENGTH_THRESHOLD = 120000;
+export const CONTEXT_WINDOW_WARNING_PERCENT = 90;
// NOTE: this is not ideal, but will get fixed w/ BOT-189 allowing us to use fixed entity_ids
export const FIXED_METABOT_IDS = {
diff --git a/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts b/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts
index 882d9df73ef..8413a7b88f9 100644
--- a/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts
+++ b/frontend/src/metabase/metabot/hooks/use-metabot-conversation.ts
@@ -14,11 +14,12 @@ import {
cancelInflightConversationRequests,
fetchConversationSnapshot,
getActiveToolCalls,
+ getContextUsagePercent,
getConversationForkedFrom,
getConversationTitle,
getDebugMode,
getIsConversationProcessing,
- getIsLongConversation,
+ getLongChatNotice,
getMessages,
getMetabotId,
getMetabotReactionsState,
@@ -159,6 +160,10 @@ export const useMetabotConversation = (conversationId: string) => {
dispatch(fetchConversationSnapshot(conversationId));
}, [dispatch, conversationId]);
+ const longChatNotice = useSelector((state) =>
+ getLongChatNotice(state, conversationId),
+ );
+
return {
conversationId,
prompt,
@@ -181,8 +186,10 @@ export const useMetabotConversation = (conversationId: string) => {
isDoingScience: useSelector((state) =>
getIsConversationProcessing(state, conversationId),
),
- isLongConversation: useSelector((state) =>
- getIsLongConversation(state, conversationId),
+ longChatNotice,
+ isContextWindowFull: longChatNotice === "full",
+ contextWindowPercentUsage: useSelector((state) =>
+ getContextUsagePercent(state, conversationId),
),
activeToolCalls: useSelector((state) =>
getActiveToolCalls(state, conversationId),
diff --git a/frontend/src/metabase/metabot/state/reducer-utils.ts b/frontend/src/metabase/metabot/state/reducer-utils.ts
index 8995bbd9afc..a02d16867c1 100644
--- a/frontend/src/metabase/metabot/state/reducer-utils.ts
+++ b/frontend/src/metabase/metabot/state/reducer-utils.ts
@@ -425,12 +425,14 @@ export const appendAgentTurnAborted = (
export const appendAgentTurnIncomplete = (
convo: WritableDraft<MetabotConversationState>,
finishReason: MetabotAgentTurnIncompleteMessage["finishReason"],
+ contextWindowFull?: boolean,
) => {
convo.messages.push({
id: createMessageId(),
role: "agent",
type: "turn_incomplete",
finishReason,
+ contextWindowFull,
externalId: convo.pendingMessageExternalId,
});
};
diff --git a/frontend/src/metabase/metabot/state/reducer.ts b/frontend/src/metabase/metabot/state/reducer.ts
index b8cc2997425..6dc00af0f07 100644
--- a/frontend/src/metabase/metabot/state/reducer.ts
+++ b/frontend/src/metabase/metabot/state/reducer.ts
@@ -18,6 +18,7 @@ import type {
} from "metabase-types/api";
import type { MetabotProfileId } from "../constants";
+import { isContextWindowFull } from "../utils/context-usage";
import { sendAgentRequest } from "./actions";
import {
@@ -485,6 +486,7 @@ export const metabot = createSlice({
convo.activeChainId = undefined;
convo.title = title;
convo.forkedFromConversationId = forkedFromConversationId;
+ convo.lastTokenUsage = undefined;
convo.isProcessing = hasInProgressMessage(messages);
if (convo.isProcessing) {
openChain(convo); // resuming mid-response
@@ -525,11 +527,22 @@ export const metabot = createSlice({
convo.state = { ...action.payload.state };
}
+ const metadata = action.payload?.processedResponse.messageMetadata;
+ if (metadata?.contextTokens && metadata.contextWindowTokens) {
+ convo.lastTokenUsage = {
+ contextTokens: metadata.contextTokens,
+ contextWindowTokens: metadata.contextWindowTokens,
+ };
+ }
+
const finishReason = action.payload?.processedResponse.finishReason;
const isResumableFinishReason =
finishReason && finishReason !== "stop" && finishReason !== "error";
if (isResumableFinishReason) {
- appendAgentTurnIncomplete(convo, finishReason);
+ const contextWindowFull =
+ finishReason === "length" &&
+ isContextWindowFull(convo.lastTokenUsage);
+ appendAgentTurnIncomplete(convo, finishReason, contextWindowFull);
}
convo.activeToolCalls = [];
diff --git a/frontend/src/metabase/metabot/state/selectors.ts b/frontend/src/metabase/metabot/state/selectors.ts
index e2427342916..974e768dab1 100644
--- a/frontend/src/metabase/metabot/state/selectors.ts
+++ b/frontend/src/metabase/metabot/state/selectors.ts
@@ -8,11 +8,15 @@ import * as Urls from "metabase/urls";
import type { TransformId } from "metabase-types/api";
import {
+ CONTEXT_WINDOW_WARNING_PERCENT,
FIXED_METABOT_IDS,
- LONG_CONVO_MSG_LENGTH_THRESHOLD,
METABOT_REQUEST_IDS,
type MetabotProfileId,
} from "../constants";
+import {
+ getContextWindowPercentUsage,
+ isContextWindowFull,
+} from "../utils/context-usage";
import type {
MetabotAgentId,
@@ -276,12 +280,24 @@ export const getConversationChart = createSelector(
},
);
-export const getIsLongConversation = createSelector(getMessages, (messages) => {
- const totalMessageLength = messages.reduce((sum, msg) => {
- return sum + ("message" in msg ? msg.message.length : 0);
- }, 0);
- return totalMessageLength >= LONG_CONVO_MSG_LENGTH_THRESHOLD;
-});
+export type MetabotLongChatNoticeVariant = "warning" | "full";
+
+export const getContextUsagePercent = createSelector(
+ [getConversation],
+ (convo): number => getContextWindowPercentUsage(convo.lastTokenUsage),
+);
+
+export const getLongChatNotice = createSelector(
+ [getConversation, getContextUsagePercent],
+ (convo, percentUsage): MetabotLongChatNoticeVariant | undefined => {
+ if (isContextWindowFull(convo.lastTokenUsage)) {
+ return "full";
+ }
+ return percentUsage >= CONTEXT_WINDOW_WARNING_PERCENT
+ ? "warning"
+ : undefined;
+ },
+);
export const getMetabotReqIdOverride = createSelector(
getConversation,
diff --git a/frontend/src/metabase/metabot/state/selectors.unit.spec.ts b/frontend/src/metabase/metabot/state/selectors.unit.spec.ts
index fe5df351e45..b1d5bb3a85d 100644
--- a/frontend/src/metabase/metabot/state/selectors.unit.spec.ts
+++ b/frontend/src/metabase/metabot/state/selectors.unit.spec.ts
@@ -4,15 +4,23 @@ import { setupEnterprisePlugins } from "__support__/enterprise";
import type { State } from "metabase/redux/store";
import { createMockState } from "metabase/redux/store/mocks";
+import { CONTEXT_WINDOW_WARNING_PERCENT } from "../constants";
+
import { getMetabotInitialState } from "./reducer-utils";
import {
type MetabotChatMessage,
+ type MetabotConversationState,
+ getContextUsagePercent,
getLastAgentMessageExternalId,
+ getLongChatNotice,
getUserPromptForMessageId,
} from "./index";
-function setup(messages: MetabotChatMessage[]): State {
+function setup(
+ messages: MetabotChatMessage[],
+ convoState?: Partial<Pick<MetabotConversationState, "lastTokenUsage">>,
+): State {
setupEnterprisePlugins();
const state = getMetabotInitialState();
@@ -22,8 +30,13 @@ function setup(messages: MetabotChatMessage[]): State {
["conversations", "omnibot", "messages"],
messages,
);
+ const withConvoState = Object.entries(convoState ?? {}).reduce(
+ (acc, [key, value]) =>
+ assocIn(acc, ["conversations", "omnibot", key], value),
+ withMessages,
+ );
- return createMockState({ metabot: withMessages });
+ return createMockState({ metabot: withConvoState });
}
describe("metabot selectors", () => {
@@ -88,4 +101,62 @@ describe("metabot selectors", () => {
expect(getLastAgentMessageExternalId(state, "omnibot")).toBe("ext-2");
});
});
+
+ describe("getLongChatNotice", () => {
+ const shortMessage: MetabotChatMessage = {
+ id: "1",
+ role: "user",
+ type: "text",
+ message: "hi",
+ };
+ const CONTEXT_WINDOW = 200000;
+ const usage = (contextTokens: number) => ({
+ lastTokenUsage: { contextTokens, contextWindowTokens: CONTEXT_WINDOW },
+ });
+
+ it("warns when context tokens reach the warning percent of the window", () => {
+ const state = setup(
+ [shortMessage],
+ usage((CONTEXT_WINDOW * CONTEXT_WINDOW_WARNING_PERCENT) / 100),
+ );
+ expect(getLongChatNotice(state, "omnibot")).toBe("warning");
+ });
+
+ it("still only warns just short of the window — the whole window is usable", () => {
+ const state = setup([shortMessage], usage(CONTEXT_WINDOW - 1));
+ expect(getLongChatNotice(state, "omnibot")).toBe("warning");
+ });
+
+ it("reports full once context tokens consume the whole window", () => {
+ const state = setup([shortMessage], usage(CONTEXT_WINDOW));
+ expect(getLongChatNotice(state, "omnibot")).toBe("full");
+ });
+
+ it("shows nothing below the warning percent or when no usage has been observed", () => {
+ expect(
+ getLongChatNotice(setup([shortMessage], usage(10000)), "omnibot"),
+ ).toBeUndefined();
+ expect(
+ getLongChatNotice(setup([shortMessage]), "omnibot"),
+ ).toBeUndefined();
+ });
+
+ describe("getContextUsagePercent", () => {
+ it("reports the last observed usage as a share of the window, 0-100", () => {
+ const state = setup([shortMessage], usage(CONTEXT_WINDOW / 4));
+ expect(getContextUsagePercent(state, "omnibot")).toBe(25);
+ });
+
+ it("reports 0 when no usage has been observed", () => {
+ expect(getContextUsagePercent(setup([shortMessage]), "omnibot")).toBe(
+ 0,
+ );
+ });
+
+ it("caps at 100 when the window is overrun", () => {
+ const state = setup([shortMessage], usage(CONTEXT_WINDOW * 2));
+ expect(getContextUsagePercent(state, "omnibot")).toBe(100);
+ });
+ });
+ });
});
diff --git a/frontend/src/metabase/metabot/state/types.ts b/frontend/src/metabase/metabot/state/types.ts
index 56b79bce5a1..d1a50b1b93f 100644
--- a/frontend/src/metabase/metabot/state/types.ts
+++ b/frontend/src/metabase/metabot/state/types.ts
@@ -85,6 +85,7 @@ export type MetabotAgentTurnIncompleteMessage = {
role: "agent";
type: "turn_incomplete";
finishReason: Exclude<FinishReason, "stop" | "error">;
+ contextWindowFull?: boolean;
externalId?: string;
};
@@ -164,6 +165,11 @@ export type MetabotReactionsState = {
suggestedTransforms: MetabotSuggestedTransform[];
};
+export type MetabotContextUsage = {
+ contextTokens: number;
+ contextWindowTokens: number;
+};
+
export interface MetabotConversationState {
conversationId: string;
title: string | undefined;
@@ -175,6 +181,7 @@ export interface MetabotConversationState {
stateBeforeTurn?: MetabotStateContext;
activeToolCalls: MetabotToolCall[];
activeChainId: string | undefined;
+ lastTokenUsage?: MetabotContextUsage;
profileOverride: MetabotProfileId | undefined;
pendingMessageExternalId: string | undefined;
experimental: {
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 ff141f041e3..9e9738a23e5 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
@@ -358,7 +358,7 @@ describe("AgentMessage", () => {
describe("turn_incomplete", () => {
const incompleteMessage = (
finishReason: MetabotAgentTurnIncompleteMessage["finishReason"],
- ): MetabotAgentChatMessage => ({
+ ): MetabotAgentTurnIncompleteMessage => ({
id: "msg",
role: "agent",
type: "turn_incomplete",
@@ -391,6 +391,18 @@ describe("AgentMessage", () => {
);
});
+ it("shows a terminal notice when the context window is full", () => {
+ setup(
+ { ...incompleteMessage("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(incompleteMessage("content-filter"), { onContinue: jest.fn() });
diff --git a/frontend/src/metabase/metabot/tests/reducer.unit.spec.ts b/frontend/src/metabase/metabot/tests/reducer.unit.spec.ts
index c3ebf8e2b91..bf8260d5468 100644
--- a/frontend/src/metabase/metabot/tests/reducer.unit.spec.ts
+++ b/frontend/src/metabase/metabot/tests/reducer.unit.spec.ts
@@ -728,8 +728,16 @@ describe("metabot reducer", () => {
]);
});
- it("releases the active chain id when a snapshot replaces the conversation", () => {
- const store = createTestStore();
+ it("releases the active chain id and context usage when a snapshot replaces the conversation", () => {
+ const store = createTestStore({
+ conversations: {
+ ...createTestMetabotState().conversations,
+ [conversationId]: createConversation({
+ conversationId,
+ lastTokenUsage: { contextTokens: 950, contextWindowTokens: 1000 },
+ }),
+ },
+ });
store.dispatch(metabotActions.reasoningStart({ conversationId }));
store.dispatch(
metabotActions.setConversationSnapshot({
@@ -739,6 +747,7 @@ describe("metabot reducer", () => {
);
expect(getConvo(store)?.activeChainId).toBeUndefined();
+ expect(getConvo(store)?.lastTokenUsage).toBeUndefined();
});
});
});
diff --git a/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx b/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx
index f74fd1d2537..62206373778 100644
--- a/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx
@@ -9,7 +9,7 @@ import {
setupGetMetabotConversationEndpointError,
} from "__support__/server-mocks";
import { act, fireEvent, screen, waitFor, within } from "__support__/ui";
-import { LONG_CONVO_MSG_LENGTH_THRESHOLD } from "metabase/metabot/constants";
+import type { SSEEvent } from "metabase/api/ai-streaming/sse-types";
import { useMetabotAgent } from "metabase/metabot/hooks";
import { metabotActions } from "metabase/metabot/state";
import { getMetabotInitialState } from "metabase/metabot/state/reducer-utils";
@@ -300,46 +300,97 @@ describe("metabot > ui", () => {
expect(secondParagraph).toBeInTheDocument();
});
- it("should warn the chat is getting long w/ ability to clear it", async () => {
- const { store } = setup();
- const longMsg = "x".repeat(LONG_CONVO_MSG_LENGTH_THRESHOLD / 2);
-
- act(() => {
- store.dispatch(
- metabotActions.addUserMessage({
- id: "1",
- type: "text",
- message: longMsg,
- conversationId: testConversationId("omnibot"),
- }),
- );
- });
- expect(await screen.findByText(/xxxxxxx/)).toBeInTheDocument();
+ const CONTEXT_WINDOW = 11000;
+
+ const contextUsageResponse = (contextTokens: number): SSEEvent[] => [
+ { type: "text-start", id: "t1" },
+ { type: "text-delta", id: "t1", delta: "answer" },
+ { type: "text-end", id: "t1" },
+ {
+ type: "finish",
+ finishReason: "stop",
+ messageMetadata: {
+ usage: {
+ inputTokens: contextTokens,
+ outputTokens: 50,
+ totalTokens: contextTokens + 50,
+ },
+ contextTokens,
+ contextWindowTokens: CONTEXT_WINDOW,
+ },
+ },
+ ];
+
+ const chatUsingContext = async (contextTokens: number) => {
+ setup();
+ mockAgentEndpoint({ events: contextUsageResponse(contextTokens) });
+ // nothing to report before a turn completes
expect(
- screen.queryByText(/This chat is getting long/),
+ screen.queryByTestId("metabot-context-usage-ring"),
).not.toBeInTheDocument();
- act(() => {
- store.dispatch(
- metabotActions.addUserMessage({
- id: "2",
- type: "text",
- message: longMsg,
- conversationId: testConversationId("omnibot"),
- }),
- );
+ await enterChatMessage("hello there");
+ expect(await screen.findByText("answer")).toBeInTheDocument();
+
+ return screen.findByTestId("metabot-long-chat-notice");
+ };
+
+ it("should warn as the chat nears the context limit", async () => {
+ const notice = await chatUsingContext(CONTEXT_WINDOW * 0.95);
+
+ expect(
+ within(notice).getByText(/This chat is nearing the/),
+ ).toBeInTheDocument();
+ expect(screen.getByTestId("metabot-chat-input")).toBeInTheDocument();
+ expect(screen.getByTestId("metabot-context-usage-ring")).toHaveAttribute(
+ "aria-label",
+ "95% of the context window used",
+ );
+
+ await userEvent.hover(
+ within(notice).getByTestId("metabot-long-chat-context-limit"),
+ );
+ expect(
+ await screen.findByText(/Once a chat reaches the context limit/),
+ ).toBeInTheDocument();
+
+ // dismissing the warning keeps the conversation
+ await userEvent.click(
+ within(notice).getByTestId("metabot-long-chat-dismiss"),
+ );
+ await waitFor(() => {
+ expect(
+ screen.queryByTestId("metabot-long-chat-notice"),
+ ).not.toBeInTheDocument();
});
+ expect(screen.getByText("answer")).toBeInTheDocument();
+ });
+
+ it("should prompt for a new chat once the context limit is met", async () => {
+ const notice = await chatUsingContext(CONTEXT_WINDOW);
+
+ expect(
+ within(notice).getByText(/This chat has reached the/),
+ ).toBeInTheDocument();
expect(
- await screen.findByText(/This chat is getting long/),
+ within(notice).queryByTestId("metabot-long-chat-dismiss"),
+ ).not.toBeInTheDocument();
+ expect(screen.getByTestId("metabot-chat-input")).toBeInTheDocument();
+ expect(
+ screen.getByTestId("metabot-context-usage-ring"),
).toBeInTheDocument();
- await userEvent.click(await screen.findByTestId("metabot-reset-long-chat"));
+
+ await userEvent.click(
+ within(notice).getByTestId("metabot-long-chat-new-chat"),
+ );
await waitFor(() => {
expect(
- screen.queryByText(/This chat is getting long/),
+ screen.queryByTestId("metabot-long-chat-notice"),
).not.toBeInTheDocument();
});
- expect(screen.queryByText(/xxxxxxx/)).not.toBeInTheDocument();
+ expect(screen.queryByText("answer")).not.toBeInTheDocument();
+ expect(screen.getByTestId("metabot-chat-input")).toBeInTheDocument();
});
it("should be able to set the prompt input's value from anywhere in the app", async () => {
diff --git a/frontend/src/metabase/metabot/tests/utils.tsx b/frontend/src/metabase/metabot/tests/utils.tsx
index 296b1dd448d..ac44f9178e1 100644
--- a/frontend/src/metabase/metabot/tests/utils.tsx
+++ b/frontend/src/metabase/metabot/tests/utils.tsx
@@ -154,7 +154,7 @@ export const lastChatMessage = async (options?: {
}) => (await chatMessages(options)).at(-1);
export const input = async () => {
const chatInput = await screen.findByTestId("metabot-chat-input");
- return chatInput.querySelector('[contenteditable="true"]')!;
+ return chatInput.querySelector<HTMLElement>("[contenteditable]")!;
};
export const enterChatMessage = async (message: string, send = true) => {
// using userEvent.type works locally but in CI characters are sometimes dropped
diff --git a/frontend/src/metabase/metabot/utils/context-usage.ts b/frontend/src/metabase/metabot/utils/context-usage.ts
new file mode 100644
index 00000000000..9266e956de3
--- /dev/null
+++ b/frontend/src/metabase/metabot/utils/context-usage.ts
@@ -0,0 +1,26 @@
+import type { MetabotContextUsage } from "../state/types";
+
+export const isValidContextUsage = (
+ contextUsage: MetabotContextUsage | undefined,
+): contextUsage is MetabotContextUsage =>
+ contextUsage != null &&
+ Number.isFinite(contextUsage.contextTokens) &&
+ Number.isFinite(contextUsage.contextWindowTokens) &&
+ contextUsage.contextTokens > 0 &&
+ contextUsage.contextWindowTokens > 0;
+
+export const getContextWindowPercentUsage = (
+ contextUsage: MetabotContextUsage | undefined,
+): number =>
+ isValidContextUsage(contextUsage)
+ ? Math.min(
+ 100,
+ (contextUsage.contextTokens / contextUsage.contextWindowTokens) * 100,
+ )
+ : 0;
+
+export const isContextWindowFull = (
+ contextUsage: MetabotContextUsage | undefined,
+): boolean =>
+ isValidContextUsage(contextUsage) &&
+ contextUsage.contextTokens >= contextUsage.contextWindowTokens;
diff --git a/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.config.tsx b/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.config.tsx
new file mode 100644
index 00000000000..280a835b579
--- /dev/null
+++ b/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.config.tsx
@@ -0,0 +1,10 @@
+import { type MantineThemeOverride, RingProgress } from "@mantine/core";
+
+export const ringProgressOverrides: MantineThemeOverride["components"] = {
+ RingProgress: RingProgress.extend({
+ defaultProps: {
+ // Mantine's default track is `gray-2`, which is outside Metabase's palette
+ rootColor: "border-neutral",
+ },
+ }),
+};
diff --git a/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.mdx b/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.mdx
new file mode 100644
index 00000000000..77d2d79af3f
--- /dev/null
+++ b/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.mdx
@@ -0,0 +1,31 @@
+import { Canvas, Meta } from "@storybook/blocks";
+import { RingProgress } from "./";
+import * as RingProgressStories from "./RingProgress.stories";
+
+<Meta of={RingProgressStories} />
+
+# RingProgress
+
+Our themed wrapper around [Mantine RingProgress](https://mantine.dev/core/ring-progress/).
+
+Set `roundCaps` to round the ends of the filled arc; it is flat by default.
+
+## Docs
+
+- [Mantine RingProgress Docs](https://mantine.dev/core/ring-progress/)
+
+## Examples
+
+<Canvas of={RingProgressStories.Default} />
+
+### With a label
+
+<Canvas of={RingProgressStories.WithLabel} />
+
+### Small
+
+<Canvas of={RingProgressStories.Small} />
+
+### Multiple sections
+
+<Canvas of={RingProgressStories.MultipleSections} />
diff --git a/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.stories.tsx b/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.stories.tsx
new file mode 100644
index 00000000000..f6d00ff083e
--- /dev/null
+++ b/frontend/src/metabase/ui/components/feedback/RingProgress/RingProgress.stories.tsx
@@ -0,0 +1,51 @@
+import { RingProgress } from "./";
+
+const args = {
+ size: 120,
+ thickness: 12,
+ roundCaps: false,
+};
+
+const argTypes = {
+ size: { control: { type: "number" } },
+ thickness: { control: { type: "number" } },
+ roundCaps: { control: { type: "boolean" } },
+};
+
+export default {
+ title: "Components/Feedback/RingProgress",
+ component: RingProgress,
+ args,
+ argTypes,
+};
+
+export const Default = {
+ args: {
+ sections: [{ value: 40, color: "brand" }],
+ },
+};
+
+export const WithLabel = {
+ args: {
+ sections: [{ value: 72, color: "brand" }],
+ label: "72%",
+ },
+};
+
+export const Small = {
+ args: {
+ size: 14,
+ thickness: 2.5,
+ sections: [{ value: 90, color: "brand" }],
+ },
+};
+
+export const MultipleSections = {
+ args: {
+ sections: [
+ { value: 40, color: "brand" },
+ { value: 20, color: "warning" },
+ { value: 15, color: "danger" },
+ ],
+ },
+};
diff --git a/frontend/src/metabase/ui/components/feedback/RingProgress/index.ts b/frontend/src/metabase/ui/components/feedback/RingProgress/index.ts
new file mode 100644
index 00000000000..447b194c860
--- /dev/null
+++ b/frontend/src/metabase/ui/components/feedback/RingProgress/index.ts
@@ -0,0 +1,3 @@
+export { RingProgress } from "@mantine/core";
+export type { RingProgressProps } from "@mantine/core";
+export * from "./RingProgress.config";
diff --git a/frontend/src/metabase/ui/components/feedback/index.ts b/frontend/src/metabase/ui/components/feedback/index.ts
index 9786bab6761..c0035c3e0c8 100644
--- a/frontend/src/metabase/ui/components/feedback/index.ts
+++ b/frontend/src/metabase/ui/components/feedback/index.ts
@@ -1,4 +1,5 @@
export * from "./Loader";
export * from "./Alert";
export * from "./Progress";
+export * from "./RingProgress";
export * from "./Skeleton";
diff --git a/frontend/src/metabase/ui/theme.ts b/frontend/src/metabase/ui/theme.ts
index d7f617e2c0c..221d0ea7f58 100644
--- a/frontend/src/metabase/ui/theme.ts
+++ b/frontend/src/metabase/ui/theme.ts
@@ -45,6 +45,7 @@ import {
portalOverrides,
progressOverrides,
radioOverrides,
+ ringProgressOverrides,
scrollAreaOverrides,
segmentedControlOverrides,
selectOverrides,
@@ -188,6 +189,7 @@ export const getThemeOverrides = (
...popoverOverrides,
...portalOverrides,
...progressOverrides,
+ ...ringProgressOverrides,
...scrollAreaOverrides,
...segmentedControlOverrides,
...skeletonOverrides,
diff --git a/src/metabase/metabot/api.clj b/src/metabase/metabot/api.clj
index 7b3bed55980..7b3cefe62b9 100644
--- a/src/metabase/metabot/api.clj
+++ b/src/metabase/metabot/api.clj
@@ -24,7 +24,9 @@
[metabase.metabot.envelope :as metabot.envelope]
[metabase.metabot.feedback :as metabot.feedback]
[metabase.metabot.persistence :as metabot.persistence]
+ [metabase.metabot.self :as metabot.self]
[metabase.metabot.self.core :as self.core]
+ [metabase.metabot.settings :as metabot.settings]
[metabase.metabot.usage :as metabot.usage]
[metabase.models.interface :as mi]
[metabase.request.core :as request]
@@ -213,7 +215,10 @@
thrown (volatile! nil)
xf (comp (u/tee-xf parts-atom)
(self.core/parts->aisdk-sse-xf
- (cond-> {:message-id external-id}
+ (cond-> {:message-id external-id
+ :context-window-tokens
+ (metabot.self/context-window-tokens
+ (metabot.settings/llm-metabot-provider))}
user-external-id (assoc :message-metadata {:userMessageId user-external-id})))
(inject-title-events-xf title-job conversation-id))]
(try
diff --git a/src/metabase/metabot/self.clj b/src/metabase/metabot/self.clj
index c0d35685e65..126ac15220b 100644
--- a/src/metabase/metabot/self.clj
+++ b/src/metabase/metabot/self.clj
@@ -85,6 +85,35 @@
:credentials credentials
:ai-proxy? ai-proxy?}))
+(defn- resolve-context-window-fn [provider]
+ ;; a `case` inside of function instead of a map so that with-redefs work well
+ (case provider
+ "anthropic" claude/context-window-tokens
+ "azure" azure/context-window-tokens
+ "bedrock" bedrock/context-window-tokens
+ "google" google/context-window-tokens
+ "mistral" mistral/context-window-tokens
+ "moonshot" moonshot/context-window-tokens
+ "openai" openai/context-window-tokens
+ "openrouter" openrouter/context-window-tokens
+ "zai" zai/context-window-tokens
+ nil))
+
+(defn context-window-tokens
+ "Input context window (tokens) for a `connection-key/model` string, or nil when the
+ connection, provider, or model isn't one we know.
+
+ This is the ceiling a conversation's context (`contextTokens`, the last call's
+ prompt + completion) cannot grow past: the max *input* tokens for providers that
+ publish split input/output limits (OpenAI's 1,050,000 window is 922,000 input +
+ 128,000 output), and the shared context window for providers whose output counts
+ against the window itself (Anthropic et al.)."
+ [model-ref]
+ (let [{:keys [type model]} (llm.provider/resolve-model-ref model-ref)
+ window-fn (resolve-context-window-fn type)]
+ (when (and window-fn model)
+ (window-fn model))))
+
(defn list-models
"List available models for a provider using its configured credentials, or `:credentials` in `opts`.
The shape of the credentials map varies by provider: API-key providers take `{:api-key ...}`, while Bedrock takes
diff --git a/src/metabase/metabot/self/azure.clj b/src/metabase/metabot/self/azure.clj
index 5c98b5db51d..38899120cf9 100644
--- a/src/metabase/metabot/self/azure.clj
+++ b/src/metabase/metabot/self/azure.clj
@@ -22,6 +22,7 @@
[metabase.metabot.self.debug :as debug]
[metabase.metabot.self.openai :as openai]
[metabase.metabot.settings :as metabot.settings]
+ [metabase.util :as u]
[metabase.util.i18n :refer [tru]]
[metabase.util.json :as json]
[metabase.util.malli :as mu]
@@ -52,6 +53,45 @@
[model]
(second (str/split (str model) #"/" 2)))
+(def ^:private model-context-windows
+ "Input context windows for the models Azure sells, keyed by model id.
+ GPT values are max input tokens (Microsoft's listed windows are input + output totals):
+ https://learn.microsoft.com/en-us/azure/foundry/foundry-models/concepts/models-sold-directly-by-azure"
+ {"claude-fable-5" 1000000
+ "claude-opus-5" 1000000
+ "claude-opus-4-8" 1000000
+ "claude-opus-4-7" 1000000
+ "claude-opus-4-6" 1000000
+ "claude-opus-4-5" 200000
+ "claude-opus-4-1" 200000
+ "claude-sonnet-5" 1000000
+ "claude-sonnet-4-6" 1000000
+ "claude-sonnet-4-5" 200000
+ "claude-haiku-4-5" 200000
+ "gpt-5.6-sol" 922000
+ "gpt-5.6-terra" 922000
+ "gpt-5.6-luna" 922000
+ "gpt-5.6" 922000
+ "gpt-5.5-pro" 922000
+ "gpt-5.5" 922000
+ "gpt-5.4-pro" 922000
+ "gpt-5.4-mini" 272000
+ "gpt-5.4-nano" 272000
+ "gpt-5.4" 922000})
+
+(defn context-window-tokens
+ "The input context window for a `{family}/{deployment}` model string. Deployment names
+ default to the model id at deploy time, so the longest model id prefixing the deployment
+ name decides (tolerating date/custom suffixes like `gpt-5.4-2026-03-05`); nil when the
+ deployment name matches no known model."
+ [model]
+ (let [deployment (u/lower-case-en (str (model->deployment model)))]
+ (some->> (keys model-context-windows)
+ (filter #(str/starts-with? deployment %))
+ seq
+ (apply max-key count)
+ model-context-windows)))
+
;;; ------------------------------------------------ HTTP plumbing ----------------------------------------------
(defn- missing-credentials-ex []
diff --git a/src/metabase/metabot/self/bedrock.clj b/src/metabase/metabot/self/bedrock.clj
index ec23eeaa4f7..f465d0512d0 100644
--- a/src/metabase/metabot/self/bedrock.clj
+++ b/src/metabase/metabot/self/bedrock.clj
@@ -172,19 +172,25 @@
(core/rethrow-api-error! "bedrock" bedrock-error-msg e))))
(def ^:private supported-models
- "Bedrock models offered in the Metabot model picker, as a map of model id -> display name.
+ "Bedrock models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the mantle `/v1/models` catalog.
- Excludes `openai.gpt-oss*`, which are not invokable through the mantle `/openai/v1` routes."
- {"anthropic.claude-fable-5" "Claude Fable 5"
- "anthropic.claude-opus-5" "Claude Opus 5"
- "anthropic.claude-opus-4-8" "Claude Opus 4.8"
- "anthropic.claude-opus-4-7" "Claude Opus 4.7"
- "anthropic.claude-sonnet-5" "Claude Sonnet 5"
- "anthropic.claude-haiku-4-5" "Claude Haiku 4.5"
- "openai.gpt-5.4" "GPT-5.4"
- "openai.gpt-5.4-2026-03-05" "GPT-5.4 (2026-03-05)"
- "openai.gpt-5.5" "GPT-5.5"
- "openai.gpt-5.5-2026-04-23" "GPT-5.5 (2026-04-23)"})
+ Excludes `openai.gpt-oss*`, which are not invokable through the mantle `/openai/v1` routes.
+ Context windows are from the per-model cards at https://docs.aws.amazon.com/bedrock/latest/userguide/model-cards.html"
+ {"anthropic.claude-fable-5" {:display-name "Claude Fable 5" :context-window 1000000}
+ "anthropic.claude-opus-5" {:display-name "Claude Opus 5" :context-window 1000000}
+ "anthropic.claude-opus-4-8" {:display-name "Claude Opus 4.8" :context-window 1000000}
+ "anthropic.claude-opus-4-7" {:display-name "Claude Opus 4.7" :context-window 1000000}
+ "anthropic.claude-sonnet-5" {:display-name "Claude Sonnet 5" :context-window 1000000}
+ "anthropic.claude-haiku-4-5" {:display-name "Claude Haiku 4.5" :context-window 200000}
+ "openai.gpt-5.4" {:display-name "GPT-5.4" :context-window 272000}
+ "openai.gpt-5.4-2026-03-05" {:display-name "GPT-5.4 (2026-03-05)" :context-window 272000}
+ "openai.gpt-5.5" {:display-name "GPT-5.5" :context-window 272000}
+ "openai.gpt-5.5-2026-04-23" {:display-name "GPT-5.5 (2026-04-23)" :context-window 272000}})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get-in supported-models [model :context-window]))
(defn- supported-model?
"Whether a `/v1/models` catalog entry is one of the [[supported-models]]."
@@ -209,7 +215,7 @@
(filter (every-pred supported-model? available-model?))
(sort-by :id)
(mapv (fn [{:keys [id]}]
- {:id id :display_name (supported-models id)})))}))
+ {:id id :display_name (get-in supported-models [id :display-name])})))}))
;;; --------------------------------------------- API family dispatch -------------------------------------------
diff --git a/src/metabase/metabot/self/claude.clj b/src/metabase/metabot/self/claude.clj
index fa73f58a9a5..2c8c4c1a21a 100644
--- a/src/metabase/metabot/self/claude.clj
+++ b/src/metabase/metabot/self/claude.clj
@@ -339,17 +339,17 @@
(def ^:private supported-models
"Anthropic chat models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the account's `/v1/models` catalog."
- {"claude-fable-5" {:display-name "Claude Fable 5" :max-tokens 128000}
- "claude-opus-5" {:display-name "Claude Opus 5" :max-tokens 128000}
- "claude-opus-4-8" {:display-name "Claude Opus 4.8" :max-tokens 128000}
- "claude-opus-4-7" {:display-name "Claude Opus 4.7" :max-tokens 128000}
- "claude-opus-4-6" {:display-name "Claude Opus 4.6" :max-tokens 128000}
- "claude-opus-4-5-20251101" {:display-name "Claude Opus 4.5" :max-tokens 64000}
- "claude-opus-4-1-20250805" {:display-name "Claude Opus 4.1" :max-tokens 32000}
- "claude-sonnet-5" {:display-name "Claude Sonnet 5" :max-tokens 128000}
- "claude-sonnet-4-6" {:display-name "Claude Sonnet 4.6" :max-tokens 128000}
- "claude-sonnet-4-5-20250929" {:display-name "Claude Sonnet 4.5" :max-tokens 64000}
- "claude-haiku-4-5-20251001" {:display-name "Claude Haiku 4.5" :max-tokens 64000}})
+ {"claude-fable-5" {:display-name "Claude Fable 5" :max-tokens 128000 :context-window 1000000}
+ "claude-opus-5" {:display-name "Claude Opus 5" :max-tokens 128000 :context-window 1000000}
+ "claude-opus-4-8" {:display-name "Claude Opus 4.8" :max-tokens 128000 :context-window 1000000}
+ "claude-opus-4-7" {:display-name "Claude Opus 4.7" :max-tokens 128000 :context-window 1000000}
+ "claude-opus-4-6" {:display-name "Claude Opus 4.6" :max-tokens 128000 :context-window 1000000}
+ "claude-opus-4-5-20251101" {:display-name "Claude Opus 4.5" :max-tokens 64000 :context-window 200000}
+ "claude-opus-4-1-20250805" {:display-name "Claude Opus 4.1" :max-tokens 32000 :context-window 200000}
+ "claude-sonnet-5" {:display-name "Claude Sonnet 5" :max-tokens 128000 :context-window 1000000}
+ "claude-sonnet-4-6" {:display-name "Claude Sonnet 4.6" :max-tokens 128000 :context-window 1000000}
+ "claude-sonnet-4-5-20250929" {:display-name "Claude Sonnet 4.5" :max-tokens 64000 :context-window 200000}
+ "claude-haiku-4-5-20251001" {:display-name "Claude Haiku 4.5" :max-tokens 64000 :context-window 200000}})
(def ^:private default-max-tokens
"`max_tokens` for an unresolved model — low enough to be safe on any of them."
@@ -400,6 +400,11 @@
[model]
(get-in supported-models [(strip-vendor-prefix model) :max-tokens]))
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get-in supported-models [(strip-vendor-prefix model) :context-window]))
+
(defn- claude-model-version
"`[family major minor]` for a Claude opus/sonnet model id, or nil."
[model]
diff --git a/src/metabase/metabot/self/core.clj b/src/metabase/metabot/self/core.clj
index f2929d8dd1e..5013e1fa2aa 100644
--- a/src/metabase/metabot/self/core.clj
+++ b/src/metabase/metabot/self/core.clj
@@ -308,15 +308,23 @@
"Translate accumulated per-model usage into the `finish` event's message
metadata.
- Input: `{\"provider/model\" {:promptTokens N :completionTokens N}}`.
+ Input: `usage-by-model` is `{\"provider/model\" {:promptTokens N :completionTokens N}}`
+ cumulative over the turn; `last-call` is `{:promptTokens N :completionTokens N}` for the
+ turn's final LLM call alone.
Output: `{:usage {:inputTokens N :outputTokens N :totalTokens N
:cacheCreationTokens N :cacheReadTokens N :cachedInputTokens N}
- :usageByModel {\"provider/model\" {…}}}`
+ :usageByModel {\"provider/model\" {…}}
+ :contextWindowTokens N
+ :contextTokens N}`
+
+ `:contextTokens` is the final call's prompt + completion — how much of the window the
+ conversation now occupies, measured against the same model `:contextWindowTokens`
+ describes. Both context keys are omitted when unknown.
Returns nil if no usage was observed. The cache counts are a subset of
:inputTokens (`:cachedInputTokens` mirrors cache-read), 0 without provider caching."
- [usage-by-model]
+ [usage-by-model last-call context-window-tokens]
(when (seq usage-by-model)
(let [by-model (update-vals
usage-by-model
@@ -334,9 +342,25 @@
{:inputTokens 0 :outputTokens 0 :totalTokens 0
:cacheCreationTokens 0 :cacheReadTokens 0
:cachedInputTokens 0}
- (vals by-model))]
- {:usage totals
- :usageByModel by-model})))
+ (vals by-model))
+ {:keys [promptTokens completionTokens]} last-call]
+ (cond-> {:usage totals
+ :usageByModel by-model}
+ context-window-tokens (assoc :contextWindowTokens context-window-tokens)
+ promptTokens (assoc :contextTokens (+ promptTokens (or completionTokens 0)))))))
+
+(defn- completion-finish-reason
+ "The wire `finishReason` for a completed turn. A provider `tool-calls` stop collapses to
+ `stop`: a turn that ends on a terminal tool call is a normal completion, not an incomplete
+ one. A loop stopped at max iterations surfaces as `tool-calls` instead, so the client can
+ offer to continue."
+ [finish-reason error? loop-finish-reason]
+ (cond
+ (= finish-reason "length") "length"
+ error? "error"
+ (= finish-reason "content-filter") "content-filter"
+ (= loop-finish-reason :max-iterations) "tool-calls"
+ :else "stop"))
(defn- tool-output->wire-output
"The `tool-output-available` event's `:output` value: the LLM-facing output
@@ -363,9 +387,10 @@
non-text part (or end of stream) closes the open block first.
Options:
- :message-id - When set, force this id into the `start` event so the client
- sees the same id we persist as `metabot_message.external_id`.
- :message-metadata - When set, emitted as the `start` event's `messageMetadata`.
+ :message-id - When set, force this id into the `start` event so the client
+ sees the same id we persist as `metabot_message.external_id`.
+ :message-metadata - When set, emitted as the `start` event's `messageMetadata`.
+ :context-window-tokens - When set, echoed as `finish.messageMetadata.contextWindowTokens`.
Input types and their SSE events:
:start (1st) -> start + start-step
@@ -381,7 +406,7 @@
:finish -> (recorded — the completion arity emits the finish)
completion -> [text-end]? finish-step + finish + [DONE]"
([] (parts->aisdk-sse-xf nil))
- ([{:keys [message-id message-metadata]}]
+ ([{:keys [message-id message-metadata context-window-tokens]}]
(fn [rf]
(let [error? (volatile! false)
finish-error-code (volatile! nil)
@@ -389,6 +414,9 @@
loop-finish-reason (volatile! nil)
started? (volatile! false)
usage-by-model (volatile! {})
+ ;; usage of the latest LLM call alone — the delta between consecutive
+ ;; cumulative snapshots for that call's model
+ last-call (volatile! nil)
;; non-nil while a text block is open; holds the block id so we can
;; emit a matching text-end when the block closes
current-text-id (volatile! nil)
@@ -422,21 +450,16 @@
(fn
([] (rf))
([result]
- (let [metadata (merge (->message-metadata @usage-by-model)
- (when @finish-error-code {:errorCode @finish-error-code}))]
+ (let [metadata (merge (->message-metadata @usage-by-model @last-call context-window-tokens)
+ (when @finish-error-code {:errorCode @finish-error-code}))
+ finish (cond-> {:type "finish"
+ :finishReason (completion-finish-reason @finish-reason @error? @loop-finish-reason)}
+ (seq metadata) (assoc :messageMetadata metadata))]
(-> result
close-text-block
close-reasoning-block
(cond-> @started? (rf (format-sse-event {:type "finish-step"})))
- (rf (format-sse-event
- (cond-> {:type "finish"
- :finishReason (cond
- (= @finish-reason "length") "length"
- @error? "error"
- (= @finish-reason "content-filter") "content-filter"
- (= @loop-finish-reason :max-iterations) "tool-calls"
- :else "stop")}
- (seq metadata) (assoc :messageMetadata metadata))))
+ (rf (format-sse-event finish))
(rf done-sse-line)
(rf))))
([result part]
@@ -526,8 +549,13 @@
:usage
;; cumulative per-model snapshot; last-wins, emitted on finish
- (do
- (vswap! usage-by-model assoc (or (:model part) "unknown") (:usage part))
+ (let [model (or (:model part) "unknown")
+ usage (:usage part)
+ prev (get @usage-by-model model)]
+ (vreset! last-call
+ {:promptTokens (- (:promptTokens usage 0) (:promptTokens prev 0))
+ :completionTokens (- (:completionTokens usage 0) (:completionTokens prev 0))})
+ (vswap! usage-by-model assoc model usage)
(when-let [fr (:finish-reason part)]
(vreset! finish-reason fr))
result)
diff --git a/src/metabase/metabot/self/google.clj b/src/metabase/metabot/self/google.clj
index a10fc40f3dd..00c6507fddf 100644
--- a/src/metabase/metabot/self/google.clj
+++ b/src/metabase/metabot/self/google.clj
@@ -49,6 +49,21 @@
"The model to use when the request does not name one."
"google/gemini-3.5-flash")
+(def ^:private model-context-windows
+ "Input context windows for known Google Gemini models, keyed by publisher-qualified model id.
+ Values:
+ - https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/gemini/3-5-flash
+ - https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/gemini/3-6-flash
+ - https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/gemini/3-7-flash"
+ {"google/gemini-3.5-flash" 1048576
+ "google/gemini-3.6-flash" 1048576
+ "google/gemini-3.7-flash" 1048576})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get model-context-windows model))
+
;;; Auth / HTTP plumbing
(def ^:private cloud-platform-scope
diff --git a/src/metabase/metabot/self/mistral.clj b/src/metabase/metabot/self/mistral.clj
index 86a5efd4f3f..8c90fb6c446 100644
--- a/src/metabase/metabot/self/mistral.clj
+++ b/src/metabase/metabot/self/mistral.clj
@@ -35,9 +35,15 @@
(tru "Mistral API error (HTTP {0})" status))))
(def ^:private supported-models
- "Mistral models offered in the Metabot model picker, as a map of model id -> display name.
+ "Mistral models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the `/models` catalog."
- {"mistral-medium-3-5" "Mistral Medium 3.5"})
+ {"mistral-medium-3-5" {:display-name "Mistral Medium 3.5" :context-window 262144}})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know.
+ Catalog aliases (e.g. `mistral-medium-latest`) are not resolved."
+ [model]
+ (get-in supported-models [model :context-window]))
(defn- whitelisted-id
"The [[supported-models]] id a `/models` catalog entry resolves to, or nil when unsupported.
@@ -80,7 +86,7 @@
distinct
sort
(mapv (fn [id]
- {:id id :display_name (supported-models id)})))}))
+ {:id id :display_name (get-in supported-models [id :display-name])})))}))
(mu/defn mistral-request-body
"Build the Chat Completions request body for an LLM request.
diff --git a/src/metabase/metabot/self/moonshot.clj b/src/metabase/metabot/self/moonshot.clj
index 9e089934c4d..941f7a879ee 100644
--- a/src/metabase/metabot/self/moonshot.clj
+++ b/src/metabase/metabot/self/moonshot.clj
@@ -41,12 +41,17 @@
(tru "Moonshot API error (HTTP {0})" status))))
(def ^:private supported-models
- "Moonshot models offered in the Metabot model picker, as a map of model id -> display name.
+ "Moonshot models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the `/models` catalog.
The `kimi-k2.7-code` models the catalog also carries are coding models, not agent models, and are excluded."
- {"kimi-k2.6" "Kimi K2.6"
- "kimi-k3" "Kimi K3"})
+ {"kimi-k2.6" {:display-name "Kimi K2.6" :context-window 262144}
+ "kimi-k3" {:display-name "Kimi K3" :context-window 1048576}})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get-in supported-models [model :context-window]))
(def ^:private thinking-only-models
"Models whose catalog entry reports `supports_thinking_type: \"only\"`: thinking cannot be turned off, so sending
@@ -95,7 +100,7 @@
(filter supported-model?)
(sort-by :id)
(mapv (fn [{:keys [id]}]
- {:id id :display_name (supported-models id)})))}))
+ {:id id :display_name (get-in supported-models [id :display-name])})))}))
(mu/defn moonshot-request-body
"Build the Chat Completions request body for an LLM request.
diff --git a/src/metabase/metabot/self/openai.clj b/src/metabase/metabot/self/openai.clj
index 24de5677fbd..6f3e0e91b57 100644
--- a/src/metabase/metabot/self/openai.clj
+++ b/src/metabase/metabot/self/openai.clj
@@ -251,16 +251,21 @@
(tru "OpenAI API error (HTTP {0})" status))))
(def ^:private supported-models
- "OpenAI chat models offered in the Metabot model picker, as a map of model id -> display name.
+ "OpenAI chat models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the account's `/v1/models` catalog."
- {"gpt-5.6-sol" "GPT-5.6 Sol"
- "gpt-5.6-terra" "GPT-5.6 Terra"
- "gpt-5.6-luna" "GPT-5.6 Luna"
- "gpt-5.5" "GPT-5.5"
- "gpt-5.5-pro" "GPT-5.5 Pro"
- "gpt-5.4" "GPT-5.4"
- "gpt-5.4-pro" "GPT-5.4 Pro"
- "gpt-5.4-mini" "GPT-5.4 Mini"})
+ {"gpt-5.6-sol" {:display-name "GPT-5.6 Sol" :context-window 922000}
+ "gpt-5.6-terra" {:display-name "GPT-5.6 Terra" :context-window 922000}
+ "gpt-5.6-luna" {:display-name "GPT-5.6 Luna" :context-window 922000}
+ "gpt-5.5" {:display-name "GPT-5.5" :context-window 922000}
+ "gpt-5.5-pro" {:display-name "GPT-5.5 Pro" :context-window 922000}
+ "gpt-5.4" {:display-name "GPT-5.4" :context-window 922000}
+ "gpt-5.4-pro" {:display-name "GPT-5.4 Pro" :context-window 922000}
+ "gpt-5.4-mini" {:display-name "GPT-5.4 Mini" :context-window 272000}})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get-in supported-models [model :context-window]))
(defn- supported-model?
"Whether a `/v1/models` catalog entry is one of the [[supported-models]]."
@@ -298,7 +303,7 @@
(filter supported-model?)
(sort-by :id)
(mapv (fn [{:keys [id]}]
- {:id id :display_name (supported-models id)})))}))
+ {:id id :display_name (get-in supported-models [id :display-name])})))}))
(defn- model-supports-temperature?
"Whether `model` accepts an explicit `temperature` parameter.
diff --git a/src/metabase/metabot/self/openrouter.clj b/src/metabase/metabot/self/openrouter.clj
index 768d7cbf42e..92b8b6a0d52 100644
--- a/src/metabase/metabot/self/openrouter.clj
+++ b/src/metabase/metabot/self/openrouter.clj
@@ -42,37 +42,47 @@
(tru "OpenRouter API error (HTTP {0})" status))))
(def ^:private supported-models
- "OpenRouter models offered in the Metabot model picker, as a map of model id -> display name.
+ "OpenRouter models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the `/v1/models` catalog.
Mirrors the models whitelisted for the direct anthropic and openai providers; note that
OpenRouter model IDs use dots in version numbers (`claude-haiku-4.5`), unlike the
- Anthropic API's hyphenated IDs (`claude-haiku-4-5`)."
- {"anthropic/claude-fable-5" "Claude Fable 5"
- "anthropic/claude-opus-5" "Claude Opus 5"
- "anthropic/claude-opus-4.8" "Claude Opus 4.8"
- "anthropic/claude-opus-4.7" "Claude Opus 4.7"
- "anthropic/claude-opus-4.6" "Claude Opus 4.6"
- "anthropic/claude-opus-4.5" "Claude Opus 4.5"
- "anthropic/claude-opus-4.1" "Claude Opus 4.1"
- "anthropic/claude-sonnet-5" "Claude Sonnet 5"
- "anthropic/claude-sonnet-4.6" "Claude Sonnet 4.6"
- "anthropic/claude-sonnet-4.5" "Claude Sonnet 4.5"
- "anthropic/claude-haiku-4.5" "Claude Haiku 4.5"
- "deepseek/deepseek-v4-pro" "DeepSeek V4 Pro 0423"
- "deepseek/deepseek-v4-pro-0813" "DeepSeek V4 Pro 0813"
- "deepseek/deepseek-v4-flash-0731" "DeepSeek V4 Flash 0731"
- "mistralai/mistral-medium-3-5" "Mistral Medium 3.5"
- "moonshotai/kimi-k3" "Kimi K3"
- "openai/gpt-5.6-sol" "GPT-5.6 Sol"
- "openai/gpt-5.6-terra" "GPT-5.6 Terra"
- "openai/gpt-5.6-luna" "GPT-5.6 Luna"
- "openai/gpt-5.5" "GPT-5.5"
- "openai/gpt-5.5-pro" "GPT-5.5 Pro"
- "openai/gpt-5.4" "GPT-5.4"
- "openai/gpt-5.4-pro" "GPT-5.4 Pro"
- "openai/gpt-5.4-mini" "GPT-5.4 Mini"
- "qwen/qwen3.8-max" "Qwen3.8 Max"
- "z-ai/glm-5.2" "GLM-5.2"})
+ Anthropic API's hyphenated IDs (`claude-haiku-4-5`). Context windows are OpenRouter's
+ serving limits, which can differ from the model's direct-provider window; they come from
+ https://openrouter.ai/api/v1/models, taking the lower of `context_length` and
+ `top_provider.context_length` since a request can be routed to any backing provider.
+ OpenAI rows subtract the 128k max output from that total, recording max input like
+ the direct openai adapter."
+ {"anthropic/claude-fable-5" {:display-name "Claude Fable 5" :context-window 1000000}
+ "anthropic/claude-opus-5" {:display-name "Claude Opus 5" :context-window 1000000}
+ "anthropic/claude-opus-4.8" {:display-name "Claude Opus 4.8" :context-window 1000000}
+ "anthropic/claude-opus-4.7" {:display-name "Claude Opus 4.7" :context-window 1000000}
+ "anthropic/claude-opus-4.6" {:display-name "Claude Opus 4.6" :context-window 1000000}
+ "anthropic/claude-opus-4.5" {:display-name "Claude Opus 4.5" :context-window 200000}
+ "anthropic/claude-opus-4.1" {:display-name "Claude Opus 4.1" :context-window 200000}
+ "anthropic/claude-sonnet-5" {:display-name "Claude Sonnet 5" :context-window 1000000}
+ "anthropic/claude-sonnet-4.6" {:display-name "Claude Sonnet 4.6" :context-window 1000000}
+ "anthropic/claude-sonnet-4.5" {:display-name "Claude Sonnet 4.5" :context-window 1000000}
+ "anthropic/claude-haiku-4.5" {:display-name "Claude Haiku 4.5" :context-window 200000}
+ "deepseek/deepseek-v4-pro" {:display-name "DeepSeek V4 Pro 0423" :context-window 1048576}
+ "deepseek/deepseek-v4-pro-0813" {:display-name "DeepSeek V4 Pro 0813" :context-window 1048575}
+ "deepseek/deepseek-v4-flash-0731" {:display-name "DeepSeek V4 Flash 0731" :context-window 1048576}
+ "mistralai/mistral-medium-3-5" {:display-name "Mistral Medium 3.5" :context-window 262144}
+ "moonshotai/kimi-k3" {:display-name "Kimi K3" :context-window 1048576}
+ "openai/gpt-5.6-sol" {:display-name "GPT-5.6 Sol" :context-window 922000}
+ "openai/gpt-5.6-terra" {:display-name "GPT-5.6 Terra" :context-window 922000}
+ "openai/gpt-5.6-luna" {:display-name "GPT-5.6 Luna" :context-window 922000}
+ "openai/gpt-5.5" {:display-name "GPT-5.5" :context-window 922000}
+ "openai/gpt-5.5-pro" {:display-name "GPT-5.5 Pro" :context-window 922000}
+ "openai/gpt-5.4" {:display-name "GPT-5.4" :context-window 922000}
+ "openai/gpt-5.4-pro" {:display-name "GPT-5.4 Pro" :context-window 922000}
+ "openai/gpt-5.4-mini" {:display-name "GPT-5.4 Mini" :context-window 272000}
+ "qwen/qwen3.8-max" {:display-name "Qwen3.8 Max" :context-window 1000000}
+ "z-ai/glm-5.2" {:display-name "GLM-5.2" :context-window 1048576}})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get-in supported-models [model :context-window]))
(defn- supported-model?
"Whether a `/v1/models` catalog entry is one of the [[supported-models]]."
@@ -112,7 +122,7 @@
(filter supported-model?)
(sort-by :id)
(mapv (fn [{:keys [id] :as model}]
- {:id id :display_name (or (:name model) (supported-models id))})))}))
+ {:id id :display_name (or (:name model) (get-in supported-models [id :display-name]))})))}))
;;; Streaming response → AISDK v5 chunks
diff --git a/src/metabase/metabot/self/zai.clj b/src/metabase/metabot/self/zai.clj
index 61df9e76038..14a26971e5f 100644
--- a/src/metabase/metabot/self/zai.clj
+++ b/src/metabase/metabot/self/zai.clj
@@ -35,9 +35,14 @@
(tru "Z.AI API error (HTTP {0})" status))))
(def ^:private supported-models
- "Z.AI models offered in the Metabot model picker, as a map of model id -> display name.
+ "Z.AI models offered in the Metabot model picker, keyed by model id.
`list-models` returns the intersection of this map with the `/models` catalog."
- {"glm-5.2" "GLM-5.2"})
+ {"glm-5.2" {:display-name "GLM-5.2" :context-window 1048576}})
+
+(defn context-window-tokens
+ "The input context window for `model`, or nil when it isn't one we know."
+ [model]
+ (get-in supported-models [model :context-window]))
(defn- supported-model?
"Whether a `/models` catalog entry is one of the [[supported-models]]."
@@ -79,7 +84,7 @@
(filter supported-model?)
(sort-by :id)
(mapv (fn [{:keys [id] :as model}]
- {:id id :display_name (or (:name model) (supported-models id))})))}))
+ {:id id :display_name (or (:name model) (get-in supported-models [id :display-name]))})))}))
(mu/defn zai-request-body
"Build the Chat Completions request body for an LLM request.
diff --git a/test/metabase/metabot/api_test.clj b/test/metabase/metabot/api_test.clj
index 8d954952ab8..4afd1c48b8a 100644
--- a/test/metabase/metabot/api_test.clj
+++ b/test/metabase/metabot/api_test.clj
@@ -49,7 +49,9 @@
[{:type :start :id "msg-1"}
{:type :text :text "Hello from native agent!"}
{:type :usage :usage {:promptTokens 10 :completionTokens 5}
- :model "test-model" :id "msg-1"}]))
+ :model "test-model" :id "msg-1"
+ :finish-reason "length"}]))
+ metabot.self/context-window-tokens (constantly 1000)
conversation-title/ensure-title! (constantly {:status :ready
:title "Orders by Month"})]
(testing "Native agent streaming request"
@@ -76,9 +78,12 @@
(let [text-deltas (filter #(= "text-delta" (:type %)) events)]
(is (= "Hello from native agent!"
(apply str (map :delta text-deltas)))))
- (is (=? {:messageMetadata {:usage {:inputTokens 10 :outputTokens 5 :totalTokens 15}}}
+ (is (=? {:finishReason "length"
+ :messageMetadata {:usage {:inputTokens 10 :outputTokens 5 :totalTokens 15}
+ :contextTokens 15
+ :contextWindowTokens 1000}}
(u/seek #(= "finish" (:type %)) events))
- "finish event carries accumulated usage"))
+ "finish event carries accumulated and final-call context usage"))
(is (=? {:user_id (mt/user->id :rasta)}
conv))
;; Native agent stores parts in the v2 at-rest format
@@ -122,7 +127,7 @@
lookups (atom 0)
lines (mapv #(self.core/format-sse-event {:type "text-delta" :id "txt-1" :delta %})
["a" "b" "c" "d"])]
- (with-redefs [metabot.persistence/conversation-title (fn [_] (swap! lookups inc) nil)]
+ (mt/with-dynamic-fn-redefs [metabot.persistence/conversation-title (fn [_] (swap! lookups inc) nil)]
(is (= lines
(into [] (#'api/inject-title-events-xf
{:status :pending :future title-future}
diff --git a/test/metabase/metabot/self/google_test.clj b/test/metabase/metabot/self/google_test.clj
index 03deb1eb505..7cd4643c5f9 100644
--- a/test/metabase/metabot/self/google_test.clj
+++ b/test/metabase/metabot/self/google_test.clj
@@ -65,6 +65,14 @@
(defn- google [opts]
(google/google (with-settings-credentials opts)))
+(deftest context-window-tokens-test
+ (testing "returns documented context windows for known Google models"
+ (are [model window] (= window (google/context-window-tokens model))
+ "google/gemini-3.5-flash" 1048576
+ "google/gemini-3.6-flash" 1048576
+ "google/gemini-3.7-flash" 1048576
+ "google/gemini-unknown" nil)))
+
;;; ──────────────────────────────────────────────────────────────────
;;; Auth / HTTP tests
;;; ──────────────────────────────────────────────────────────────────
diff --git a/test/metabase/metabot/self_test.clj b/test/metabase/metabot/self_test.clj
index 172ba28275d..bd021e6a546 100644
--- a/test/metabase/metabot/self_test.clj
+++ b/test/metabase/metabot/self_test.clj
@@ -730,7 +730,15 @@
(testing "a length finish outranks a max-iterations stop"
(is (=? {:type "finish" :finishReason "length"}
(last (sse-events [(usage-part "length" "max_tokens")
- {:type :finish :finish-reason :max-iterations}])))))))
+ {:type :finish :finish-reason :max-iterations}])))))
+ (testing "a turn ending on a terminal tool call is a normal stop, not an incomplete turn"
+ (is (=? {:type "finish" :finishReason "stop"}
+ (last (sse-events [(usage-part "tool-calls" "tool_use")])))))
+ (testing "an in-turn error outranks every non-length provider finish reason"
+ (doseq [finish-reason (disj self.core/finish-reasons "length" "error")]
+ (is (=? {:type "finish" :finishReason "error"}
+ (last (sse-events [error-part
+ (usage-part finish-reason nil)]))))))))
(deftest parts->aisdk-sse-xf-lifecycle-test
(testing "first :start opens the message and a step; later :start is a step boundary; completion closes"
@@ -912,10 +920,10 @@
(testing "accumulated usage lands on finish.messageMetadata, last snapshot per model"
(let [parts [{:type :start :id "m"}
{:type :usage :model "claude-sonnet-4-6" :usage {:promptTokens 5 :completionTokens 1}}
- {:type :usage :model "claude-sonnet-4-6" :usage {:promptTokens 10 :completionTokens 5}}
{:type :usage :model "gpt-5" :usage {:promptTokens 2 :completionTokens 3}}
+ {:type :usage :model "claude-sonnet-4-6" :usage {:promptTokens 10 :completionTokens 5}}
{:type :finish}]
- finish (last (sse-events parts))]
+ finish (last (sse-events {:context-window-tokens 1000000} parts))]
(is (= {:type "finish"
:finishReason "stop"
:messageMetadata {:usage {:inputTokens 12 :outputTokens 8 :totalTokens 20
@@ -923,8 +931,18 @@
:usageByModel {:claude-sonnet-4-6 {:inputTokens 10 :outputTokens 5 :totalTokens 15
:cacheCreationTokens 0 :cacheReadTokens 0 :cachedInputTokens 0}
:gpt-5 {:inputTokens 2 :outputTokens 3 :totalTokens 5
- :cacheCreationTokens 0 :cacheReadTokens 0 :cachedInputTokens 0}}}}
+ :cacheCreationTokens 0 :cacheReadTokens 0 :cachedInputTokens 0}}
+ :contextWindowTokens 1000000
+ ;; the turn's last call alone: (10-5) prompt + (5-1) completion
+ :contextTokens 9}}
finish))))
+ (testing "contextTokens follows the turn's last call, not its biggest"
+ (let [parts [{:type :start :id "m"}
+ {:type :usage :model "gpt-5" :usage {:promptTokens 900 :completionTokens 100}}
+ {:type :usage :model "claude-sonnet-4-6" :usage {:promptTokens 7 :completionTokens 3}}
+ {:type :finish}]
+ finish (last (sse-events {:context-window-tokens 1000000} parts))]
+ (is (= 10 (get-in finish [:messageMetadata :contextTokens])))))
(testing "finish omits messageMetadata when no usage was observed"
(is (not (contains? (last (sse-events [{:type :text :id "t" :text "x"}]))
:messageMetadata)))))
@@ -932,12 +950,12 @@
(deftest parts->aisdk-sse-xf-usage-cache-test
(testing "Anthropic cache breakdown flows onto finish.messageMetadata; non-cache models contribute 0"
(let [parts [{:type :start :id "m"}
+ {:type :usage :model "gpt-5" :usage {:promptTokens 2 :completionTokens 3}}
{:type :usage :model "claude-sonnet-4-6"
:usage {:promptTokens 1540 :completionTokens 10
:cacheCreationTokens 300 :cacheReadTokens 1200}}
- {:type :usage :model "gpt-5" :usage {:promptTokens 2 :completionTokens 3}}
{:type :finish}]
- finish (last (sse-events parts))]
+ finish (last (sse-events {:context-window-tokens 1000000} parts))]
(is (= {:type "finish"
:finishReason "stop"
:messageMetadata
@@ -947,9 +965,22 @@
:usageByModel {:claude-sonnet-4-6 {:inputTokens 1540 :outputTokens 10 :totalTokens 1550
:cacheCreationTokens 300 :cacheReadTokens 1200 :cachedInputTokens 1200}
:gpt-5 {:inputTokens 2 :outputTokens 3 :totalTokens 5
- :cacheCreationTokens 0 :cacheReadTokens 0 :cachedInputTokens 0}}}}
+ :cacheCreationTokens 0 :cacheReadTokens 0 :cachedInputTokens 0}}
+ :contextWindowTokens 1000000
+ :contextTokens 1550}}
finish)))))
+(deftest context-window-tokens-test
+ (llm.tu/with-default-connections
+ (are [model window] (= window (self/context-window-tokens model))
+ "anthropic/claude-sonnet-4-6" 1000000 ; adapter table hit
+ "metabase/anthropic/claude-sonnet-4-6" 1000000 ; proxy prefix is stripped
+ "azure/openai/gpt-5.4-mini-prod" 272000 ; longest model-id prefix wins
+ "google/google/gemini-3.6-flash" 1048576 ; publisher-qualified model reaches Google adapter
+ "azure/openai/my-deployment" nil ; unmatched deployment
+ "anthropic/some-future-model" nil ; unknown model
+ "unknown" nil))) ; no such connection
+
;;; ===================== Retry Logic Tests =====================
(deftest retryable-error-test