feat: add bigquery.ml.get_insights function

Author: GarrettWu

bigframes/bigquery/_operations/ml.py

@@ -480,6 +480,39 @@ def generate_text(
         return session.read_gbq_query(sql)
 
 
+@log_adapter.method_logger(custom_base_name="bigquery_ml")
+def get_insights(
+    model: Union[bigframes.ml.base.BaseEstimator, str, pd.Series],
+) -> dataframe.DataFrame:
+    """
+    Gets insights from a BigQuery ML model.
+
+    See the `BigQuery ML GET_INSIGHTS function syntax
+    <https://cloud.google.com/bigquery/docs/reference/standard-sql/bigqueryml-syntax-get-insights>`_
+    for additional reference.
+
+    Args:
+        model (bigframes.ml.base.BaseEstimator, str, or pd.Series):
+            The model to get insights from.
+
+    Returns:
+        bigframes.pandas.DataFrame:
+            The insights.
+    """
+    import bigframes.pandas as bpd
+
+    model_name, session = utils.get_model_name_and_session(model)
+
+    sql = bigframes.core.sql.ml.get_insights(
+        model_name=model_name,
+    )
+
+    if session is None:
+        return bpd.read_gbq_query(sql)
+    else:
+        return session.read_gbq_query(sql)
+
+
 @log_adapter.method_logger(custom_base_name="bigquery_ml")
 def generate_embedding(
     model: Union[bigframes.ml.base.BaseEstimator, str, pd.Series],

bigframes/core/sql/ml.py

@@ -268,6 +268,16 @@ def generate_text(
     return sql
 
 
+def get_insights(
+    model_name: str,
+) -> str:
+    """Encode the ML.GET_INSIGHTS statement.
+    See https://cloud.google.com/bigquery/docs/reference/standard-sql/bigqueryml-syntax-get-insights for reference.
+    """
+    sql = f"SELECT * FROM ML.GET_INSIGHTS(MODEL {sqlglot_ir.identifier(model_name)})\n"
+    return sql
+
+
 def generate_embedding(
     model_name: str,
     table: str,