Package com.google.cloud.aiplatform.v1

Interface EvaluateInstancesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EvaluateInstancesRequest, EvaluateInstancesRequest.Builder
@Generated public interface EvaluateInstancesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasExactMatchInput

      boolean hasExactMatchInput()
       Auto metric instances.
 Instances and metric spec for exact match metric.
      .google.cloud.aiplatform.v1.ExactMatchInput exact_match_input = 2;
      Returns:
      Whether the exactMatchInput field is set.

    • getExactMatchInput

      ExactMatchInput getExactMatchInput()
       Auto metric instances.
 Instances and metric spec for exact match metric.
      .google.cloud.aiplatform.v1.ExactMatchInput exact_match_input = 2;
      Returns:
      The exactMatchInput.

    • getExactMatchInputOrBuilder

      ExactMatchInputOrBuilder getExactMatchInputOrBuilder()
       Auto metric instances.
 Instances and metric spec for exact match metric.
      .google.cloud.aiplatform.v1.ExactMatchInput exact_match_input = 2;

    • hasBleuInput

      boolean hasBleuInput()
       Instances and metric spec for bleu metric.
      .google.cloud.aiplatform.v1.BleuInput bleu_input = 3;
      Returns:
      Whether the bleuInput field is set.

    • getBleuInput

      BleuInput getBleuInput()
       Instances and metric spec for bleu metric.
      .google.cloud.aiplatform.v1.BleuInput bleu_input = 3;
      Returns:
      The bleuInput.

    • getBleuInputOrBuilder

      BleuInputOrBuilder getBleuInputOrBuilder()
       Instances and metric spec for bleu metric.
      .google.cloud.aiplatform.v1.BleuInput bleu_input = 3;

    • hasRougeInput

      boolean hasRougeInput()
       Instances and metric spec for rouge metric.
      .google.cloud.aiplatform.v1.RougeInput rouge_input = 4;
      Returns:
      Whether the rougeInput field is set.

    • getRougeInput

      RougeInput getRougeInput()
       Instances and metric spec for rouge metric.
      .google.cloud.aiplatform.v1.RougeInput rouge_input = 4;
      Returns:
      The rougeInput.

    • getRougeInputOrBuilder

      RougeInputOrBuilder getRougeInputOrBuilder()
       Instances and metric spec for rouge metric.
      .google.cloud.aiplatform.v1.RougeInput rouge_input = 4;

    • hasFluencyInput

      boolean hasFluencyInput()
       LLM-based metric instance.
 General text generation metrics, applicable to other categories.
 Input for fluency metric.
      .google.cloud.aiplatform.v1.FluencyInput fluency_input = 5;
      Returns:
      Whether the fluencyInput field is set.

    • getFluencyInput

      FluencyInput getFluencyInput()
       LLM-based metric instance.
 General text generation metrics, applicable to other categories.
 Input for fluency metric.
      .google.cloud.aiplatform.v1.FluencyInput fluency_input = 5;
      Returns:
      The fluencyInput.

    • getFluencyInputOrBuilder

      FluencyInputOrBuilder getFluencyInputOrBuilder()
       LLM-based metric instance.
 General text generation metrics, applicable to other categories.
 Input for fluency metric.
      .google.cloud.aiplatform.v1.FluencyInput fluency_input = 5;

    • hasCoherenceInput

      boolean hasCoherenceInput()
       Input for coherence metric.
      .google.cloud.aiplatform.v1.CoherenceInput coherence_input = 6;
      Returns:
      Whether the coherenceInput field is set.

    • getCoherenceInput

      CoherenceInput getCoherenceInput()
       Input for coherence metric.
      .google.cloud.aiplatform.v1.CoherenceInput coherence_input = 6;
      Returns:
      The coherenceInput.

    • getCoherenceInputOrBuilder

      CoherenceInputOrBuilder getCoherenceInputOrBuilder()
       Input for coherence metric.
      .google.cloud.aiplatform.v1.CoherenceInput coherence_input = 6;

    • hasSafetyInput

      boolean hasSafetyInput()
       Input for safety metric.
      .google.cloud.aiplatform.v1.SafetyInput safety_input = 8;
      Returns:
      Whether the safetyInput field is set.

    • getSafetyInput

      SafetyInput getSafetyInput()
       Input for safety metric.
      .google.cloud.aiplatform.v1.SafetyInput safety_input = 8;
      Returns:
      The safetyInput.

    • getSafetyInputOrBuilder

      SafetyInputOrBuilder getSafetyInputOrBuilder()
       Input for safety metric.
      .google.cloud.aiplatform.v1.SafetyInput safety_input = 8;

    • hasGroundednessInput

      boolean hasGroundednessInput()
       Input for groundedness metric.
      .google.cloud.aiplatform.v1.GroundednessInput groundedness_input = 9;
      Returns:
      Whether the groundednessInput field is set.

    • getGroundednessInput

      GroundednessInput getGroundednessInput()
       Input for groundedness metric.
      .google.cloud.aiplatform.v1.GroundednessInput groundedness_input = 9;
      Returns:
      The groundednessInput.

    • getGroundednessInputOrBuilder

      GroundednessInputOrBuilder getGroundednessInputOrBuilder()
       Input for groundedness metric.
      .google.cloud.aiplatform.v1.GroundednessInput groundedness_input = 9;

    • hasFulfillmentInput

      boolean hasFulfillmentInput()
       Input for fulfillment metric.
      .google.cloud.aiplatform.v1.FulfillmentInput fulfillment_input = 12;
      Returns:
      Whether the fulfillmentInput field is set.

    • getFulfillmentInput

      FulfillmentInput getFulfillmentInput()
       Input for fulfillment metric.
      .google.cloud.aiplatform.v1.FulfillmentInput fulfillment_input = 12;
      Returns:
      The fulfillmentInput.

    • getFulfillmentInputOrBuilder

      FulfillmentInputOrBuilder getFulfillmentInputOrBuilder()
       Input for fulfillment metric.
      .google.cloud.aiplatform.v1.FulfillmentInput fulfillment_input = 12;

    • hasSummarizationQualityInput

      boolean hasSummarizationQualityInput()
       Input for summarization quality metric.
      .google.cloud.aiplatform.v1.SummarizationQualityInput summarization_quality_input = 7;
      Returns:
      Whether the summarizationQualityInput field is set.

    • getSummarizationQualityInput

      SummarizationQualityInput getSummarizationQualityInput()
       Input for summarization quality metric.
      .google.cloud.aiplatform.v1.SummarizationQualityInput summarization_quality_input = 7;
      Returns:
      The summarizationQualityInput.

    • getSummarizationQualityInputOrBuilder

      SummarizationQualityInputOrBuilder getSummarizationQualityInputOrBuilder()
       Input for summarization quality metric.
      .google.cloud.aiplatform.v1.SummarizationQualityInput summarization_quality_input = 7;

    • hasPairwiseSummarizationQualityInput

      boolean hasPairwiseSummarizationQualityInput()
       Input for pairwise summarization quality metric.
      .google.cloud.aiplatform.v1.PairwiseSummarizationQualityInput pairwise_summarization_quality_input = 23;
      Returns:
      Whether the pairwiseSummarizationQualityInput field is set.

    • getPairwiseSummarizationQualityInput

      PairwiseSummarizationQualityInput getPairwiseSummarizationQualityInput()
       Input for pairwise summarization quality metric.
      .google.cloud.aiplatform.v1.PairwiseSummarizationQualityInput pairwise_summarization_quality_input = 23;
      Returns:
      The pairwiseSummarizationQualityInput.

    • getPairwiseSummarizationQualityInputOrBuilder

      PairwiseSummarizationQualityInputOrBuilder getPairwiseSummarizationQualityInputOrBuilder()
       Input for pairwise summarization quality metric.
      .google.cloud.aiplatform.v1.PairwiseSummarizationQualityInput pairwise_summarization_quality_input = 23;

    • hasSummarizationHelpfulnessInput

      boolean hasSummarizationHelpfulnessInput()
       Input for summarization helpfulness metric.
      .google.cloud.aiplatform.v1.SummarizationHelpfulnessInput summarization_helpfulness_input = 14;
      Returns:
      Whether the summarizationHelpfulnessInput field is set.

    • getSummarizationHelpfulnessInput

      SummarizationHelpfulnessInput getSummarizationHelpfulnessInput()
       Input for summarization helpfulness metric.
      .google.cloud.aiplatform.v1.SummarizationHelpfulnessInput summarization_helpfulness_input = 14;
      Returns:
      The summarizationHelpfulnessInput.

    • getSummarizationHelpfulnessInputOrBuilder

      SummarizationHelpfulnessInputOrBuilder getSummarizationHelpfulnessInputOrBuilder()
       Input for summarization helpfulness metric.
      .google.cloud.aiplatform.v1.SummarizationHelpfulnessInput summarization_helpfulness_input = 14;

    • hasSummarizationVerbosityInput

      boolean hasSummarizationVerbosityInput()
       Input for summarization verbosity metric.
      .google.cloud.aiplatform.v1.SummarizationVerbosityInput summarization_verbosity_input = 15;
      Returns:
      Whether the summarizationVerbosityInput field is set.

    • getSummarizationVerbosityInput

      SummarizationVerbosityInput getSummarizationVerbosityInput()
       Input for summarization verbosity metric.
      .google.cloud.aiplatform.v1.SummarizationVerbosityInput summarization_verbosity_input = 15;
      Returns:
      The summarizationVerbosityInput.

    • getSummarizationVerbosityInputOrBuilder

      SummarizationVerbosityInputOrBuilder getSummarizationVerbosityInputOrBuilder()
       Input for summarization verbosity metric.
      .google.cloud.aiplatform.v1.SummarizationVerbosityInput summarization_verbosity_input = 15;

    • hasQuestionAnsweringQualityInput

      boolean hasQuestionAnsweringQualityInput()
       Input for question answering quality metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringQualityInput question_answering_quality_input = 10;
      Returns:
      Whether the questionAnsweringQualityInput field is set.

    • getQuestionAnsweringQualityInput

      QuestionAnsweringQualityInput getQuestionAnsweringQualityInput()
       Input for question answering quality metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringQualityInput question_answering_quality_input = 10;
      Returns:
      The questionAnsweringQualityInput.

    • getQuestionAnsweringQualityInputOrBuilder

      QuestionAnsweringQualityInputOrBuilder getQuestionAnsweringQualityInputOrBuilder()
       Input for question answering quality metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringQualityInput question_answering_quality_input = 10;

    • hasPairwiseQuestionAnsweringQualityInput

      boolean hasPairwiseQuestionAnsweringQualityInput()
       Input for pairwise question answering quality metric.
      .google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityInput pairwise_question_answering_quality_input = 24;
      Returns:
      Whether the pairwiseQuestionAnsweringQualityInput field is set.

    • getPairwiseQuestionAnsweringQualityInput

      PairwiseQuestionAnsweringQualityInput getPairwiseQuestionAnsweringQualityInput()
       Input for pairwise question answering quality metric.
      .google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityInput pairwise_question_answering_quality_input = 24;
      Returns:
      The pairwiseQuestionAnsweringQualityInput.

    • getPairwiseQuestionAnsweringQualityInputOrBuilder

      PairwiseQuestionAnsweringQualityInputOrBuilder getPairwiseQuestionAnsweringQualityInputOrBuilder()
       Input for pairwise question answering quality metric.
      .google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityInput pairwise_question_answering_quality_input = 24;

    • hasQuestionAnsweringRelevanceInput

      boolean hasQuestionAnsweringRelevanceInput()
       Input for question answering relevance metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringRelevanceInput question_answering_relevance_input = 16;
      Returns:
      Whether the questionAnsweringRelevanceInput field is set.

    • getQuestionAnsweringRelevanceInput

      QuestionAnsweringRelevanceInput getQuestionAnsweringRelevanceInput()
       Input for question answering relevance metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringRelevanceInput question_answering_relevance_input = 16;
      Returns:
      The questionAnsweringRelevanceInput.

    • getQuestionAnsweringRelevanceInputOrBuilder

      QuestionAnsweringRelevanceInputOrBuilder getQuestionAnsweringRelevanceInputOrBuilder()
       Input for question answering relevance metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringRelevanceInput question_answering_relevance_input = 16;

    • hasQuestionAnsweringHelpfulnessInput

      boolean hasQuestionAnsweringHelpfulnessInput()
       Input for question answering helpfulness
 metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessInput question_answering_helpfulness_input = 17;
      Returns:
      Whether the questionAnsweringHelpfulnessInput field is set.

    • getQuestionAnsweringHelpfulnessInput

      QuestionAnsweringHelpfulnessInput getQuestionAnsweringHelpfulnessInput()
       Input for question answering helpfulness
 metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessInput question_answering_helpfulness_input = 17;
      Returns:
      The questionAnsweringHelpfulnessInput.

    • getQuestionAnsweringHelpfulnessInputOrBuilder

      QuestionAnsweringHelpfulnessInputOrBuilder getQuestionAnsweringHelpfulnessInputOrBuilder()
       Input for question answering helpfulness
 metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessInput question_answering_helpfulness_input = 17;

    • hasQuestionAnsweringCorrectnessInput

      boolean hasQuestionAnsweringCorrectnessInput()
       Input for question answering correctness
 metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessInput question_answering_correctness_input = 18;
      Returns:
      Whether the questionAnsweringCorrectnessInput field is set.

    • getQuestionAnsweringCorrectnessInput

      QuestionAnsweringCorrectnessInput getQuestionAnsweringCorrectnessInput()
       Input for question answering correctness
 metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessInput question_answering_correctness_input = 18;
      Returns:
      The questionAnsweringCorrectnessInput.

    • getQuestionAnsweringCorrectnessInputOrBuilder

      QuestionAnsweringCorrectnessInputOrBuilder getQuestionAnsweringCorrectnessInputOrBuilder()
       Input for question answering correctness
 metric.
      .google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessInput question_answering_correctness_input = 18;

    • hasPointwiseMetricInput

      boolean hasPointwiseMetricInput()
       Input for pointwise metric.
      .google.cloud.aiplatform.v1.PointwiseMetricInput pointwise_metric_input = 28;
      Returns:
      Whether the pointwiseMetricInput field is set.

    • getPointwiseMetricInput

      PointwiseMetricInput getPointwiseMetricInput()
       Input for pointwise metric.
      .google.cloud.aiplatform.v1.PointwiseMetricInput pointwise_metric_input = 28;
      Returns:
      The pointwiseMetricInput.

    • getPointwiseMetricInputOrBuilder

      PointwiseMetricInputOrBuilder getPointwiseMetricInputOrBuilder()
       Input for pointwise metric.
      .google.cloud.aiplatform.v1.PointwiseMetricInput pointwise_metric_input = 28;

    • hasPairwiseMetricInput

      boolean hasPairwiseMetricInput()
       Input for pairwise metric.
      .google.cloud.aiplatform.v1.PairwiseMetricInput pairwise_metric_input = 29;
      Returns:
      Whether the pairwiseMetricInput field is set.

    • getPairwiseMetricInput

      PairwiseMetricInput getPairwiseMetricInput()
       Input for pairwise metric.
      .google.cloud.aiplatform.v1.PairwiseMetricInput pairwise_metric_input = 29;
      Returns:
      The pairwiseMetricInput.

    • getPairwiseMetricInputOrBuilder

      PairwiseMetricInputOrBuilder getPairwiseMetricInputOrBuilder()
       Input for pairwise metric.
      .google.cloud.aiplatform.v1.PairwiseMetricInput pairwise_metric_input = 29;

    • hasToolCallValidInput

      boolean hasToolCallValidInput()
       Tool call metric instances.
 Input for tool call valid metric.
      .google.cloud.aiplatform.v1.ToolCallValidInput tool_call_valid_input = 19;
      Returns:
      Whether the toolCallValidInput field is set.

    • getToolCallValidInput

      ToolCallValidInput getToolCallValidInput()
       Tool call metric instances.
 Input for tool call valid metric.
      .google.cloud.aiplatform.v1.ToolCallValidInput tool_call_valid_input = 19;
      Returns:
      The toolCallValidInput.

    • getToolCallValidInputOrBuilder

      ToolCallValidInputOrBuilder getToolCallValidInputOrBuilder()
       Tool call metric instances.
 Input for tool call valid metric.
      .google.cloud.aiplatform.v1.ToolCallValidInput tool_call_valid_input = 19;

    • hasToolNameMatchInput

      boolean hasToolNameMatchInput()
       Input for tool name match metric.
      .google.cloud.aiplatform.v1.ToolNameMatchInput tool_name_match_input = 20;
      Returns:
      Whether the toolNameMatchInput field is set.

    • getToolNameMatchInput

      ToolNameMatchInput getToolNameMatchInput()
       Input for tool name match metric.
      .google.cloud.aiplatform.v1.ToolNameMatchInput tool_name_match_input = 20;
      Returns:
      The toolNameMatchInput.

    • getToolNameMatchInputOrBuilder

      ToolNameMatchInputOrBuilder getToolNameMatchInputOrBuilder()
       Input for tool name match metric.
      .google.cloud.aiplatform.v1.ToolNameMatchInput tool_name_match_input = 20;

    • hasToolParameterKeyMatchInput

      boolean hasToolParameterKeyMatchInput()
       Input for tool parameter key match metric.
      .google.cloud.aiplatform.v1.ToolParameterKeyMatchInput tool_parameter_key_match_input = 21;
      Returns:
      Whether the toolParameterKeyMatchInput field is set.

    • getToolParameterKeyMatchInput

      ToolParameterKeyMatchInput getToolParameterKeyMatchInput()
       Input for tool parameter key match metric.
      .google.cloud.aiplatform.v1.ToolParameterKeyMatchInput tool_parameter_key_match_input = 21;
      Returns:
      The toolParameterKeyMatchInput.

    • getToolParameterKeyMatchInputOrBuilder

      ToolParameterKeyMatchInputOrBuilder getToolParameterKeyMatchInputOrBuilder()
       Input for tool parameter key match metric.
      .google.cloud.aiplatform.v1.ToolParameterKeyMatchInput tool_parameter_key_match_input = 21;

    • hasToolParameterKvMatchInput

      boolean hasToolParameterKvMatchInput()
       Input for tool parameter key value match metric.
      .google.cloud.aiplatform.v1.ToolParameterKVMatchInput tool_parameter_kv_match_input = 22;
      Returns:
      Whether the toolParameterKvMatchInput field is set.

    • getToolParameterKvMatchInput

      ToolParameterKVMatchInput getToolParameterKvMatchInput()
       Input for tool parameter key value match metric.
      .google.cloud.aiplatform.v1.ToolParameterKVMatchInput tool_parameter_kv_match_input = 22;
      Returns:
      The toolParameterKvMatchInput.

    • getToolParameterKvMatchInputOrBuilder

      ToolParameterKVMatchInputOrBuilder getToolParameterKvMatchInputOrBuilder()
       Input for tool parameter key value match metric.
      .google.cloud.aiplatform.v1.ToolParameterKVMatchInput tool_parameter_kv_match_input = 22;

    • hasCometInput

      boolean hasCometInput()
       Translation metrics.
 Input for Comet metric.
      .google.cloud.aiplatform.v1.CometInput comet_input = 31;
      Returns:
      Whether the cometInput field is set.

    • getCometInput

      CometInput getCometInput()
       Translation metrics.
 Input for Comet metric.
      .google.cloud.aiplatform.v1.CometInput comet_input = 31;
      Returns:
      The cometInput.

    • getCometInputOrBuilder

      CometInputOrBuilder getCometInputOrBuilder()
       Translation metrics.
 Input for Comet metric.
      .google.cloud.aiplatform.v1.CometInput comet_input = 31;

    • hasMetricxInput

      boolean hasMetricxInput()
       Input for Metricx metric.
      .google.cloud.aiplatform.v1.MetricxInput metricx_input = 32;
      Returns:
      Whether the metricxInput field is set.

    • getMetricxInput

      MetricxInput getMetricxInput()
       Input for Metricx metric.
      .google.cloud.aiplatform.v1.MetricxInput metricx_input = 32;
      Returns:
      The metricxInput.

    • getMetricxInputOrBuilder

      MetricxInputOrBuilder getMetricxInputOrBuilder()
       Input for Metricx metric.
      .google.cloud.aiplatform.v1.MetricxInput metricx_input = 32;

    • getLocation

      String getLocation()
       Required. The resource name of the Location to evaluate the instances.
 Format: `projects/{project}/locations/{location}`
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The location.

    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       Required. The resource name of the Location to evaluate the instances.
 Format: `projects/{project}/locations/{location}`
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for location.

    • getMetricInputsCase

      EvaluateInstancesRequest.MetricInputsCase getMetricInputsCase()