You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Note:

When making an API call, you may pass DetectLabelsRequest data as a hash:

{
  image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  max_labels: 1,
  min_confidence: 1.0,
}

Instance Attribute Summary collapse

Instance Attribute Details

#imageTypes::Image

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

Returns:



752
753
754
755
756
757
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 752

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence)
  include Aws::Structure
end

#max_labelsInteger

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

Returns:

  • (Integer)


752
753
754
755
756
757
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 752

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence)
  include Aws::Structure
end

#min_confidenceFloat

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 50 percent.

Returns:

  • (Float)


752
753
754
755
756
757
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 752

class DetectLabelsRequest < Struct.new(
  :image,
  :max_labels,
  :min_confidence)
  include Aws::Structure
end