Class AutomatedEvaluationConfig

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

The configuration details of an automated evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.

See Also:

  • Method Details

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

      Configuration details of the prompt datasets and metrics you want to use for your 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:
      Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

    • evaluatorModelConfig

      public final EvaluatorModelConfig evaluatorModelConfig()

      Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

      Returns:
      Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

    • customMetricConfig

      public final AutomatedEvaluationCustomMetricConfig customMetricConfig()

      Defines the configuration of custom metrics to be used in an evaluation job.

      Returns:
      Defines the configuration of custom metrics to be used in an evaluation job.

    • toBuilder

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

    • builder

      public static AutomatedEvaluationConfig.Builder builder()

    • serializableBuilderClass

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