Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Metric (v1.40.0)

1.40.0 (latest) 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.1 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.1 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Metric.

The metric used for running evaluations.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#aggregation_metrics

def aggregation_metrics() -> ::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>) — Optional. The aggregation metrics to use.

#aggregation_metrics=

def aggregation_metrics=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>

Parameter

• value (::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>) — Optional. The aggregation metrics to use.

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>) — Optional. The aggregation metrics to use.

#bleu_spec

def bleu_spec() -> ::Google::Cloud::AIPlatform::V1::BleuSpec

Returns

• (::Google::Cloud::AIPlatform::V1::BleuSpec) — Spec for bleu metric.

  Note: The following fields are mutually exclusive: bleu_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bleu_spec=

def bleu_spec=(value) -> ::Google::Cloud::AIPlatform::V1::BleuSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::BleuSpec) — Spec for bleu metric.

  Note: The following fields are mutually exclusive: bleu_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::BleuSpec) — Spec for bleu metric.

  Note: The following fields are mutually exclusive: bleu_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#computation_based_metric_spec

def computation_based_metric_spec() -> ::Google::Cloud::AIPlatform::V1::ComputationBasedMetricSpec

Returns

• (::Google::Cloud::AIPlatform::V1::ComputationBasedMetricSpec) — Spec for a computation based metric.

  Note: The following fields are mutually exclusive: computation_based_metric_spec, predefined_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#computation_based_metric_spec=

def computation_based_metric_spec=(value) -> ::Google::Cloud::AIPlatform::V1::ComputationBasedMetricSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::ComputationBasedMetricSpec) — Spec for a computation based metric.

  Note: The following fields are mutually exclusive: computation_based_metric_spec, predefined_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::ComputationBasedMetricSpec) — Spec for a computation based metric.

  Note: The following fields are mutually exclusive: computation_based_metric_spec, predefined_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exact_match_spec

def exact_match_spec() -> ::Google::Cloud::AIPlatform::V1::ExactMatchSpec

Returns

• (::Google::Cloud::AIPlatform::V1::ExactMatchSpec) — Spec for exact match metric.

  Note: The following fields are mutually exclusive: exact_match_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exact_match_spec=

def exact_match_spec=(value) -> ::Google::Cloud::AIPlatform::V1::ExactMatchSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::ExactMatchSpec) — Spec for exact match metric.

  Note: The following fields are mutually exclusive: exact_match_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::ExactMatchSpec) — Spec for exact match metric.

  Note: The following fields are mutually exclusive: exact_match_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#llm_based_metric_spec

def llm_based_metric_spec() -> ::Google::Cloud::AIPlatform::V1::LLMBasedMetricSpec

Returns

• (::Google::Cloud::AIPlatform::V1::LLMBasedMetricSpec) — Spec for an LLM based metric.

  Note: The following fields are mutually exclusive: llm_based_metric_spec, predefined_metric_spec, computation_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#llm_based_metric_spec=

def llm_based_metric_spec=(value) -> ::Google::Cloud::AIPlatform::V1::LLMBasedMetricSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::LLMBasedMetricSpec) — Spec for an LLM based metric.

  Note: The following fields are mutually exclusive: llm_based_metric_spec, predefined_metric_spec, computation_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::LLMBasedMetricSpec) — Spec for an LLM based metric.

  Note: The following fields are mutually exclusive: llm_based_metric_spec, predefined_metric_spec, computation_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pairwise_metric_spec

def pairwise_metric_spec() -> ::Google::Cloud::AIPlatform::V1::PairwiseMetricSpec

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseMetricSpec) — Spec for pairwise metric.

  Note: The following fields are mutually exclusive: pairwise_metric_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pairwise_metric_spec=

def pairwise_metric_spec=(value) -> ::Google::Cloud::AIPlatform::V1::PairwiseMetricSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::PairwiseMetricSpec) — Spec for pairwise metric.

  Note: The following fields are mutually exclusive: pairwise_metric_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseMetricSpec) — Spec for pairwise metric.

  Note: The following fields are mutually exclusive: pairwise_metric_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pointwise_metric_spec

def pointwise_metric_spec() -> ::Google::Cloud::AIPlatform::V1::PointwiseMetricSpec

Returns

• (::Google::Cloud::AIPlatform::V1::PointwiseMetricSpec) — Spec for pointwise metric.

  Note: The following fields are mutually exclusive: pointwise_metric_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pointwise_metric_spec=

def pointwise_metric_spec=(value) -> ::Google::Cloud::AIPlatform::V1::PointwiseMetricSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::PointwiseMetricSpec) — Spec for pointwise metric.

  Note: The following fields are mutually exclusive: pointwise_metric_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::PointwiseMetricSpec) — Spec for pointwise metric.

  Note: The following fields are mutually exclusive: pointwise_metric_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#predefined_metric_spec

def predefined_metric_spec() -> ::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec

Returns

• (::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec) — The spec for a pre-defined metric.

  Note: The following fields are mutually exclusive: predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#predefined_metric_spec=

def predefined_metric_spec=(value) -> ::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec) — The spec for a pre-defined metric.

  Note: The following fields are mutually exclusive: predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec) — The spec for a pre-defined metric.

  Note: The following fields are mutually exclusive: predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec, rouge_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#rouge_spec

def rouge_spec() -> ::Google::Cloud::AIPlatform::V1::RougeSpec

Returns

• (::Google::Cloud::AIPlatform::V1::RougeSpec) — Spec for rouge metric.

  Note: The following fields are mutually exclusive: rouge_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#rouge_spec=

def rouge_spec=(value) -> ::Google::Cloud::AIPlatform::V1::RougeSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::RougeSpec) — Spec for rouge metric.

  Note: The following fields are mutually exclusive: rouge_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::RougeSpec) — Spec for rouge metric.

  Note: The following fields are mutually exclusive: rouge_spec, predefined_metric_spec, computation_based_metric_spec, llm_based_metric_spec, pointwise_metric_spec, pairwise_metric_spec, exact_match_spec, bleu_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.