Interface MetricOrBuilder (3.88.0)

public interface MetricOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregationMetrics(int index)

public abstract Metric.AggregationMetric getAggregationMetrics(int index)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Metric.AggregationMetric

The aggregationMetrics at the given index.

getAggregationMetricsCount()

public abstract int getAggregationMetricsCount()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of aggregationMetrics.

getAggregationMetricsList()

public abstract List<Metric.AggregationMetric> getAggregationMetricsList()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AggregationMetric>

A list containing the aggregationMetrics.

getAggregationMetricsValue(int index)

public abstract int getAggregationMetricsValue(int index)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of aggregationMetrics at the given index.

getAggregationMetricsValueList()

public abstract List<Integer> getAggregationMetricsValueList()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for aggregationMetrics.

getBleuSpec()

public abstract BleuSpec getBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
BleuSpec

The bleuSpec.

getBleuSpecOrBuilder()

public abstract BleuSpecOrBuilder getBleuSpecOrBuilder()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
BleuSpecOrBuilder

getComputationBasedMetricSpec()

public abstract ComputationBasedMetricSpec getComputationBasedMetricSpec()

Spec for a computation based metric.

.google.cloud.aiplatform.v1beta1.ComputationBasedMetricSpec computation_based_metric_spec = 9;

Returns
Type Description
ComputationBasedMetricSpec

The computationBasedMetricSpec.

getComputationBasedMetricSpecOrBuilder()

public abstract ComputationBasedMetricSpecOrBuilder getComputationBasedMetricSpecOrBuilder()

Spec for a computation based metric.

.google.cloud.aiplatform.v1beta1.ComputationBasedMetricSpec computation_based_metric_spec = 9;

Returns
Type Description
ComputationBasedMetricSpecOrBuilder

getExactMatchSpec()

public abstract ExactMatchSpec getExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
ExactMatchSpec

The exactMatchSpec.

getExactMatchSpecOrBuilder()

public abstract ExactMatchSpecOrBuilder getExactMatchSpecOrBuilder()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
ExactMatchSpecOrBuilder

getLlmBasedMetricSpec()

public abstract LLMBasedMetricSpec getLlmBasedMetricSpec()

Spec for an LLM based metric.

.google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec llm_based_metric_spec = 10;

Returns
Type Description
LLMBasedMetricSpec

The llmBasedMetricSpec.

getLlmBasedMetricSpecOrBuilder()

public abstract LLMBasedMetricSpecOrBuilder getLlmBasedMetricSpecOrBuilder()

Spec for an LLM based metric.

.google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec llm_based_metric_spec = 10;

Returns
Type Description
LLMBasedMetricSpecOrBuilder

getMetricSpecCase()

public abstract Metric.MetricSpecCase getMetricSpecCase()
Returns
Type Description
Metric.MetricSpecCase

getPairwiseMetricSpec()

public abstract PairwiseMetricSpec getPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
PairwiseMetricSpec

The pairwiseMetricSpec.

getPairwiseMetricSpecOrBuilder()

public abstract PairwiseMetricSpecOrBuilder getPairwiseMetricSpecOrBuilder()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
PairwiseMetricSpecOrBuilder

getPointwiseMetricSpec()

public abstract PointwiseMetricSpec getPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
PointwiseMetricSpec

The pointwiseMetricSpec.

getPointwiseMetricSpecOrBuilder()

public abstract PointwiseMetricSpecOrBuilder getPointwiseMetricSpecOrBuilder()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
PointwiseMetricSpecOrBuilder

getPredefinedMetricSpec()

public abstract PredefinedMetricSpec getPredefinedMetricSpec()

The spec for a pre-defined metric.

.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_metric_spec = 8;

Returns
Type Description
PredefinedMetricSpec

The predefinedMetricSpec.

getPredefinedMetricSpecOrBuilder()

public abstract PredefinedMetricSpecOrBuilder getPredefinedMetricSpecOrBuilder()

The spec for a pre-defined metric.

.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_metric_spec = 8;

Returns
Type Description
PredefinedMetricSpecOrBuilder

getRougeSpec()

public abstract RougeSpec getRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
RougeSpec

The rougeSpec.

getRougeSpecOrBuilder()

public abstract RougeSpecOrBuilder getRougeSpecOrBuilder()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
RougeSpecOrBuilder

hasBleuSpec()

public abstract boolean hasBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
boolean

Whether the bleuSpec field is set.

hasComputationBasedMetricSpec()

public abstract boolean hasComputationBasedMetricSpec()

Spec for a computation based metric.

.google.cloud.aiplatform.v1beta1.ComputationBasedMetricSpec computation_based_metric_spec = 9;

Returns
Type Description
boolean

Whether the computationBasedMetricSpec field is set.

hasExactMatchSpec()

public abstract boolean hasExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
boolean

Whether the exactMatchSpec field is set.

hasLlmBasedMetricSpec()

public abstract boolean hasLlmBasedMetricSpec()

Spec for an LLM based metric.

.google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec llm_based_metric_spec = 10;

Returns
Type Description
boolean

Whether the llmBasedMetricSpec field is set.

hasPairwiseMetricSpec()

public abstract boolean hasPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
boolean

Whether the pairwiseMetricSpec field is set.

hasPointwiseMetricSpec()

public abstract boolean hasPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
boolean

Whether the pointwiseMetricSpec field is set.

hasPredefinedMetricSpec()

public abstract boolean hasPredefinedMetricSpec()

The spec for a pre-defined metric.

.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_metric_spec = 8;

Returns
Type Description
boolean

Whether the predefinedMetricSpec field is set.

hasRougeSpec()

public abstract boolean hasRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
boolean

Whether the rougeSpec field is set.