AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Rekognition::Types::IndexFacesResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#face_model_versionString

The version number of the face detection model that\'s associated with the input collection (CollectionId).

Returns:

  • (String)

    The version number of the face detection model that\'s associated with the input collection (CollectionId).

#face_recordsArray<Types::FaceRecord>

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

Returns:

  • (Array<Types::FaceRecord>)

    An array of faces detected and added to the collection.

#orientation_correctionString

If your collection is associated with a face detection model that\'s later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that\'s version 3.0 or earlier, the following applies:

  • 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. The value of OrientationCorrection is null.

  • If the image doesn\'t contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Possible values:

  • ROTATE_0
  • ROTATE_90
  • ROTATE_180
  • ROTATE_270

Returns:

  • (String)

    If your collection is associated with a face detection model that\'s later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

#unindexed_facesArray<Types::UnindexedFace>

An array of faces that were detected in the image but weren\'t indexed. They weren\'t indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

Returns:

  • (Array<Types::UnindexedFace>)

    An array of faces that were detected in the image but weren\'t indexed.