Class EvaluationDatasetMetricConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EvaluationDatasetMetricConfig.Builder,
EvaluationDatasetMetricConfig>
Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final EvaluationDataset
dataset()
Specifies the prompt dataset.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MetricNames property.The names of the metrics used.static Class
<? extends EvaluationDatasetMetricConfig.Builder> final EvaluationTaskType
taskType()
The task type you want the model to carry out.final String
The task type you want the model to carry out.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
taskType
The task type you want the model to carry out.
If the service returns an enum value that is not available in the current SDK version,
taskType
will returnEvaluationTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- The task type you want the model to carry out.
- See Also:
-
taskTypeAsString
The task type you want the model to carry out.
If the service returns an enum value that is not available in the current SDK version,
taskType
will returnEvaluationTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- The task type you want the model to carry out.
- See Also:
-
dataset
Specifies the prompt dataset.
- Returns:
- Specifies the prompt dataset.
-
hasMetricNames
public final boolean hasMetricNames()For responses, this returns true if the service returned a value for the MetricNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
metricNames
The names of the metrics used. For automated model evaluation jobs valid values are
"Builtin.Accuracy"
,"Builtin.Robustness"
, and"Builtin.Toxicity"
. In human-based model evaluation jobs the array of strings must match thename
parameter specified inHumanEvaluationCustomMetric
.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
hasMetricNames()
method.- Returns:
- The names of the metrics used. For automated model evaluation jobs valid values are
"Builtin.Accuracy"
,"Builtin.Robustness"
, and"Builtin.Toxicity"
. In human-based model evaluation jobs the array of strings must match thename
parameter specified inHumanEvaluationCustomMetric
.
-
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 interfaceToCopyableBuilder<EvaluationDatasetMetricConfig.Builder,
EvaluationDatasetMetricConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-