DetectCustomLabelsRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rekognition.model.DetectCustomLabelsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class DetectCustomLabelsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
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).

During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn't return labels whose confidence value is below the model's calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model's calculated threshold. You can get the model's calculated threshold from the model's training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0.

You can also add the MaxResults parameter to limit the number of labels returned.

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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DetectCustomLabelsRequest()

Constructors
Constructor and Description
`DetectCustomLabelsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`Image`	`getImage()` Provides the input image either as bytes or an S3 object.
`java.lang.Integer`	`getMaxResults()` Maximum number of results you want the service to return in the response.
`java.lang.Float`	`getMinConfidence()` Specifies the minimum confidence level for the labels to return.
`java.lang.String`	`getProjectVersionArn()` The ARN of the model version that you want to use.
`int`	`hashCode()`
`void`	`setImage(Image image)` Provides the input image either as bytes or an S3 object.
`void`	`setMaxResults(java.lang.Integer maxResults)` Maximum number of results 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.
`void`	`setProjectVersionArn(java.lang.String projectVersionArn)` The ARN of the model version that you want to use.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DetectCustomLabelsRequest`	`withImage(Image image)` Provides the input image either as bytes or an S3 object.
`DetectCustomLabelsRequest`	`withMaxResults(java.lang.Integer maxResults)` Maximum number of results you want the service to return in the response.
`DetectCustomLabelsRequest`	`withMinConfidence(java.lang.Float minConfidence)` Specifies the minimum confidence level for the labels to return.
`DetectCustomLabelsRequest`	`withProjectVersionArn(java.lang.String projectVersionArn)` The ARN of the model version that you want to use.

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
  - DetectCustomLabelsRequest
```
public DetectCustomLabelsRequest()
```
- Method Detail
  - getProjectVersionArn
```
public java.lang.String getProjectVersionArn()
```
    The ARN of the model version that you want to use.
    
    Constraints:
    Length: 20 - 2048
    Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)
    
    Returns:
    
    The ARN of the model version that you want to use.
  - setProjectVersionArn
```
public void setProjectVersionArn(java.lang.String projectVersionArn)
```
    The ARN of the model version that you want to use.
    
    Constraints:
    Length: 20 - 2048
    Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)
    
    Parameters:
    
    projectVersionArn -
    The ARN of the model version that you want to use.
  - withProjectVersionArn
```
public DetectCustomLabelsRequest withProjectVersionArn(java.lang.String projectVersionArn)
```
    The ARN of the model version that you want to use.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)
    
    Parameters:
    
    projectVersionArn -
    The ARN of the model version that you want to use.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getImage
```
public Image getImage()
```
    Provides the input image either as bytes or an S3 object.
    
    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
    
    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
    
    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
    
    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
    
    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
    
    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
    
    Returns:
    
    Provides the input image either as bytes or an S3 object.
    
    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
    
    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
    
    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
    
    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
    
    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
    
    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
  - setImage
```
public void setImage(Image image)
```
    Provides the input image either as bytes or an S3 object.
    
    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
    
    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
    
    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
    
    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
    
    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
    
    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
    
    Parameters:
    
    image -
    Provides the input image either as bytes or an S3 object.
    
    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
    
    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
    
    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
    
    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
    
    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
    
    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
  - withImage
```
public DetectCustomLabelsRequest withImage(Image image)
```
    Provides the input image either as bytes or an S3 object.
    
    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
    
    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
    
    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
    
    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
    
    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
    
    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    image -
    Provides the input image either as bytes or an S3 object.
    
    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
    
    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
    
    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
    
    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
    
    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
    
    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    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.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    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.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer 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.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    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.
  - withMaxResults
```
public DetectCustomLabelsRequest withMaxResults(java.lang.Integer 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    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.
    
    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 a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
    
    Constraints:
    Length: 0 - 100
    
    Returns:
    
    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
  - 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 a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
    
    Constraints:
    Length: 0 - 100
    
    Parameters:
    
    minConfidence -
    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
  - withMinConfidence
```
public DetectCustomLabelsRequest withMinConfidence(java.lang.Float minConfidence)
```
    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
    
    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 a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
    
    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

Class DetectCustomLabelsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DetectCustomLabelsRequest

Method Detail

getProjectVersionArn

setProjectVersionArn

withProjectVersionArn

getImage

setImage

withImage

getMaxResults

setMaxResults

withMaxResults

getMinConfidence

setMinConfidence

withMinConfidence

toString

hashCode

equals