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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HumanEvaluationCustomMetric.Builder,HumanEvaluationCustomMetric>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.