Package software.amazon.awssdk.services.rekognition.model

Interface SearchFacesByImageRequest.Builder

All Superinterfaces:

CopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>, SdkBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

Enclosing class:

SearchFacesByImageRequest

public static interface SearchFacesByImageRequest.Builder
extends CopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

Method Summary

Modifier and Type	Method	Description
SearchFacesByImageRequest.Builder	collectionId(String collectionId)	ID of the collection to search.
SearchFacesByImageRequest.Builder	faceMatchThreshold(Float faceMatchThreshold)	(Optional) Specifies the minimum confidence in the face match to return.
SearchFacesByImageRequest.Builder	image(Image image)	The input image as bytes or an S3 object.
SearchFacesByImageRequest.Builder	maxFaces(Integer maxFaces)	Maximum number of faces to return.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

collectionId

SearchFacesByImageRequest.Builder collectionId(String collectionId)

ID of the collection to search.

Parameters:

collectionId - ID of the collection to search.

Returns:

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

image

SearchFacesByImageRequest.Builder image(Image image)

The input image as bytes or an S3 object.

Parameters:

image - The input image as bytes or an S3 object.

Returns:

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

maxFaces

SearchFacesByImageRequest.Builder maxFaces(Integer maxFaces)

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

Parameters:

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

Returns:

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

faceMatchThreshold

SearchFacesByImageRequest.Builder faceMatchThreshold(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%.

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%.

Returns:

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