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

Class HumanEvaluationCustomMetric

java.lang.Object

software.amazon.awssdk.services.bedrock.model.HumanEvaluationCustomMetric

All Implemented Interfaces:

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

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

In a model evaluation job that uses human workers you must define the name of the metric, and how you want that metric rated ratingMethod, and an optional description of the metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HumanEvaluationCustomMetric.Builder

Method Summary

Modifier and Type	Method	Description
static HumanEvaluationCustomMetric.Builder	builder()
String	description()	An optional description of the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the metric.
String	ratingMethod()	Choose how you want your human workers to evaluation your model.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HumanEvaluationCustomMetric.Builder>	serializableBuilderClass()
HumanEvaluationCustomMetric.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 of the metric. Your human evaluators will see this name in the evaluation UI.

Returns:

The name of the metric. Your human evaluators will see this name in the evaluation UI.

description

public final String description()

An optional description of the metric. Use this parameter to provide more details about the metric.

Returns:

An optional description of the metric. Use this parameter to provide more details about the metric.

ratingMethod

public final String ratingMethod()

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank

Returns:

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank

toBuilder

public HumanEvaluationCustomMetric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HumanEvaluationCustomMetric.Builder,HumanEvaluationCustomMetric>

builder

public static HumanEvaluationCustomMetric.Builder builder()

serializableBuilderClass

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