aws-elixir v0.4.0 AWS.Rekognition
This is the Amazon Rekognition API reference.
Summary
Functions
Compares a face in the source input image with each face detected in the target input image
Creates a collection in an AWS Region. You can add faces to the collection using the operation
Deletes the specified collection. Note that this operation removes all
faces in the collection. For an example, see example1
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection
Detects faces within an image (JPEG or PNG) that is provided as input
Detects instances of real-world labels within an image (JPEG or PNG)
provided as input. This includes objects like flower, tree, and table;
events like wedding, graduation, and birthday party; and concepts like
landscape, evening, and nature. For an example, see
get-started-exercise-detect-labels
Detects faces in the input image and adds them to the specified collection
Returns list of collection IDs in your account. If the result is truncated,
the response also provides a NextToken
that you can use in the subsequent
request to fetch the next set of collection IDs
Returns metadata for faces in the specified collection. This metadata
includes information such as the bounding box coordinates, the confidence
(that the bounding box contains a face), and face ID. For an example, see
example3
For a given input face ID, searches for matching faces in the collection
the face belongs to. You get a face ID when you add a face to the
collection using the IndexFaces
operation. The operation compares the
features of the input face with faces in the specified collection
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection
Functions
Compares a face in the source input image with each face detected in the target input image.
by similarity score with the highest similarity scores first. For each face
match, the response provides a bounding box of the face 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.
about the face in the source image, including the bounding box of the face and confidence value.
This operation requires permissions to perform the
rekognition:CompareFaces
action.
Creates a collection in an AWS Region. You can add faces to the collection using the operation.
For example, you might create collections, one for each of your application
users. A user can then index faces using the IndexFaces
operation and
persist results in a specific collection. Then, a user can search the
collection for faces in the user-specific container.
For an example, see example1
.
This operation requires permissions to perform the
rekognition:CreateCollection
action.
Deletes the specified collection. Note that this operation removes all
faces in the collection. For an example, see example1
.
This operation requires permissions to perform the
rekognition:DeleteCollection
action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the
rekognition:DeleteFaces
action.
Detects faces within an image (JPEG or PNG) that is provided as input.
For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence.
This operation requires permissions to perform the
rekognition:DetectFaces
action.
Detects instances of real-world labels within an image (JPEG or PNG)
provided as input. This includes objects like flower, tree, and table;
events like wedding, graduation, and birthday party; and concepts like
landscape, evening, and nature. For an example, see
get-started-exercise-detect-labels
.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
You can provide the input image as an S3 object or as base64-encoded bytes.
In response, the API returns an array of labels. In addition, the response
also includes the orientation correction. Optionally, you can specify
MinConfidence
to control the confidence threshold for the labels
returned. The default is 50%. You can also add the MaxLabels
parameter to
limit the number of labels returned.
persist any data.
This operation requires permissions to perform the
rekognition:DetectLabels
action.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.
If you provide the optional externalImageID
for the input image you
provided, Amazon Rekognition associates this ID with all faces that it
detects. When you call the operation, the response returns the external ID.
You can use this external image ID to create a client-side index to
associate the faces with each image. You can then use the index to find all
faces in an image.
In response, the operation returns an array of metadata for all detected
faces. This includes, the bounding box of the detected face, confidence
value (indicating the bounding box contains a face), a face ID assigned by
the service for each face that is detected and stored, and an image ID
assigned by the service for the input image If you request all facial
attributes (using the detectionAttributes
parameter, Amazon Rekognition
returns detailed facial attributes such as facial landmarks (for example,
location of eye and mount) and other facial attributes such gender. If you
provide the same image, specify the same collection, and use the same
external ID in the IndexFaces
operation, Amazon Rekognition doesn’t save
duplicate face metadata.
For an example, see example2
.
This operation requires permissions to perform the rekognition:IndexFaces
action.
Returns list of collection IDs in your account. If the result is truncated,
the response also provides a NextToken
that you can use in the subsequent
request to fetch the next set of collection IDs.
For an example, see example1
.
This operation requires permissions to perform the
rekognition:ListCollections
action.
Returns metadata for faces in the specified collection. This metadata
includes information such as the bounding box coordinates, the confidence
(that the bounding box contains a face), and face ID. For an example, see
example3
.
This operation requires permissions to perform the rekognition:ListFaces
action.
For a given input face ID, searches for matching faces in the collection
the face belongs to. You get a face ID when you add a face to the
collection using the IndexFaces
operation. The operation compares the
features of the input face with faces in the specified collection.
ordered by similarity score with the highest similarity first. More
specifically, it is an array of metadata for each face match that is found.
Along with the metadata, the response also includes a confidence
value
for each face match, indicating the confidence that the specific face
matches the input face.
For an example, see example3
.
This operation requires permissions to perform the
rekognition:SearchFaces
action.
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
similarity score with the highest similarity first. More specifically, it
is an array of metadata for each face match found. Along with the metadata,
the response also includes a similarity
indicating how similar the face
is to the input face. In the response, the operation also returns the
bounding box (and a confidence level that the bounding box contains a face)
of the face that Amazon Rekognition used for the input image.
For an example, see example3
.
This operation requires permissions to perform the
rekognition:SearchFacesByImage
action.