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.
Container for the parameters to the DetectCustomLabels operation.
This operation applies only to Amazon Rekognition Custom Labels.
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
). Note that for the DetectCustomLabelsLabels
operation, Polygons
are not returned in the Geometry
section of the
response.
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.
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public class DetectCustomLabelsRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The DetectCustomLabelsRequest type exposes the following members
Name | Description | |
---|---|---|
![]() |
DetectCustomLabelsRequest() |
Name | Type | Description | |
---|---|---|---|
![]() |
Image | Amazon.Rekognition.Model.Image |
Gets and sets the property Image. |
![]() |
MaxResults | System.Int32 |
Gets and sets the property 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. |
![]() |
MinConfidence | System.Single |
Gets and sets the property MinConfidence.
Specifies the minimum confidence level for the labels to return. |
![]() |
ProjectVersionArn | System.String |
Gets and sets the property ProjectVersionArn. The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned. |
Detects custom labels in an image with an Amazon Rekognition Custom Labels model
var client = new AmazonRekognitionClient(); var response = client.DetectCustomLabels(new DetectCustomLabelsRequest { Image = new Image { S3Object = new S3Object { Bucket = "custom-labels-console-us-east-1-1111111111", Name = "assets/flowers_1_test_dataset/camellia4.jpg" } }, MaxResults = 100, MinConfidence = 50, ProjectVersionArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/my-project.2023-07-31T11.49.37/1690829378219" }); List<CustomLabel> customLabels = response.CustomLabels;
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5