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

Class AutomatedEvaluationConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.AutomatedEvaluationConfig

All Implemented Interfaces:

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

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

The configuration details of an automated evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutomatedEvaluationConfig.Builder

Method Summary

Modifier and Type	Method	Description
static AutomatedEvaluationConfig.Builder	builder()
AutomatedEvaluationCustomMetricConfig	customMetricConfig()	Defines the configuration of custom metrics to be used in an evaluation job.
List<EvaluationDatasetMetricConfig>	datasetMetricConfigs()	Configuration details of the prompt datasets and metrics you want to use for your evaluation job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EvaluatorModelConfig	evaluatorModelConfig()	Contains the evaluator model configuration details.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDatasetMetricConfigs()	For responses, this returns true if the service returned a value for the DatasetMetricConfigs property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AutomatedEvaluationConfig.Builder>	serializableBuilderClass()
AutomatedEvaluationConfig.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

hasDatasetMetricConfigs

public final boolean hasDatasetMetricConfigs()

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

datasetMetricConfigs

public final List<EvaluationDatasetMetricConfig> datasetMetricConfigs()

Configuration details of the prompt datasets and metrics you want to use for your 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 hasDatasetMetricConfigs() method.

Returns:

Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

evaluatorModelConfig

public final EvaluatorModelConfig evaluatorModelConfig()

Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

Returns:

Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

customMetricConfig

public final AutomatedEvaluationCustomMetricConfig customMetricConfig()

Defines the configuration of custom metrics to be used in an evaluation job.

Returns:

Defines the configuration of custom metrics to be used in an evaluation job.

toBuilder

public AutomatedEvaluationConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutomatedEvaluationConfig.Builder,AutomatedEvaluationConfig>

builder

public static AutomatedEvaluationConfig.Builder builder()

serializableBuilderClass

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