Package software.amazon.awssdk.services.bedrock.model

Class CustomMetricDefinition

java.lang.Object

software.amazon.awssdk.services.bedrock.model.CustomMetricDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomMetricDefinition.Builder,CustomMetricDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class CustomMetricDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomMetricDefinition.Builder,CustomMetricDefinition>

The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.

For more information about how to define a custom metric in Amazon Bedrock, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and Create a prompt for a custom metrics (RAG evaluations).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomMetricDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static CustomMetricDefinition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRatingScale()	For responses, this returns true if the service returned a value for the RatingScale property.
String	instructions()	The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.
String	name()	The name for a custom metric.
List<RatingScaleItem>	ratingScale()	Defines the rating scale to be used for a custom metric.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomMetricDefinition.Builder>	serializableBuilderClass()
CustomMetricDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name for a custom metric. Names must be unique in your Amazon Web Services region.

Returns:

The name for a custom metric. Names must be unique in your Amazon Web Services region.

instructions

public final String instructions()

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

Returns:

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

hasRatingScale

public final boolean hasRatingScale()

For responses, this returns true if the service returned a value for the RatingScale property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ratingScale

public final List<RatingScaleItem> ratingScale()

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRatingScale() method.

Returns:

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

toBuilder

public CustomMetricDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomMetricDefinition.Builder,CustomMetricDefinition>

builder

public static CustomMetricDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends CustomMetricDefinition.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo