feat: Display button to view evaluation results in an Ipython environment.

PiperOrigin-RevId: 715546506

Author: vertex-sdk-bot

google/cloud/aiplatform/utils/_ipython_utils.py

@@ -17,6 +17,7 @@
 
 import sys
 import typing
+import urllib
 from uuid import uuid4
 from typing import Optional
 
@@ -266,3 +267,18 @@ def display_browse_prebuilt_metrics_button() -> None:
         "https://cloud.google.com/vertex-ai/generative-ai/docs/models/metrics-templates"
     )
     display_link("Browse pre-built metrics", uri, "list")
+
+
+def display_gen_ai_evaluation_results_button(
+    gcs_file_path: Optional[str] = None,
+) -> None:
+    """Function to generate a link bound to the Gen AI evaluation run."""
+    if not is_ipython_available():
+        return
+
+    uri = "https://cloud.google.com/vertex-ai/generative-ai/docs/models/view-evaluation"
+    if gcs_file_path is not None:
+        gcs_file_path = urllib.parse.quote(gcs_file_path)
+        uri = f"https://console.cloud.google.com/storage/browser/_details/{gcs_file_path};colab_enterprise=gen_ai_evaluation"
+
+    display_link("View evaluation results", uri, "bar_chart")

vertexai/evaluation/utils.py

@@ -29,6 +29,7 @@
 from google.cloud.aiplatform import compat
 from google.cloud.aiplatform import initializer
 from google.cloud.aiplatform import utils
+from google.cloud.aiplatform.utils import _ipython_utils
 from google.cloud.aiplatform_v1.services import (
     evaluation_service as gapic_evaluation_services,
 )
@@ -295,12 +296,16 @@ def upload_evaluation_results(
         file_name: File name to store the data.
     """
     if not destination_uri_prefix:
+        _ipython_utils.display_gen_ai_evaluation_results_button()
         return
     if destination_uri_prefix.startswith(_GCS_PREFIX):
         _, extension = os.path.splitext(file_name)
         file_type = extension.lower()[1:]
         output_path = destination_uri_prefix + "/" + file_name
         _upload_pandas_df_to_gcs(dataset, output_path, file_type)
+        _ipython_utils.display_gen_ai_evaluation_results_button(
+            output_path.split(_GCS_PREFIX)[1]
+        )
     else:
         raise ValueError(
             f"Unsupported destination URI: {destination_uri_prefix}."