com.amazonaws.services.rekognition.model

Class DetectLabelsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.DetectLabelsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DetectLabelsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Detects instances of real-world entities 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 Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

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, 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 includes 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.

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 55%. You can also add the MaxLabels parameter to limit the number of labels returned.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DetectLabelsRequest() Default constructor for DetectLabelsRequest object.
DetectLabelsRequest(Image image) Constructs a new DetectLabelsRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Image	getImage() The input image as base64-encoded bytes or an S3 object.
java.lang.Integer	getMaxLabels() Maximum number of labels you want the service to return in the response.
java.lang.Float	getMinConfidence() Specifies the minimum confidence level for the labels to return.
int	hashCode()
void	setImage(Image image) The input image as base64-encoded bytes or an S3 object.
void	setMaxLabels(java.lang.Integer maxLabels) Maximum number of labels you want the service to return in the response.
void	setMinConfidence(java.lang.Float minConfidence) Specifies the minimum confidence level for the labels to return.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DetectLabelsRequest	withImage(Image image) The input image as base64-encoded bytes or an S3 object.
DetectLabelsRequest	withMaxLabels(java.lang.Integer maxLabels) Maximum number of labels you want the service to return in the response.
DetectLabelsRequest	withMinConfidence(java.lang.Float minConfidence) Specifies the minimum confidence level for the labels to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DetectLabelsRequest

public DetectLabelsRequest()

Default constructor for DetectLabelsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

DetectLabelsRequest

public DetectLabelsRequest(Image image)

Constructs a new DetectLabelsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

image -

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Method Detail

getImage

public Image getImage()

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

setImage

public void setImage(Image image)

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Parameters:

image -

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

withImage

public DetectLabelsRequest withImage(Image image)

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:

image -

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxLabels

public java.lang.Integer getMaxLabels()

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

Constraints:
Range: 0 -

Returns:

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

setMaxLabels

public void setMaxLabels(java.lang.Integer maxLabels)

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

Constraints:
Range: 0 -

Parameters:

maxLabels -

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

withMaxLabels

public DetectLabelsRequest withMaxLabels(java.lang.Integer maxLabels)

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:

maxLabels -

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

Returns:

A reference to this updated object so that method calls can be chained together.

getMinConfidence

public java.lang.Float getMinConfidence()

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Constraints:
Length: 0 - 100

Returns:

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

setMinConfidence

public void setMinConfidence(java.lang.Float minConfidence)

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Constraints:
Length: 0 - 100

Parameters:

minConfidence -

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

withMinConfidence

public DetectLabelsRequest withMinConfidence(java.lang.Float minConfidence)

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 100

Parameters:

minConfidence -

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object