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

Class AutomatedEvaluationCustomMetricConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.AutomatedEvaluationCustomMetricConfig

All Implemented Interfaces:

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

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

Defines the configuration of custom metrics to be used in an evaluation job. To learn more about using custom metrics in Amazon Bedrock evaluation jobs, 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	AutomatedEvaluationCustomMetricConfig.Builder

Method Summary

Modifier and Type	Method	Description
static AutomatedEvaluationCustomMetricConfig.Builder	builder()
List<AutomatedEvaluationCustomMetricSource>	customMetrics()	Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
CustomMetricEvaluatorModelConfig	evaluatorModelConfig()	Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomMetrics()	For responses, this returns true if the service returned a value for the CustomMetrics property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AutomatedEvaluationCustomMetricConfig.Builder>	serializableBuilderClass()
AutomatedEvaluationCustomMetricConfig.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

hasCustomMetrics

public final boolean hasCustomMetrics()

For responses, this returns true if the service returned a value for the CustomMetrics 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.

customMetrics

public final List<AutomatedEvaluationCustomMetricSource> customMetrics()

Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job.

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 hasCustomMetrics() method.

Returns:

Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job.

evaluatorModelConfig

public final CustomMetricEvaluatorModelConfig evaluatorModelConfig()

Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.

Returns:

Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.

toBuilder

public AutomatedEvaluationCustomMetricConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutomatedEvaluationCustomMetricConfig.Builder,AutomatedEvaluationCustomMetricConfig>

builder

public static AutomatedEvaluationCustomMetricConfig.Builder builder()

serializableBuilderClass

public static Class<? extends AutomatedEvaluationCustomMetricConfig.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