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>- (::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>- value (::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>) — Optional. The aggregation metrics to use.
- (::Array<::Google::Cloud::AIPlatform::V1::Metric::AggregationMetric>) — Optional. The aggregation metrics to use.
#bleu_spec
def bleu_spec() -> ::Google::Cloud::AIPlatform::V1::BleuSpec-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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.