com.amazonaws.services.rekognition.model

Class SearchFacesByImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.SearchFacesByImageRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchFacesByImageRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.

You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchFacesByImageRequest() Default constructor for SearchFacesByImageRequest object.
SearchFacesByImageRequest(java.lang.String collectionId, Image image) Constructs a new SearchFacesByImageRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCollectionId() ID of the collection to search.
java.lang.Float	getFaceMatchThreshold() (Optional) Specifies the minimum confidence in the face match to return.
Image	getImage() The input image as base64-encoded bytes or an S3 object.
java.lang.Integer	getMaxFaces() Maximum number of faces to return.
java.lang.String	getQualityFilter() A filter that specifies a quality bar for how much filtering is done to identify faces.
int	hashCode()
void	setCollectionId(java.lang.String collectionId) ID of the collection to search.
void	setFaceMatchThreshold(java.lang.Float faceMatchThreshold) (Optional) Specifies the minimum confidence in the face match to return.
void	setImage(Image image) The input image as base64-encoded bytes or an S3 object.
void	setMaxFaces(java.lang.Integer maxFaces) Maximum number of faces to return.
void	setQualityFilter(QualityFilter qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.
void	setQualityFilter(java.lang.String qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchFacesByImageRequest	withCollectionId(java.lang.String collectionId) ID of the collection to search.
SearchFacesByImageRequest	withFaceMatchThreshold(java.lang.Float faceMatchThreshold) (Optional) Specifies the minimum confidence in the face match to return.
SearchFacesByImageRequest	withImage(Image image) The input image as base64-encoded bytes or an S3 object.
SearchFacesByImageRequest	withMaxFaces(java.lang.Integer maxFaces) Maximum number of faces to return.
SearchFacesByImageRequest	withQualityFilter(QualityFilter qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.
SearchFacesByImageRequest	withQualityFilter(java.lang.String qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchFacesByImageRequest

public SearchFacesByImageRequest()

Default constructor for SearchFacesByImageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

SearchFacesByImageRequest

public SearchFacesByImageRequest(java.lang.String collectionId,
                                 Image image)

Constructs a new SearchFacesByImageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

collectionId -

ID of the collection to search.

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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Method Detail

getCollectionId

public java.lang.String getCollectionId()

ID of the collection to search.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Returns:

ID of the collection to search.

setCollectionId

public void setCollectionId(java.lang.String collectionId)

ID of the collection to search.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

collectionId -

ID of the collection to search.

withCollectionId

public SearchFacesByImageRequest withCollectionId(java.lang.String collectionId)

ID of the collection to search.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

collectionId -

ID of the collection to search.

Returns:

A reference to this updated object so that method calls can be chained together.

getImage

public Image getImage()

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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

setImage

public void setImage(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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Parameters:

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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

withImage

public SearchFacesByImageRequest withImage(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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxFaces

public java.lang.Integer getMaxFaces()

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Constraints:
Range: 1 - 4096

Returns:

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

setMaxFaces

public void setMaxFaces(java.lang.Integer maxFaces)

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Constraints:
Range: 1 - 4096

Parameters:

maxFaces -

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

withMaxFaces

public SearchFacesByImageRequest withMaxFaces(java.lang.Integer maxFaces)

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 4096

Parameters:

maxFaces -

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns:

A reference to this updated object so that method calls can be chained together.

getFaceMatchThreshold

public java.lang.Float getFaceMatchThreshold()

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Constraints:
Length: 0 - 100

Returns:

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

setFaceMatchThreshold

public void setFaceMatchThreshold(java.lang.Float faceMatchThreshold)

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Constraints:
Length: 0 - 100

Parameters:

faceMatchThreshold -

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

withFaceMatchThreshold

public SearchFacesByImageRequest withFaceMatchThreshold(java.lang.Float faceMatchThreshold)

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 100

Parameters:

faceMatchThreshold -

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Returns:

A reference to this updated object so that method calls can be chained together.

getQualityFilter

public java.lang.String getQualityFilter()

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Returns:

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

See Also:

QualityFilter

setQualityFilter

public void setQualityFilter(java.lang.String qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Parameters:

qualityFilter -

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE .

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

See Also:

QualityFilter

withQualityFilter

public SearchFacesByImageRequest withQualityFilter(java.lang.String qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Parameters:

qualityFilter -

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE .

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

QualityFilter

setQualityFilter

public void setQualityFilter(QualityFilter qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Parameters:

qualityFilter -

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE .

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

See Also:

QualityFilter

withQualityFilter

public SearchFacesByImageRequest withQualityFilter(QualityFilter qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Parameters:

qualityFilter -

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. 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 NONE .

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

QualityFilter

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object