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

Class SearchFacesByImageRequest

    • Method Detail

      • collectionId

        public final String collectionId()

        ID of the collection to search.

        Returns:
        ID of the collection to search.

      • image

        public final 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:
        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.

      • maxFaces

        public final Integer maxFaces()

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

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

      • faceMatchThreshold

        public final 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:
        (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%.

      • qualityFilter

        public final 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.

        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().

        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

      • qualityFilterAsString

        public final String qualityFilterAsString()

        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.

        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().

        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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object