The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
BOT-1723 Support OpenAI models (#76499)
appleby9160419f64cb
diff --git a/frontend/src/metabase/admin/ai/AIProviderSettingsSection.unit.spec.tsx b/frontend/src/metabase/admin/ai/AIProviderSettingsSection.unit.spec.tsxindex 9e66c68c3ee..babbe098ab7 100644--- a/frontend/src/metabase/admin/ai/AIProviderSettingsSection.unit.spec.tsx+++ b/frontend/src/metabase/admin/ai/AIProviderSettingsSection.unit.spec.tsx@@ -89,10 +89,10 @@ const DEFAULT_RESPONSES: Record<MetabotProvider, MetabotSettingsResponse> = {],},openai: {- value: "openai/gpt-4.1-mini",+ value: "openai/gpt-5.4",models: [- { id: "gpt-4.1-mini", display_name: "GPT-4.1 mini" },- { id: "gpt-4.1", display_name: "GPT-4.1" },+ { id: "gpt-5.4", display_name: "gpt-5.4" },+ { id: "gpt-5.4-mini", display_name: "gpt-5.4-mini" },],},openrouter: {@@ -575,7 +575,7 @@ describe("AIProviderSettingsSection", () => {expect(anthropicOption).not.toHaveAttribute("aria-disabled", "true");});- it("shows Coming soon for non-Anthropic providers and disables them", async () => {+ it("shows OpenAI as selectable in the provider dropdown", async () => {await setup({ savedProviderValue: null, isConfigured: false });await userEvent.click(screen.getByLabelText("Provider"));@@ -583,14 +583,21 @@ describe("AIProviderSettingsSection", () => {const openaiOption = await screen.findByRole("option", {name: /OpenAI/,});- expect(openaiOption).toHaveAttribute("data-combobox-disabled");+ expect(openaiOption).toBeInTheDocument();+ expect(openaiOption).not.toHaveAttribute("data-combobox-disabled");+ });++ it("shows Coming soon for unsupported providers and disables them", async () => {+ await setup({ savedProviderValue: null, isConfigured: false });++ await userEvent.click(screen.getByLabelText("Provider"));const openrouterOption = await screen.findByRole("option", {name: /OpenRouter/,});expect(openrouterOption).toHaveAttribute("data-combobox-disabled");- expect(screen.getAllByText("Coming soon")).toHaveLength(2);+ expect(screen.getAllByText("Coming soon")).toHaveLength(1);});it("BOT-1429: keeps the form interactive while session-properties refetches in the background", async () => {@@ -1523,6 +1530,89 @@ describe("AIProviderSettingsSection", () => {).not.toBeInTheDocument();});+ it("connects to OpenAI by saving the API key and selecting a model", async () => {+ await setup({+ savedProviderValue: null,+ isConfigured: false,+ apiKeyValues: { openai: null },+ updateResponse: {+ value: "openai/gpt-5.4",+ models: DEFAULT_RESPONSES.openai.models,+ },+ });++ await selectProvider("OpenAI");+ await userEvent.type(screen.getByLabelText("API key"), "sk-openai-test");+ await userEvent.click(screen.getByRole("button", { name: "Connect" }));++ await waitFor(() => {+ expect(+ fetchMock.callHistory.calls("path:/api/metabot/settings", {+ method: "PUT",+ }),+ ).toHaveLength(1);+ });++ const connectRequest = fetchMock.callHistory+ .calls("path:/api/metabot/settings", { method: "PUT" })+ .at(-1);+ expect(connectRequest?.options?.body).toBe(+ JSON.stringify({ provider: "openai", "api-key": "sk-openai-test" }),+ );++ await screen.findByLabelText("Model");+ await openModelSelector();+ await userEvent.click(await screen.findByText("gpt-5.4"));++ await waitFor(() => {+ expect(+ fetchMock.callHistory.calls("path:/api/metabot/settings", {+ method: "PUT",+ }),+ ).toHaveLength(2);+ });++ const modelRequest = fetchMock.callHistory+ .calls("path:/api/metabot/settings", { method: "PUT" })+ .at(-1);+ expect(modelRequest?.options?.body).toBe(+ JSON.stringify({ provider: "openai", model: "gpt-5.4" }),+ );++ expect(+ screen.queryByRole("button", { name: "Connect" }),+ ).not.toBeInTheDocument();+ });++ it("disconnects OpenAI by clearing both the provider and API key settings", async () => {+ await setup({+ savedProviderValue: "openai/gpt-5.4",+ isConfigured: true,+ apiKeyValues: { openai: "**********ey" },+ });++ await screen.findByText("Connected to OpenAI");+ await screen.findByLabelText("API key");+ await confirmDisconnectProvider();++ await waitFor(() => {+ expect(+ fetchMock.callHistory.called("path:/api/setting", {+ method: "PUT",+ body: {+ "llm-metabot-provider": null,+ "llm-openai-api-key": null,+ },+ }),+ ).toBe(true);+ });++ expect(+ await screen.findByText("Connect to an AI provider"),+ ).toBeInTheDocument();+ expect(screen.getByLabelText("Provider")).toHaveValue("");+ });+it("disconnects an API-key provider by clearing both the provider and API key settings", async () => {await setup();diff --git a/frontend/src/metabase/metabot/components/AIProviderConfigurationForm/utils.ts b/frontend/src/metabase/metabot/components/AIProviderConfigurationForm/utils.tsindex d8a007090f2..7b6cd0aee7e 100644--- a/frontend/src/metabase/metabot/components/AIProviderConfigurationForm/utils.ts+++ b/frontend/src/metabase/metabot/components/AIProviderConfigurationForm/utils.ts@@ -96,7 +96,8 @@ export function isAvailableProvider(provider: MetabotProvider): boolean {provider === "anthropic" ||provider === "azure" ||provider === "bedrock" ||- provider === "metabase"+ provider === "metabase" ||+ provider === "openai");}diff --git a/src/metabase/llm/settings.clj b/src/metabase/llm/settings.cljindex 44546d645b5..067fcc0390d 100644--- a/src/metabase/llm/settings.clj+++ b/src/metabase/llm/settings.clj@@ -82,10 +82,10 @@;;; -------------------------------------------------- OpenAI ---------------------------------------------------(defsetting llm-openai-model- (deferred-tru "The OpenAI Model (e.g. ''gpt-4'', ''gpt-3.5-turbo'')")+ (deferred-tru "The OpenAI Model (e.g. ''gpt-5.5'', ''gpt-5.4-mini'')"):encryption :no:visibility :settings-manager- :default "gpt-4.1-mini"+ :default "gpt-5.4":export? false:deprecated-name :ee-openai-model:doc false)diff --git a/src/metabase/metabot/api.clj b/src/metabase/metabot/api.cljindex 54b2b9f95e4..a6b52129d4c 100644--- a/src/metabase/metabot/api.clj+++ b/src/metabase/metabot/api.clj@@ -396,6 +396,12 @@(str/starts-with? id "openai.") "OpenAI":else nil))+(defn- openai-model-group+ "Group an OpenAI model by version family for the picker."+ [{:keys [id]}]+ (when-let [version (second (re-find #"^gpt-(\d+(?:\.\d+)?)" id))]+ (str "GPT-" version)))+(defn- openrouter-model-group[{:keys [display_name id]}](or (some-> display_name@@ -411,6 +417,7 @@(case provider"anthropic" (assoc model :group (anthropic-model-group model))"bedrock" (assoc model :group (bedrock-model-group model))+ "openai" (assoc model :group (openai-model-group model))"openrouter" (assoc model :group (openrouter-model-group model))model))@@ -428,7 +435,7 @@(map normalize-metabase-model models)models)decorated-models (map #(decorate-provider-model provider %) models)]- (if (contains? #{"anthropic" "bedrock" "openrouter"} provider)+ (if (contains? #{"anthropic" "bedrock" "openai" "openrouter"} provider)(let [grouped-models (group-by :group decorated-models)](->> grouped-modelskeysdiff --git a/src/metabase/metabot/example_question_generator.clj b/src/metabase/metabot/example_question_generator.cljindex bdcbe75bd77..bc12b25bce3 100644--- a/src/metabase/metabot/example_question_generator.clj+++ b/src/metabase/metabot/example_question_generator.clj@@ -100,7 +100,7 @@"Output-token ceiling for a single generation. The answer itself is tiny, but reasoning models spend output tokensreasoning *before* emitting the forced structured_output tool call, so the cap must leave room for that or the callreturns no tool call. Non-reasoning providers stop well under this, so the higher ceiling costs them nothing."- 2048)+ 4096)(defn- call-llm"Make a structured LLM call for example question generation.diff --git a/src/metabase/metabot/self/core.clj b/src/metabase/metabot/self/core.cljindex 86d00c36497..8333e940dec 100644--- a/src/metabase/metabot/self/core.clj+++ b/src/metabase/metabot/self/core.clj@@ -36,7 +36,7 @@"Canonical schema for the opts map passed to every LLM provider adapter.Required:- :model - Model name string (e.g. \"claude-haiku-4-5\", \"gpt-4.1-mini\")+ :model - Model name string (e.g. \"claude-haiku-4-5\", \"gpt-5.4\")Optional::system - System prompt stringdiff --git a/src/metabase/metabot/self/openai.clj b/src/metabase/metabot/self/openai.cljindex 0ddcc173293..e9add7c3aab 100644--- a/src/metabase/metabot/self/openai.clj+++ b/src/metabase/metabot/self/openai.clj@@ -181,6 +181,11 @@:description doc:parameters (mjs/transform params {:additionalProperties false})}))+(defn- ai-proxy-unsupported-ex []+ (ex-info (tru "AI proxy is not supported for OpenAI")+ {:api-error true+ :error-code :proxy-unsupported}))+(defn- openai-error-msg"Canonical, status-specific OpenAI error message."[res]@@ -193,30 +198,55 @@500 (tru "OpenAI API is not working but not saying why")(tru "OpenAI API error (HTTP {0})" status))))+(def ^:private supported-models+ "OpenAI chat models offered in the Metabot model picker.+ `list-models` returns the intersection of this set with the account's `/v1/models` catalog."+ #{"gpt-5.5"+ "gpt-5.5-pro"+ "gpt-5.4"+ "gpt-5.4-pro"+ "gpt-5.4-mini"+ "gpt-5"})++(defn- supported-model?+ "Whether a `/v1/models` catalog entry is one of the [[supported-models]]."+ [{:keys [id]}]+ (contains? supported-models id))++(defn- list-all-models+ "Fetch the full OpenAI model catalog (`GET /v1/models`).+ `:ai-proxy?` is not supported for OpenAI and throws when true."+ [{:keys [credentials ai-proxy?]}]+ (when ai-proxy?+ (throw (ai-proxy-unsupported-ex)))+ (when (and credentials (str/blank? (:api-key credentials)))+ (throw (core/missing-api-key-ex "OpenAI")))+ (try+ (let [auth (core/resolve-auth "openai" "OpenAI"+ (when-let [k (or (not-empty (:api-key credentials))+ (not-empty (llm/llm-openai-api-key)))]+ {:url (llm/llm-openai-api-base-url)+ :headers {"Authorization" (str "Bearer " k)}})+ ai-proxy?)+ res (core/request auth {:method :get+ :url "/v1/models"+ :as :json+ :headers {"Content-Type" "application/json"}})]+ (get-in res [:body :data]))+ (catch Exception e+ (core/rethrow-api-error! "openai" openai-error-msg e))))+(defn list-models- "List available OpenAI models.- No-arg uses the configured API key. Opts map supports `:credentials` (`{:api-key ...}`) and `:ai-proxy?`."+ "List the OpenAI chat models supported by this adapter (see [[supported-models]]).+ No-arg uses the configured API key. Opts map supports `:credentials` (`{:api-key ...}`) and `:ai-proxy?`.+ `:ai-proxy?` is not supported for OpenAI and throws when true."([] (list-models {}))- ([{:keys [credentials ai-proxy?]}]- (when (and credentials (str/blank? (:api-key credentials)))- (throw (core/missing-api-key-ex "OpenAI")))- (try- (let [auth (core/resolve-auth "openai" "OpenAI"- (when-let [k (or (not-empty (:api-key credentials))- (not-empty (llm/llm-openai-api-key)))]- {:url (llm/llm-openai-api-base-url)- :headers {"Authorization" (str "Bearer " k)}})- ai-proxy?)- res (core/request auth {:method :get- :url "/v1/models"- :as :json- :headers {"Content-Type" "application/json"}})]- {:models (mapv (fn [model]- {:id (:id model)- :display_name (:id model)})- (reverse (sort-by :created (get-in res [:body :data]))))})- (catch Exception e- (core/rethrow-api-error! "openai" openai-error-msg e)))))+ ([opts]+ {:models (->> (list-all-models opts)+ (filter supported-model?)+ (sort-by :id)+ (mapv (fn [{:keys [id]}]+ {:id id :display_name id})))}))(defn- model-supports-temperature?"Whether `model` accepts an explicit `temperature` parameter.@@ -230,7 +260,7 @@(mu/defn openai-request-body"Build the OpenAI Responses API request body for an LLM request."[{:keys [model system input tools schema tool_choice temperature max-tokens]- :or {model "gpt-4.1-mini"}} :- core/LLMRequestOpts]+ :or {model "gpt-5.4"}} :- core/LLMRequestOpts](let [all-tools (or (when schema;; Structured output: force a tool call with the given JSON schema[{:type "function"@@ -254,9 +284,12 @@(assoc :temperature temperature))))(mu/defn openai-raw- "Perform a streaming request to OpenAI Responses API."+ "Perform a streaming request to OpenAI Responses API.+ `:ai-proxy?` is not supported for OpenAI and throws when true."[{:keys [model ai-proxy?] :as opts- :or {model "gpt-4.1-mini"}} :- core/LLMRequestOpts]+ :or {model "gpt-5.4"}} :- core/LLMRequestOpts]+ (when ai-proxy?+ (throw (ai-proxy-unsupported-ex)))(let [req (openai-request-body opts)](try(let [api-key (not-empty (llm/llm-openai-api-key))diff --git a/src/metabase/metabot/settings.clj b/src/metabase/metabot/settings.cljindex 1e61a5a9807..65ace18d20d 100644--- a/src/metabase/metabot/settings.clj+++ b/src/metabase/metabot/settings.clj@@ -114,6 +114,10 @@"Default Bedrock model used for Metabot when no explicit model is selected.""anthropic.claude-opus-4-8")+(def ^:private default-openai-llm-metabot-model+ "Default OpenAI model used for Metabot when no explicit model is selected."+ "gpt-5.4")+(def default-llm-metabot-provider"Default provider/model used for Metabot when no explicit model is selected."(str "anthropic/" default-anthropic-llm-metabot-model))@@ -125,6 +129,7 @@managed `metabase` provider uses the proxied `provider/model` form."{"anthropic" default-anthropic-llm-metabot-model"bedrock" default-bedrock-llm-metabot-model+ "openai" default-openai-llm-metabot-modelprovider-util/metabase-provider-prefix default-llm-metabot-provider})(def default-metabase-llm-metabot-provider@@ -243,7 +248,7 @@(validate-direct-provider! value)))(defsetting llm-metabot-provider- (deferred-tru "The AI provider and model for Metabot. Format: provider/model-name, e.g. `anthropic/claude-haiku-4-5`, `openai/gpt-4.1-mini`, `openrouter/anthropic/claude-haiku-4-5`.")+ (deferred-tru "The AI provider and model for Metabot. Format: provider/model-name, e.g. `anthropic/claude-haiku-4-5`, `openai/gpt-5.4`, `openrouter/anthropic/claude-haiku-4-5`."):type :string:encryption :no:default default-llm-metabot-providerdiff --git a/test/metabase/metabot/api_test.clj b/test/metabase/metabot/api_test.cljindex 8d810824c1d..85dcdd5ba75 100644--- a/test/metabase/metabot/api_test.clj+++ b/test/metabase/metabot/api_test.clj@@ -327,6 +327,25 @@(mt/user-http-request :crowberto :get 200 "metabot/settings":provider "openrouter"))))))+(deftest settings-get-groups-openai-models-test+ (mt/with-temporary-setting-values [metabot.settings/llm-metabot-provider "openai/gpt-5-mini"+ llm.settings/llm-openai-api-key "sk-valid"]+ (mt/with-dynamic-fn-redefs [metabot.self/list-models (fn [_provider {:keys [credentials]}]+ (is (= {:api-key "sk-valid"} credentials))+ {:models [{:id "gpt-5.5" :display_name "gpt-5.5"}+ {:id "gpt-5.5-pro" :display_name "gpt-5.5-pro"}+ {:id "gpt-5.4" :display_name "gpt-5.4"}+ {:id "gpt-5.4-mini" :display_name "gpt-5.4-mini"}+ {:id "gpt-4.1-mini" :display_name "gpt-4.1-mini"}]})]+ (is (= {:value (metabot.settings/llm-metabot-provider)+ :models [{:id "gpt-4.1-mini" :display_name "gpt-4.1-mini" :group "GPT-4.1"}+ {:id "gpt-5.4" :display_name "gpt-5.4" :group "GPT-5.4"}+ {:id "gpt-5.4-mini" :display_name "gpt-5.4-mini" :group "GPT-5.4"}+ {:id "gpt-5.5" :display_name "gpt-5.5" :group "GPT-5.5"}+ {:id "gpt-5.5-pro" :display_name "gpt-5.5-pro" :group "GPT-5.5"}]}+ (mt/user-http-request :crowberto :get 200 "metabot/settings"+ :provider "openai"))))))+(deftest settings-get-returns-metabase-models-without-api-key-test(mt/with-temporary-setting-values [metabot.settings/llm-metabot-provider "metabase/anthropic/claude-sonnet-4-6"](mt/with-dynamic-fn-redefs [metabot.self/list-models (fn@@ -347,7 +366,7 @@(deftest settings-put-updates-provider-test(mt/with-temporary-setting-values [metabot.settings/llm-metabot-provider "anthropic/claude-haiku-4-5"- llm.settings/llm-openai-api-key "sk-valid"]+ llm.settings/llm-openai-api-key "sk-valid"](mt/with-dynamic-fn-redefs [metabot.self/list-models (fn([provider](is (= "openai" provider))@@ -360,13 +379,40 @@:display_name "GPT-4.1 mini"}]}))](is (= {:value "openai/gpt-4.1-mini":models [{:id "gpt-4.1-mini"- :display_name "GPT-4.1 mini"}]}+ :display_name "GPT-4.1 mini"+ :group "GPT-4.1"}]}(mt/user-http-request :crowberto :put 200 "metabot/settings"{:provider "openai":model "gpt-4.1-mini"})))(is (= "openai/gpt-4.1-mini"(metabot.settings/llm-metabot-provider))))))+(deftest settings-put-connect-openai-defaults-model-test+ (testing "connecting openai with only an api-key switches to the default openai model"+ (mt/with-temporary-setting-values [metabot.settings/llm-metabot-provider "anthropic/claude-haiku-4-5"+ llm.settings/llm-openai-api-key nil]+ (mt/with-dynamic-fn-redefs [metabot.self/list-models (fn+ ([provider]+ (is (= "openai" provider))+ {:models [{:id "gpt-5.4"+ :display_name "gpt-5.4"}]})+ ([provider {:keys [credentials]}]+ (is (= "openai" provider))+ (is (= {:api-key "sk-fresh"} credentials))+ {:models [{:id "gpt-5.4"+ :display_name "gpt-5.4"}]}))]+ (is (= {:value "openai/gpt-5.4"+ :models [{:id "gpt-5.4"+ :display_name "gpt-5.4"+ :group "GPT-5.4"}]}+ (mt/user-http-request :crowberto :put 200 "metabot/settings"+ {:provider "openai"+ :api-key "sk-fresh"})))+ (is (= "openai/gpt-5.4"+ (metabot.settings/llm-metabot-provider)))+ (is (= "sk-fresh"+ (llm.settings/llm-openai-api-key)))))))+(deftest settings-put-updates-metabase-provider-without-api-key-test(mt/with-temporary-setting-values [metabot.settings/llm-metabot-provider "anthropic/claude-haiku-4-5"](mt/with-dynamic-fn-redefs [metabot.self/list-models (fndiff --git a/test/metabase/metabot/self/openai_test.clj b/test/metabase/metabot/self/openai_test.cljindex 438094156d5..9e20767f1f6 100644--- a/test/metabase/metabot/self/openai_test.clj+++ b/test/metabase/metabot/self/openai_test.clj@@ -254,6 +254,36 @@(openai/parts->openai-input[{:type :tool-output :id "call-1" :error {:message "Tool failed"}}])))))+;;; ──────────────────────────────────────────────────────────────────+;;; list-models filtering tests+;;; ──────────────────────────────────────────────────────────────────++(deftest ^:parallel supported-model?-test+ (testing "whitelisted models are supported"+ (doseq [id ["gpt-5.5" "gpt-5.4-mini" "gpt-5"]]+ (is (true? (#'openai/supported-model? {:id id})) id)))+ (testing "non-white-listed models are not supported"+ (doseq [id ["gpt-4.1" "gpt-4.1-mini" "gpt-4o" "o3" "text-embedding-3-small"]]+ (is (false? (#'openai/supported-model? {:id id})) id))))++(deftest list-models-filters-catalog-to-whitelist-test+ (testing "list-models keeps only whitelisted models sorted by id"+ (mt/with-temporary-setting-values [llm.settings/llm-openai-api-key "sk-test"]+ (with-redefs [http/request (fn [_]+ {:status 200+ :body {:data [{:id "gpt-5-mini" :created 30}+ {:id "gpt-5" :created 28}+ {:id "gpt-5.4" :created 25}+ {:id "gpt-4.1" :created 20}+ {:id "gpt-4.1-mini" :created 19}+ {:id "gpt-4o-mini" :created 18}+ {:id "o3" :created 15}+ {:id "text-embedding-3-small" :created 8}+ {:id "whisper-1" :created 7}]}})]+ (is (= [{:id "gpt-5" :display_name "gpt-5"}+ {:id "gpt-5.4" :display_name "gpt-5.4"}]+ (:models (openai/list-models))))))))+;;; ──────────────────────────────────────────────────────────────────;;; temperature support tests;;; ──────────────────────────────────────────────────────────────────@@ -307,17 +337,6 @@:headers {"Authorization" "Bearer sk-ant-byok"}:body string?}(openai/openai-raw {:input [{:role :user :content "hi"}]})))))- (testing "Uses ai proxy when explicitly requested"- (mt/with-temporary-setting-values [llm.settings/llm-openai-api-key nil]- (with-redefs [self.core/sse-reducible identity- debug/capture-stream (fn [r _] r)- http/request (fn [req] {:body req})]- (is (=? {:method :post- :url "https://proxy.example/openai/v1/responses"- :headers {"x-metabase-instance-token" "proxy-token"}- :body string?}- (openai/openai-raw {:input [{:role :user :content "hi"}]- :ai-proxy? true}))))))(testing "Does not fall back to ai proxy when BYOK is missing"(mt/with-temporary-setting-values [llm.settings/llm-openai-api-key nil](is (thrown-with-msg?@@ -331,3 +350,27 @@clojure.lang.ExceptionInfo#"No OpenAI API key is set"(openai/openai-raw {:input [{:role :user :content "hi"}]})))))))))++;;; ──────────────────────────────────────────────────────────────────+;;; AI proxy (unsupported)+;;; ──────────────────────────────────────────────────────────────────++(deftest list-models-ai-proxy-unsupported-test+ (testing "ai-proxy? throws before credentials are even consulted"+ (mt/with-temporary-setting-values [llm.settings/llm-openai-api-key nil]+ (with-redefs [http/request (fn [_] (throw (ex-info "should never be called" {})))]+ (is (thrown-with-msg?+ clojure.lang.ExceptionInfo+ #"AI proxy is not supported for OpenAI"+ (openai/list-models {:ai-proxy? true})))))))++(deftest openai-raw-ai-proxy-unsupported-test+ (testing "ai-proxy? throws before credentials are even consulted"+ (mt/with-temporary-setting-values [llm.settings/llm-openai-api-key nil]+ (with-redefs [http/request (fn [_] (throw (ex-info "should never be called" {})))]+ (is (thrown-with-msg?+ clojure.lang.ExceptionInfo+ #"AI proxy is not supported for OpenAI"+ (openai/openai-raw {:model "gpt-4.1-mini"+ :input [{:role :user :content "hi"}]+ :ai-proxy? true})))))))