IndexFacesResponse Class | AWS SDK for .NET V3

This is the response object from the IndexFaces operation.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.Rekognition.Model.IndexFacesResponse

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

public class IndexFacesResponse : AmazonWebServiceResponse

The IndexFacesResponse type exposes the following members

Constructors

	Name	Description
	IndexFacesResponse()

Properties

Name	Type	Description
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
FaceModelVersion	System.String	Gets and sets the property FaceModelVersion. The version number of the face detection model that's associated with the input collection (`CollectionId`).
FaceRecords	System.Collections.Generic.List<Amazon.Rekognition.Model.FaceRecord>	Gets and sets the property FaceRecords. 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.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
OrientationCorrection	Amazon.Rekognition.OrientationCorrection	Gets and sets the property OrientationCorrection. 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.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
UnindexedFaces	System.Collections.Generic.List<Amazon.Rekognition.Model.UnindexedFace>	Gets and sets the property UnindexedFaces. 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.

Examples

This operation detects faces in an image and adds them to the specified Rekognition collection.

To add a face to a collection


var client = new AmazonRekognitionClient();
var response = client.IndexFaces(new IndexFacesRequest 
{
    CollectionId = "myphotos",
    DetectionAttributes = new List<string> {
                    
    },
    ExternalImageId = "myphotoid",
    Image = new Image { S3Object = new S3Object {
        Bucket = "mybucket",
        Name = "myphoto"
    } }
});

List<FaceRecord> faceRecords = response.FaceRecords;
string orientationCorrection = response.OrientationCorrection;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5