com.google.cloud.aiplatform.v1beta1

Class Metric

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.Metric

All Implemented Interfaces:

MetricOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Metric
extends com.google.protobuf.GeneratedMessageV3
implements MetricOrBuilder

 The metric used for dataset level evaluation.
 

Protobuf type google.cloud.aiplatform.v1beta1.Metric

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metric.AggregationMetric The aggregation metrics supported by EvaluationService.EvaluateDataset.
static class	Metric.Builder The metric used for dataset level evaluation.
static class	Metric.MetricSpecCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGREGATION_METRICS_FIELD_NUMBER
static int	BLEU_SPEC_FIELD_NUMBER
static int	EXACT_MATCH_SPEC_FIELD_NUMBER
static int	PAIRWISE_METRIC_SPEC_FIELD_NUMBER
static int	POINTWISE_METRIC_SPEC_FIELD_NUMBER
static int	ROUGE_SPEC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Metric.AggregationMetric	getAggregationMetrics(int index) Optional.
int	getAggregationMetricsCount() Optional.
List<Metric.AggregationMetric>	getAggregationMetricsList() Optional.
int	getAggregationMetricsValue(int index) Optional.
List<Integer>	getAggregationMetricsValueList() Optional.
BleuSpec	getBleuSpec() Spec for bleu metric.
BleuSpecOrBuilder	getBleuSpecOrBuilder() Spec for bleu metric.
static Metric	getDefaultInstance()
Metric	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ExactMatchSpec	getExactMatchSpec() Spec for exact match metric.
ExactMatchSpecOrBuilder	getExactMatchSpecOrBuilder() Spec for exact match metric.
Metric.MetricSpecCase	getMetricSpecCase()
PairwiseMetricSpec	getPairwiseMetricSpec() Spec for pairwise metric.
PairwiseMetricSpecOrBuilder	getPairwiseMetricSpecOrBuilder() Spec for pairwise metric.
com.google.protobuf.Parser<Metric>	getParserForType()
PointwiseMetricSpec	getPointwiseMetricSpec() Spec for pointwise metric.
PointwiseMetricSpecOrBuilder	getPointwiseMetricSpecOrBuilder() Spec for pointwise metric.
RougeSpec	getRougeSpec() Spec for rouge metric.
RougeSpecOrBuilder	getRougeSpecOrBuilder() Spec for rouge metric.
int	getSerializedSize()
boolean	hasBleuSpec() Spec for bleu metric.
boolean	hasExactMatchSpec() Spec for exact match metric.
int	hashCode()
boolean	hasPairwiseMetricSpec() Spec for pairwise metric.
boolean	hasPointwiseMetricSpec() Spec for pointwise metric.
boolean	hasRougeSpec() Spec for rouge metric.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Metric.Builder	newBuilder()
static Metric.Builder	newBuilder(Metric prototype)
Metric.Builder	newBuilderForType()
protected Metric.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Metric	parseDelimitedFrom(InputStream input)
static Metric	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(byte[] data)
static Metric	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(ByteBuffer data)
static Metric	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(com.google.protobuf.ByteString data)
static Metric	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(com.google.protobuf.CodedInputStream input)
static Metric	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(InputStream input)
static Metric	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Metric>	parser()
Metric.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

POINTWISE_METRIC_SPEC_FIELD_NUMBER

public static final int POINTWISE_METRIC_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

PAIRWISE_METRIC_SPEC_FIELD_NUMBER

public static final int PAIRWISE_METRIC_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

EXACT_MATCH_SPEC_FIELD_NUMBER

public static final int EXACT_MATCH_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

BLEU_SPEC_FIELD_NUMBER

public static final int BLEU_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

ROUGE_SPEC_FIELD_NUMBER

public static final int ROUGE_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

AGGREGATION_METRICS_FIELD_NUMBER

public static final int AGGREGATION_METRICS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getMetricSpecCase

public Metric.MetricSpecCase getMetricSpecCase()

Specified by:

getMetricSpecCase in interface MetricOrBuilder

hasPointwiseMetricSpec

public boolean hasPointwiseMetricSpec()

 Spec for pointwise metric.
 

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

Specified by:

hasPointwiseMetricSpec in interface MetricOrBuilder

Returns:

Whether the pointwiseMetricSpec field is set.

getPointwiseMetricSpec

public PointwiseMetricSpec getPointwiseMetricSpec()

 Spec for pointwise metric.
 

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

Specified by:

getPointwiseMetricSpec in interface MetricOrBuilder

Returns:

The pointwiseMetricSpec.

getPointwiseMetricSpecOrBuilder

public PointwiseMetricSpecOrBuilder getPointwiseMetricSpecOrBuilder()

 Spec for pointwise metric.
 

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

Specified by:

getPointwiseMetricSpecOrBuilder in interface MetricOrBuilder

hasPairwiseMetricSpec

public boolean hasPairwiseMetricSpec()

 Spec for pairwise metric.
 

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

Specified by:

hasPairwiseMetricSpec in interface MetricOrBuilder

Returns:

Whether the pairwiseMetricSpec field is set.

getPairwiseMetricSpec

public PairwiseMetricSpec getPairwiseMetricSpec()

 Spec for pairwise metric.
 

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

Specified by:

getPairwiseMetricSpec in interface MetricOrBuilder

Returns:

The pairwiseMetricSpec.

getPairwiseMetricSpecOrBuilder

public PairwiseMetricSpecOrBuilder getPairwiseMetricSpecOrBuilder()

 Spec for pairwise metric.
 

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

Specified by:

getPairwiseMetricSpecOrBuilder in interface MetricOrBuilder

hasExactMatchSpec

public boolean hasExactMatchSpec()

 Spec for exact match metric.
 

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

Specified by:

hasExactMatchSpec in interface MetricOrBuilder

Returns:

Whether the exactMatchSpec field is set.

getExactMatchSpec

public ExactMatchSpec getExactMatchSpec()

 Spec for exact match metric.
 

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

Specified by:

getExactMatchSpec in interface MetricOrBuilder

Returns:

The exactMatchSpec.

getExactMatchSpecOrBuilder

public ExactMatchSpecOrBuilder getExactMatchSpecOrBuilder()

 Spec for exact match metric.
 

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

Specified by:

getExactMatchSpecOrBuilder in interface MetricOrBuilder

hasBleuSpec

public boolean hasBleuSpec()

 Spec for bleu metric.
 

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

Specified by:

hasBleuSpec in interface MetricOrBuilder

Returns:

Whether the bleuSpec field is set.

getBleuSpec

public BleuSpec getBleuSpec()

 Spec for bleu metric.
 

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

Specified by:

getBleuSpec in interface MetricOrBuilder

Returns:

The bleuSpec.

getBleuSpecOrBuilder

public BleuSpecOrBuilder getBleuSpecOrBuilder()

 Spec for bleu metric.
 

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

Specified by:

getBleuSpecOrBuilder in interface MetricOrBuilder

hasRougeSpec

public boolean hasRougeSpec()

 Spec for rouge metric.
 

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

Specified by:

hasRougeSpec in interface MetricOrBuilder

Returns:

Whether the rougeSpec field is set.

getRougeSpec

public RougeSpec getRougeSpec()

 Spec for rouge metric.
 

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

Specified by:

getRougeSpec in interface MetricOrBuilder

Returns:

The rougeSpec.

getRougeSpecOrBuilder

public RougeSpecOrBuilder getRougeSpecOrBuilder()

 Spec for rouge metric.
 

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

Specified by:

getRougeSpecOrBuilder in interface MetricOrBuilder

getAggregationMetricsList

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];

Specified by:

getAggregationMetricsList in interface MetricOrBuilder

Returns:

A list containing the aggregationMetrics.

getAggregationMetricsCount

public int getAggregationMetricsCount()

 Optional. The aggregation metrics to use.
 

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

Specified by:

getAggregationMetricsCount in interface MetricOrBuilder

Returns:

The count of aggregationMetrics.

getAggregationMetrics

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];

Specified by:

getAggregationMetrics in interface MetricOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The aggregationMetrics at the given index.

getAggregationMetricsValueList

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];

Specified by:

getAggregationMetricsValueList in interface MetricOrBuilder

Returns:

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

getAggregationMetricsValue

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];

Specified by:

getAggregationMetricsValue in interface MetricOrBuilder

Parameters:

index - The index of the value to return.

Returns:

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Metric parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Metric parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Metric parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Metric parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Metric parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Metric parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Metric.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Metric.Builder newBuilder()

newBuilder

public static Metric.Builder newBuilder(Metric prototype)

toBuilder

public Metric.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Metric.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Metric getDefaultInstance()

parser

public static com.google.protobuf.Parser<Metric> parser()

getParserForType

public com.google.protobuf.Parser<Metric> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Metric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder