Class HumanEvaluationConfig

java.lang.Object
software.amazon.awssdk.services.bedrock.model.HumanEvaluationConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HumanEvaluationConfig.Builder,HumanEvaluationConfig>
@Generated("software.amazon.awssdk:codegen") public final class HumanEvaluationConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HumanEvaluationConfig.Builder,HumanEvaluationConfig>

Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers only support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see Custom prompt datasets.

When you create custom metrics in HumanEvaluationCustomMetric you must specify the metric's name. The list of names specified in the HumanEvaluationCustomMetric array, must match the metricNames array of strings specified in EvaluationDatasetMetricConfig. For example, if in the HumanEvaluationCustomMetric array your specified the names "accuracy", "toxicity", "readability" as custom metrics then the metricNames array would need to look like the following ["accuracy", "toxicity", "readability"] in EvaluationDatasetMetricConfig.

See Also:

  • Method Details

    • humanWorkflowConfig

      public final HumanWorkflowConfig humanWorkflowConfig()

      The parameters of the human workflow.

      Returns:
      The parameters of the human workflow.

    • 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<HumanEvaluationCustomMetric> customMetrics()

      A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.

      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:
      A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.

    • 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()

      Use to specify the metrics, task, and prompt dataset to be used in your model 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:
      Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.

    • toBuilder

      public HumanEvaluationConfig.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<HumanEvaluationConfig.Builder,HumanEvaluationConfig>
      Returns:
      a builder for type T

    • builder

      public static HumanEvaluationConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.