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.



4201
4202
4203
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4201

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) 


4173
4174
4175
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4173

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) 


4179
4180
4181
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4179

def candidate
  @candidate
end

#explanation ⇒ String

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

Returns:

  • (String) 


4184
4185
4186
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4184

def explanation
  @explanation
end

#metric ⇒ String

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

Returns:

  • (String) 


4189
4190
4191
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4189

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:



4194
4195
4196
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4194

def rubric_verdicts
  @rubric_verdicts
end

#score ⇒ Float

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

Returns:

  • (Float) 


4199
4200
4201
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4199

def score
  @score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4206
4207
4208
4209
4210
4211
4212
4213
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4206

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