Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetric

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

Overview

The metric used for evaluation runs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1EvaluationRunMetric

Returns a new instance of GoogleCloudAiplatformV1EvaluationRunMetric.



10898
10899
10900
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10898

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

Instance Attribute Details

#computation_based_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec

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

Returns:



10866
10867
10868
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10866

def computation_based_metric_spec
  @computation_based_metric_spec
end

#llm_based_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricLlmBasedMetricSpec

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

Returns:



10871
10872
10873
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10871

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) 


10876
10877
10878
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10876

def metric
  @metric
end

#metric_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Metric

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

Returns:



10881
10882
10883
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10881

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) 


10886
10887
10888
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10886

def metric_resource_name
  @metric_resource_name
end

#predefined_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec

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

Returns:



10891
10892
10893
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10891

def predefined_metric_spec
  @predefined_metric_spec
end

#rubric_based_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec

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

Returns:



10896
10897
10898
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10896

def rubric_based_metric_spec
  @rubric_based_metric_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10903
10904
10905
10906
10907
10908
10909
10910
10911
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10903

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