| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.DetectCustomLabels
Description
Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
You specify which version of a model version to use by using the
ProjectVersionArn input parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object that the model version detects on an image, the API
returns a (CustomLabel) object in an array (CustomLabels). Each
CustomLabel object provides the label name (Name), the level of
confidence that the image contains the object (Confidence), and object
location information, if it exists, for the label on the image
(Geometry).
To filter labels that are returned, specify a value for MinConfidence.
DetectCustomLabelsLabels only returns labels with a confidence that's
higher than the specified value. The value of MinConfidence maps to
the assumed threshold values created during training. For more
information, see Assumed threshold in the Amazon Rekognition Custom
Labels Developer Guide. Amazon Rekognition Custom Labels metrics
expresses an assumed threshold as a floating point value between 0-1.
The range of MinConfidence normalizes the threshold value to a
percentage value (0-100). Confidence responses from DetectCustomLabels
are also returned as a percentage. You can use MinConfidence to change
the precision and recall or your model. For more information, see
Analyzing an image in the Amazon Rekognition Custom Labels Developer
Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels
returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the
rekognition:DetectCustomLabels action.
For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
Synopsis
- data DetectCustomLabels = DetectCustomLabels' {}
- newDetectCustomLabels :: Text -> Image -> DetectCustomLabels
- detectCustomLabels_minConfidence :: Lens' DetectCustomLabels (Maybe Double)
- detectCustomLabels_maxResults :: Lens' DetectCustomLabels (Maybe Natural)
- detectCustomLabels_projectVersionArn :: Lens' DetectCustomLabels Text
- detectCustomLabels_image :: Lens' DetectCustomLabels Image
- data DetectCustomLabelsResponse = DetectCustomLabelsResponse' {
- customLabels :: Maybe [CustomLabel]
- httpStatus :: Int
- newDetectCustomLabelsResponse :: Int -> DetectCustomLabelsResponse
- detectCustomLabelsResponse_customLabels :: Lens' DetectCustomLabelsResponse (Maybe [CustomLabel])
- detectCustomLabelsResponse_httpStatus :: Lens' DetectCustomLabelsResponse Int
Creating a Request
data DetectCustomLabels Source #
See: newDetectCustomLabels smart constructor.
Constructors
| DetectCustomLabels' | |
Fields
| |
Instances
newDetectCustomLabels Source #
Arguments
| :: Text | |
| -> Image | |
| -> DetectCustomLabels |
Create a value of DetectCustomLabels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minConfidence:DetectCustomLabels', detectCustomLabels_minConfidence - Specifies the minimum confidence level for the labels to return.
DetectCustomLabels doesn't return any labels with a confidence value
that's lower than this specified value. If you specify a value of 0,
DetectCustomLabels returns all labels, regardless of the assumed
threshold applied to each label. If you don't specify a value for
MinConfidence, DetectCustomLabels returns labels based on the
assumed threshold of each label.
$sel:maxResults:DetectCustomLabels', detectCustomLabels_maxResults - Maximum number of results you want the service to return in the
response. The service returns the specified number of highest confidence
labels ranked from highest confidence to lowest.
$sel:projectVersionArn:DetectCustomLabels', detectCustomLabels_projectVersionArn - The ARN of the model version that you want to use.
$sel:image:DetectCustomLabels', detectCustomLabels_image - Undocumented member.
Request Lenses
detectCustomLabels_minConfidence :: Lens' DetectCustomLabels (Maybe Double) Source #
Specifies the minimum confidence level for the labels to return.
DetectCustomLabels doesn't return any labels with a confidence value
that's lower than this specified value. If you specify a value of 0,
DetectCustomLabels returns all labels, regardless of the assumed
threshold applied to each label. If you don't specify a value for
MinConfidence, DetectCustomLabels returns labels based on the
assumed threshold of each label.
detectCustomLabels_maxResults :: Lens' DetectCustomLabels (Maybe Natural) Source #
Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.
detectCustomLabels_projectVersionArn :: Lens' DetectCustomLabels Text Source #
The ARN of the model version that you want to use.
detectCustomLabels_image :: Lens' DetectCustomLabels Image Source #
Undocumented member.
Destructuring the Response
data DetectCustomLabelsResponse Source #
See: newDetectCustomLabelsResponse smart constructor.
Constructors
| DetectCustomLabelsResponse' | |
Fields
| |
Instances
newDetectCustomLabelsResponse Source #
Create a value of DetectCustomLabelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customLabels:DetectCustomLabelsResponse', detectCustomLabelsResponse_customLabels - An array of custom labels detected in the input image.
$sel:httpStatus:DetectCustomLabelsResponse', detectCustomLabelsResponse_httpStatus - The response's http status code.
Response Lenses
detectCustomLabelsResponse_customLabels :: Lens' DetectCustomLabelsResponse (Maybe [CustomLabel]) Source #
An array of custom labels detected in the input image.
detectCustomLabelsResponse_httpStatus :: Lens' DetectCustomLabelsResponse Int Source #
The response's http status code.