Class: Aws::Rekognition::Types::DetectCustomLabelsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::DetectCustomLabelsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #image ⇒ Types::Image

  Provides the input image either as bytes or an S3 object.

• #max_results ⇒ Integer

  Maximum number of results you want the service to return in the response.

• #min_confidence ⇒ Float

  Specifies the minimum confidence level for the labels to return.

• #project_version_arn ⇒ String

  The ARN of the model version that you want to use.

Instance Attribute Details

#image ⇒ Types::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 How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

Returns:

• (Types::Image)

# File 'lib/aws-sdk-rekognition/types.rb', line 2049

class DetectCustomLabelsRequest < Struct.new(
  :project_version_arn,
  :image,
  :max_results,
  :min_confidence)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 2049

class DetectCustomLabelsRequest < Struct.new(
  :project_version_arn,
  :image,
  :max_results,
  :min_confidence)
  SENSITIVE = []
  include Aws::Structure
end

#min_confidence ⇒ Float

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.

Returns:

• (Float)

# File 'lib/aws-sdk-rekognition/types.rb', line 2049

class DetectCustomLabelsRequest < Struct.new(
  :project_version_arn,
  :image,
  :max_results,
  :min_confidence)
  SENSITIVE = []
  include Aws::Structure
end

#project_version_arn ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 2049

class DetectCustomLabelsRequest < Struct.new(
  :project_version_arn,
  :image,
  :max_results,
  :min_confidence)
  SENSITIVE = []
  include Aws::Structure
end