Filter class
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value
, but not an Operator
,
Amazon SageMaker uses the equals operator.
In search, there are several property types:
- Metrics
-
To define a metric filter, enter a value using the form
"Metrics.<name>"
, where<name>
is a metric name. For example, the following filter searches for training jobs with an"accuracy"
metric greater than"0.9"
:{
"Name": "Metrics.accuracy",
"Operator": "GreaterThan",
"Value": "0.9"
}
- HyperParameters
-
To define a hyperparameter filter, enter a value with the form
"HyperParameters.<name>"
. Decimal hyperparameter values are treated as a decimal in a comparison if the specifiedValue
is also a decimal value. If the specifiedValue
is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a"learning_rate"
hyperparameter that is less than"0.5"
:{
"Name": "HyperParameters.learning_rate",
"Operator": "LessThan",
"Value": "0.5"
}
- Tags
-
To define a tag filter, enter a value with the form
Tags.<key>
.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String
-
A resource property name. For example,
TrainingJobName
. For valid property names, see SearchRecord. You must specify a valid property for the resource.final - operator → Operator?
-
A Boolean binary operator that is used to evaluate the filter. The operator
field contains one of the following values:
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- value → String?
-
A value used with
Name
andOperator
to determine which resources satisfy the filter's condition. For numerical properties,Value
must be an integer or floating-point decimal. For timestamp properties,Value
must be an ISO 8601 date-time string of the following format:YYYY-mm-dd'T'HH:MM:SS
.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited