Package com.google.cloud.aiplatform.v1

Class Metric

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Metric
All Implemented Interfaces:
MetricOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Metric extends com.google.protobuf.GeneratedMessage implements MetricOrBuilder
 The metric used for running evaluations.
Protobuf type google.cloud.aiplatform.v1.Metric
See Also:

  • Field Details

    • PREDEFINED_METRIC_SPEC_FIELD_NUMBER

      public static final int PREDEFINED_METRIC_SPEC_FIELD_NUMBER
      See Also:

    • COMPUTATION_BASED_METRIC_SPEC_FIELD_NUMBER

      public static final int COMPUTATION_BASED_METRIC_SPEC_FIELD_NUMBER
      See Also:

    • LLM_BASED_METRIC_SPEC_FIELD_NUMBER

      public static final int LLM_BASED_METRIC_SPEC_FIELD_NUMBER
      See Also:

    • POINTWISE_METRIC_SPEC_FIELD_NUMBER

      public static final int POINTWISE_METRIC_SPEC_FIELD_NUMBER
      See Also:

    • PAIRWISE_METRIC_SPEC_FIELD_NUMBER

      public static final int PAIRWISE_METRIC_SPEC_FIELD_NUMBER
      See Also:

    • EXACT_MATCH_SPEC_FIELD_NUMBER

      public static final int EXACT_MATCH_SPEC_FIELD_NUMBER
      See Also:

    • BLEU_SPEC_FIELD_NUMBER

      public static final int BLEU_SPEC_FIELD_NUMBER
      See Also:

    • ROUGE_SPEC_FIELD_NUMBER

      public static final int ROUGE_SPEC_FIELD_NUMBER
      See Also:

    • AGGREGATION_METRICS_FIELD_NUMBER

      public static final int AGGREGATION_METRICS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getMetricSpecCase

      public Metric.MetricSpecCase getMetricSpecCase()
      Specified by:
      getMetricSpecCase in interface MetricOrBuilder

    • hasPredefinedMetricSpec

      public boolean hasPredefinedMetricSpec()
       The spec for a pre-defined metric.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_metric_spec = 8;
      Specified by:
      hasPredefinedMetricSpec in interface MetricOrBuilder
      Returns:
      Whether the predefinedMetricSpec field is set.

    • getPredefinedMetricSpec

      public PredefinedMetricSpec getPredefinedMetricSpec()
       The spec for a pre-defined metric.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_metric_spec = 8;
      Specified by:
      getPredefinedMetricSpec in interface MetricOrBuilder
      Returns:
      The predefinedMetricSpec.

    • getPredefinedMetricSpecOrBuilder

      public PredefinedMetricSpecOrBuilder getPredefinedMetricSpecOrBuilder()
       The spec for a pre-defined metric.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_metric_spec = 8;
      Specified by:
      getPredefinedMetricSpecOrBuilder in interface MetricOrBuilder

    • hasComputationBasedMetricSpec

      public boolean hasComputationBasedMetricSpec()
       Spec for a computation based metric.
      .google.cloud.aiplatform.v1.ComputationBasedMetricSpec computation_based_metric_spec = 9;
      Specified by:
      hasComputationBasedMetricSpec in interface MetricOrBuilder
      Returns:
      Whether the computationBasedMetricSpec field is set.

    • getComputationBasedMetricSpec

      public ComputationBasedMetricSpec getComputationBasedMetricSpec()
       Spec for a computation based metric.
      .google.cloud.aiplatform.v1.ComputationBasedMetricSpec computation_based_metric_spec = 9;
      Specified by:
      getComputationBasedMetricSpec in interface MetricOrBuilder
      Returns:
      The computationBasedMetricSpec.

    • getComputationBasedMetricSpecOrBuilder

      public ComputationBasedMetricSpecOrBuilder getComputationBasedMetricSpecOrBuilder()
       Spec for a computation based metric.
      .google.cloud.aiplatform.v1.ComputationBasedMetricSpec computation_based_metric_spec = 9;
      Specified by:
      getComputationBasedMetricSpecOrBuilder in interface MetricOrBuilder

    • hasLlmBasedMetricSpec

      public boolean hasLlmBasedMetricSpec()
       Spec for an LLM based metric.
      .google.cloud.aiplatform.v1.LLMBasedMetricSpec llm_based_metric_spec = 10;
      Specified by:
      hasLlmBasedMetricSpec in interface MetricOrBuilder
      Returns:
      Whether the llmBasedMetricSpec field is set.

    • getLlmBasedMetricSpec

      public LLMBasedMetricSpec getLlmBasedMetricSpec()
       Spec for an LLM based metric.
      .google.cloud.aiplatform.v1.LLMBasedMetricSpec llm_based_metric_spec = 10;
      Specified by:
      getLlmBasedMetricSpec in interface MetricOrBuilder
      Returns:
      The llmBasedMetricSpec.

    • getLlmBasedMetricSpecOrBuilder

      public LLMBasedMetricSpecOrBuilder getLlmBasedMetricSpecOrBuilder()
       Spec for an LLM based metric.
      .google.cloud.aiplatform.v1.LLMBasedMetricSpec llm_based_metric_spec = 10;
      Specified by:
      getLlmBasedMetricSpecOrBuilder in interface MetricOrBuilder

    • hasPointwiseMetricSpec

      public boolean hasPointwiseMetricSpec()
       Spec for pointwise metric.
      .google.cloud.aiplatform.v1.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.v1.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.v1.PointwiseMetricSpec pointwise_metric_spec = 2;
      Specified by:
      getPointwiseMetricSpecOrBuilder in interface MetricOrBuilder

    • hasPairwiseMetricSpec

      public boolean hasPairwiseMetricSpec()
       Spec for pairwise metric.
      .google.cloud.aiplatform.v1.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.v1.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.v1.PairwiseMetricSpec pairwise_metric_spec = 3;
      Specified by:
      getPairwiseMetricSpecOrBuilder in interface MetricOrBuilder

    • hasExactMatchSpec

      public boolean hasExactMatchSpec()
       Spec for exact match metric.
      .google.cloud.aiplatform.v1.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.v1.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.v1.ExactMatchSpec exact_match_spec = 4;
      Specified by:
      getExactMatchSpecOrBuilder in interface MetricOrBuilder

    • hasBleuSpec

      public boolean hasBleuSpec()
       Spec for bleu metric.
      .google.cloud.aiplatform.v1.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.v1.BleuSpec bleu_spec = 5;
      Specified by:
      getBleuSpec in interface MetricOrBuilder
      Returns:
      The bleuSpec.

    • getBleuSpecOrBuilder

      public BleuSpecOrBuilder getBleuSpecOrBuilder()
       Spec for bleu metric.
      .google.cloud.aiplatform.v1.BleuSpec bleu_spec = 5;
      Specified by:
      getBleuSpecOrBuilder in interface MetricOrBuilder

    • hasRougeSpec

      public boolean hasRougeSpec()
       Spec for rouge metric.
      .google.cloud.aiplatform.v1.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.v1.RougeSpec rouge_spec = 6;
      Specified by:
      getRougeSpec in interface MetricOrBuilder
      Returns:
      The rougeSpec.

    • getRougeSpecOrBuilder

      public RougeSpecOrBuilder getRougeSpecOrBuilder()
       Spec for rouge metric.
      .google.cloud.aiplatform.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public Metric getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder