Package com.google.genai.types

Class PairwiseMetricSpec

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.PairwiseMetricSpec

public abstract class PairwiseMetricSpec
extends JsonSerializable

Spec for pairwise metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PairwiseMetricSpec.Builder	Builder for PairwiseMetricSpec.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
PairwiseMetricSpec()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	baselineResponseFieldName()	Optional.
static PairwiseMetricSpec.Builder	builder()	Instantiates a builder for PairwiseMetricSpec.
abstract Optional<String>	candidateResponseFieldName()	Optional.
abstract Optional<CustomOutputFormatConfig>	customOutputFormatConfig()	Optional.
static PairwiseMetricSpec	fromJson(String jsonString)	Deserializes a JSON string to a PairwiseMetricSpec object.
abstract Optional<String>	metricPromptTemplate()	Required.
abstract Optional<String>	systemInstruction()	Optional.
abstract PairwiseMetricSpec.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PairwiseMetricSpec

public PairwiseMetricSpec()

Method Details

metricPromptTemplate

public abstract Optional<String> metricPromptTemplate()

Required. Metric prompt template for pairwise metric.

baselineResponseFieldName

public abstract Optional<String> baselineResponseFieldName()

Optional. The field name of the baseline response.

candidateResponseFieldName

public abstract Optional<String> candidateResponseFieldName()

Optional. The field name of the candidate response.

customOutputFormatConfig

public abstract Optional<CustomOutputFormatConfig> customOutputFormatConfig()

Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.

systemInstruction

public abstract Optional<String> systemInstruction()

Optional. System instructions for pairwise metric.

builder

public static PairwiseMetricSpec.Builder builder()

Instantiates a builder for PairwiseMetricSpec.

toBuilder

public abstract PairwiseMetricSpec.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static PairwiseMetricSpec fromJson(String jsonString)

Deserializes a JSON string to a PairwiseMetricSpec object.