Package com.google.genai.types
Class PointwiseMetricSpec
-
- All Implemented Interfaces:
public abstract class PointwiseMetricSpec extends JsonSerializable
Spec for pointwise metric.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract classPointwiseMetricSpec.BuilderBuilder for PointwiseMetricSpec.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description PointwiseMetricSpec()
-
Method Summary
Modifier and Type Method Description abstract Optional<String>metricPromptTemplate()Required. abstract Optional<CustomOutputFormatConfig>customOutputFormatConfig()Optional. abstract Optional<String>systemInstruction()Optional. static PointwiseMetricSpec.Builderbuilder()Instantiates a builder for PointwiseMetricSpec. abstract PointwiseMetricSpec.BuildertoBuilder()Creates a builder with the same values as this instance. static PointwiseMetricSpecfromJson(String jsonString)Deserializes a JSON string to a PointwiseMetricSpec object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
metricPromptTemplate
abstract Optional<String> metricPromptTemplate()
Required. Metric prompt template for pointwise metric.
-
customOutputFormatConfig
abstract Optional<CustomOutputFormatConfig> 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.
-
systemInstruction
abstract Optional<String> systemInstruction()
Optional. System instructions for pointwise metric.
-
builder
static PointwiseMetricSpec.Builder builder()
Instantiates a builder for PointwiseMetricSpec.
-
toBuilder
abstract PointwiseMetricSpec.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static PointwiseMetricSpec fromJson(String jsonString)
Deserializes a JSON string to a PointwiseMetricSpec object.
-
-
-
-