Skip to content

CompareFacesResponse

Source code in docs_src/capo_rekognition/types/compare_faces_response.py
class CompareFacesResponse(TypedDict, closed=True):
    source_image_face: NotRequired[
        "capo_rekognition.types.compared_source_image_face.ComparedSourceImageFace"
    ]
    """<p>The face in the source image that was used for comparison.</p>"""
    face_matches: NotRequired[
        "capo_rekognition.types.compare_faces_match_list.CompareFacesMatchList"
    ]
    """<p>An array of faces in the target image that match the source image face. Each <code>CompareFacesMatch</code> object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.</p>"""
    unmatched_faces: NotRequired[
        "capo_rekognition.types.compare_faces_unmatch_list.CompareFacesUnmatchList"
    ]
    """<p>An array of faces in the target image that did not match the source image face.</p>"""
    source_image_orientation_correction: NotRequired[
        "capo_rekognition.types.orientation_correction.OrientationCorrection"
    ]
    """<p>The value of <code>SourceImageOrientationCorrection</code> is always null.</p> <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.</p> <p>Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. </p>"""
    target_image_orientation_correction: NotRequired[
        "capo_rekognition.types.orientation_correction.OrientationCorrection"
    ]
    """<p>The value of <code>TargetImageOrientationCorrection</code> is always null.</p> <p>If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.</p> <p>Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. </p>"""

face_matches instance-attribute

face_matches: NotRequired[CompareFacesMatchList]

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

source_image_face instance-attribute

source_image_face: NotRequired[ComparedSourceImageFace]

The face in the source image that was used for comparison.

source_image_orientation_correction instance-attribute

source_image_orientation_correction: NotRequired[OrientationCorrection]

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

target_image_orientation_correction instance-attribute

target_image_orientation_correction: NotRequired[OrientationCorrection]

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

unmatched_faces instance-attribute

unmatched_faces: NotRequired[CompareFacesUnmatchList]

An array of faces in the target image that did not match the source image face.