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

Class: Aws::Rekognition::Types::DetectTextRequest

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

Overview

Note:

When passing DetectTextRequest 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",
    },
  },
  filters: {
    word_filter: {
      min_confidence: 1.0,
      min_bounding_box_height: 1.0,
      min_bounding_box_width: 1.0,
    },
    regions_of_interest: [
      {
        bounding_box: {
          width: 1.0,
          height: 1.0,
          left: 1.0,
          top: 1.0,
        },
      },
    ],
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Types::DetectTextFilters

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Returns:

  • (Types::DetectTextFilters) —

    Optional parameters that let you set the criteria that the text must meet to be included in your response.

#image ⇒ Types::Image

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can\'t pass image bytes.

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 Amazon S3 object.