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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DetectLabelsRequest as input to an Aws::Client method, you can use a vanilla 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

#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) —

    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. The service returns the specified number of highest confidence labels.

Returns:

  • (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. 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.

Returns:

  • (Float) —

    Specifies the minimum confidence level for the labels to return.