Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetric

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

The metric used for evaluation runs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1EvaluationRunMetric

Returns a new instance of GoogleCloudAiplatformV1beta1EvaluationRunMetric.



18352
18353
18354
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18352

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#computation_based_metric_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec

Specification for a computation based metric. Corresponds to the JSON property computationBasedMetricSpec

Returns:



18320
18321
18322
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18320

def computation_based_metric_spec
  @computation_based_metric_spec
end

#llm_based_metric_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricLlmBasedMetricSpec

Specification for an LLM based metric. Corresponds to the JSON property llmBasedMetricSpec

Returns:



18325
18326
18327
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18325

def llm_based_metric_spec
  @llm_based_metric_spec
end

#metric ⇒ String

Required. The name of the metric. Corresponds to the JSON property metric

Returns:

  • (String) 


18330
18331
18332
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18330

def metric
  @metric
end

#metric_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Metric

The metric used for running evaluations. Corresponds to the JSON property metricConfig

Returns:



18335
18336
18337
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18335

def metric_config
  @metric_config
end

#metric_resource_name ⇒ String

Optional. The resource name of the metric definition. Corresponds to the JSON property metricResourceName

Returns:

  • (String) 


18340
18341
18342
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18340

def metric_resource_name
  @metric_resource_name
end

#predefined_metric_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec

Specification for a pre-defined metric. Corresponds to the JSON property predefinedMetricSpec

Returns:



18345
18346
18347
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18345

def predefined_metric_spec
  @predefined_metric_spec
end

#rubric_based_metric_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec

Specification for a metric that is based on rubrics. Corresponds to the JSON property rubricBasedMetricSpec

Returns:



18350
18351
18352
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18350

def rubric_based_metric_spec
  @rubric_based_metric_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18357
18358
18359
18360
18361
18362
18363
18364
18365
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18357

def update!(**args)
  @computation_based_metric_spec = args[:computation_based_metric_spec] if args.key?(:computation_based_metric_spec)
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
  @metric = args[:metric] if args.key?(:metric)
  @metric_config = args[:metric_config] if args.key?(:metric_config)
  @metric_resource_name = args[:metric_resource_name] if args.key?(:metric_resource_name)
  @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
  @rubric_based_metric_spec = args[:rubric_based_metric_spec] if args.key?(:rubric_based_metric_spec)
end