Class Metric (3.77.0)
public final class Metric extends GeneratedMessageV3 implements MetricOrBuilder
The metric used for dataset level evaluation.
Protobuf type google.cloud.aiplatform.v1beta1.Metric
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int AGGREGATION_METRICS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int BLEU_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXACT_MATCH_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PAIRWISE_METRIC_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int POINTWISE_METRIC_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ROUGE_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Metric getDefaultInstance()
| Returns |
| Type |
Description |
Metric |
|
public static final Descriptors.Descriptor getDescriptor()
public static Metric.Builder newBuilder()
public static Metric.Builder newBuilder(Metric prototype)
| Parameter |
| Name |
Description |
prototype |
Metric
|
public static Metric parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(ByteString data)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(InputStream input)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Parser<Metric> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public 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.
|
public 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.
|
public 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];
public 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.
|
public 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.
|
public BleuSpec getBleuSpec()
Spec for bleu metric.
.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;
| Returns |
| Type |
Description |
BleuSpec |
The bleuSpec.
|
public BleuSpecOrBuilder getBleuSpecOrBuilder()
Spec for bleu metric.
.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;
public Metric getDefaultInstanceForType()
| Returns |
| Type |
Description |
Metric |
|
public ExactMatchSpec getExactMatchSpec()
Spec for exact match metric.
.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;
public ExactMatchSpecOrBuilder getExactMatchSpecOrBuilder()
Spec for exact match metric.
.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;
public Metric.MetricSpecCase getMetricSpecCase()
public PairwiseMetricSpec getPairwiseMetricSpec()
Spec for pairwise metric.
.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;
public PairwiseMetricSpecOrBuilder getPairwiseMetricSpecOrBuilder()
Spec for pairwise metric.
.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;
public Parser<Metric> getParserForType()
Overrides
public PointwiseMetricSpec getPointwiseMetricSpec()
Spec for pointwise metric.
.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;
public PointwiseMetricSpecOrBuilder getPointwiseMetricSpecOrBuilder()
Spec for pointwise metric.
.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;
public RougeSpec getRougeSpec()
Spec for rouge metric.
.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;
| Returns |
| Type |
Description |
RougeSpec |
The rougeSpec.
|
public RougeSpecOrBuilder getRougeSpecOrBuilder()
Spec for rouge metric.
.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasBleuSpec()
Spec for bleu metric.
.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;
| Returns |
| Type |
Description |
boolean |
Whether the bleuSpec field is set.
|
public 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.
|
public 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.
|
public 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.
|
public boolean hasRougeSpec()
Spec for rouge metric.
.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;
| Returns |
| Type |
Description |
boolean |
Whether the rougeSpec field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Metric.Builder newBuilderForType()
protected Metric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Metric.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
