Interface SearchFacesByImageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>, RekognitionRequest.Builder, SdkBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchFacesByImageRequest
public static interface SearchFacesByImageRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

  • Method Details

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

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

    • image

      default SearchFacesByImageRequest.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 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.

      This is a convenience method that creates an instance of the Image.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).

      Parameters:
      image - a consumer that will call methods on Image.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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%. The default value is 80%.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • qualityFilter

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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • qualityFilter

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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      SearchFacesByImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SearchFacesByImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.