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

Class 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:
    Serialized Form

    • Method Detail

      • 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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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