Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateInstancesRequest

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

Overview

Request message for EvaluationService.EvaluateInstances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1EvaluateInstancesRequest

Returns a new instance of GoogleCloudAiplatformV1beta1EvaluateInstancesRequest.



10420
10421
10422
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10420

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

Instance Attribute Details

#autorater_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AutoraterConfig

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

Returns:



10231
10232
10233
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10231

def autorater_config
  @autorater_config
end

#bleu_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuInput

Input for bleu metric. Corresponds to the JSON property bleuInput

Returns:



10236
10237
10238
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10236

def bleu_input
  @bleu_input
end

#coherence_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CoherenceInput

Input for coherence metric. Corresponds to the JSON property coherenceInput

Returns:



10241
10242
10243
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10241

def coherence_input
  @coherence_input
end

#comet_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CometInput

Input for Comet metric. Corresponds to the JSON property cometInput

Returns:



10246
10247
10248
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10246

def comet_input
  @comet_input
end

#exact_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchInput

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

Returns:



10251
10252
10253
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10251

def exact_match_input
  @exact_match_input
end

#fluency_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FluencyInput

Input for fluency metric. Corresponds to the JSON property fluencyInput

Returns:



10256
10257
10258
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10256

def fluency_input
  @fluency_input
end

#fulfillment_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FulfillmentInput

Input for fulfillment metric. Corresponds to the JSON property fulfillmentInput

Returns:



10261
10262
10263
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10261

def fulfillment_input
  @fulfillment_input
end

#groundedness_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundednessInput

Input for groundedness metric. Corresponds to the JSON property groundednessInput

Returns:



10266
10267
10268
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10266

def groundedness_input
  @groundedness_input
end

#instance ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstance

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:



10273
10274
10275
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10273

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) 


10279
10280
10281
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10279

def location
  @location
end

#metric_sources ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetricSource>

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:



10286
10287
10288
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10286

def metric_sources
  @metric_sources
end

#metrics ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Metric>

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:



10293
10294
10295
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10293

def metrics
  @metrics
end

#metricx_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetricxInput

Input for MetricX metric. Corresponds to the JSON property metricxInput

Returns:



10298
10299
10300
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10298

def metricx_input
  @metricx_input
end

#pairwise_metric_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PairwiseMetricInput

Input for pairwise metric. Corresponds to the JSON property pairwiseMetricInput

Returns:



10303
10304
10305
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10303

def pairwise_metric_input
  @pairwise_metric_input
end

#pairwise_question_answering_quality_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput

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

Returns:



10308
10309
10310
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10308

def pairwise_question_answering_quality_input
  @pairwise_question_answering_quality_input
end

#pairwise_summarization_quality_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput

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

Returns:



10313
10314
10315
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10313

def pairwise_summarization_quality_input
  @pairwise_summarization_quality_input
end

#pointwise_metric_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PointwiseMetricInput

Input for pointwise metric. Corresponds to the JSON property pointwiseMetricInput

Returns:



10318
10319
10320
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10318

def pointwise_metric_input
  @pointwise_metric_input
end

#question_answering_correctness_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput

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

Returns:



10323
10324
10325
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10323

def question_answering_correctness_input
  @question_answering_correctness_input
end

#question_answering_helpfulness_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInput

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

Returns:



10328
10329
10330
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10328

def question_answering_helpfulness_input
  @question_answering_helpfulness_input
end

#question_answering_quality_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInput

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

Returns:



10333
10334
10335
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10333

def question_answering_quality_input
  @question_answering_quality_input
end

#question_answering_relevance_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInput

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

Returns:



10338
10339
10340
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10338

def question_answering_relevance_input
  @question_answering_relevance_input
end

#rouge_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RougeInput

Input for rouge metric. Corresponds to the JSON property rougeInput

Returns:



10343
10344
10345
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10343

def rouge_input
  @rouge_input
end

#rubric_based_instruction_following_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput

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

Returns:



10348
10349
10350
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10348

def rubric_based_instruction_following_input
  @rubric_based_instruction_following_input
end

#safety_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetyInput

Input for safety metric. Corresponds to the JSON property safetyInput

Returns:



10353
10354
10355
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10353

def safety_input
  @safety_input
end

#summarization_helpfulness_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInput

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

Returns:



10358
10359
10360
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10358

def summarization_helpfulness_input
  @summarization_helpfulness_input
end

#summarization_quality_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SummarizationQualityInput

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

Returns:



10363
10364
10365
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10363

def summarization_quality_input
  @summarization_quality_input
end

#summarization_verbosity_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SummarizationVerbosityInput

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

Returns:



10368
10369
10370
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10368

def summarization_verbosity_input
  @summarization_verbosity_input
end

#tool_call_valid_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolCallValidInput

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

Returns:



10373
10374
10375
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10373

def tool_call_valid_input
  @tool_call_valid_input
end

#tool_name_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolNameMatchInput

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

Returns:



10378
10379
10380
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10378

def tool_name_match_input
  @tool_name_match_input
end

#tool_parameter_key_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInput

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

Returns:



10383
10384
10385
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10383

def tool_parameter_key_match_input
  @tool_parameter_key_match_input
end

#tool_parameter_kv_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolParameterKvMatchInput

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

Returns:



10388
10389
10390
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10388

def tool_parameter_kv_match_input
  @tool_parameter_kv_match_input
end

#trajectory_any_order_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInput

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

Returns:



10393
10394
10395
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10393

def trajectory_any_order_match_input
  @trajectory_any_order_match_input
end

#trajectory_exact_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrajectoryExactMatchInput

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

Returns:



10398
10399
10400
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10398

def trajectory_exact_match_input
  @trajectory_exact_match_input
end

#trajectory_in_order_match_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInput

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

Returns:



10403
10404
10405
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10403

def trajectory_in_order_match_input
  @trajectory_in_order_match_input
end

#trajectory_precision_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrajectoryPrecisionInput

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

Returns:



10408
10409
10410
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10408

def trajectory_precision_input
  @trajectory_precision_input
end

#trajectory_recall_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrajectoryRecallInput

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

Returns:



10413
10414
10415
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10413

def trajectory_recall_input
  @trajectory_recall_input
end

#trajectory_single_tool_use_input ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInput

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

Returns:



10418
10419
10420
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10418

def trajectory_single_tool_use_input
  @trajectory_single_tool_use_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10425

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