Interface EvaluateInstancesResponseOrBuilder (3.50.0)

public interface EvaluateInstancesResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBleuResults()

public abstract BleuResults getBleuResults()

Results for bleu metric.

.google.cloud.aiplatform.v1.BleuResults bleu_results = 2;

Returns
Type Description
BleuResults

The bleuResults.

getBleuResultsOrBuilder()

public abstract BleuResultsOrBuilder getBleuResultsOrBuilder()

Results for bleu metric.

.google.cloud.aiplatform.v1.BleuResults bleu_results = 2;

Returns
Type Description
BleuResultsOrBuilder

getCoherenceResult()

public abstract CoherenceResult getCoherenceResult()

Result for coherence metric.

.google.cloud.aiplatform.v1.CoherenceResult coherence_result = 5;

Returns
Type Description
CoherenceResult

The coherenceResult.

getCoherenceResultOrBuilder()

public abstract CoherenceResultOrBuilder getCoherenceResultOrBuilder()

Result for coherence metric.

.google.cloud.aiplatform.v1.CoherenceResult coherence_result = 5;

Returns
Type Description
CoherenceResultOrBuilder

getEvaluationResultsCase()

public abstract EvaluateInstancesResponse.EvaluationResultsCase getEvaluationResultsCase()
Returns
Type Description
EvaluateInstancesResponse.EvaluationResultsCase

getExactMatchResults()

public abstract ExactMatchResults getExactMatchResults()

Auto metric evaluation results. Results for exact match metric.

.google.cloud.aiplatform.v1.ExactMatchResults exact_match_results = 1;

Returns
Type Description
ExactMatchResults

The exactMatchResults.

getExactMatchResultsOrBuilder()

public abstract ExactMatchResultsOrBuilder getExactMatchResultsOrBuilder()

Auto metric evaluation results. Results for exact match metric.

.google.cloud.aiplatform.v1.ExactMatchResults exact_match_results = 1;

Returns
Type Description
ExactMatchResultsOrBuilder

getFluencyResult()

public abstract FluencyResult getFluencyResult()

LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.

.google.cloud.aiplatform.v1.FluencyResult fluency_result = 4;

Returns
Type Description
FluencyResult

The fluencyResult.

getFluencyResultOrBuilder()

public abstract FluencyResultOrBuilder getFluencyResultOrBuilder()

LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.

.google.cloud.aiplatform.v1.FluencyResult fluency_result = 4;

Returns
Type Description
FluencyResultOrBuilder

getFulfillmentResult()

public abstract FulfillmentResult getFulfillmentResult()

Result for fulfillment metric.

.google.cloud.aiplatform.v1.FulfillmentResult fulfillment_result = 11;

Returns
Type Description
FulfillmentResult

The fulfillmentResult.

getFulfillmentResultOrBuilder()

public abstract FulfillmentResultOrBuilder getFulfillmentResultOrBuilder()

Result for fulfillment metric.

.google.cloud.aiplatform.v1.FulfillmentResult fulfillment_result = 11;

Returns
Type Description
FulfillmentResultOrBuilder

getGroundednessResult()

public abstract GroundednessResult getGroundednessResult()

Result for groundedness metric.

.google.cloud.aiplatform.v1.GroundednessResult groundedness_result = 8;

Returns
Type Description
GroundednessResult

The groundednessResult.

getGroundednessResultOrBuilder()

public abstract GroundednessResultOrBuilder getGroundednessResultOrBuilder()

Result for groundedness metric.

.google.cloud.aiplatform.v1.GroundednessResult groundedness_result = 8;

Returns
Type Description
GroundednessResultOrBuilder

getPairwiseMetricResult()

public abstract PairwiseMetricResult getPairwiseMetricResult()

Result for pairwise metric.

.google.cloud.aiplatform.v1.PairwiseMetricResult pairwise_metric_result = 28;

Returns
Type Description
PairwiseMetricResult

The pairwiseMetricResult.

getPairwiseMetricResultOrBuilder()

public abstract PairwiseMetricResultOrBuilder getPairwiseMetricResultOrBuilder()

Result for pairwise metric.

.google.cloud.aiplatform.v1.PairwiseMetricResult pairwise_metric_result = 28;

Returns
Type Description
PairwiseMetricResultOrBuilder

getPairwiseQuestionAnsweringQualityResult()

public abstract PairwiseQuestionAnsweringQualityResult getPairwiseQuestionAnsweringQualityResult()

Result for pairwise question answering quality metric.

.google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityResult pairwise_question_answering_quality_result = 23;

Returns
Type Description
PairwiseQuestionAnsweringQualityResult

The pairwiseQuestionAnsweringQualityResult.

getPairwiseQuestionAnsweringQualityResultOrBuilder()

public abstract PairwiseQuestionAnsweringQualityResultOrBuilder getPairwiseQuestionAnsweringQualityResultOrBuilder()

Result for pairwise question answering quality metric.

.google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityResult pairwise_question_answering_quality_result = 23;

Returns
Type Description
PairwiseQuestionAnsweringQualityResultOrBuilder

getPairwiseSummarizationQualityResult()

public abstract PairwiseSummarizationQualityResult getPairwiseSummarizationQualityResult()

Result for pairwise summarization quality metric.

.google.cloud.aiplatform.v1.PairwiseSummarizationQualityResult pairwise_summarization_quality_result = 22;

Returns
Type Description
PairwiseSummarizationQualityResult

The pairwiseSummarizationQualityResult.

getPairwiseSummarizationQualityResultOrBuilder()

public abstract PairwiseSummarizationQualityResultOrBuilder getPairwiseSummarizationQualityResultOrBuilder()

Result for pairwise summarization quality metric.

.google.cloud.aiplatform.v1.PairwiseSummarizationQualityResult pairwise_summarization_quality_result = 22;

Returns
Type Description
PairwiseSummarizationQualityResultOrBuilder

getPointwiseMetricResult()

public abstract PointwiseMetricResult getPointwiseMetricResult()

Generic metrics. Result for pointwise metric.

.google.cloud.aiplatform.v1.PointwiseMetricResult pointwise_metric_result = 27;

Returns
Type Description
PointwiseMetricResult

The pointwiseMetricResult.

getPointwiseMetricResultOrBuilder()

public abstract PointwiseMetricResultOrBuilder getPointwiseMetricResultOrBuilder()

Generic metrics. Result for pointwise metric.

.google.cloud.aiplatform.v1.PointwiseMetricResult pointwise_metric_result = 27;

Returns
Type Description
PointwiseMetricResultOrBuilder

getQuestionAnsweringCorrectnessResult()

public abstract QuestionAnsweringCorrectnessResult getQuestionAnsweringCorrectnessResult()

Result for question answering correctness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessResult question_answering_correctness_result = 17;

Returns
Type Description
QuestionAnsweringCorrectnessResult

The questionAnsweringCorrectnessResult.

getQuestionAnsweringCorrectnessResultOrBuilder()

public abstract QuestionAnsweringCorrectnessResultOrBuilder getQuestionAnsweringCorrectnessResultOrBuilder()

Result for question answering correctness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessResult question_answering_correctness_result = 17;

Returns
Type Description
QuestionAnsweringCorrectnessResultOrBuilder

getQuestionAnsweringHelpfulnessResult()

public abstract QuestionAnsweringHelpfulnessResult getQuestionAnsweringHelpfulnessResult()

Result for question answering helpfulness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessResult question_answering_helpfulness_result = 16;

Returns
Type Description
QuestionAnsweringHelpfulnessResult

The questionAnsweringHelpfulnessResult.

getQuestionAnsweringHelpfulnessResultOrBuilder()

public abstract QuestionAnsweringHelpfulnessResultOrBuilder getQuestionAnsweringHelpfulnessResultOrBuilder()

Result for question answering helpfulness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessResult question_answering_helpfulness_result = 16;

Returns
Type Description
QuestionAnsweringHelpfulnessResultOrBuilder

getQuestionAnsweringQualityResult()

public abstract QuestionAnsweringQualityResult getQuestionAnsweringQualityResult()

Question answering only metrics. Result for question answering quality metric.

.google.cloud.aiplatform.v1.QuestionAnsweringQualityResult question_answering_quality_result = 9;

Returns
Type Description
QuestionAnsweringQualityResult

The questionAnsweringQualityResult.

getQuestionAnsweringQualityResultOrBuilder()

public abstract QuestionAnsweringQualityResultOrBuilder getQuestionAnsweringQualityResultOrBuilder()

Question answering only metrics. Result for question answering quality metric.

.google.cloud.aiplatform.v1.QuestionAnsweringQualityResult question_answering_quality_result = 9;

Returns
Type Description
QuestionAnsweringQualityResultOrBuilder

getQuestionAnsweringRelevanceResult()

public abstract QuestionAnsweringRelevanceResult getQuestionAnsweringRelevanceResult()

Result for question answering relevance metric.

.google.cloud.aiplatform.v1.QuestionAnsweringRelevanceResult question_answering_relevance_result = 15;

Returns
Type Description
QuestionAnsweringRelevanceResult

The questionAnsweringRelevanceResult.

getQuestionAnsweringRelevanceResultOrBuilder()

public abstract QuestionAnsweringRelevanceResultOrBuilder getQuestionAnsweringRelevanceResultOrBuilder()

Result for question answering relevance metric.

.google.cloud.aiplatform.v1.QuestionAnsweringRelevanceResult question_answering_relevance_result = 15;

Returns
Type Description
QuestionAnsweringRelevanceResultOrBuilder

getRougeResults()

public abstract RougeResults getRougeResults()

Results for rouge metric.

.google.cloud.aiplatform.v1.RougeResults rouge_results = 3;

Returns
Type Description
RougeResults

The rougeResults.

getRougeResultsOrBuilder()

public abstract RougeResultsOrBuilder getRougeResultsOrBuilder()

Results for rouge metric.

.google.cloud.aiplatform.v1.RougeResults rouge_results = 3;

Returns
Type Description
RougeResultsOrBuilder

getSafetyResult()

public abstract SafetyResult getSafetyResult()

Result for safety metric.

.google.cloud.aiplatform.v1.SafetyResult safety_result = 7;

Returns
Type Description
SafetyResult

The safetyResult.

getSafetyResultOrBuilder()

public abstract SafetyResultOrBuilder getSafetyResultOrBuilder()

Result for safety metric.

.google.cloud.aiplatform.v1.SafetyResult safety_result = 7;

Returns
Type Description
SafetyResultOrBuilder

getSummarizationHelpfulnessResult()

public abstract SummarizationHelpfulnessResult getSummarizationHelpfulnessResult()

Result for summarization helpfulness metric.

.google.cloud.aiplatform.v1.SummarizationHelpfulnessResult summarization_helpfulness_result = 13;

Returns
Type Description
SummarizationHelpfulnessResult

The summarizationHelpfulnessResult.

getSummarizationHelpfulnessResultOrBuilder()

public abstract SummarizationHelpfulnessResultOrBuilder getSummarizationHelpfulnessResultOrBuilder()

Result for summarization helpfulness metric.

.google.cloud.aiplatform.v1.SummarizationHelpfulnessResult summarization_helpfulness_result = 13;

Returns
Type Description
SummarizationHelpfulnessResultOrBuilder

getSummarizationQualityResult()

public abstract SummarizationQualityResult getSummarizationQualityResult()

Summarization only metrics. Result for summarization quality metric.

.google.cloud.aiplatform.v1.SummarizationQualityResult summarization_quality_result = 6;

Returns
Type Description
SummarizationQualityResult

The summarizationQualityResult.

getSummarizationQualityResultOrBuilder()

public abstract SummarizationQualityResultOrBuilder getSummarizationQualityResultOrBuilder()

Summarization only metrics. Result for summarization quality metric.

.google.cloud.aiplatform.v1.SummarizationQualityResult summarization_quality_result = 6;

Returns
Type Description
SummarizationQualityResultOrBuilder

getSummarizationVerbosityResult()

public abstract SummarizationVerbosityResult getSummarizationVerbosityResult()

Result for summarization verbosity metric.

.google.cloud.aiplatform.v1.SummarizationVerbosityResult summarization_verbosity_result = 14;

Returns
Type Description
SummarizationVerbosityResult

The summarizationVerbosityResult.

getSummarizationVerbosityResultOrBuilder()

public abstract SummarizationVerbosityResultOrBuilder getSummarizationVerbosityResultOrBuilder()

Result for summarization verbosity metric.

.google.cloud.aiplatform.v1.SummarizationVerbosityResult summarization_verbosity_result = 14;

Returns
Type Description
SummarizationVerbosityResultOrBuilder

getToolCallValidResults()

public abstract ToolCallValidResults getToolCallValidResults()

Tool call metrics. Results for tool call valid metric.

.google.cloud.aiplatform.v1.ToolCallValidResults tool_call_valid_results = 18;

Returns
Type Description
ToolCallValidResults

The toolCallValidResults.

getToolCallValidResultsOrBuilder()

public abstract ToolCallValidResultsOrBuilder getToolCallValidResultsOrBuilder()

Tool call metrics. Results for tool call valid metric.

.google.cloud.aiplatform.v1.ToolCallValidResults tool_call_valid_results = 18;

Returns
Type Description
ToolCallValidResultsOrBuilder

getToolNameMatchResults()

public abstract ToolNameMatchResults getToolNameMatchResults()

Results for tool name match metric.

.google.cloud.aiplatform.v1.ToolNameMatchResults tool_name_match_results = 19;

Returns
Type Description
ToolNameMatchResults

The toolNameMatchResults.

getToolNameMatchResultsOrBuilder()

public abstract ToolNameMatchResultsOrBuilder getToolNameMatchResultsOrBuilder()

Results for tool name match metric.

.google.cloud.aiplatform.v1.ToolNameMatchResults tool_name_match_results = 19;

Returns
Type Description
ToolNameMatchResultsOrBuilder

getToolParameterKeyMatchResults()

public abstract ToolParameterKeyMatchResults getToolParameterKeyMatchResults()

Results for tool parameter key match metric.

.google.cloud.aiplatform.v1.ToolParameterKeyMatchResults tool_parameter_key_match_results = 20;

Returns
Type Description
ToolParameterKeyMatchResults

The toolParameterKeyMatchResults.

getToolParameterKeyMatchResultsOrBuilder()

public abstract ToolParameterKeyMatchResultsOrBuilder getToolParameterKeyMatchResultsOrBuilder()

Results for tool parameter key match metric.

.google.cloud.aiplatform.v1.ToolParameterKeyMatchResults tool_parameter_key_match_results = 20;

Returns
Type Description
ToolParameterKeyMatchResultsOrBuilder

getToolParameterKvMatchResults()

public abstract ToolParameterKVMatchResults getToolParameterKvMatchResults()

Results for tool parameter key value match metric.

.google.cloud.aiplatform.v1.ToolParameterKVMatchResults tool_parameter_kv_match_results = 21;

Returns
Type Description
ToolParameterKVMatchResults

The toolParameterKvMatchResults.

getToolParameterKvMatchResultsOrBuilder()

public abstract ToolParameterKVMatchResultsOrBuilder getToolParameterKvMatchResultsOrBuilder()

Results for tool parameter key value match metric.

.google.cloud.aiplatform.v1.ToolParameterKVMatchResults tool_parameter_kv_match_results = 21;

Returns
Type Description
ToolParameterKVMatchResultsOrBuilder

hasBleuResults()

public abstract boolean hasBleuResults()

Results for bleu metric.

.google.cloud.aiplatform.v1.BleuResults bleu_results = 2;

Returns
Type Description
boolean

Whether the bleuResults field is set.

hasCoherenceResult()

public abstract boolean hasCoherenceResult()

Result for coherence metric.

.google.cloud.aiplatform.v1.CoherenceResult coherence_result = 5;

Returns
Type Description
boolean

Whether the coherenceResult field is set.

hasExactMatchResults()

public abstract boolean hasExactMatchResults()

Auto metric evaluation results. Results for exact match metric.

.google.cloud.aiplatform.v1.ExactMatchResults exact_match_results = 1;

Returns
Type Description
boolean

Whether the exactMatchResults field is set.

hasFluencyResult()

public abstract boolean hasFluencyResult()

LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.

.google.cloud.aiplatform.v1.FluencyResult fluency_result = 4;

Returns
Type Description
boolean

Whether the fluencyResult field is set.

hasFulfillmentResult()

public abstract boolean hasFulfillmentResult()

Result for fulfillment metric.

.google.cloud.aiplatform.v1.FulfillmentResult fulfillment_result = 11;

Returns
Type Description
boolean

Whether the fulfillmentResult field is set.

hasGroundednessResult()

public abstract boolean hasGroundednessResult()

Result for groundedness metric.

.google.cloud.aiplatform.v1.GroundednessResult groundedness_result = 8;

Returns
Type Description
boolean

Whether the groundednessResult field is set.

hasPairwiseMetricResult()

public abstract boolean hasPairwiseMetricResult()

Result for pairwise metric.

.google.cloud.aiplatform.v1.PairwiseMetricResult pairwise_metric_result = 28;

Returns
Type Description
boolean

Whether the pairwiseMetricResult field is set.

hasPairwiseQuestionAnsweringQualityResult()

public abstract boolean hasPairwiseQuestionAnsweringQualityResult()

Result for pairwise question answering quality metric.

.google.cloud.aiplatform.v1.PairwiseQuestionAnsweringQualityResult pairwise_question_answering_quality_result = 23;

Returns
Type Description
boolean

Whether the pairwiseQuestionAnsweringQualityResult field is set.

hasPairwiseSummarizationQualityResult()

public abstract boolean hasPairwiseSummarizationQualityResult()

Result for pairwise summarization quality metric.

.google.cloud.aiplatform.v1.PairwiseSummarizationQualityResult pairwise_summarization_quality_result = 22;

Returns
Type Description
boolean

Whether the pairwiseSummarizationQualityResult field is set.

hasPointwiseMetricResult()

public abstract boolean hasPointwiseMetricResult()

Generic metrics. Result for pointwise metric.

.google.cloud.aiplatform.v1.PointwiseMetricResult pointwise_metric_result = 27;

Returns
Type Description
boolean

Whether the pointwiseMetricResult field is set.

hasQuestionAnsweringCorrectnessResult()

public abstract boolean hasQuestionAnsweringCorrectnessResult()

Result for question answering correctness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringCorrectnessResult question_answering_correctness_result = 17;

Returns
Type Description
boolean

Whether the questionAnsweringCorrectnessResult field is set.

hasQuestionAnsweringHelpfulnessResult()

public abstract boolean hasQuestionAnsweringHelpfulnessResult()

Result for question answering helpfulness metric.

.google.cloud.aiplatform.v1.QuestionAnsweringHelpfulnessResult question_answering_helpfulness_result = 16;

Returns
Type Description
boolean

Whether the questionAnsweringHelpfulnessResult field is set.

hasQuestionAnsweringQualityResult()

public abstract boolean hasQuestionAnsweringQualityResult()

Question answering only metrics. Result for question answering quality metric.

.google.cloud.aiplatform.v1.QuestionAnsweringQualityResult question_answering_quality_result = 9;

Returns
Type Description
boolean

Whether the questionAnsweringQualityResult field is set.

hasQuestionAnsweringRelevanceResult()

public abstract boolean hasQuestionAnsweringRelevanceResult()

Result for question answering relevance metric.

.google.cloud.aiplatform.v1.QuestionAnsweringRelevanceResult question_answering_relevance_result = 15;

Returns
Type Description
boolean

Whether the questionAnsweringRelevanceResult field is set.

hasRougeResults()

public abstract boolean hasRougeResults()

Results for rouge metric.

.google.cloud.aiplatform.v1.RougeResults rouge_results = 3;

Returns
Type Description
boolean

Whether the rougeResults field is set.

hasSafetyResult()

public abstract boolean hasSafetyResult()

Result for safety metric.

.google.cloud.aiplatform.v1.SafetyResult safety_result = 7;

Returns
Type Description
boolean

Whether the safetyResult field is set.

hasSummarizationHelpfulnessResult()

public abstract boolean hasSummarizationHelpfulnessResult()

Result for summarization helpfulness metric.

.google.cloud.aiplatform.v1.SummarizationHelpfulnessResult summarization_helpfulness_result = 13;

Returns
Type Description
boolean

Whether the summarizationHelpfulnessResult field is set.

hasSummarizationQualityResult()

public abstract boolean hasSummarizationQualityResult()

Summarization only metrics. Result for summarization quality metric.

.google.cloud.aiplatform.v1.SummarizationQualityResult summarization_quality_result = 6;

Returns
Type Description
boolean

Whether the summarizationQualityResult field is set.

hasSummarizationVerbosityResult()

public abstract boolean hasSummarizationVerbosityResult()

Result for summarization verbosity metric.

.google.cloud.aiplatform.v1.SummarizationVerbosityResult summarization_verbosity_result = 14;

Returns
Type Description
boolean

Whether the summarizationVerbosityResult field is set.

hasToolCallValidResults()

public abstract boolean hasToolCallValidResults()

Tool call metrics. Results for tool call valid metric.

.google.cloud.aiplatform.v1.ToolCallValidResults tool_call_valid_results = 18;

Returns
Type Description
boolean

Whether the toolCallValidResults field is set.

hasToolNameMatchResults()

public abstract boolean hasToolNameMatchResults()

Results for tool name match metric.

.google.cloud.aiplatform.v1.ToolNameMatchResults tool_name_match_results = 19;

Returns
Type Description
boolean

Whether the toolNameMatchResults field is set.

hasToolParameterKeyMatchResults()

public abstract boolean hasToolParameterKeyMatchResults()

Results for tool parameter key match metric.

.google.cloud.aiplatform.v1.ToolParameterKeyMatchResults tool_parameter_key_match_results = 20;

Returns
Type Description
boolean

Whether the toolParameterKeyMatchResults field is set.

hasToolParameterKvMatchResults()

public abstract boolean hasToolParameterKvMatchResults()

Results for tool parameter key value match metric.

.google.cloud.aiplatform.v1.ToolParameterKVMatchResults tool_parameter_kv_match_results = 21;

Returns
Type Description
boolean

Whether the toolParameterKvMatchResults field is set.