@Generated(value="software.amazon.awssdk:codegen") public final class IndexFacesRequest extends RekognitionRequest implements ToCopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
IndexFacesRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static IndexFacesRequest.Builder |
builder() |
String |
collectionId()
The ID of an existing collection to which you want to add the faces that are detected in the input images.
|
List<Attribute> |
detectionAttributes()
An array of facial attributes that you want to be returned.
|
List<String> |
detectionAttributesAsStrings()
An array of facial attributes that you want to be returned.
|
boolean |
equals(Object obj) |
String |
externalImageId()
The ID you want to assign to all the faces detected in the image.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
Image |
image()
The input image as base64-encoded bytes or an S3 object.
|
Integer |
maxFaces()
The maximum number of faces to index.
|
QualityFilter |
qualityFilter()
A filter that specifies how much filtering is done to identify faces that are detected with low quality.
|
String |
qualityFilterAsString()
A filter that specifies how much filtering is done to identify faces that are detected with low quality.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends IndexFacesRequest.Builder> |
serializableBuilderClass() |
IndexFacesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic String collectionId()
The ID of an existing collection to which you want to add the faces that are detected in the input images.
public Image image()
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.
public String externalImageId()
The ID you want to assign to all the faces detected in the image.
public List<Attribute> detectionAttributes()
An array of facial attributes that you want to be returned. This can be the default list of attributes or all
attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"],
the API returns the following subset of facial attributes: BoundingBox, Confidence,
Pose, Quality, and Landmarks. If you provide ["ALL"], all
facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which
attributes to return (in this case, all attributes).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Attributes or if you specify
["DEFAULT"], the API returns the following subset of facial attributes:
BoundingBox, Confidence, Pose, Quality, and
Landmarks. If you provide ["ALL"], all facial attributes are returned, but the
operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to
determine which attributes to return (in this case, all attributes).
public List<String> detectionAttributesAsStrings()
An array of facial attributes that you want to be returned. This can be the default list of attributes or all
attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"],
the API returns the following subset of facial attributes: BoundingBox, Confidence,
Pose, Quality, and Landmarks. If you provide ["ALL"], all
facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which
attributes to return (in this case, all attributes).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Attributes or if you specify
["DEFAULT"], the API returns the following subset of facial attributes:
BoundingBox, Confidence, Pose, Quality, and
Landmarks. If you provide ["ALL"], all facial attributes are returned, but the
operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to
determine which attributes to return (in this case, all attributes).
public Integer maxFaces()
The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1.
IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value
for MaxFaces.
If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest
quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces
with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of
MaxFaces). Information about the unindexed faces is available in the UnindexedFaces
array.
The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the
smallest size, in descending order.
MaxFaces can be used with a collection associated with any version of the face model.
MaxFaces must be greater than or equal to
1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a
larger value for MaxFaces.
If IndexFaces detects more faces than the value of MaxFaces, the faces with the
lowest quality are filtered out first. If there are still more faces than the value of
MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number
that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is
available in the UnindexedFaces array.
The faces that are returned by IndexFaces are sorted by the largest face bounding box size
to the smallest size, in descending order.
MaxFaces can be used with a collection associated with any version of the face model.
public QualityFilter qualityFilter()
A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered
faces aren't indexed. If you specify AUTO, filtering prioritizes the identification of faces that
don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common
use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's
misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you
specify NONE, no filtering is performed. The default value is AUTO.
To use quality filtering, the collection you are using must be associated with version 3 of the face model.
If the service returns an enum value that is not available in the current SDK version, qualityFilter
will return QualityFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
qualityFilterAsString().
AUTO, filtering prioritizes the identification
of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based
on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples
are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too
extreme to use. If you specify NONE, no filtering is performed. The default value is
AUTO.
To use quality filtering, the collection you are using must be associated with version 3 of the face model.
QualityFilterpublic String qualityFilterAsString()
A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered
faces aren't indexed. If you specify AUTO, filtering prioritizes the identification of faces that
don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common
use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's
misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you
specify NONE, no filtering is performed. The default value is AUTO.
To use quality filtering, the collection you are using must be associated with version 3 of the face model.
If the service returns an enum value that is not available in the current SDK version, qualityFilter
will return QualityFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
qualityFilterAsString().
AUTO, filtering prioritizes the identification
of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based
on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples
are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too
extreme to use. If you specify NONE, no filtering is performed. The default value is
AUTO.
To use quality filtering, the collection you are using must be associated with version 3 of the face model.
QualityFilterpublic IndexFacesRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>toBuilder in class RekognitionRequestpublic static IndexFacesRequest.Builder builder()
public static Class<? extends IndexFacesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.