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

Class EvaluationDatasetMetricConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.EvaluationDatasetMetricConfig

All Implemented Interfaces:

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

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

Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EvaluationDatasetMetricConfig.Builder

Method Summary

Modifier and Type	Method	Description
static EvaluationDatasetMetricConfig.Builder	builder()
EvaluationDataset	dataset()	Specifies the prompt dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricNames()	For responses, this returns true if the service returned a value for the MetricNames property.
List<String>	metricNames()	The names of the metrics used.
List<SdkField<?>>	sdkFields()
static Class<? extends EvaluationDatasetMetricConfig.Builder>	serializableBuilderClass()
EvaluationTaskType	taskType()	The task type you want the model to carry out.
String	taskTypeAsString()	The task type you want the model to carry out.
EvaluationDatasetMetricConfig.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

taskType

public final EvaluationTaskType taskType()

The task type you want the model to carry out.

If the service returns an enum value that is not available in the current SDK version, taskType will return EvaluationTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskTypeAsString().

Returns:

The task type you want the model to carry out.

See Also:

EvaluationTaskType

taskTypeAsString

public final String taskTypeAsString()

The task type you want the model to carry out.

If the service returns an enum value that is not available in the current SDK version, taskType will return EvaluationTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskTypeAsString().

Returns:

The task type you want the model to carry out.

See Also:

EvaluationTaskType

dataset

public final EvaluationDataset dataset()

Specifies the prompt dataset.

Returns:

Specifies the prompt dataset.

hasMetricNames

public final boolean hasMetricNames()

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

metricNames

public final List<String> metricNames()

The names of the metrics used. For automated model evaluation jobs valid values are "Builtin.Accuracy", "Builtin.Robustness", and "Builtin.Toxicity". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.

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

Returns:

The names of the metrics used. For automated model evaluation jobs valid values are "Builtin.Accuracy", "Builtin.Robustness", and "Builtin.Toxicity". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.

toBuilder

public EvaluationDatasetMetricConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EvaluationDatasetMetricConfig.Builder,EvaluationDatasetMetricConfig>

builder

public static EvaluationDatasetMetricConfig.Builder builder()

serializableBuilderClass

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