/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.rekognition.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* 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. *

*

* 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. *

*

* Optional Parameters *

*

* You can specify one or both of the GENERAL_LABELS and * IMAGE_PROPERTIES feature types when calling the DetectLabels * API. Including GENERAL_LABELS will ensure the response includes * the labels detected in the input image, while including * IMAGE_PROPERTIES will ensure the response includes information * about the image quality and color. *

*

* When using GENERAL_LABELS and/or IMAGE_PROPERTIES * you can provide filtering criteria to the Settings parameter. You can filter * with sets of individual labels or with label categories. You can specify * inclusive filters, exclusive filters, or a combination of inclusive and * exclusive filters. For more information on filtering see Detecting Labels in an Image. *

*

* 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. The * default and upper limit is 1000 labels. *

*

* Response Elements *

*

* For each object, scene, and concept the API returns one or more labels. The * API returns the following types of information about labels: *

* *

* The API returns the following information regarding the image, as part of the * ImageProperties structure: *

* *

* The list of returned labels will include at least one label for every * detected object, along with information about that label. In the following * example, suppose the input image has a lighthouse, the sea, and a rock. The * response includes all three labels, one for each object, as well as the * confidence in the label: *

*

* {Name: lighthouse, Confidence: 98.4629} *

*

* {Name: rock,Confidence: 79.2097} *

*

* {Name: sea,Confidence: 75.061} *

*

* The list of labels can include multiple labels for the same object. 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. *

* *

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

*
*

* This is a stateless API operation that doesn't return any data. *

*

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

*/ public class DetectLabelsRequest extends AmazonWebServiceRequest implements Serializable { /** *

* 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. *

*/ private Image image; /** *

* 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 -
*/ private Integer maxLabels; /** *

* 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.0 - 100.0
*/ private Float minConfidence; /** *

* A list of the types of analysis to perform. Specifying GENERAL_LABELS * uses the label detection feature, while specifying IMAGE_PROPERTIES * returns information regarding image color and quality. If no option is * specified GENERAL_LABELS is used by default. *

*/ private java.util.List features; /** *

* A list of the filters to be applied to returned detected labels and image * properties. Specified filters can be inclusive, exclusive, or a * combination of both. Filters can be used for individual labels or label * categories. The exact label names or label categories must be supplied. * For a full list of labels and label categories, see Detecting labels. *

*/ private DetectLabelsSettings settings; /** * Default constructor for DetectLabelsRequest object. Callers should use * the setter or fluent setter (with...) methods to initialize any * additional object members. */ public DetectLabelsRequest() { } /** * Constructs a new DetectLabelsRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param 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. *

*/ public DetectLabelsRequest(Image image) { setImage(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. *

* * @return

* 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. *

*/ public Image getImage() { return 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. *

* * @param 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. *

*/ public void setImage(Image image) { this.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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectLabelsRequest withImage(Image image) { this.image = image; return this; } /** *

* 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 -
* * @return

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

*/ public Integer getMaxLabels() { return 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 -
* * @param maxLabels

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

*/ public void setMaxLabels(Integer maxLabels) { this.maxLabels = 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 -
* * @param maxLabels

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

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectLabelsRequest withMaxLabels(Integer maxLabels) { this.maxLabels = maxLabels; return this; } /** *

* 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.0 - 100.0
* * @return

* 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. *

*/ public Float getMinConfidence() { return 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.0 - 100.0
* * @param 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. *

*/ public void setMinConfidence(Float minConfidence) { this.minConfidence = 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.0 - 100.0
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectLabelsRequest withMinConfidence(Float minConfidence) { this.minConfidence = minConfidence; return this; } /** *

* A list of the types of analysis to perform. Specifying GENERAL_LABELS * uses the label detection feature, while specifying IMAGE_PROPERTIES * returns information regarding image color and quality. If no option is * specified GENERAL_LABELS is used by default. *

* * @return

* A list of the types of analysis to perform. Specifying * GENERAL_LABELS uses the label detection feature, while specifying * IMAGE_PROPERTIES returns information regarding image color and * quality. If no option is specified GENERAL_LABELS is used by * default. *

*/ public java.util.List getFeatures() { return features; } /** *

* A list of the types of analysis to perform. Specifying GENERAL_LABELS * uses the label detection feature, while specifying IMAGE_PROPERTIES * returns information regarding image color and quality. If no option is * specified GENERAL_LABELS is used by default. *

* * @param features

* A list of the types of analysis to perform. Specifying * GENERAL_LABELS uses the label detection feature, while * specifying IMAGE_PROPERTIES returns information regarding * image color and quality. If no option is specified * GENERAL_LABELS is used by default. *

*/ public void setFeatures(java.util.Collection features) { if (features == null) { this.features = null; return; } this.features = new java.util.ArrayList(features); } /** *

* A list of the types of analysis to perform. Specifying GENERAL_LABELS * uses the label detection feature, while specifying IMAGE_PROPERTIES * returns information regarding image color and quality. If no option is * specified GENERAL_LABELS is used by default. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param features

* A list of the types of analysis to perform. Specifying * GENERAL_LABELS uses the label detection feature, while * specifying IMAGE_PROPERTIES returns information regarding * image color and quality. If no option is specified * GENERAL_LABELS is used by default. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectLabelsRequest withFeatures(String... features) { if (getFeatures() == null) { this.features = new java.util.ArrayList(features.length); } for (String value : features) { this.features.add(value); } return this; } /** *

* A list of the types of analysis to perform. Specifying GENERAL_LABELS * uses the label detection feature, while specifying IMAGE_PROPERTIES * returns information regarding image color and quality. If no option is * specified GENERAL_LABELS is used by default. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param features

* A list of the types of analysis to perform. Specifying * GENERAL_LABELS uses the label detection feature, while * specifying IMAGE_PROPERTIES returns information regarding * image color and quality. If no option is specified * GENERAL_LABELS is used by default. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectLabelsRequest withFeatures(java.util.Collection features) { setFeatures(features); return this; } /** *

* A list of the filters to be applied to returned detected labels and image * properties. Specified filters can be inclusive, exclusive, or a * combination of both. Filters can be used for individual labels or label * categories. The exact label names or label categories must be supplied. * For a full list of labels and label categories, see Detecting labels. *

* * @return

* A list of the filters to be applied to returned detected labels * and image properties. Specified filters can be inclusive, * exclusive, or a combination of both. Filters can be used for * individual labels or label categories. The exact label names or * label categories must be supplied. For a full list of labels and * label categories, see Detecting labels. *

*/ public DetectLabelsSettings getSettings() { return settings; } /** *

* A list of the filters to be applied to returned detected labels and image * properties. Specified filters can be inclusive, exclusive, or a * combination of both. Filters can be used for individual labels or label * categories. The exact label names or label categories must be supplied. * For a full list of labels and label categories, see Detecting labels. *

* * @param settings

* A list of the filters to be applied to returned detected * labels and image properties. Specified filters can be * inclusive, exclusive, or a combination of both. Filters can be * used for individual labels or label categories. The exact * label names or label categories must be supplied. For a full * list of labels and label categories, see Detecting labels. *

*/ public void setSettings(DetectLabelsSettings settings) { this.settings = settings; } /** *

* A list of the filters to be applied to returned detected labels and image * properties. Specified filters can be inclusive, exclusive, or a * combination of both. Filters can be used for individual labels or label * categories. The exact label names or label categories must be supplied. * For a full list of labels and label categories, see Detecting labels. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param settings

* A list of the filters to be applied to returned detected * labels and image properties. Specified filters can be * inclusive, exclusive, or a combination of both. Filters can be * used for individual labels or label categories. The exact * label names or label categories must be supplied. For a full * list of labels and label categories, see Detecting labels. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectLabelsRequest withSettings(DetectLabelsSettings settings) { this.settings = settings; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getImage() != null) sb.append("Image: " + getImage() + ","); if (getMaxLabels() != null) sb.append("MaxLabels: " + getMaxLabels() + ","); if (getMinConfidence() != null) sb.append("MinConfidence: " + getMinConfidence() + ","); if (getFeatures() != null) sb.append("Features: " + getFeatures() + ","); if (getSettings() != null) sb.append("Settings: " + getSettings()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getImage() == null) ? 0 : getImage().hashCode()); hashCode = prime * hashCode + ((getMaxLabels() == null) ? 0 : getMaxLabels().hashCode()); hashCode = prime * hashCode + ((getMinConfidence() == null) ? 0 : getMinConfidence().hashCode()); hashCode = prime * hashCode + ((getFeatures() == null) ? 0 : getFeatures().hashCode()); hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DetectLabelsRequest == false) return false; DetectLabelsRequest other = (DetectLabelsRequest) obj; if (other.getImage() == null ^ this.getImage() == null) return false; if (other.getImage() != null && other.getImage().equals(this.getImage()) == false) return false; if (other.getMaxLabels() == null ^ this.getMaxLabels() == null) return false; if (other.getMaxLabels() != null && other.getMaxLabels().equals(this.getMaxLabels()) == false) return false; if (other.getMinConfidence() == null ^ this.getMinConfidence() == null) return false; if (other.getMinConfidence() != null && other.getMinConfidence().equals(this.getMinConfidence()) == false) return false; if (other.getFeatures() == null ^ this.getFeatures() == null) return false; if (other.getFeatures() != null && other.getFeatures().equals(this.getFeatures()) == false) return false; if (other.getSettings() == null ^ this.getSettings() == null) return false; if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false) return false; return true; } }