feat: Add metric_resource_name to evaluation types and methods

PiperOrigin-RevId: 877145985

Author: vertex-sdk-bot

vertexai/_genai/evals.py

@@ -309,6 +309,12 @@ def _EvaluationRunMetric_from_vertex(
             ["metric_config"],
             _UnifiedMetric_from_vertex(getv(from_object, ["metricConfig"]), to_object),
         )
+    if getv(from_object, ["metricResourceName"]) is not None:
+        setv(
+            to_object,
+            ["metric_resource_name"],
+            getv(from_object, ["metricResourceName"]),
+        )
 
     return to_object
 
@@ -327,6 +333,12 @@ def _EvaluationRunMetric_to_vertex(
             ["metricConfig"],
             _UnifiedMetric_to_vertex(getv(from_object, ["metric_config"]), to_object),
         )
+    if getv(from_object, ["metric_resource_name"]) is not None:
+        setv(
+            to_object,
+            ["metricResourceName"],
+            getv(from_object, ["metric_resource_name"]),
+        )
 
     return to_object
 
@@ -415,6 +427,12 @@ def _GenerateInstanceRubricsRequest_to_vertex(
                 getv(from_object, ["rubric_generation_spec"]), to_object
             ),
         )
+    if getv(from_object, ["metric_resource_name"]) is not None:
+        setv(
+            to_object,
+            ["metricResourceName"],
+            getv(from_object, ["metric_resource_name"]),
+        )
 
     if getv(from_object, ["config"]) is not None:
         setv(to_object, ["config"], getv(from_object, ["config"]))
@@ -574,6 +592,12 @@ def _RubricGenerationSpec_to_vertex(
             ["rubricTypeOntology"],
             getv(from_object, ["rubric_type_ontology"]),
         )
+    if getv(from_object, ["metric_resource_name"]) is not None:
+        setv(
+            to_object,
+            ["metricResourceName"],
+            getv(from_object, ["metric_resource_name"]),
+        )
 
     return to_object
 
@@ -949,6 +973,7 @@ def _generate_rubrics(
         self,
         *,
         contents: list[genai_types.ContentOrDict],
+        metric_resource_name: Optional[str] = None,
         predefined_rubric_generation_spec: Optional[
             types.PredefinedMetricSpecOrDict
         ] = None,
@@ -963,6 +988,7 @@ def _generate_rubrics(
             contents=contents,
             predefined_rubric_generation_spec=predefined_rubric_generation_spec,
             rubric_generation_spec=rubric_generation_spec,
+            metric_resource_name=metric_resource_name,
             config=config,
         )
 
@@ -1463,6 +1489,7 @@ def generate_rubrics(
         generator_model_config: Optional["genai_types.AutoraterConfigOrDict"] = None,
         rubric_content_type: Optional["types.RubricContentType"] = None,
         rubric_type_ontology: Optional[list[str]] = None,
+        metric_resource_name: Optional[str] = None,
         predefined_spec_name: Optional[Union[str, "types.PrebuiltMetric"]] = None,
         metric_spec_parameters: Optional[dict[str, Any]] = None,
         config: Optional[types.RubricGenerationConfigOrDict] = None,
@@ -1498,6 +1525,7 @@ def generate_rubrics(
               generated. Only used if `prompt_template` is provided.
             rubric_type_ontology: Optional. A pre-defined list of allowed types
               for generated rubrics. Only used if `prompt_template` is provided.
+            metric_resource_name: Optional. The resource name of the metric definition.
             predefined_spec_name: Optional. The name of a Predefined Metric to use
                 for rubric generation (e.g., "general_quality_v1") or a types.PrebuiltMetric object.
                 Mutually exclusive with `prompt_template` and its related parameters.
@@ -1601,6 +1629,8 @@ def generate_rubrics(
             }
             spec_dict = {k: v for k, v in spec_dict.items() if v is not None}
             rubric_gen_spec = types.RubricGenerationSpec.model_validate(spec_dict)
+        elif metric_resource_name:
+            pass
         else:
             raise ValueError(
                 "Either predefined_spec_name or prompt_template must be provided."
@@ -1626,6 +1656,7 @@ def generate_rubrics(
                     contents=contents,
                     rubric_generation_spec=rubric_gen_spec,
                     predefined_rubric_generation_spec=predefined_spec,
+                    metric_resource_name=metric_resource_name,
                     config=config,
                 )
                 rubric_group = {rubric_group_name: response.generated_rubrics}

vertexai/_genai/types/common.py

@@ -2261,6 +2261,10 @@ class RubricGenerationSpec(_common.BaseModel):
       If this field is provided, it implies `include_rubric_type` should be true,
       and the generated rubric types should be chosen from this ontology.""",
     )
+    metric_resource_name: Optional[str] = Field(
+        default=None,
+        description="""The resource name of the metric definition.""",
+    )
 
 
 class RubricGenerationSpecDict(TypedDict, total=False):
@@ -2283,6 +2287,8 @@ class RubricGenerationSpecDict(TypedDict, total=False):
       If this field is provided, it implies `include_rubric_type` should be true,
       and the generated rubric types should be chosen from this ontology."""
 
+    metric_resource_name: Optional[str]
+
 
 RubricGenerationSpecOrDict = Union[RubricGenerationSpec, RubricGenerationSpecDict]
 
@@ -2469,6 +2475,10 @@ class EvaluationRunMetric(_common.BaseModel):
     metric_config: Optional[UnifiedMetric] = Field(
         default=None, description="""The unified metric used for evaluation run."""
     )
+    metric_resource_name: Optional[str] = Field(
+        default=None,
+        description="""The resource name of the metric definition.""",
+    )
 
 
 class EvaluationRunMetricDict(TypedDict, total=False):
@@ -2480,6 +2490,8 @@ class EvaluationRunMetricDict(TypedDict, total=False):
     metric_config: Optional[UnifiedMetricDict]
     """The unified metric used for evaluation run."""
 
+    metric_resource_name: Optional[str]
+
 
 EvaluationRunMetricOrDict = Union[EvaluationRunMetric, EvaluationRunMetricDict]
 
@@ -5249,6 +5261,10 @@ class _GenerateInstanceRubricsRequest(_common.BaseModel):
         default=None,
         description="""Specification for how the rubrics should be generated.""",
     )
+    metric_resource_name: Optional[str] = Field(
+        default=None,
+        description="""The resource name of the metric definition.""",
+    )
     config: Optional[RubricGenerationConfig] = Field(default=None, description="""""")
 
 
@@ -5269,6 +5285,7 @@ class _GenerateInstanceRubricsRequestDict(TypedDict, total=False):
     rubric_generation_spec: Optional[RubricGenerationSpecDict]
     """Specification for how the rubrics should be generated."""
 
+    metric_resource_name: Optional[str]
     config: Optional[RubricGenerationConfigDict]
     """"""