Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::LLMBasedMetricSpec (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::LLMBasedMetricSpec.

Specification for an LLM based metric.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#additional_config

def additional_config() -> ::Google::Protobuf::Struct

Returns

• (::Google::Protobuf::Struct) — Optional. Optional additional configuration for the metric.

#additional_config=

def additional_config=(value) -> ::Google::Protobuf::Struct

Parameter

• value (::Google::Protobuf::Struct) — Optional. Optional additional configuration for the metric.

Returns

• (::Google::Protobuf::Struct) — Optional. Optional additional configuration for the metric.

#judge_autorater_config

def judge_autorater_config() -> ::Google::Cloud::AIPlatform::V1::AutoraterConfig

Returns

• (::Google::Cloud::AIPlatform::V1::AutoraterConfig) — Optional. Optional configuration for the judge LLM (Autorater).

#judge_autorater_config=

def judge_autorater_config=(value) -> ::Google::Cloud::AIPlatform::V1::AutoraterConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::AutoraterConfig) — Optional. Optional configuration for the judge LLM (Autorater).

Returns

• (::Google::Cloud::AIPlatform::V1::AutoraterConfig) — Optional. Optional configuration for the judge LLM (Autorater).

#metric_prompt_template

def metric_prompt_template() -> ::String

Returns

• (::String) — Required. Template for the prompt sent to the judge model.

#metric_prompt_template=

def metric_prompt_template=(value) -> ::String

Parameter

• value (::String) — Required. Template for the prompt sent to the judge model.

Returns

• (::String) — Required. Template for the prompt sent to the judge model.

#predefined_rubric_generation_spec

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

Returns

• (::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec) — Dynamically generate rubrics using a predefined spec.

  Note: The following fields are mutually exclusive: predefined_rubric_generation_spec, rubric_group_key. If a field in that set is populated, all other fields in the set will automatically be cleared.

#predefined_rubric_generation_spec=

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

Parameter

• value (::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec) — Dynamically generate rubrics using a predefined spec.

  Note: The following fields are mutually exclusive: predefined_rubric_generation_spec, rubric_group_key. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::PredefinedMetricSpec) — Dynamically generate rubrics using a predefined spec.

  Note: The following fields are mutually exclusive: predefined_rubric_generation_spec, rubric_group_key. If a field in that set is populated, all other fields in the set will automatically be cleared.

#rubric_group_key

def rubric_group_key() -> ::String

Returns

• (::String) — Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.

  Note: The following fields are mutually exclusive: rubric_group_key, predefined_rubric_generation_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#rubric_group_key=

def rubric_group_key=(value) -> ::String

Parameter

• value (::String) — Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.

  Note: The following fields are mutually exclusive: rubric_group_key, predefined_rubric_generation_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.

  Note: The following fields are mutually exclusive: rubric_group_key, predefined_rubric_generation_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#system_instruction

def system_instruction() -> ::String

Returns

• (::String) — Optional. System instructions for the judge model.

#system_instruction=

def system_instruction=(value) -> ::String

Parameter

• value (::String) — Optional. System instructions for the judge model.

Returns

• (::String) — Optional. System instructions for the judge model.