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.



8566
8567
8568
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8566

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:



8384
8385
8386
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8384

def autorater_config
  @autorater_config
end

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

Input for bleu metric. Corresponds to the JSON property bleuInput

Returns:



8389
8390
8391
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8389

def bleu_input
  @bleu_input
end

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

Input for coherence metric. Corresponds to the JSON property coherenceInput

Returns:



8394
8395
8396
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8394

def coherence_input
  @coherence_input
end

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

Input for Comet metric. Corresponds to the JSON property cometInput

Returns:



8399
8400
8401
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8399

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:



8404
8405
8406
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8404

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:



8409
8410
8411
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8409

def fluency_input
  @fluency_input
end

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

Input for fulfillment metric. Corresponds to the JSON property fulfillmentInput

Returns:



8414
8415
8416
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8414

def fulfillment_input
  @fulfillment_input
end

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

Input for groundedness metric. Corresponds to the JSON property groundednessInput

Returns:



8419
8420
8421
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8419

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:



8426
8427
8428
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8426

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) 


8432
8433
8434
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8432

def location
  @location
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:



8439
8440
8441
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8439

def metrics
  @metrics
end

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

Input for MetricX metric. Corresponds to the JSON property metricxInput

Returns:



8444
8445
8446
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8444

def metricx_input
  @metricx_input
end

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

Input for pairwise metric. Corresponds to the JSON property pairwiseMetricInput

Returns:



8449
8450
8451
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8449

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:



8454
8455
8456
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8454

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:



8459
8460
8461
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8459

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:



8464
8465
8466
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8464

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:



8469
8470
8471
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8469

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:



8474
8475
8476
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8474

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:



8479
8480
8481
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8479

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:



8484
8485
8486
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8484

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:



8489
8490
8491
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8489

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:



8494
8495
8496
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8494

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:



8499
8500
8501
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8499

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:



8504
8505
8506
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8504

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:



8509
8510
8511
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8509

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:



8514
8515
8516
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8514

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:



8519
8520
8521
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8519

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:



8524
8525
8526
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8524

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:



8529
8530
8531
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8529

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:



8534
8535
8536
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8534

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:



8539
8540
8541
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8539

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:



8544
8545
8546
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8544

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:



8549
8550
8551
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8549

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:



8554
8555
8556
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8554

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:



8559
8560
8561
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8559

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:



8564
8565
8566
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8564

def trajectory_single_tool_use_input
  @trajectory_single_tool_use_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8571

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)
  @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