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

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

Spec for pointwise metric.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#custom_output_format_config

def custom_output_format_config() -> ::Google::Cloud::AIPlatform::V1::CustomOutputFormatConfig
Returns
  • (::Google::Cloud::AIPlatform::V1::CustomOutputFormatConfig) —

    Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either:

    • The raw output string.
    • A parsed output based on a user-defined schema. If a custom format is chosen, the score and explanation fields in the corresponding metric result will be empty.

#custom_output_format_config=

def custom_output_format_config=(value) -> ::Google::Cloud::AIPlatform::V1::CustomOutputFormatConfig
Parameter
  • value (::Google::Cloud::AIPlatform::V1::CustomOutputFormatConfig) —

    Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either:

    • The raw output string.
    • A parsed output based on a user-defined schema. If a custom format is chosen, the score and explanation fields in the corresponding metric result will be empty.
Returns
  • (::Google::Cloud::AIPlatform::V1::CustomOutputFormatConfig) —

    Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either:

    • The raw output string.
    • A parsed output based on a user-defined schema. If a custom format is chosen, the score and explanation fields in the corresponding metric result will be empty.

#metric_prompt_template

def metric_prompt_template() -> ::String
Returns
  • (::String) — Required. Metric prompt template for pointwise metric.

#metric_prompt_template=

def metric_prompt_template=(value) -> ::String
Parameter
  • value (::String) — Required. Metric prompt template for pointwise metric.
Returns
  • (::String) — Required. Metric prompt template for pointwise metric.

#system_instruction

def system_instruction() -> ::String
Returns
  • (::String) — Optional. System instructions for pointwise metric.

#system_instruction=

def system_instruction=(value) -> ::String
Parameter
  • value (::String) — Optional. System instructions for pointwise metric.
Returns
  • (::String) — Optional. System instructions for pointwise metric.