Skip to content

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

Metabot use case configuration groundwork (#66673)

Noah Mossdce776c8cc63
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
index d0c13a6b1f8..a5dbaf0975b 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
@@ -24,7 +24,9 @@
[metabase.util.malli.schema :as ms]
[toucan2.core :as t2]))
-(defn- store-message! [conversation-id profile-id messages]
+(defn- store-message!
+ "Store a message in the conversation. `profile-id` is optional (for legacy/dev override)."
+ [conversation-id use-case profile-id messages]
(let [finish (let [m (u/last messages)]
(when (= (:_type m) :FINISH_MESSAGE)
m))
@@ -42,6 +44,7 @@
:data messages
:usage (:usage finish)
:role (:role (first messages))
+ :use_case use-case
:profile_id profile-id
:total_tokens (->> (vals (:usage finish))
;; NOTE: this filter is supporting backward-compatible usage format, can be
@@ -52,23 +55,26 @@
(defn streaming-request
"Handles an incoming request, making all required tool invocation, LLM call loops, etc."
- [{:keys [metabot_id profile_id message context history conversation_id state]}]
+ [{:keys [metabot_id use_case profile_id message context history conversation_id state]}]
(let [message (metabot-v3.envelope/user-message message)
metabot-id (metabot-v3.config/resolve-dynamic-metabot-id metabot_id)
- profile-id (metabot-v3.config/resolve-dynamic-profile-id profile_id metabot-id)
+ use-case (or use_case (metabot-v3.config/default-use-case metabot-id))
+ metabot-pk (metabot-v3.config/normalize-metabot-id metabot-id)
+ profile (metabot-v3.config/resolve-profile metabot-pk use-case profile_id)
session-id (metabot-v3.client/get-ai-service-token api/*current-user-id* metabot-id)]
- (store-message! conversation_id profile-id [message])
+ (store-message! conversation_id use-case profile [message])
(metabot-v3.client/streaming-request
{:context (metabot-v3.context/create-context context)
:metabot-id metabot-id
- :profile-id profile-id
+ :use-case use-case
+ :profile-id profile
:session-id session-id
:conversation-id conversation_id
:message message
:history history
:state state
:on-complete (fn [lines]
- (store-message! conversation_id profile-id (metabot-v3.u/aisdk->messages :assistant lines))
+ (store-message! conversation_id use-case profile (metabot-v3.u/aisdk->messages :assistant lines))
:store-in-db)})))
;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
@@ -80,6 +86,7 @@
[_route-params
_query-params
body :- [:map
+ [:use_case {:optional true} :string]
[:profile_id {:optional true} :string]
[:metabot_id {:optional true} :string]
[:message ms/NonBlankString]
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj
index 4c2b19c1b9f..082e38dd817 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj
@@ -11,6 +11,7 @@
[metabase.premium-features.core :as premium-features]
[metabase.request.core :as request]
[metabase.util.i18n :refer [tru]]
+ [metabase.util.malli.schema :as ms]
[toucan2.core :as t2]))
;; TODO: Eventually this should be paged but since we are just going to hardcode two models for now
@@ -24,7 +25,7 @@
"List configured metabot instances"
[]
(api/check-superuser)
- {:items (t2/select :model/Metabot {:order-by [[:name :asc]]})})
+ {:items (t2/hydrate (t2/select :model/Metabot {:order-by [[:name :asc]]}) :use_cases)})
;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
;; use our API + we will need it when we make auto-TypeScript-signature generation happen
@@ -34,7 +35,7 @@
"Retrieve one metabot instance"
[{:keys [id]} :- [:map [:id pos-int?]]]
(api/check-superuser)
- (api/check-404 (t2/select-one :model/Metabot :id id)))
+ (api/check-404 (t2/hydrate (t2/select-one :model/Metabot :id id) :use_cases)))
;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
;; use our API + we will need it when we make auto-TypeScript-signature generation happen
@@ -44,12 +45,17 @@
"Update a metabot instance"
[{:keys [id]} :- [:map [:id pos-int?]]
_query-params
- metabot-updates :- [:map {:closed true}
- [:use_verified_content {:optional true} :boolean]
- [:collection_id {:optional true} [:maybe pos-int?]]]]
+ {:keys [use_cases] :as metabot-updates} :- [:map {:closed true}
+ [:use_verified_content {:optional true} :boolean]
+ [:collection_id {:optional true} [:maybe pos-int?]]
+ [:use_cases {:optional true}
+ [:sequential [:map {:closed true}
+ [:id ms/PositiveInt]
+ [:enabled {:optional true} :boolean]]]]]]
(api/check-superuser)
(api/check-404 (t2/exists? :model/Metabot :id id))
- (let [old-metabot (t2/select-one :model/Metabot :id id)]
+ (let [old-metabot (t2/select-one :model/Metabot :id id)
+ metabot-field-updates (dissoc metabot-updates :use_cases)]
;; Prevent updating collection_id on the primary metabot instance
(when (and (contains? metabot-updates :collection_id)
(= (:entity_id old-metabot)
@@ -58,12 +64,17 @@
;; Prevent enabling verified content without the premium feature
(when (:use_verified_content metabot-updates)
(premium-features/assert-has-feature :content-verification (tru "Content verification")))
- (let [old-vals (select-keys old-metabot (keys metabot-updates))]
- (when (not= old-vals metabot-updates)
- (t2/update! :model/Metabot id metabot-updates)
+ ;; Update use cases
+ (doseq [{use-case-id :id :as use-case-updates} use_cases]
+ (api/check-404 (t2/exists? :model/MetabotUseCase :id use-case-id :metabot_id id))
+ (t2/update! :model/MetabotUseCase use-case-id (dissoc use-case-updates :id)))
+ ;; Update metabot fields
+ (let [old-vals (select-keys old-metabot (keys metabot-field-updates))]
+ (when (not= old-vals metabot-field-updates)
+ (t2/update! :model/Metabot id metabot-field-updates)
(metabot-v3.suggested-prompts/delete-all-metabot-prompts id)
(metabot-v3.suggested-prompts/generate-sample-prompts id))
- (t2/select-one :model/Metabot :id id))))
+ (t2/hydrate (t2/select-one :model/Metabot :id id) :use_cases))))
;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
;; use our API + we will need it when we make auto-TypeScript-signature generation happen
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/client.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/client.clj
index 44bf8ed77c8..9da0939fad8 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/client.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/client.clj
@@ -137,12 +137,13 @@
Response chunks are encoded in the format understood by the frontend and AI Service, Clojure backend doesn't
know anything about it and just shuttles them over.
"
- [{:keys [context message history profile-id conversation-id session-id state on-complete]}
+ [{:keys [context message history use-case profile-id conversation-id session-id state on-complete]}
:- [:map
[:context :map]
[:message ::metabot-v3.client.schema/message]
[:history ::metabot-v3.client.schema/messages]
- [:profile-id :string]
+ [:use-case :string]
+ [:profile-id {:optional true} [:maybe :string]]
[:conversation-id :string]
[:session-id :string]
[:state :map]
@@ -153,6 +154,7 @@
body {:messages (conj (vec history) message)
:context context
:conversation_id conversation-id
+ :use_case use-case
:profile_id profile-id
:user_id api/*current-user-id*
:state state}
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/config.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/config.clj
index 939dca3d155..7c0022d4ed2 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/config.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/config.clj
@@ -1,55 +1,60 @@
(ns metabase-enterprise.metabot-v3.config
(:require
- [medley.core :as m]
[metabase-enterprise.metabot-v3.settings :as metabot-v3.settings]
+ [metabase.util.log :as log]
[toucan2.core :as t2]))
(def internal-metabot-id
- "The ID of the internal Metabot instance."
+ "The UUID of the internal Metabot instance."
"b5716059-ad40-4d83-a4e1-673af020b2d8")
(def embedded-metabot-id
- "The ID of the embedded Metabot instance."
+ "The UUID of the embedded Metabot instance."
"c61bf5f5-1025-47b6-9298-bf1827105bb6")
(def metabot-config
- "The name of the collection exposed by the answer-sources tool."
- {internal-metabot-id {:profile-id "internal"
- :entity-id "metabotmetabotmetabot"}
- embedded-metabot-id {:profile-id "embedding"
- :entity-id "embeddedmetabotmetabo"}})
-
-(defn metabot-id->profile-id
- "Return the profile-id for the Metabot instance with ID `metabot-id` or \"default\" if no profile-id is configured."
- [metabot-id]
- (or (get-in metabot-config [metabot-id :profile-id])
- (:profile-id (m/find-first #(when (= (:entity-id %) metabot-id)
- (:profile-id %))
- (vals metabot-config)))))
+ "Configuration for the built-in metabot instances."
+ {internal-metabot-id {:entity-id "metabotmetabotmetabot"
+ :default-use-case "omnibot"}
+ embedded-metabot-id {:entity-id "embeddedmetabotmetabo"
+ :default-use-case "embedding"}})
(defn normalize-metabot-id
"Return the primary key for the metabot instance identified by `metabot-id`.
- Returns nil, no entry can be found.
+ Returns nil if no entry can be found.
The provided ID can be a UUID from [[metabot-config]] or an entity_id of a Metabot instance."
[metabot-id]
(t2/select-one-pk :model/Metabot :entity_id (get-in metabot-config [metabot-id :entity-id] metabot-id)))
+(defn default-use-case
+ "Return the default use case for a metabot. Falls back to \"omnibot\" for unknown metabots."
+ [metabot-id]
+ (or (get-in metabot-config [metabot-id :default-use-case])
+ "omnibot"))
+
(defn resolve-dynamic-metabot-id
- "Resolve dynamic metabot ID with logical fall backs
+ "Resolve dynamic metabot ID with logical fall backs.
Precedence: explicit metabot-id > env metabot-id > default (internal)"
[metabot-id]
(or metabot-id
(metabot-v3.settings/metabot-id)
internal-metabot-id))
-(defn resolve-dynamic-profile-id
- "Resolve the ultimate ai-service profile ID with logical fall backs
- Precedence: explicit profile_id > env profile_id > metabot-id->profile-id > default (embedded)"
- ([profile-id]
- (resolve-dynamic-profile-id profile-id (resolve-dynamic-metabot-id nil)))
- ([profile-id metabot-id]
- (or profile-id
- (metabot-v3.settings/ai-service-profile-id)
- (metabot-id->profile-id metabot-id)
- "default")))
+(defn resolve-profile
+ "Resolve the AI service profile for a use case.
+ Precedence: explicit profile override > use case profile from DB
+
+ Arguments:
+ - metabot-pk: The primary key of the metabot instance
+ - use-case: The use case name (e.g., \"nlq\", \"transforms\")
+ - profile-override: Optional explicit profile override (e.g., from /profile command)"
+ [metabot-pk use-case profile-override]
+ (or profile-override
+ (when (and metabot-pk use-case)
+ (let [profile (t2/select-one-fn :profile :model/MetabotUseCase
+ :metabot_id metabot-pk
+ :name use-case)]
+ (when-not profile
+ (log/warnf "No profile found for metabot %d with use-case %s" metabot-pk use-case))
+ profile))))
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot.clj
index 460b12e9139..13acb7eb8ee 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot.clj
@@ -20,14 +20,28 @@
(methodical/defmethod t2/batched-hydrate [:model/Metabot :prompts]
"Hydrate the list of prompts for a collection of metabots."
- [_model k metabots]
+ [_model hydration-key metabots]
(mi/instances-with-hydrated-data
- metabots k
+ metabots
+ hydration-key
#(group-by :metabot_id
(t2/select :model/MetabotPrompt {:where [:in :metabot_id (map :id metabots)]}))
:id
{:default []}))
+(methodical/defmethod t2/batched-hydrate [:model/Metabot :use_cases]
+ "Hydrate the list of use cases for a collection of metabots."
+ [_model hydration-key metabots]
+ (mi/instances-with-hydrated-data
+ metabots
+ hydration-key
+ #(group-by :metabot_id
+ (t2/select :model/MetabotUseCase
+ {:where [:in :metabot_id (map :id metabots)]
+ :order-by [[:name :asc]]}))
+ :id
+ {:default []}))
+
;;; ------------------------------------------------- Serialization -------------------------------------------------
(defmethod serdes/hash-fields :model/Metabot
@@ -35,8 +49,9 @@
[:name])
(defmethod serdes/dependencies "Metabot"
- [{:keys [prompts]}]
- (set (mapcat serdes/dependencies prompts)))
+ [{:keys [collection_id prompts]}]
+ (cond-> (set (mapcat serdes/dependencies prompts))
+ collection_id (conj [{:model "Collection" :id collection_id}])))
(defmethod serdes/generate-path "Metabot" [_ metabot]
[(serdes/infer-self-path "Metabot" metabot)])
@@ -46,4 +61,5 @@
:transform {:created_at (serdes/date)
:updated_at (serdes/date)
:collection_id (serdes/fk :model/Collection)
- :prompts (serdes/nested :model/MetabotPrompt :metabot_id opts)}})
+ :prompts (serdes/nested :model/MetabotPrompt :metabot_id opts)
+ :use_cases (serdes/nested :model/MetabotUseCase :metabot_id opts)}})
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot_use_case.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot_use_case.clj
new file mode 100644
index 00000000000..7cce3d17da8
--- /dev/null
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/models/metabot_use_case.clj
@@ -0,0 +1,37 @@
+(ns metabase-enterprise.metabot-v3.models.metabot-use-case
+ "Model for Metabot use cases (e.g., nlq, sql, transforms, omnibot, embedding).
+
+ Use cases are predefined configurations that map to AI service profiles.
+ Default use cases are created via database migrations."
+ (:require
+ [metabase.models.interface :as mi]
+ [metabase.models.serialization :as serdes]
+ [methodical.core :as methodical]
+ [toucan2.core :as t2]))
+
+;;; --------------------------------------------------- Lifecycle ----------------------------------------------------
+
+(methodical/defmethod t2/table-name :model/MetabotUseCase [_model] :metabot_use_case)
+
+(doto :model/MetabotUseCase
+ (derive :metabase/model)
+ (derive ::mi/read-policy.superuser)
+ (derive ::mi/write-policy.superuser)
+ (derive :hook/entity-id)
+ (derive :hook/timestamped?))
+
+;;; ------------------------------------------------- Serialization -------------------------------------------------
+
+(defmethod serdes/hash-fields :model/MetabotUseCase
+ [_table]
+ [:metabot_id :name])
+
+(defmethod serdes/generate-path "MetabotUseCase" [_ entity]
+ (conj (serdes/generate-path "Metabot" (t2/select-one :model/Metabot (:metabot_id entity)))
+ (serdes/infer-self-path "MetabotUseCase" entity)))
+
+(defmethod serdes/make-spec "MetabotUseCase" [_model-name _opts]
+ {:copy [:entity_id :name :profile :enabled]
+ :transform {:created_at (serdes/date)
+ :updated_at (serdes/date)
+ :metabot_id (serdes/parent-ref)}})
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj
index f965c44de86..9d21bad1a1c 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj
@@ -40,12 +40,3 @@
:encryption :no
:export? false
:doc false)
-
-(defsetting ai-service-profile-id
- (deferred-tru "Override Metabot profile ID for agent streaming requests.")
- :type :string
- :visibility :internal
- :feature :metabot-v3
- :encryption :no
- :export? false
- :doc false)
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/deftool.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/deftool.clj
index 12e909b0da7..36967bfe07c 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/deftool.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/deftool.clj
@@ -3,6 +3,7 @@
(:require
[malli.core :as mc]
[malli.transform :as mtx]
+ [metabase-enterprise.metabot-v3.config :as metabot-v3.config]
[metabase-enterprise.metabot-v3.context :as metabot-v3.context]
[metabase.api.macros :as api.macros]
[metabase.util.malli.registry :as mr]
@@ -36,16 +37,19 @@
- `:handler` - Function to call with encoded arguments (receives args map with :metabot-id)
The handler receives a single map argument containing the encoded args plus `:metabot-id`
- (extracted from the request). For no-args tools, the handler receives just `{:metabot-id ...}`."
+ and `:use-case` (extracted from the request)."
[{:keys [arguments conversation_id] :as body}
request
{:keys [api-name args-schema result-schema handler]}]
(metabot-v3.context/log (assoc body :api api-name) :llm.log/llm->be)
(let [metabot-id (:metabot-v3/metabot-id request)
+ use-case (or (get-in request [:headers "x-metabot-use-case"])
+ (metabot-v3.config/default-use-case metabot-id))
encoded-args (cond-> (if args-schema
(mc/encode args-schema arguments request-transformer)
{})
- metabot-id (assoc :metabot-id metabot-id))
+ metabot-id (assoc :metabot-id metabot-id)
+ :always (assoc :use-case use-case))
raw-result (handler encoded-args)
result (if result-schema
(mc/decode result-schema raw-result response-transformer)
diff --git a/enterprise/backend/src/metabase_enterprise/serialization/v2/models.clj b/enterprise/backend/src/metabase_enterprise/serialization/v2/models.clj
index 8316ff02fd7..b7cdb9bfd31 100644
--- a/enterprise/backend/src/metabase_enterprise/serialization/v2/models.clj
+++ b/enterprise/backend/src/metabase_enterprise/serialization/v2/models.clj
@@ -42,6 +42,7 @@
"ParameterCard"
"DashboardCardSeries"
"MetabotPrompt"
+ "MetabotUseCase"
"TimelineEvent"
"TransformJobTransformTag"
"TransformTransformTag"])
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/api/metabot_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/api/metabot_test.clj
index 0c7b8430c0f..f4be79b4a29 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/api/metabot_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/api/metabot_test.clj
@@ -175,7 +175,18 @@
(testing "should require superuser permissions"
(is (= "You don't have permissions to do that."
- (mt/user-http-request :rasta :get 403 "ee/metabot-v3/metabot")))))))))
+ (mt/user-http-request :rasta :get 403 "ee/metabot-v3/metabot"))))))))
+
+ (testing "GET /api/ee/metabot-v3/metabot should include use_cases"
+ (mt/with-premium-features #{:metabot-v3}
+ (with-clean-metabots
+ (mt/with-temp [:model/Metabot {metabot-id :id} {:name "Test Metabot"}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "omnibot" :profile "internal" :enabled true}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "transforms" :profile "transforms_codegen" :enabled true}]
+ (let [{[metabot] :items} (mt/user-http-request :crowberto :get 200 "ee/metabot-v3/metabot")]
+ (is (= [{:metabot_id metabot-id :name "omnibot" :profile "internal" :enabled true}
+ {:metabot_id metabot-id :name "transforms" :profile "transforms_codegen" :enabled true}]
+ (map #(select-keys % [:metabot_id :name :profile :enabled]) (:use_cases metabot))))))))))
(deftest metabot-get-single-test
(testing "GET /api/ee/metabot-v3/metabot/:id"
@@ -184,7 +195,8 @@
:model/Metabot {metabot-id :id} {:name "Test Metabot"
:description "Test Description"
:use_verified_content true
- :collection_id collection-id}]
+ :collection_id collection-id}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "transforms" :profile "transforms_codegen" :enabled true}]
(testing "should return metabot with all fields"
(let [response (mt/user-http-request :crowberto :get 200
@@ -193,7 +205,9 @@
(is (= "Test Metabot" (:name response)))
(is (= "Test Description" (:description response)))
(is (true? (:use_verified_content response)))
- (is (= collection-id (:collection_id response)))))
+ (is (= collection-id (:collection_id response)))
+ (is (= [{:metabot_id metabot-id :name "transforms" :profile "transforms_codegen" :enabled true}]
+ (map #(select-keys % [:metabot_id :name :profile :enabled]) (:use_cases response))))))
(testing "should require superuser permissions"
(is (= "You don't have permissions to do that."
@@ -293,6 +307,42 @@
(is (true? (:use_verified_content response)))
(is (= nil (:collection_id response)))))))))))
+(deftest metabot-put-use-cases-test
+ (testing "PUT /api/ee/metabot-v3/metabot/:id can update use_cases"
+ (mt/with-premium-features #{:metabot-v3}
+ (mt/with-temp [:model/Metabot {metabot-id :id} {:name "Test Metabot"}
+ :model/MetabotUseCase {uc-id :id} {:metabot_id metabot-id
+ :name "transforms"
+ :profile "transforms_codegen"
+ :enabled true}]
+ (testing "should update use_case enabled status"
+ (let [response (mt/user-http-request :crowberto :put 200
+ (format "ee/metabot-v3/metabot/%d" metabot-id)
+ {:use_cases [{:id uc-id :enabled false}]})]
+ ;; Verify response includes updated use_cases
+ (let [updated-uc (some #(when (= uc-id (:id %)) %) (:use_cases response))]
+ (is (false? (:enabled updated-uc))))
+ ;; Verify persisted in database
+ (let [db-uc (t2/select-one :model/MetabotUseCase :id uc-id)]
+ (is (false? (:enabled db-uc))))))
+
+ (testing "should return 404 for non-existent use_case"
+ (is (= "Not found."
+ (mt/user-http-request :crowberto :put 404
+ (format "ee/metabot-v3/metabot/%d" metabot-id)
+ {:use_cases [{:id Integer/MAX_VALUE :enabled true}]}))))
+
+ (testing "should return 404 for use_case belonging to different metabot"
+ (mt/with-temp [:model/Metabot {other-metabot-id :id} {:name "Other Metabot"}
+ :model/MetabotUseCase {other-uc-id :id} {:metabot_id other-metabot-id
+ :name "embedding"
+ :profile "embedding"
+ :enabled true}]
+ (is (= "Not found."
+ (mt/user-http-request :crowberto :put 404
+ (format "ee/metabot-v3/metabot/%d" metabot-id)
+ {:use_cases [{:id other-uc-id :enabled false}]})))))))))
+
(deftest metabot-prompt-regeneration-on-config-change-test
(mt/dataset test-data
(testing "PUT /api/ee/metabot-v3/metabot/:id should regenerate prompts when config changes"
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
index 22dff4094a4..55881ba7087 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
@@ -43,12 +43,14 @@
:context {}
:conversation_id conversation-id
:history [historical-message]
- :state {}}
+ :state {}
+ :use_case "nlq"}
(m/assoc-some :metabot_id metabot-id)))
conv (t2/select-one :model/MetabotConversation :id conversation-id)
messages (t2/select :model/MetabotMessage :conversation_id conversation-id)]
(is (=? [{:messages [historical-message question]
- :conversation_id conversation-id}]
+ :conversation_id conversation-id
+ :use_case "nlq"}]
@ai-requests))
(is (=? [{:_type :TEXT
:role "assistant"
@@ -61,9 +63,11 @@
conv))
(is (=? [{:total_tokens 0
:role :user
+ :use_case "nlq"
:data [{:role "user" :content (:content question)}]}
{:total_tokens 15
:role :assistant
+ :use_case "nlq"
:data [{:role "assistant" :content "Hello from streaming!"}]}]
messages))))))))))
@@ -100,7 +104,7 @@
(search.tu/with-index-disabled
(mt/with-premium-features #{:metabot-v3}
(with-redefs [client/ai-url (constantly ai-url)
- api/store-message! (fn [_conv-id _prof-id msgs]
+ api/store-message! (fn [_conv-id _use-case _profile msgs]
(reset! messages msgs))
sr/async-cancellation-poll-interval-ms 5]
(testing "Closing body stream drops connection"
@@ -111,7 +115,8 @@
:context {}
:conversation_id (str (random-uuid))
:history []
- :state {}})]
+ :state {}
+ :use_case "nlq"})]
(.read ^java.io.InputStream body) ;; start the handler
(.close ^java.io.Closeable body)
(u/poll {:thunk #(deref canceled)
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/client_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/client_test.clj
index d8d984dec38..e0f999c8757 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/client_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/client_test.clj
@@ -65,7 +65,7 @@
req {:context {:some "context"}
:message {:role :user :content "stuff"}
:history []
- :profile-id "test-profile"
+ :use-case "nlq"
:conversation-id cid
:session-id "test-session"
:state {:some "state"}}]
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/config_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/config_test.clj
index fdfa85e446e..9d8841d38f8 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/config_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/config_test.clj
@@ -21,58 +21,3 @@
(testing "falls back to internal default when no explicit or env value"
(is (= metabot-v3.config/internal-metabot-id
(metabot-v3.config/resolve-dynamic-metabot-id nil))))))))
-
-(deftest resolve-dynamic-profile-id-test
- (testing "profile ID resolution precedence"
- (mt/with-premium-features #{:metabot-v3}
- (mt/with-temporary-setting-values [metabot-v3.settings/ai-service-profile-id nil]
- (testing "explicit profile-id takes highest precedence"
- (is (= "explicit-profile"
- (metabot-v3.config/resolve-dynamic-profile-id "explicit-profile" "any-metabot-id"))))
-
- (testing "environment variable takes second precedence"
- (mt/with-temporary-setting-values [metabot-v3.settings/ai-service-profile-id "env-profile"]
- (is (= "env-profile"
- (metabot-v3.config/resolve-dynamic-profile-id nil "any-metabot-id")))))
-
- (testing "metabot-id mapping takes third precedence"
- (is (= "internal"
- (metabot-v3.config/resolve-dynamic-profile-id nil metabot-v3.config/internal-metabot-id)))
- (is (= "embedding"
- (metabot-v3.config/resolve-dynamic-profile-id nil metabot-v3.config/embedded-metabot-id))))
-
- (testing "falls back to default when no matches"
- (is (= "default"
- (metabot-v3.config/resolve-dynamic-profile-id nil "unknown-metabot-id"))))
-
- (testing "single arity version uses dynamic metabot resolution"
- (mt/with-temporary-setting-values [metabot-v3.settings/metabot-id metabot-v3.config/embedded-metabot-id]
- (is (= "embedding"
- (metabot-v3.config/resolve-dynamic-profile-id nil)))))))))
-
-(deftest integrated-resolution-test
- (testing "combination of metabot-id and profile-id precedence resolution"
- (mt/with-premium-features #{:metabot-v3}
- (testing "explicit params override everything"
- (mt/with-temporary-setting-values [metabot-v3.settings/metabot-id nil
- metabot-v3.settings/ai-service-profile-id nil]
- (let [metabot-id (metabot-v3.config/resolve-dynamic-metabot-id "custom-metabot")
- profile-id (metabot-v3.config/resolve-dynamic-profile-id "custom-profile" metabot-id)]
- (is (= "custom-metabot" metabot-id))
- (is (= "custom-profile" profile-id)))))
-
- (testing "environment variables work together"
- (mt/with-temporary-setting-values [metabot-v3.settings/metabot-id "env-metabot"
- metabot-v3.settings/ai-service-profile-id "env-profile"]
- (let [metabot-id (metabot-v3.config/resolve-dynamic-metabot-id nil)
- profile-id (metabot-v3.config/resolve-dynamic-profile-id nil metabot-id)]
- (is (= "env-metabot" metabot-id))
- (is (= "env-profile" profile-id)))))
-
- (testing "defaults work together"
- (mt/with-temporary-setting-values [metabot-v3.settings/metabot-id nil
- metabot-v3.settings/ai-service-profile-id nil]
- (let [metabot-id (metabot-v3.config/resolve-dynamic-metabot-id nil)
- profile-id (metabot-v3.config/resolve-dynamic-profile-id nil metabot-id)]
- (is (= metabot-v3.config/internal-metabot-id metabot-id))
- (is (= "internal" profile-id))))))))
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/models/metabot_use_case_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/models/metabot_use_case_test.clj
new file mode 100644
index 00000000000..4d525a743dc
--- /dev/null
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/models/metabot_use_case_test.clj
@@ -0,0 +1,27 @@
+(ns metabase-enterprise.metabot-v3.models.metabot-use-case-test
+ (:require
+ [clojure.test :refer :all]
+ [metabase-enterprise.metabot-v3.config :as metabot-v3.config]
+ [metabase.test :as mt]
+ [metabase.test.fixtures :as fixtures]))
+
+(use-fixtures :once (fixtures/initialize :db))
+
+(deftest resolve-profile-test
+ (mt/with-temp [:model/Metabot {metabot-id :id} {:name "Test Metabot"}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "nlq" :profile "internal" :enabled true}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "sql" :profile "internal" :enabled true}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "transforms" :profile "transforms_codegen" :enabled true}
+ :model/MetabotUseCase _ {:metabot_id metabot-id :name "omnibot" :profile "internal" :enabled true}]
+ (testing "resolves profile from use case in DB"
+ (is (= "internal" (metabot-v3.config/resolve-profile metabot-id "nlq" nil)))
+ (is (= "internal" (metabot-v3.config/resolve-profile metabot-id "sql" nil)))
+ (is (= "transforms_codegen" (metabot-v3.config/resolve-profile metabot-id "transforms" nil)))
+ (is (= "internal" (metabot-v3.config/resolve-profile metabot-id "omnibot" nil))))
+
+ (testing "profile override takes precedence"
+ (is (= "custom-profile" (metabot-v3.config/resolve-profile metabot-id "nlq" "custom-profile")))
+ (is (= "custom-profile" (metabot-v3.config/resolve-profile metabot-id "transforms" "custom-profile"))))
+
+ (testing "returns nil for unknown use case"
+ (is (nil? (metabot-v3.config/resolve-profile metabot-id "unknown-use-case" nil))))))
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/deftool_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/deftool_test.clj
index 4b8d083cef9..e49e0135d79 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/deftool_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/deftool_test.clj
@@ -8,22 +8,24 @@
;;; ---------------------------------------------------- invoke-tool tests ----------------------------------------------------
(deftest ^:parallel invoke-tool-no-args-test
- (testing "invoke-tool with no arguments schema passes metabot-id in args"
+ (testing "invoke-tool with no arguments schema passes metabot-id and use-case in args"
(let [received-args (atom nil)
handler (fn [args]
(reset! received-args args)
{:structured_output {:message "hello"}})
body {:conversation_id "conv-123"}
- request {:metabot-v3/metabot-id "bot-456"}
+ request {:metabot-v3/metabot-id "bot-456"
+ :headers {"x-metabot-use-case" "transforms"}}
opts {:api-name :test-tool
:handler handler
:result-schema nil}
result (deftool/invoke-tool body request opts)]
- (is (= {:metabot-id "bot-456"} @received-args) "Handler should receive metabot-id in args")
+ (is (= {:metabot-id "bot-456" :use-case "transforms"} @received-args)
+ "Handler should receive metabot-id and use-case in args")
(is (= "conv-123" (:conversation_id result)))
(is (= {:message "hello"} (:structured_output result)))))
- (testing "invoke-tool with no arguments schema and no metabot-id"
+ (testing "invoke-tool with no arguments schema and no metabot-id defaults use-case to omnibot"
(let [received-args (atom nil)
handler (fn [args]
(reset! received-args args)
@@ -34,7 +36,8 @@
:handler handler
:result-schema nil}
result (deftool/invoke-tool body request opts)]
- (is (= {} @received-args) "Handler should receive empty args when no metabot-id")
+ (is (= {:use-case "omnibot"} @received-args)
+ "Handler should receive default use-case when no metabot-id or header")
(is (= "conv-123" (:conversation_id result))))))
(deftest ^:parallel invoke-tool-with-args-test
@@ -49,14 +52,15 @@
{:structured_output {:processed true}})
body {:arguments {:user_id 42}
:conversation_id "conv-456"}
- request {:metabot-v3/metabot-id "bot-789"}
+ request {:metabot-v3/metabot-id "bot-789"
+ :headers {"x-metabot-use-case" "nlq"}}
opts {:api-name :test-tool
:args-schema ::test-args
:handler handler
:result-schema nil}
result (deftool/invoke-tool body request opts)]
- (is (= {:user-id 42, :metabot-id "bot-789"} @received-args)
- "Arguments should be encoded with schema transformer and include metabot-id")
+ (is (= {:user-id 42 :metabot-id "bot-789" :use-case "nlq"} @received-args)
+ "Arguments should be encoded with schema transformer and include metabot-id and use-case")
(is (= "conv-456" (:conversation_id result))))))
(deftest ^:parallel invoke-tool-with-result-decoding-test
diff --git a/enterprise/backend/test/metabase_enterprise/serialization/models/entity_id_test.clj b/enterprise/backend/test/metabase_enterprise/serialization/models/entity_id_test.clj
index 80f895e0f62..2c8fdc3d660 100644
--- a/enterprise/backend/test/metabase_enterprise/serialization/models/entity_id_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/serialization/models/entity_id_test.clj
@@ -116,7 +116,7 @@
(testing "All exported models should get entity id except those with other unique property (like name)"
(is (= (set (concat serdes.models/exported-models
;; those are inline models which still have entity_id
- ["DashboardCard" "DashboardTab" "Dimension" "MetabotPrompt"]))
+ ["DashboardCard" "DashboardTab" "Dimension" "MetabotPrompt" "MetabotUseCase"]))
(set (->> (concat entity-id-models
entities-external-name)
(map name))))))
diff --git a/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj b/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj
index b07edf89150..aa6edd6e4af 100644
--- a/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj
@@ -1891,8 +1891,9 @@
ser))
(is (not (contains? ser :id)))
- (testing "metabot depends on its model entities"
- (is (= #{[{:model "Card" :id model-eid}]}
+ (testing "metabot depends on its model entities and collection"
+ (is (= #{[{:model "Card" :id model-eid}]
+ [{:model "Collection" :id coll-eid}]}
(set (serdes/dependencies ser))))))))))
(deftest metabot-collection-test
@@ -1938,8 +1939,9 @@
ser))
(is (not (contains? ser :id)))
- (testing "metabot depends on its prompts' cards"
- (is (= #{[{:model "Card" :id card-eid}]}
+ (testing "metabot depends on its prompts' cards and collection"
+ (is (= #{[{:model "Card" :id card-eid}]
+ [{:model "Collection" :id coll-eid}]}
(set (serdes/dependencies ser))))))))))
(deftest document-test
diff --git a/enterprise/frontend/src/metabase-enterprise/api/metabot.ts b/enterprise/frontend/src/metabase-enterprise/api/metabot.ts
index 82cf5c90e4e..1d149c64bc5 100644
--- a/enterprise/frontend/src/metabase-enterprise/api/metabot.ts
+++ b/enterprise/frontend/src/metabase-enterprise/api/metabot.ts
@@ -28,7 +28,7 @@ export const metabotApi = EnterpriseApi.injectEndpoints({
MetabotInfo,
{ id: MetabotId } & Partial<
Pick<MetabotInfo, "use_verified_content" | "collection_id">
- >
+ > & { use_cases?: Array<{ id: number; enabled?: boolean }> }
>({
query: ({ id, ...updates }) => ({
method: "PUT",
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/state/selectors.ts b/enterprise/frontend/src/metabase-enterprise/metabot/state/selectors.ts
index 67fc7bfbba9..ebb9270e94a 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/state/selectors.ts
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/state/selectors.ts
@@ -136,31 +136,28 @@ export const getProfileOverride = createSelector(
(metabot) => metabot.experimental.profileOverride,
);
-export const getProfile = createSelector(
- getProfileOverride,
+export const getUseCase = createSelector(
getLocation,
- (profileOverride, location) => {
- if (profileOverride) {
- return profileOverride;
- }
-
+ (location): "transforms" | "omnibot" => {
return location.pathname.startsWith(Urls.transformList())
- ? "transforms_codegen"
- : undefined;
+ ? "transforms"
+ : "omnibot";
},
);
export const getAgentRequestMetadata = createSelector(
getHistory,
getMetabotState,
- getProfile,
- (history, state, profile) => ({
+ getUseCase,
+ getProfileOverride,
+ (history, state, useCase, profileOverride) => ({
state,
// NOTE: need end to end support for ids on messages as BE will error if ids are present
history: history.map((h) =>
h.id && h.id.startsWith(`msg_`) ? _.omit(h, "id") : h,
),
- ...(profile ? { profile_id: profile } : {}),
+ use_case: useCase,
+ ...(profileOverride ? { profile_id: profileOverride } : {}),
}),
);
diff --git a/frontend/src/metabase-types/api/metabot.ts b/frontend/src/metabase-types/api/metabot.ts
index 00de7c70814..02897e00275 100644
--- a/frontend/src/metabase-types/api/metabot.ts
+++ b/frontend/src/metabase-types/api/metabot.ts
@@ -138,12 +138,20 @@ export type MetabotEntityInfo =
/* Metabot v3 - API Request Types */
+export type MetabotUseCase =
+ | "omnibot"
+ | "transforms"
+ | "nlq"
+ | "sql"
+ | "embedding";
+
export type MetabotAgentRequest = {
message: string;
context: MetabotChatContext;
history: MetabotHistory;
state: MetabotStateContext;
conversation_id: string; // uuid
+ use_case: MetabotUseCase;
metabot_id?: string;
profile_id?: string;
};
@@ -211,6 +219,13 @@ export interface MetabotFeedback {
export type MetabotId = number;
export type MetabotName = string;
+export type MetabotUseCaseInfo = {
+ id: number;
+ name: MetabotUseCase;
+ profile: string;
+ enabled: boolean;
+};
+
export type MetabotInfo = {
id: MetabotId;
entity_id: string;
@@ -218,6 +233,7 @@ export type MetabotInfo = {
description: string;
use_verified_content: boolean;
collection_id: number | null;
+ use_cases: MetabotUseCaseInfo[];
created_at: string;
updated_at: string;
};
diff --git a/frontend/src/metabase-types/api/mocks/metabot.ts b/frontend/src/metabase-types/api/mocks/metabot.ts
index e205b664596..337d6df8e0c 100644
--- a/frontend/src/metabase-types/api/mocks/metabot.ts
+++ b/frontend/src/metabase-types/api/mocks/metabot.ts
@@ -9,6 +9,7 @@ export const createMockMetabotInfo = (
description: "",
use_verified_content: false,
collection_id: null,
+ use_cases: [],
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
...opts,
diff --git a/resources/migrations/058_update_migrations.yaml b/resources/migrations/058_update_migrations.yaml
index 4814924684d..e447b041860 100644
--- a/resources/migrations/058_update_migrations.yaml
+++ b/resources/migrations/058_update_migrations.yaml
@@ -1,5 +1,6 @@
databaseChangeLog:
- objectQuotingStrategy: QUOTE_ALL_OBJECTS
+
- changeSet:
id: v58.2025-10-30T09:03:00
author: sanex3339
@@ -893,6 +894,7 @@ databaseChangeLog:
remarks: JSON object containing custom tenant attributes
constraints:
nullable: true
+
- changeSet:
id: v58.2025-11-18T12:31:54
author: johnswanson
@@ -1138,7 +1140,6 @@ databaseChangeLog:
constraints:
nullable: true
-
- changeSet:
id: v58.2025-12-05T17:41:54
author: ranquild
@@ -1191,6 +1192,212 @@ databaseChangeLog:
path: instance_analytics_views/tables/v1/h2-tables.sql
relativeToChangelogFile: true
+ - changeSet:
+ id: v58.2025-12-10T16:00:00
+ author: noahmoss
+ comment: Create metabot_use_case table
+ changes:
+ - createTable:
+ tableName: metabot_use_case
+ remarks: Use cases available for a metabot instance
+ columns:
+ - column:
+ name: id
+ type: int
+ autoIncrement: true
+ remarks: Unique identifier for the use case
+ constraints:
+ primaryKey: true
+ nullable: false
+ - column:
+ name: metabot_id
+ type: int
+ remarks: The metabot this use case belongs to
+ constraints:
+ nullable: false
+ - column:
+ name: entity_id
+ type: char(21)
+ remarks: Random NanoID tag for entity
+ constraints:
+ nullable: true
+ - column:
+ name: name
+ type: varchar(255)
+ remarks: The name of the use case (e.g., nlq, sql, transforms, omnibot, embedding)
+ constraints:
+ nullable: false
+ - column:
+ name: profile
+ type: varchar(255)
+ remarks: The AI service profile to use for this use case
+ constraints:
+ nullable: false
+ - column:
+ name: enabled
+ type: ${boolean.type}
+ remarks: Whether this use case is enabled
+ defaultValueBoolean: true
+ constraints:
+ nullable: false
+ - column:
+ name: created_at
+ type: ${timestamp_type}
+ remarks: Timestamp when this use case was created
+ defaultValueComputed: current_timestamp
+ constraints:
+ nullable: false
+ - column:
+ name: updated_at
+ type: ${timestamp_type}
+ remarks: Timestamp when this use case was last updated
+ defaultValueComputed: current_timestamp
+ constraints:
+ nullable: false
+ rollback:
+ - dropTable:
+ tableName: metabot_use_case
+
+ - changeSet:
+ id: v58.2025-12-10T16:01:00
+ author: noahmoss
+ comment: Add index on metabot_use_case.metabot_id
+ changes:
+ - createIndex:
+ tableName: metabot_use_case
+ indexName: idx_metabot_use_case_metabot_id
+ columns:
+ - column:
+ name: metabot_id
+ rollback:
+ - dropIndex:
+ tableName: metabot_use_case
+ indexName: idx_metabot_use_case_metabot_id
+
+ - changeSet:
+ id: v58.2025-12-10T16:02:00
+ author: noahmoss
+ comment: Add unique constraint on metabot_use_case (metabot_id, name)
+ changes:
+ - addUniqueConstraint:
+ tableName: metabot_use_case
+ columnNames: metabot_id, name
+ constraintName: unique_metabot_use_case_metabot_id_name
+ rollback:
+ - dropUniqueConstraint:
+ tableName: metabot_use_case
+ constraintName: unique_metabot_use_case_metabot_id_name
+
+ - changeSet:
+ id: v58.2025-12-10T16:03:00
+ author: noahmoss
+ comment: Add unique constraint on metabot_use_case.entity_id
+ changes:
+ - addUniqueConstraint:
+ tableName: metabot_use_case
+ columnNames: entity_id
+ constraintName: metabot_use_case_entity_id_key
+ rollback:
+ - dropUniqueConstraint:
+ tableName: metabot_use_case
+ constraintName: metabot_use_case_entity_id_key
+
+ - changeSet:
+ id: v58.2025-12-10T16:04:00
+ author: noahmoss
+ comment: Add foreign key constraint on metabot_use_case.metabot_id
+ changes:
+ - addForeignKeyConstraint:
+ baseTableName: metabot_use_case
+ baseColumnNames: metabot_id
+ constraintName: fk_metabot_use_case_metabot_id
+ referencedTableName: metabot
+ referencedColumnNames: id
+ onDelete: CASCADE
+ rollback:
+ - dropForeignKeyConstraint:
+ baseTableName: metabot_use_case
+ constraintName: fk_metabot_use_case_metabot_id
+
+ - changeSet:
+ id: v58.2025-12-10T16:05:00
+ author: noahmoss
+ comment: Create default use cases for internal metabot
+ preConditions:
+ - onFail: MARK_RAN
+ - sqlCheck:
+ expectedResult: 0
+ sql: >-
+ SELECT COUNT(*) FROM metabot_use_case
+ WHERE metabot_id = (SELECT id FROM metabot WHERE entity_id = 'metabotmetabotmetabot');
+ changes:
+ - sql:
+ sql: >-
+ INSERT INTO metabot_use_case (metabot_id, entity_id, name, profile, enabled, created_at, updated_at)
+ VALUES
+ ((SELECT id FROM metabot WHERE entity_id = 'metabotmetabotmetabot'), 'usecasenlqinternal000', 'nlq', 'internal', true, now(), now())
+ , ((SELECT id FROM metabot WHERE entity_id = 'metabotmetabotmetabot'), 'usecasesqlinternal000', 'sql', 'internal', true, now(), now())
+ , ((SELECT id FROM metabot WHERE entity_id = 'metabotmetabotmetabot'), 'usecasetransforms000', 'transforms', 'transforms_codegen', true, now(), now())
+ , ((SELECT id FROM metabot WHERE entity_id = 'metabotmetabotmetabot'), 'usecaseomnibot000000', 'omnibot', 'internal', true, now(), now());
+ rollback:
+ - sql:
+ sql: >-
+ DELETE FROM metabot_use_case
+ WHERE metabot_id = (SELECT id FROM metabot WHERE entity_id = 'metabotmetabotmetabot');
+
+ - changeSet:
+ id: v58.2025-12-10T16:06:00
+ author: noahmoss
+ comment: Create default use cases for embedded metabot
+ preConditions:
+ - onFail: MARK_RAN
+ - sqlCheck:
+ expectedResult: 0
+ sql: >-
+ SELECT COUNT(*) FROM metabot_use_case
+ WHERE metabot_id = (SELECT id FROM metabot WHERE entity_id = 'embeddedmetabotmetabo');
+ changes:
+ - sql:
+ sql: >-
+ INSERT INTO metabot_use_case (metabot_id, entity_id, name, profile, enabled, created_at, updated_at)
+ VALUES
+ ((SELECT id FROM metabot WHERE entity_id = 'embeddedmetabotmetabo'), 'usecaseembedding0000', 'embedding', 'embedding', true, now(), now());
+ rollback:
+ - sql:
+ sql: >-
+ DELETE FROM metabot_use_case
+ WHERE metabot_id = (SELECT id FROM metabot WHERE entity_id = 'embeddedmetabotmetabo');
+
+ - changeSet:
+ id: v58.2025-12-10T16:07:00
+ author: noahmoss
+ comment: Add use_case column to metabot_message
+ changes:
+ - addColumn:
+ tableName: metabot_message
+ columns:
+ - column:
+ name: use_case
+ type: ${text.type}
+ remarks: Name of the use case this message belongs to
+ constraints:
+ nullable: true
+
+ - changeSet:
+ id: v58.2025-12-10T16:08:00
+ author: noahmoss
+ comment: Make profile_id nullable on metabot_message
+ changes:
+ - dropNotNullConstraint:
+ tableName: metabot_message
+ columnName: profile_id
+ columnDataType: ${text.type}
+ rollback:
+ - addNotNullConstraint:
+ tableName: metabot_message
+ columnName: profile_id
+ columnDataType: ${text.type}
+
# >>>>>>>>>> DO NOT ADD NEW MIGRATIONS BELOW THIS LINE! ADD THEM ABOVE <<<<<<<<<<
########################################################################################################################
diff --git a/src/metabase/cmd/copy.clj b/src/metabase/cmd/copy.clj
index fe6f14ebad6..0774413d496 100644
--- a/src/metabase/cmd/copy.clj
+++ b/src/metabase/cmd/copy.clj
@@ -128,7 +128,8 @@
:model/Metabot
:model/MetabotConversation
:model/MetabotMessage
- :model/MetabotPrompt])))
+ :model/MetabotPrompt
+ :model/MetabotUseCase])))
(defn- objects->colums+values
"Given a sequence of objects/rows fetched from the H2 DB, return a the `columns` that should be used in the `INSERT`
diff --git a/src/metabase/models/resolution.clj b/src/metabase/models/resolution.clj
index f411236f3ae..1d2f1171f4a 100644
--- a/src/metabase/models/resolution.clj
+++ b/src/metabase/models/resolution.clj
@@ -55,6 +55,7 @@
:model/MetabotConversation metabase-enterprise.metabot-v3.models.metabot-conversation
:model/MetabotMessage metabase-enterprise.metabot-v3.models.metabot-message
:model/MetabotPrompt metabase-enterprise.metabot-v3.models.metabot-prompt
+ :model/MetabotUseCase metabase-enterprise.metabot-v3.models.metabot-use-case
:model/ModelIndex metabase.indexed-entities.models.model-index
:model/ModelIndexValue metabase.indexed-entities.models.model-index
:model/ModerationReview metabase.content-verification.models.moderation-review
diff --git a/test_resources/serialization_baseline/collections/gQuHAIM4C-7fToHzHyNNQ_ai_model/metabots/gr1EkP92whbdA_TKQljLU.yaml b/test_resources/serialization_baseline/collections/gQuHAIM4C-7fToHzHyNNQ_ai_model/metabots/gr1EkP92whbdA_TKQljLU.yaml
index dbf1da8a685..38c184023fa 100644
--- a/test_resources/serialization_baseline/collections/gQuHAIM4C-7fToHzHyNNQ_ai_model/metabots/gr1EkP92whbdA_TKQljLU.yaml
+++ b/test_resources/serialization_baseline/collections/gQuHAIM4C-7fToHzHyNNQ_ai_model/metabots/gr1EkP92whbdA_TKQljLU.yaml
@@ -19,4 +19,5 @@ prompts:
model: Metabot
- id: U4V5PzzpaMasl1Kt9BvNy
model: MetabotPrompt
+use_cases: []
use_verified_content: false
diff --git a/test_resources/serialization_baseline/collections/metabots/CyLr7tYRKiOoTWlcbl36q.yaml b/test_resources/serialization_baseline/collections/metabots/CyLr7tYRKiOoTWlcbl36q.yaml
index 0df80bf204a..eb6bf1d5fd5 100644
--- a/test_resources/serialization_baseline/collections/metabots/CyLr7tYRKiOoTWlcbl36q.yaml
+++ b/test_resources/serialization_baseline/collections/metabots/CyLr7tYRKiOoTWlcbl36q.yaml
@@ -8,4 +8,5 @@ serdes/meta:
model: Metabot
collection_id: null
prompts: []
+use_cases: []
use_verified_content: false
diff --git a/test_resources/serialization_baseline/collections/metabots/OYeHvLi8mMGwwMwJpetYw.yaml b/test_resources/serialization_baseline/collections/metabots/OYeHvLi8mMGwwMwJpetYw.yaml
index ad0c551c368..27a1212ffc8 100644
--- a/test_resources/serialization_baseline/collections/metabots/OYeHvLi8mMGwwMwJpetYw.yaml
+++ b/test_resources/serialization_baseline/collections/metabots/OYeHvLi8mMGwwMwJpetYw.yaml
@@ -19,4 +19,5 @@ prompts:
model: Metabot
- id: SNoFh7dZXzjvgeNp5aJJY
model: MetabotPrompt
+use_cases: []
use_verified_content: false
diff --git a/test_resources/serialization_baseline/collections/metabots/embeddedmetabotmetabo.yaml b/test_resources/serialization_baseline/collections/metabots/embeddedmetabotmetabo.yaml
index 6b48e040af9..db08fb1d37c 100644
--- a/test_resources/serialization_baseline/collections/metabots/embeddedmetabotmetabo.yaml
+++ b/test_resources/serialization_baseline/collections/metabots/embeddedmetabotmetabo.yaml
@@ -8,4 +8,5 @@ serdes/meta:
model: Metabot
collection_id: null
prompts: []
+use_cases: []
use_verified_content: false
diff --git a/test_resources/serialization_baseline/collections/metabots/metabotmetabotmetabot.yaml b/test_resources/serialization_baseline/collections/metabots/metabotmetabotmetabot.yaml
index 95221febb71..db34fc4027c 100644
--- a/test_resources/serialization_baseline/collections/metabots/metabotmetabotmetabot.yaml
+++ b/test_resources/serialization_baseline/collections/metabots/metabotmetabotmetabot.yaml
@@ -8,4 +8,5 @@ serdes/meta:
model: Metabot
collection_id: null
prompts: []
+use_cases: []
use_verified_content: false
diff --git a/test_resources/serialization_baseline/collections/metabots/zXxMBaxni6nRGRhD7vmPc.yaml b/test_resources/serialization_baseline/collections/metabots/zXxMBaxni6nRGRhD7vmPc.yaml
index f8bfaa8c5a3..8240ae47a14 100644
--- a/test_resources/serialization_baseline/collections/metabots/zXxMBaxni6nRGRhD7vmPc.yaml
+++ b/test_resources/serialization_baseline/collections/metabots/zXxMBaxni6nRGRhD7vmPc.yaml
@@ -8,4 +8,5 @@ serdes/meta:
model: Metabot
collection_id: null
prompts: []
+use_cases: []
use_verified_content: false