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.



4766
4767
4768
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4766

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) 


4728
4729
4730
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4728

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) 


4734
4735
4736
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4734

def candidate
  @candidate
end

#error ⇒ Google::Apis::AiplatformV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



4744
4745
4746
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4744

def error
  @error
end

#explanation ⇒ String

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

Returns:

  • (String) 


4749
4750
4751
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4749

def explanation
  @explanation
end

#metric ⇒ String

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

Returns:

  • (String) 


4754
4755
4756
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4754

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:



4759
4760
4761
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4759

def rubric_verdicts
  @rubric_verdicts
end

#score ⇒ Float

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

Returns:

  • (Float) 


4764
4765
4766
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4764

def score
  @score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4771
4772
4773
4774
4775
4776
4777
4778
4779
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4771

def update!(**args)
  @additional_results = args[:additional_results] if args.key?(:additional_results)
  @candidate = args[:candidate] if args.key?(:candidate)
  @error = args[:error] if args.key?(:error)
  @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