Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateInstancesRequest

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

Request message for EvaluationService.EvaluateInstances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1EvaluateInstancesRequest

Returns a new instance of GoogleCloudAiplatformV1EvaluateInstancesRequest.



9258
9259
9260
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9258

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

Instance Attribute Details

#autorater_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AutoraterConfig

The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. Corresponds to the JSON property autoraterConfig

Returns:



9069
9070
9071
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9069

def autorater_config
  @autorater_config
end

#bleu_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BleuInput

Input for bleu metric. Corresponds to the JSON property bleuInput

Returns:



9074
9075
9076
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9074

def bleu_input
  @bleu_input
end

#coherence_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CoherenceInput

Input for coherence metric. Corresponds to the JSON property coherenceInput

Returns:



9079
9080
9081
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9079

def coherence_input
  @coherence_input
end

#comet_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CometInput

Input for Comet metric. Corresponds to the JSON property cometInput

Returns:



9084
9085
9086
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9084

def comet_input
  @comet_input
end

#exact_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExactMatchInput

Input for exact match metric. Corresponds to the JSON property exactMatchInput

Returns:



9089
9090
9091
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9089

def exact_match_input
  @exact_match_input
end

#fluency_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FluencyInput

Input for fluency metric. Corresponds to the JSON property fluencyInput

Returns:



9094
9095
9096
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9094

def fluency_input
  @fluency_input
end

#fulfillment_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FulfillmentInput

Input for fulfillment metric. Corresponds to the JSON property fulfillmentInput

Returns:



9099
9100
9101
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9099

def fulfillment_input
  @fulfillment_input
end

#groundedness_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundednessInput

Input for groundedness metric. Corresponds to the JSON property groundednessInput

Returns:



9104
9105
9106
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9104

def groundedness_input
  @groundedness_input
end

#instance ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstance

A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations Corresponds to the JSON property instance

Returns:



9111
9112
9113
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9111

def instance
  @instance
end

#location ⇒ String

Required. The resource name of the Location to evaluate the instances. Format: projects/project/locations/location` Corresponds to the JSON propertylocation`

Returns:

  • (String) 


9117
9118
9119
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9117

def location
  @location
end

#metric_sources ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetricSource>

Optional. The metrics (either inline or registered) used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated. Corresponds to the JSON property metricSources

Returns:



9124
9125
9126
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9124

def metric_sources
  @metric_sources
end

#metrics ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Metric>

The metrics used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated. Corresponds to the JSON property metrics

Returns:



9131
9132
9133
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9131

def metrics
  @metrics
end

#metricx_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetricxInput

Input for MetricX metric. Corresponds to the JSON property metricxInput

Returns:



9136
9137
9138
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9136

def metricx_input
  @metricx_input
end

#pairwise_metric_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PairwiseMetricInput

Input for pairwise metric. Corresponds to the JSON property pairwiseMetricInput

Returns:



9141
9142
9143
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9141

def pairwise_metric_input
  @pairwise_metric_input
end

#pairwise_question_answering_quality_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput

Input for pairwise question answering quality metric. Corresponds to the JSON property pairwiseQuestionAnsweringQualityInput

Returns:



9146
9147
9148
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9146

def pairwise_question_answering_quality_input
  @pairwise_question_answering_quality_input
end

#pairwise_summarization_quality_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PairwiseSummarizationQualityInput

Input for pairwise summarization quality metric. Corresponds to the JSON property pairwiseSummarizationQualityInput

Returns:



9151
9152
9153
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9151

def pairwise_summarization_quality_input
  @pairwise_summarization_quality_input
end

#pointwise_metric_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PointwiseMetricInput

Input for pointwise metric. Corresponds to the JSON property pointwiseMetricInput

Returns:



9156
9157
9158
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9156

def pointwise_metric_input
  @pointwise_metric_input
end

#question_answering_correctness_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput

Input for question answering correctness metric. Corresponds to the JSON property questionAnsweringCorrectnessInput

Returns:



9161
9162
9163
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9161

def question_answering_correctness_input
  @question_answering_correctness_input
end

#question_answering_helpfulness_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput

Input for question answering helpfulness metric. Corresponds to the JSON property questionAnsweringHelpfulnessInput

Returns:



9166
9167
9168
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9166

def question_answering_helpfulness_input
  @question_answering_helpfulness_input
end

#question_answering_quality_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QuestionAnsweringQualityInput

Input for question answering quality metric. Corresponds to the JSON property questionAnsweringQualityInput

Returns:



9171
9172
9173
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9171

def question_answering_quality_input
  @question_answering_quality_input
end

#question_answering_relevance_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput

Input for question answering relevance metric. Corresponds to the JSON property questionAnsweringRelevanceInput

Returns:



9176
9177
9178
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9176

def question_answering_relevance_input
  @question_answering_relevance_input
end

#rouge_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RougeInput

Input for rouge metric. Corresponds to the JSON property rougeInput

Returns:



9181
9182
9183
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9181

def rouge_input
  @rouge_input
end

#rubric_based_instruction_following_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput

Instance and metric spec for RubricBasedInstructionFollowing metric. Corresponds to the JSON property rubricBasedInstructionFollowingInput

Returns:



9186
9187
9188
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9186

def rubric_based_instruction_following_input
  @rubric_based_instruction_following_input
end

#safety_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetyInput

Input for safety metric. Corresponds to the JSON property safetyInput

Returns:



9191
9192
9193
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9191

def safety_input
  @safety_input
end

#summarization_helpfulness_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SummarizationHelpfulnessInput

Input for summarization helpfulness metric. Corresponds to the JSON property summarizationHelpfulnessInput

Returns:



9196
9197
9198
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9196

def summarization_helpfulness_input
  @summarization_helpfulness_input
end

#summarization_quality_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SummarizationQualityInput

Input for summarization quality metric. Corresponds to the JSON property summarizationQualityInput

Returns:



9201
9202
9203
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9201

def summarization_quality_input
  @summarization_quality_input
end

#summarization_verbosity_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SummarizationVerbosityInput

Input for summarization verbosity metric. Corresponds to the JSON property summarizationVerbosityInput

Returns:



9206
9207
9208
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9206

def summarization_verbosity_input
  @summarization_verbosity_input
end

#tool_call_valid_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolCallValidInput

Input for tool call valid metric. Corresponds to the JSON property toolCallValidInput

Returns:



9211
9212
9213
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9211

def tool_call_valid_input
  @tool_call_valid_input
end

#tool_name_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolNameMatchInput

Input for tool name match metric. Corresponds to the JSON property toolNameMatchInput

Returns:



9216
9217
9218
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9216

def tool_name_match_input
  @tool_name_match_input
end

#tool_parameter_key_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolParameterKeyMatchInput

Input for tool parameter key match metric. Corresponds to the JSON property toolParameterKeyMatchInput

Returns:



9221
9222
9223
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9221

def tool_parameter_key_match_input
  @tool_parameter_key_match_input
end

#tool_parameter_kv_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolParameterKvMatchInput

Input for tool parameter key value match metric. Corresponds to the JSON property toolParameterKvMatchInput

Returns:



9226
9227
9228
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9226

def tool_parameter_kv_match_input
  @tool_parameter_kv_match_input
end

#trajectory_any_order_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput

Instances and metric spec for TrajectoryAnyOrderMatch metric. Corresponds to the JSON property trajectoryAnyOrderMatchInput

Returns:



9231
9232
9233
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9231

def trajectory_any_order_match_input
  @trajectory_any_order_match_input
end

#trajectory_exact_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrajectoryExactMatchInput

Instances and metric spec for TrajectoryExactMatch metric. Corresponds to the JSON property trajectoryExactMatchInput

Returns:



9236
9237
9238
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9236

def trajectory_exact_match_input
  @trajectory_exact_match_input
end

#trajectory_in_order_match_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrajectoryInOrderMatchInput

Instances and metric spec for TrajectoryInOrderMatch metric. Corresponds to the JSON property trajectoryInOrderMatchInput

Returns:



9241
9242
9243
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9241

def trajectory_in_order_match_input
  @trajectory_in_order_match_input
end

#trajectory_precision_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrajectoryPrecisionInput

Instances and metric spec for TrajectoryPrecision metric. Corresponds to the JSON property trajectoryPrecisionInput

Returns:



9246
9247
9248
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9246

def trajectory_precision_input
  @trajectory_precision_input
end

#trajectory_recall_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrajectoryRecallInput

Instances and metric spec for TrajectoryRecall metric. Corresponds to the JSON property trajectoryRecallInput

Returns:



9251
9252
9253
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9251

def trajectory_recall_input
  @trajectory_recall_input
end

#trajectory_single_tool_use_input ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrajectorySingleToolUseInput

Instances and metric spec for TrajectorySingleToolUse metric. Corresponds to the JSON property trajectorySingleToolUseInput

Returns:



9256
9257
9258
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9256

def trajectory_single_tool_use_input
  @trajectory_single_tool_use_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9263

def update!(**args)
  @autorater_config = args[:autorater_config] if args.key?(:autorater_config)
  @bleu_input = args[:bleu_input] if args.key?(:bleu_input)
  @coherence_input = args[:coherence_input] if args.key?(:coherence_input)
  @comet_input = args[:comet_input] if args.key?(:comet_input)
  @exact_match_input = args[:exact_match_input] if args.key?(:exact_match_input)
  @fluency_input = args[:fluency_input] if args.key?(:fluency_input)
  @fulfillment_input = args[:fulfillment_input] if args.key?(:fulfillment_input)
  @groundedness_input = args[:groundedness_input] if args.key?(:groundedness_input)
  @instance = args[:instance] if args.key?(:instance)
  @location = args[:location] if args.key?(:location)
  @metric_sources = args[:metric_sources] if args.key?(:metric_sources)
  @metrics = args[:metrics] if args.key?(:metrics)
  @metricx_input = args[:metricx_input] if args.key?(:metricx_input)
  @pairwise_metric_input = args[:pairwise_metric_input] if args.key?(:pairwise_metric_input)
  @pairwise_question_answering_quality_input = args[:pairwise_question_answering_quality_input] if args.key?(:pairwise_question_answering_quality_input)
  @pairwise_summarization_quality_input = args[:pairwise_summarization_quality_input] if args.key?(:pairwise_summarization_quality_input)
  @pointwise_metric_input = args[:pointwise_metric_input] if args.key?(:pointwise_metric_input)
  @question_answering_correctness_input = args[:question_answering_correctness_input] if args.key?(:question_answering_correctness_input)
  @question_answering_helpfulness_input = args[:question_answering_helpfulness_input] if args.key?(:question_answering_helpfulness_input)
  @question_answering_quality_input = args[:question_answering_quality_input] if args.key?(:question_answering_quality_input)
  @question_answering_relevance_input = args[:question_answering_relevance_input] if args.key?(:question_answering_relevance_input)
  @rouge_input = args[:rouge_input] if args.key?(:rouge_input)
  @rubric_based_instruction_following_input = args[:rubric_based_instruction_following_input] if args.key?(:rubric_based_instruction_following_input)
  @safety_input = args[:safety_input] if args.key?(:safety_input)
  @summarization_helpfulness_input = args[:summarization_helpfulness_input] if args.key?(:summarization_helpfulness_input)
  @summarization_quality_input = args[:summarization_quality_input] if args.key?(:summarization_quality_input)
  @summarization_verbosity_input = args[:summarization_verbosity_input] if args.key?(:summarization_verbosity_input)
  @tool_call_valid_input = args[:tool_call_valid_input] if args.key?(:tool_call_valid_input)
  @tool_name_match_input = args[:tool_name_match_input] if args.key?(:tool_name_match_input)
  @tool_parameter_key_match_input = args[:tool_parameter_key_match_input] if args.key?(:tool_parameter_key_match_input)
  @tool_parameter_kv_match_input = args[:tool_parameter_kv_match_input] if args.key?(:tool_parameter_kv_match_input)
  @trajectory_any_order_match_input = args[:trajectory_any_order_match_input] if args.key?(:trajectory_any_order_match_input)
  @trajectory_exact_match_input = args[:trajectory_exact_match_input] if args.key?(:trajectory_exact_match_input)
  @trajectory_in_order_match_input = args[:trajectory_in_order_match_input] if args.key?(:trajectory_in_order_match_input)
  @trajectory_precision_input = args[:trajectory_precision_input] if args.key?(:trajectory_precision_input)
  @trajectory_recall_input = args[:trajectory_recall_input] if args.key?(:trajectory_recall_input)
  @trajectory_single_tool_use_input = args[:trajectory_single_tool_use_input] if args.key?(:trajectory_single_tool_use_input)
end