Values.CompareFacesResponseSourceCompares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. 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 by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
type nonrec t = {sourceImageFace : ComparedSourceImageFace.t option;The face in the source image that was used for comparison.
*)faceMatches : CompareFacesMatchList.t option;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.
*)unmatchedFaces : CompareFacesUnmatchList.t option;An array of faces in the target image that did not match the source image face.
*)sourceImageOrientationCorrection : OrientationCorrection.t option;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.
*)targetImageOrientationCorrection : OrientationCorrection.t option;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.
*)}type nonrec error = [ | `AccessDeniedException of AccessDeniedException.t| `ImageTooLargeException of ImageTooLargeException.t| `InternalServerError of InternalServerError.t| `InvalidImageFormatException of InvalidImageFormatException.t| `InvalidParameterException of InvalidParameterException.t| `InvalidS3ObjectException of InvalidS3ObjectException.t| `ProvisionedThroughputExceededException of
ProvisionedThroughputExceededException.t| `ThrottlingException of ThrottlingException.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `AccessDeniedException of unit
| `ImageTooLargeException of unit
| `InternalServerError of unit
| `InvalidImageFormatException of unit
| `InvalidParameterException of unit
| `InvalidS3ObjectException of unit
| `ProvisionedThroughputExceededException of unit
| `ThrottlingException of unit
| `Unknown_operation_error of string * string option ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `AccessDeniedException of unit
| `ImageTooLargeException of unit
| `InternalServerError of unit
| `InvalidImageFormatException of unit
| `InvalidParameterException of unit
| `InvalidS3ObjectException of unit
| `ProvisionedThroughputExceededException of unit
| `ThrottlingException of unit
| `Unknown_operation_error of string * string option ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `Float of Percent.t
| `List of
[> `Structure of
(string * [> `Enum of string | `Float of Float_.t ])
list ]
list
| `Structure of
(string
* [> `Boolean of Boolean.t
| `Float of Percent.t
| `List of
[> `Structure of
(string
* [> `Enum of string | `Float of Float_.t ])
list ]
list
| `Structure of
(string
* [> `Boolean of Boolean.t | `Float of Float_.t ])
list ])
list ])
list ]
list
| `Structure of
(string
* [> `Float of Percent.t
| `Structure of (string * [> `Float of Float_.t ]) list ])
list ])
list ]