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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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. You can provide a blob of image bytes or an S3 object.



505
506
507
508
509
510
# File 'lib/aws-sdk-rekognition/types.rb', line 505

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.



505
506
507
508
509
510
# File 'lib/aws-sdk-rekognition/types.rb', line 505

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.



505
506
507
508
509
510
# File 'lib/aws-sdk-rekognition/types.rb', line 505

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