public final class Metric extends GeneratedMessage implements MetricOrBuilder
The metric used for running evaluations.
Protobuf type google.cloud.aiplatform.v1beta1.Metric
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,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 COMPUTATION_BASED_METRIC_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 LLM_BASED_METRIC_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 PREDEFINED_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 ComputationBasedMetricSpec getComputationBasedMetricSpec()
Spec for a computation based metric.
.google.cloud.aiplatform.v1beta1.ComputationBasedMetricSpec computation_based_metric_spec = 9;
public ComputationBasedMetricSpecOrBuilder getComputationBasedMetricSpecOrBuilder()
Spec for a computation based metric.
.google.cloud.aiplatform.v1beta1.ComputationBasedMetricSpec computation_based_metric_spec = 9;
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 LLMBasedMetricSpec getLlmBasedMetricSpec()
Spec for an LLM based metric.
.google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec llm_based_metric_spec = 10;
public LLMBasedMetricSpecOrBuilder getLlmBasedMetricSpecOrBuilder()
Spec for an LLM based metric.
.google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec llm_based_metric_spec = 10;
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 PredefinedMetricSpec getPredefinedMetricSpec()
The spec for a pre-defined metric.
.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_metric_spec = 8;
public PredefinedMetricSpecOrBuilder getPredefinedMetricSpecOrBuilder()
The spec for a pre-defined metric.
.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_metric_spec = 8;
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 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.
|
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 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.
|
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 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.
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Metric.Builder newBuilderForType()
protected Metric.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public Metric.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
