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.



9568
9569
9570
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9568

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:



9379
9380
9381
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9379

def autorater_config
  @autorater_config
end

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

Input for bleu metric. Corresponds to the JSON property bleuInput

Returns:



9384
9385
9386
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9384

def bleu_input
  @bleu_input
end

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

Input for coherence metric. Corresponds to the JSON property coherenceInput

Returns:



9389
9390
9391
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9389

def coherence_input
  @coherence_input
end

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

Input for Comet metric. Corresponds to the JSON property cometInput

Returns:



9394
9395
9396
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9394

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:



9399
9400
9401
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9399

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:



9404
9405
9406
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9404

def fluency_input
  @fluency_input
end

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

Input for fulfillment metric. Corresponds to the JSON property fulfillmentInput

Returns:



9409
9410
9411
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9409

def fulfillment_input
  @fulfillment_input
end

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

Input for groundedness metric. Corresponds to the JSON property groundednessInput

Returns:



9414
9415
9416
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9414

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:



9421
9422
9423
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9421

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) 


9427
9428
9429
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9427

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:



9434
9435
9436
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9434

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:



9441
9442
9443
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9441

def metrics
  @metrics
end

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

Input for MetricX metric. Corresponds to the JSON property metricxInput

Returns:



9446
9447
9448
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9446

def metricx_input
  @metricx_input
end

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

Input for pairwise metric. Corresponds to the JSON property pairwiseMetricInput

Returns:



9451
9452
9453
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9451

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:



9456
9457
9458
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9456

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:



9461
9462
9463
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9461

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:



9466
9467
9468
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9466

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:



9471
9472
9473
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9471

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:



9476
9477
9478
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9476

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:



9481
9482
9483
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9481

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:



9486
9487
9488
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9486

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:



9491
9492
9493
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9491

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:



9496
9497
9498
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9496

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:



9501
9502
9503
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9501

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:



9506
9507
9508
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9506

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:



9511
9512
9513
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9511

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:



9516
9517
9518
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9516

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:



9521
9522
9523
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9521

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:



9526
9527
9528
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9526

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:



9531
9532
9533
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9531

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:



9536
9537
9538
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9536

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:



9541
9542
9543
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9541

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:



9546
9547
9548
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9546

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:



9551
9552
9553
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9551

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:



9556
9557
9558
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9556

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:



9561
9562
9563
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9561

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:



9566
9567
9568
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9566

def trajectory_single_tool_use_input
  @trajectory_single_tool_use_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9573

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