Skip to content

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

Bridge the gap between agent/mcp field types and representations field types format (#72547)

Alexander Polyankincf1ef102e725
diff --git a/src/metabase/agent_api/api.clj b/src/metabase/agent_api/api.clj
index 2fb353128b5..e80eb52e09e 100644
--- a/src/metabase/agent_api/api.clj
+++ b/src/metabase/agent_api/api.clj
@@ -61,19 +61,18 @@
;; - Use :encode/api transformers to convert kebab-case data from internal functions
;; - Convert keyword enum values (like :table, :metric) to strings for JSON
-(mr/def ::field-type
- "A data type for a field derived from Metabase's type hierarchy."
- [:enum :boolean :date :datetime :time :number :string])
-
(mr/def ::field
"A field from a table or metric. The field_id format is '<prefix><entity-id>-<field-index>' where prefix indicates the source (t=table, c=metric) and index is the position in the entity's fields."
[:map {:encode/api #(update-keys % metabot.u/safe->snake_case_en)}
[:field_id :string]
[:name :string]
- [:type {:optional true} [:maybe ::field-type]]
+ [:display_name :string]
[:description {:optional true} [:maybe :string]]
- [:database_type {:optional true} [:maybe :string]]
+ [:base_type :string]
+ [:effective_type {:optional true} [:maybe :string]]
[:semantic_type {:optional true} [:maybe :string]]
+ [:database_type {:optional true} [:maybe :string]]
+ [:coercion_strategy {:optional true} [:maybe :string]]
[:field_values {:optional true} [:maybe [:sequential :any]]]])
(mr/def ::entity-type
diff --git a/src/metabase/agent_api/reference.md b/src/metabase/agent_api/reference.md
index 0a0baa2df81..cbb7ee5460f 100644
--- a/src/metabase/agent_api/reference.md
+++ b/src/metabase/agent_api/reference.md
@@ -135,10 +135,11 @@ Response:
{
"field_id": "t42-0",
"name": "ID",
- "type": "number",
+ "display_name": "ID",
"description": "Primary key",
- "database_type": "BIGINT",
+ "base_type": "type/BigInteger",
"semantic_type": "type/PK",
+ "database_type": "BIGINT",
"field_values": [1, 2, 3]
}
],
@@ -196,7 +197,8 @@ Response:
{
"field_id": "c10-0",
"name": "CREATED_AT",
- "type": "datetime"
+ "display_name": "Created At",
+ "base_type": "type/DateTime"
}
],
"segments": []
diff --git a/src/metabase/metabot/suggested_prompts.clj b/src/metabase/metabot/suggested_prompts.clj
index 883c4f542b2..2435f4c70f6 100644
--- a/src/metabase/metabot/suggested_prompts.clj
+++ b/src/metabase/metabot/suggested_prompts.clj
@@ -11,8 +11,10 @@
(set! *warn-on-reflection* true)
(defn- column-input
- [answer-source-column]
- (some-> answer-source-column (select-keys [:name :type :description :table-reference])))
+ [{:keys [base_type effective_type] :as answer-source-column}]
+ (some-> answer-source-column
+ (select-keys [:name :description :table-reference])
+ (assoc :type (or effective_type base_type))))
(defn- metric-input
[{:keys [queryable-dimensions default-time-dimension-field-id] :as answer-source-metric}]
diff --git a/src/metabase/metabot/tools/util.clj b/src/metabase/metabot/tools/util.clj
index d7667d8023a..2492b3a7e26 100644
--- a/src/metabase/metabot/tools/util.clj
+++ b/src/metabase/metabot/tools/util.clj
@@ -8,7 +8,6 @@
[metabase.lib-be.core :as lib-be]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
- [metabase.lib.types.isa :as lib.types.isa]
[metabase.premium-features.core :as premium-features]
[metabase.util :as u]
[metabase.util.log :as log]
@@ -24,18 +23,6 @@
status-code (assoc :status-code status-code))
(throw e))))
-(defn convert-field-type
- "Return tool type for `column`."
- [column]
- (let [column (u/normalize-map column)]
- (cond
- (lib.types.isa/boolean? column) :boolean
- (lib.types.isa/string-or-string-like? column) :string
- (lib.types.isa/numeric? column) :number
- (isa? (:effective-type column) :type/DateTime) :datetime
- (isa? (:effective-type column) :type/Time) :time
- (lib.types.isa/temporal? column) :date)))
-
(defn add-table-reference
"Add table-reference to columns that have FK relationships."
[query col]
@@ -69,16 +56,21 @@
"Return tool result columns for `column` of `query`. The position of `column` is determined by `index`.
The ID is then generated by prefixing the position with `field-id-prefix`."
[query column index field-id-prefix]
- (let [semantic-type (some-> (:semantic-type column) name u/->snake_case_en)]
+ (let [base-type (some-> (:base-type column) u/qualified-name)
+ effective-type (some-> (:effective-type column) u/qualified-name)
+ semantic-type (some-> (:semantic-type column) u/qualified-name)
+ coercion-strategy (some-> (:coercion-strategy column) u/qualified-name)]
(-> {:field_id (str field-id-prefix index)
;; Prefer desired-column-alias over source-column-alias to ensure we use deduplicated names if needed
:name (or (:lib/desired-column-alias column)
(:lib/source-column-alias column))
- :display_name (lib/display-name query column)
- :type (convert-field-type column)}
+ :display_name (lib/display-name query column)}
(m/assoc-some :description (:description column)
- :database_type (:database-type column)
+ :base_type base-type
+ :effective_type (when (not= effective-type base-type) effective-type)
:semantic_type semantic-type
+ :database_type (:database-type column)
+ :coercion_strategy coercion-strategy
:field_values (:field-values column)
:table_reference (:table-reference column)))))
diff --git a/test/metabase/agent_api/api_test.clj b/test/metabase/agent_api/api_test.clj
index f4f8eef28ed..4f223b40f0d 100644
--- a/test/metabase/agent_api/api_test.clj
+++ b/test/metabase/agent_api/api_test.clj
@@ -106,6 +106,36 @@
table (mt/user-http-request :rasta :get 200 (str "agent/v1/table/" table-id "?with-field-values=true"))]
(is (some #(seq (:field_values %)) (:fields table))))))
+(deftest get-table-details-field-types-test
+ (testing "Field metadata (base_type, effective_type, semantic_type, coercion_strategy) is returned correctly"
+ (mt/with-temp [:model/Database {db-id :id} {}
+ :model/Table {table-id :id} {:db_id db-id, :name "t", :active true}
+ :model/Field _ {:table_id table-id, :name "id"
+ :base_type :type/BigInteger
+ :semantic_type :type/PK}
+ :model/Field _ {:table_id table-id, :name "name"
+ :base_type :type/Text}
+ :model/Field _ {:table_id table-id, :name "created_at"
+ :base_type :type/Text
+ :effective_type :type/DateTime
+ :coercion_strategy :Coercion/ISO8601->DateTime}]
+ (let [fields (-> (mt/user-http-request :rasta :get 200 (str "agent/v1/table/" table-id))
+ :fields)
+ by-name (m/index-by :name fields)]
+ (testing "base_type is always set"
+ (is (= "type/BigInteger" (get-in by-name ["id" :base_type])))
+ (is (= "type/Text" (get-in by-name ["name" :base_type])))
+ (is (= "type/Text" (get-in by-name ["created_at" :base_type]))))
+ (testing "semantic_type is returned when set"
+ (is (= "type/PK" (get-in by-name ["id" :semantic_type])))
+ (is (nil? (get-in by-name ["name" :semantic_type]))))
+ (testing "effective_type and coercion_strategy are returned when coerced"
+ (is (= "type/DateTime" (get-in by-name ["created_at" :effective_type])))
+ (is (= "Coercion/ISO8601->DateTime" (get-in by-name ["created_at" :coercion_strategy]))))
+ (testing "effective_type is omitted when it equals base_type"
+ (is (not (contains? (get by-name "id") :effective_type)))
+ (is (not (contains? (get by-name "name") :effective_type))))))))
+
(deftest get-metric-details-test
(mt/with-temp [:model/Card metric {:name "Test Metric"
:type :metric
diff --git a/test/metabase/metabot/agent/messages_test.clj b/test/metabase/metabot/agent/messages_test.clj
index f88ad3b816d..6bd9c99a0e8 100644
--- a/test/metabase/metabot/agent/messages_test.clj
+++ b/test/metabase/metabot/agent/messages_test.clj
@@ -246,9 +246,9 @@
:database_id 2,
:name "orders",
:fields
- [{:field_id "t23-0" :name "id" :display_name "ID" :type :number :database_type "int4" :semantic_type "pk"}
- {:field_id "t24-0" :name "status" :display_name "Status" :type :number :database_type "int4"}
- {:field_id "t25-0" :name "total" :display_name "Total" :type :number :database_type "int4"}]
+ [{:field_id "t23-0" :name "id" :display_name "ID" :base_type "type/Integer" :database_type "int4" :semantic_type "type/PK"}
+ {:field_id "t24-0" :name "status" :display_name "Status" :base_type "type/Integer" :database_type "int4"}
+ {:field_id "t25-0" :name "total" :display_name "Total" :base_type "type/Integer" :database_type "int4"}]
:type :table
:database_schema "public",
:display_name "Orders"}],
diff --git a/test/metabase/metabot/table_utils_test.clj b/test/metabase/metabot/table_utils_test.clj
index 1c6591c9646..659f081448c 100644
--- a/test/metabase/metabot/table_utils_test.clj
+++ b/test/metabase/metabot/table_utils_test.clj
@@ -348,7 +348,7 @@
(is (every? #(= :table (:type %)) tables))
(is (every? #(every? (fn [field] (contains? field :field_id)) (:fields %)) tables))
(is (every? #(every? (fn [field] (contains? field :name)) (:fields %)) tables))
- (is (every? #(every? (fn [field] (contains? field :type)) (:fields %)) tables))
+ (is (every? #(every? (fn [field] (contains? field :base_type)) (:fields %)) tables))
(is (every? #(every? (fn [field] (contains? field :database_type)) (:fields %)) tables))
(is (every? #(contains? % :metrics) tables)))))