Class: Aws::Rekognition::Types::DetectLabelsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::DetectLabelsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #features ⇒ Array<String>

  A list of the types of analysis to perform.

• #image ⇒ Types::Image

  The input image as base64-encoded bytes or an S3 object.

• #max_labels ⇒ Integer

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

• #min_confidence ⇒ Float

  Specifies the minimum confidence level for the labels to return.

• #settings ⇒ Types::DetectLabelsSettings

  A list of the filters to be applied to returned detected labels and image properties.

Instance Attribute Details

#features ⇒ Array<String>

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:

• (Array<String>)

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

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#image ⇒ Types::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:

• (Types::Image)

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

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#max_labels ⇒ Integer

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.

Returns:

• (Integer)

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

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#min_confidence ⇒ Float

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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.

Returns:

• (Float)

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

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::DetectLabelsSettings

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

[1]: docs.aws.amazon.com/rekognition/latest/dg/labels.html

Returns:

• (Types::DetectLabelsSettings)

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

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end