Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CandidateResult

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

Result for a single candidate.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1CandidateResult

Returns a new instance of GoogleCloudAiplatformV1CandidateResult.



3851
3852
3853
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3851

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

Instance Attribute Details

#additional_results ⇒ Object

Optional. Additional results for the metric. Corresponds to the JSON property additionalResults

Returns:

  • (Object) 


3823
3824
3825
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3823

def additional_results
  @additional_results
end

#candidate ⇒ String

Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. Corresponds to the JSON property candidate

Returns:

  • (String) 


3829
3830
3831
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3829

def candidate
  @candidate
end

#explanation ⇒ String

Optional. The explanation for the metric. Corresponds to the JSON property explanation

Returns:

  • (String) 


3834
3835
3836
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3834

def explanation
  @explanation
end

#metric ⇒ String

Required. The metric that was evaluated. Corresponds to the JSON property metric

Returns:

  • (String) 


3839
3840
3841
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3839

def metric
  @metric
end

#rubric_verdicts ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricVerdict>

Optional. The rubric verdicts for the metric. Corresponds to the JSON property rubricVerdicts

Returns:



3844
3845
3846
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3844

def rubric_verdicts
  @rubric_verdicts
end

#score ⇒ Float

Optional. The score for the metric. Corresponds to the JSON property score

Returns:

  • (Float) 


3849
3850
3851
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3849

def score
  @score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3856
3857
3858
3859
3860
3861
3862
3863
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 3856

def update!(**args)
  @additional_results = args[:additional_results] if args.key?(:additional_results)
  @candidate = args[:candidate] if args.key?(:candidate)
  @explanation = args[:explanation] if args.key?(:explanation)
  @metric = args[:metric] if args.key?(:metric)
  @rubric_verdicts = args[:rubric_verdicts] if args.key?(:rubric_verdicts)
  @score = args[:score] if args.key?(:score)
end