Interface EvaluateInstancesRequestOrBuilder (3.54.0)

Version 3.54.0

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface EvaluateInstancesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBleuInput()

public abstract BleuInput getBleuInput()

Instances and metric spec for bleu metric.

.google.cloud.aiplatform.v1.BleuInput bleu_input = 3;

Returns
Type	Description
BleuInput	The bleuInput.

getBleuInputOrBuilder()

public abstract BleuInputOrBuilder getBleuInputOrBuilder()

Instances and metric spec for bleu metric.

.google.cloud.aiplatform.v1.BleuInput bleu_input = 3;

Returns
Type	Description
BleuInputOrBuilder

getCoherenceInput()

public abstract CoherenceInput getCoherenceInput()

Input for coherence metric.

.google.cloud.aiplatform.v1.CoherenceInput coherence_input = 6;

Returns
Type	Description
CoherenceInput	The coherenceInput.

getCoherenceInputOrBuilder()

public abstract CoherenceInputOrBuilder getCoherenceInputOrBuilder()

Input for coherence metric.

.google.cloud.aiplatform.v1.CoherenceInput coherence_input = 6;

Returns
Type	Description
CoherenceInputOrBuilder

getExactMatchInput()

public abstract ExactMatchInput getExactMatchInput()

Auto metric instances. Instances and metric spec for exact match metric.

.google.cloud.aiplatform.v1.ExactMatchInput exact_match_input = 2;

Returns
Type	Description
ExactMatchInput	The exactMatchInput.

getExactMatchInputOrBuilder()

public abstract ExactMatchInputOrBuilder getExactMatchInputOrBuilder()

Auto metric instances. Instances and metric spec for exact match metric.

.google.cloud.aiplatform.v1.ExactMatchInput exact_match_input = 2;

Returns
Type	Description
ExactMatchInputOrBuilder

getFluencyInput()

public abstract 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
Type	Description
FluencyInput	The fluencyInput.

getFluencyInputOrBuilder()

public abstract 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;

Returns
Type	Description
FluencyInputOrBuilder

getFulfillmentInput()

public abstract FulfillmentInput getFulfillmentInput()

Input for fulfillment metric.

.google.cloud.aiplatform.v1.FulfillmentInput fulfillment_input = 12;

Returns
Type	Description
FulfillmentInput	The fulfillmentInput.

getFulfillmentInputOrBuilder()

public abstract FulfillmentInputOrBuilder getFulfillmentInputOrBuilder()

Input for fulfillment metric.

.google.cloud.aiplatform.v1.FulfillmentInput fulfillment_input = 12;

Returns
Type	Description
FulfillmentInputOrBuilder

getGroundednessInput()

public abstract GroundednessInput getGroundednessInput()

Input for groundedness metric.

.google.cloud.aiplatform.v1.GroundednessInput groundedness_input = 9;

Returns
Type	Description
GroundednessInput	The groundednessInput.

getGroundednessInputOrBuilder()

public abstract GroundednessInputOrBuilder getGroundednessInputOrBuilder()

Input for groundedness metric.

.google.cloud.aiplatform.v1.GroundednessInput groundedness_input = 9;

Returns
Type	Description
GroundednessInputOrBuilder

getLocation()

public abstract 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
Type	Description
String	The location.

getLocationBytes()

public abstract 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
Type	Description
ByteString	The bytes for location.

getMetricInputsCase()

public abstract EvaluateInstancesRequest.MetricInputsCase getMetricInputsCase()

Returns
Type	Description
EvaluateInstancesRequest.MetricInputsCase

getPairwiseMetricInput()

public abstract PairwiseMetricInput getPairwiseMetricInput()

Input for pairwise metric.

.google.cloud.aiplatform.v1.PairwiseMetricInput pairwise_metric_input = 29;

Returns
Type	Description
PairwiseMetricInput	The pairwiseMetricInput.

getPairwiseMetricInputOrBuilder()

public abstract PairwiseMetricInputOrBuilder getPairwiseMetricInputOrBuilder()

Input for pairwise metric.

.google.cloud.aiplatform.v1.PairwiseMetricInput pairwise_metric_input = 29;

Returns
Type	Description
PairwiseMetricInputOrBuilder

getPairwiseQuestionAnsweringQualityInput()

public abstract PairwiseQuestionAnsweringQualityInput getPairwiseQuestionAnsweringQualityInput()

Input for pairwise question answering quality metric.

.google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityInput pairwise_question_answering_quality_input = 24;

Returns
Type	Description
PairwiseQuestionAnsweringQualityInput	The pairwiseQuestionAnsweringQualityInput.

getPairwiseQuestionAnsweringQualityInputOrBuilder()

public abstract PairwiseQuestionAnsweringQualityInputOrBuilder getPairwiseQuestionAnsweringQualityInputOrBuilder()

Input for pairwise question answering quality metric.

.google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityInput pairwise_question_answering_quality_input = 24;

Returns
Type	Description
PairwiseQuestionAnsweringQualityInputOrBuilder

getPairwiseSummarizationQualityInput()

public abstract PairwiseSummarizationQualityInput getPairwiseSummarizationQualityInput()

Input for pairwise summarization quality metric.

.google.cloud.aiplatform.v1.PairwiseSummarizationQualityInput pairwise_summarization_quality_input = 23;

Returns
Type	Description
PairwiseSummarizationQualityInput	The pairwiseSummarizationQualityInput.

getPairwiseSummarizationQualityInputOrBuilder()

public abstract PairwiseSummarizationQualityInputOrBuilder getPairwiseSummarizationQualityInputOrBuilder()

Input for pairwise summarization quality metric.

.google.cloud.aiplatform.v1.PairwiseSummarizationQualityInput pairwise_summarization_quality_input = 23;

Returns
Type	Description
PairwiseSummarizationQualityInputOrBuilder

getPointwiseMetricInput()

public abstract PointwiseMetricInput getPointwiseMetricInput()

Input for pointwise metric.

.google.cloud.aiplatform.v1.PointwiseMetricInput pointwise_metric_input = 28;

Returns
Type	Description
PointwiseMetricInput	The pointwiseMetricInput.

getPointwiseMetricInputOrBuilder()

public abstract PointwiseMetricInputOrBuilder getPointwiseMetricInputOrBuilder()

Input for pointwise metric.

.google.cloud.aiplatform.v1.PointwiseMetricInput pointwise_metric_input = 28;

Returns
Type	Description
PointwiseMetricInputOrBuilder

getQuestionAnsweringCorrectnessInput()

public abstract QuestionAnsweringCorrectnessInput getQuestionAnsweringCorrectnessInput()

Input for question answering correctness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessInput question_answering_correctness_input = 18;

Returns
Type	Description
QuestionAnsweringCorrectnessInput	The questionAnsweringCorrectnessInput.

getQuestionAnsweringCorrectnessInputOrBuilder()

public abstract QuestionAnsweringCorrectnessInputOrBuilder getQuestionAnsweringCorrectnessInputOrBuilder()

Input for question answering correctness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessInput question_answering_correctness_input = 18;

Returns
Type	Description
QuestionAnsweringCorrectnessInputOrBuilder

getQuestionAnsweringHelpfulnessInput()

public abstract QuestionAnsweringHelpfulnessInput getQuestionAnsweringHelpfulnessInput()

Input for question answering helpfulness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessInput question_answering_helpfulness_input = 17;

Returns
Type	Description
QuestionAnsweringHelpfulnessInput	The questionAnsweringHelpfulnessInput.

getQuestionAnsweringHelpfulnessInputOrBuilder()

public abstract QuestionAnsweringHelpfulnessInputOrBuilder getQuestionAnsweringHelpfulnessInputOrBuilder()

Input for question answering helpfulness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessInput question_answering_helpfulness_input = 17;

Returns
Type	Description
QuestionAnsweringHelpfulnessInputOrBuilder

getQuestionAnsweringQualityInput()

public abstract QuestionAnsweringQualityInput getQuestionAnsweringQualityInput()

Input for question answering quality metric.

.google.cloud.aiplatform.v1.QuestionAnsweringQualityInput question_answering_quality_input = 10;

Returns
Type	Description
QuestionAnsweringQualityInput	The questionAnsweringQualityInput.

getQuestionAnsweringQualityInputOrBuilder()

public abstract QuestionAnsweringQualityInputOrBuilder getQuestionAnsweringQualityInputOrBuilder()

Input for question answering quality metric.

.google.cloud.aiplatform.v1.QuestionAnsweringQualityInput question_answering_quality_input = 10;

Returns
Type	Description
QuestionAnsweringQualityInputOrBuilder

getQuestionAnsweringRelevanceInput()

public abstract QuestionAnsweringRelevanceInput getQuestionAnsweringRelevanceInput()

Input for question answering relevance metric.

.google.cloud.aiplatform.v1.QuestionAnsweringRelevanceInput question_answering_relevance_input = 16;

Returns
Type	Description
QuestionAnsweringRelevanceInput	The questionAnsweringRelevanceInput.

getQuestionAnsweringRelevanceInputOrBuilder()

public abstract QuestionAnsweringRelevanceInputOrBuilder getQuestionAnsweringRelevanceInputOrBuilder()

Input for question answering relevance metric.

.google.cloud.aiplatform.v1.QuestionAnsweringRelevanceInput question_answering_relevance_input = 16;

Returns
Type	Description
QuestionAnsweringRelevanceInputOrBuilder

getRougeInput()

public abstract RougeInput getRougeInput()

Instances and metric spec for rouge metric.

.google.cloud.aiplatform.v1.RougeInput rouge_input = 4;

Returns
Type	Description
RougeInput	The rougeInput.

getRougeInputOrBuilder()

public abstract RougeInputOrBuilder getRougeInputOrBuilder()

Instances and metric spec for rouge metric.

.google.cloud.aiplatform.v1.RougeInput rouge_input = 4;

Returns
Type	Description
RougeInputOrBuilder

getSafetyInput()

public abstract SafetyInput getSafetyInput()

Input for safety metric.

.google.cloud.aiplatform.v1.SafetyInput safety_input = 8;

Returns
Type	Description
SafetyInput	The safetyInput.

getSafetyInputOrBuilder()

public abstract SafetyInputOrBuilder getSafetyInputOrBuilder()

Input for safety metric.

.google.cloud.aiplatform.v1.SafetyInput safety_input = 8;

Returns
Type	Description
SafetyInputOrBuilder

getSummarizationHelpfulnessInput()

public abstract SummarizationHelpfulnessInput getSummarizationHelpfulnessInput()

Input for summarization helpfulness metric.

.google.cloud.aiplatform.v1.SummarizationHelpfulnessInput summarization_helpfulness_input = 14;

Returns
Type	Description
SummarizationHelpfulnessInput	The summarizationHelpfulnessInput.

getSummarizationHelpfulnessInputOrBuilder()

public abstract SummarizationHelpfulnessInputOrBuilder getSummarizationHelpfulnessInputOrBuilder()

Input for summarization helpfulness metric.

.google.cloud.aiplatform.v1.SummarizationHelpfulnessInput summarization_helpfulness_input = 14;

Returns
Type	Description
SummarizationHelpfulnessInputOrBuilder

getSummarizationQualityInput()

public abstract SummarizationQualityInput getSummarizationQualityInput()

Input for summarization quality metric.

.google.cloud.aiplatform.v1.SummarizationQualityInput summarization_quality_input = 7;

Returns
Type	Description
SummarizationQualityInput	The summarizationQualityInput.

getSummarizationQualityInputOrBuilder()

public abstract SummarizationQualityInputOrBuilder getSummarizationQualityInputOrBuilder()

Input for summarization quality metric.

.google.cloud.aiplatform.v1.SummarizationQualityInput summarization_quality_input = 7;

Returns
Type	Description
SummarizationQualityInputOrBuilder

getSummarizationVerbosityInput()

public abstract SummarizationVerbosityInput getSummarizationVerbosityInput()

Input for summarization verbosity metric.

.google.cloud.aiplatform.v1.SummarizationVerbosityInput summarization_verbosity_input = 15;

Returns
Type	Description
SummarizationVerbosityInput	The summarizationVerbosityInput.

getSummarizationVerbosityInputOrBuilder()

public abstract SummarizationVerbosityInputOrBuilder getSummarizationVerbosityInputOrBuilder()

Input for summarization verbosity metric.

.google.cloud.aiplatform.v1.SummarizationVerbosityInput summarization_verbosity_input = 15;

Returns
Type	Description
SummarizationVerbosityInputOrBuilder

getToolCallValidInput()

public abstract ToolCallValidInput getToolCallValidInput()

Tool call metric instances. Input for tool call valid metric.

.google.cloud.aiplatform.v1.ToolCallValidInput tool_call_valid_input = 19;

Returns
Type	Description
ToolCallValidInput	The toolCallValidInput.

getToolCallValidInputOrBuilder()

public abstract ToolCallValidInputOrBuilder getToolCallValidInputOrBuilder()

Tool call metric instances. Input for tool call valid metric.

.google.cloud.aiplatform.v1.ToolCallValidInput tool_call_valid_input = 19;

Returns
Type	Description
ToolCallValidInputOrBuilder

getToolNameMatchInput()

public abstract ToolNameMatchInput getToolNameMatchInput()

Input for tool name match metric.

.google.cloud.aiplatform.v1.ToolNameMatchInput tool_name_match_input = 20;

Returns
Type	Description
ToolNameMatchInput	The toolNameMatchInput.

getToolNameMatchInputOrBuilder()

public abstract ToolNameMatchInputOrBuilder getToolNameMatchInputOrBuilder()

Input for tool name match metric.

.google.cloud.aiplatform.v1.ToolNameMatchInput tool_name_match_input = 20;

Returns
Type	Description
ToolNameMatchInputOrBuilder

getToolParameterKeyMatchInput()

public abstract ToolParameterKeyMatchInput getToolParameterKeyMatchInput()

Input for tool parameter key match metric.

.google.cloud.aiplatform.v1.ToolParameterKeyMatchInput tool_parameter_key_match_input = 21;

Returns
Type	Description
ToolParameterKeyMatchInput	The toolParameterKeyMatchInput.

getToolParameterKeyMatchInputOrBuilder()

public abstract ToolParameterKeyMatchInputOrBuilder getToolParameterKeyMatchInputOrBuilder()

Input for tool parameter key match metric.

.google.cloud.aiplatform.v1.ToolParameterKeyMatchInput tool_parameter_key_match_input = 21;

Returns
Type	Description
ToolParameterKeyMatchInputOrBuilder

getToolParameterKvMatchInput()

public abstract ToolParameterKVMatchInput getToolParameterKvMatchInput()

Input for tool parameter key value match metric.

.google.cloud.aiplatform.v1.ToolParameterKVMatchInput tool_parameter_kv_match_input = 22;

Returns
Type	Description
ToolParameterKVMatchInput	The toolParameterKvMatchInput.

getToolParameterKvMatchInputOrBuilder()

public abstract ToolParameterKVMatchInputOrBuilder getToolParameterKvMatchInputOrBuilder()

Input for tool parameter key value match metric.

.google.cloud.aiplatform.v1.ToolParameterKVMatchInput tool_parameter_kv_match_input = 22;

Returns
Type	Description
ToolParameterKVMatchInputOrBuilder

hasBleuInput()

public abstract boolean hasBleuInput()

Instances and metric spec for bleu metric.

.google.cloud.aiplatform.v1.BleuInput bleu_input = 3;

Returns
Type	Description
boolean	Whether the bleuInput field is set.

hasCoherenceInput()

public abstract boolean hasCoherenceInput()

Input for coherence metric.

.google.cloud.aiplatform.v1.CoherenceInput coherence_input = 6;

Returns
Type	Description
boolean	Whether the coherenceInput field is set.

hasExactMatchInput()

public abstract boolean hasExactMatchInput()

Auto metric instances. Instances and metric spec for exact match metric.

.google.cloud.aiplatform.v1.ExactMatchInput exact_match_input = 2;

Returns
Type	Description
boolean	Whether the exactMatchInput field is set.

hasFluencyInput()

public abstract 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
Type	Description
boolean	Whether the fluencyInput field is set.

hasFulfillmentInput()

public abstract boolean hasFulfillmentInput()

Input for fulfillment metric.

.google.cloud.aiplatform.v1.FulfillmentInput fulfillment_input = 12;

Returns
Type	Description
boolean	Whether the fulfillmentInput field is set.

hasGroundednessInput()

public abstract boolean hasGroundednessInput()

Input for groundedness metric.

.google.cloud.aiplatform.v1.GroundednessInput groundedness_input = 9;

Returns
Type	Description
boolean	Whether the groundednessInput field is set.

hasPairwiseMetricInput()

public abstract boolean hasPairwiseMetricInput()

Input for pairwise metric.

.google.cloud.aiplatform.v1.PairwiseMetricInput pairwise_metric_input = 29;

Returns
Type	Description
boolean	Whether the pairwiseMetricInput field is set.

hasPairwiseQuestionAnsweringQualityInput()

public abstract boolean hasPairwiseQuestionAnsweringQualityInput()

Input for pairwise question answering quality metric.

.google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityInput pairwise_question_answering_quality_input = 24;

Returns
Type	Description
boolean	Whether the pairwiseQuestionAnsweringQualityInput field is set.

hasPairwiseSummarizationQualityInput()

public abstract boolean hasPairwiseSummarizationQualityInput()

Input for pairwise summarization quality metric.

.google.cloud.aiplatform.v1.PairwiseSummarizationQualityInput pairwise_summarization_quality_input = 23;

Returns
Type	Description
boolean	Whether the pairwiseSummarizationQualityInput field is set.

hasPointwiseMetricInput()

public abstract boolean hasPointwiseMetricInput()

Input for pointwise metric.

.google.cloud.aiplatform.v1.PointwiseMetricInput pointwise_metric_input = 28;

Returns
Type	Description
boolean	Whether the pointwiseMetricInput field is set.

hasQuestionAnsweringCorrectnessInput()

public abstract boolean hasQuestionAnsweringCorrectnessInput()

Input for question answering correctness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessInput question_answering_correctness_input = 18;

Returns
Type	Description
boolean	Whether the questionAnsweringCorrectnessInput field is set.

hasQuestionAnsweringHelpfulnessInput()

public abstract boolean hasQuestionAnsweringHelpfulnessInput()

Input for question answering helpfulness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessInput question_answering_helpfulness_input = 17;

Returns
Type	Description
boolean	Whether the questionAnsweringHelpfulnessInput field is set.

hasQuestionAnsweringQualityInput()

public abstract boolean hasQuestionAnsweringQualityInput()

Input for question answering quality metric.

.google.cloud.aiplatform.v1.QuestionAnsweringQualityInput question_answering_quality_input = 10;

Returns
Type	Description
boolean	Whether the questionAnsweringQualityInput field is set.

hasQuestionAnsweringRelevanceInput()

public abstract boolean hasQuestionAnsweringRelevanceInput()

Input for question answering relevance metric.

.google.cloud.aiplatform.v1.QuestionAnsweringRelevanceInput question_answering_relevance_input = 16;

Returns
Type	Description
boolean	Whether the questionAnsweringRelevanceInput field is set.

hasRougeInput()

public abstract boolean hasRougeInput()

Instances and metric spec for rouge metric.

.google.cloud.aiplatform.v1.RougeInput rouge_input = 4;

Returns
Type	Description
boolean	Whether the rougeInput field is set.

hasSafetyInput()

public abstract boolean hasSafetyInput()

Input for safety metric.

.google.cloud.aiplatform.v1.SafetyInput safety_input = 8;

Returns
Type	Description
boolean	Whether the safetyInput field is set.

hasSummarizationHelpfulnessInput()

public abstract boolean hasSummarizationHelpfulnessInput()

Input for summarization helpfulness metric.

.google.cloud.aiplatform.v1.SummarizationHelpfulnessInput summarization_helpfulness_input = 14;

Returns
Type	Description
boolean	Whether the summarizationHelpfulnessInput field is set.

hasSummarizationQualityInput()

public abstract boolean hasSummarizationQualityInput()

Input for summarization quality metric.

.google.cloud.aiplatform.v1.SummarizationQualityInput summarization_quality_input = 7;

Returns
Type	Description
boolean	Whether the summarizationQualityInput field is set.

hasSummarizationVerbosityInput()

public abstract boolean hasSummarizationVerbosityInput()

Input for summarization verbosity metric.

.google.cloud.aiplatform.v1.SummarizationVerbosityInput summarization_verbosity_input = 15;

Returns
Type	Description
boolean	Whether the summarizationVerbosityInput field is set.

hasToolCallValidInput()

public abstract boolean hasToolCallValidInput()

Tool call metric instances. Input for tool call valid metric.

.google.cloud.aiplatform.v1.ToolCallValidInput tool_call_valid_input = 19;

Returns
Type	Description
boolean	Whether the toolCallValidInput field is set.

hasToolNameMatchInput()

public abstract boolean hasToolNameMatchInput()

Input for tool name match metric.

.google.cloud.aiplatform.v1.ToolNameMatchInput tool_name_match_input = 20;

Returns
Type	Description
boolean	Whether the toolNameMatchInput field is set.

hasToolParameterKeyMatchInput()

public abstract boolean hasToolParameterKeyMatchInput()

Input for tool parameter key match metric.

.google.cloud.aiplatform.v1.ToolParameterKeyMatchInput tool_parameter_key_match_input = 21;

Returns
Type	Description
boolean	Whether the toolParameterKeyMatchInput field is set.

hasToolParameterKvMatchInput()

public abstract boolean hasToolParameterKvMatchInput()

Input for tool parameter key value match metric.

.google.cloud.aiplatform.v1.ToolParameterKVMatchInput tool_parameter_kv_match_input = 22;

Returns
Type	Description
boolean	Whether the toolParameterKvMatchInput field is set.