public static interface IndexFacesRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>
| Modifier and Type | Method and Description |
|---|---|
IndexFacesRequest.Builder |
collectionId(String collectionId)
The ID of an existing collection to which you want to add the faces that are detected in the input images.
|
IndexFacesRequest.Builder |
detectionAttributes(Attribute... detectionAttributes)
An array of facial attributes that you want to be returned.
|
IndexFacesRequest.Builder |
detectionAttributes(Collection<Attribute> detectionAttributes)
An array of facial attributes that you want to be returned.
|
IndexFacesRequest.Builder |
detectionAttributesWithStrings(Collection<String> detectionAttributes)
An array of facial attributes that you want to be returned.
|
IndexFacesRequest.Builder |
detectionAttributesWithStrings(String... detectionAttributes)
An array of facial attributes that you want to be returned.
|
IndexFacesRequest.Builder |
externalImageId(String externalImageId)
The ID you want to assign to all the faces detected in the image.
|
default IndexFacesRequest.Builder |
image(Consumer<Image.Builder> image)
The input image as base64-encoded bytes or an S3 object.
|
IndexFacesRequest.Builder |
image(Image image)
The input image as base64-encoded bytes or an S3 object.
|
IndexFacesRequest.Builder |
maxFaces(Integer maxFaces)
The maximum number of faces to index.
|
IndexFacesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
IndexFacesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
IndexFacesRequest.Builder |
qualityFilter(QualityFilter qualityFilter)
A filter that specifies how much filtering is done to identify faces that are detected with low quality.
|
IndexFacesRequest.Builder |
qualityFilter(String qualityFilter)
A filter that specifies how much filtering is done to identify faces that are detected with low quality.
|
buildoverrideConfigurationcopyapplyMutation, buildIndexFacesRequest.Builder collectionId(String collectionId)
The ID of an existing collection to which you want to add the faces that are detected in the input images.
collectionId - The ID of an existing collection to which you want to add the faces that are detected in the input
images.IndexFacesRequest.Builder image(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.
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.default IndexFacesRequest.Builder image(Consumer<Image.Builder> 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.
This is a convenience that creates an instance of theImage.Builder avoiding the need to create one
manually via Image.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to image(Image).image - a consumer that will call methods on Image.Builderimage(Image)IndexFacesRequest.Builder externalImageId(String externalImageId)
The ID you want to assign to all the faces detected in the image.
externalImageId - The ID you want to assign to all the faces detected in the image.IndexFacesRequest.Builder detectionAttributesWithStrings(Collection<String> 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).
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).
IndexFacesRequest.Builder detectionAttributesWithStrings(String... 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).
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).
IndexFacesRequest.Builder detectionAttributes(Collection<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).
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).
IndexFacesRequest.Builder detectionAttributes(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).
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).
IndexFacesRequest.Builder maxFaces(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 - 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.
IndexFacesRequest.Builder qualityFilter(String 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.
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.
QualityFilter,
QualityFilterIndexFacesRequest.Builder qualityFilter(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.
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.
QualityFilter,
QualityFilterIndexFacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.IndexFacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.