NAME

Paws::Textract::Block

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Textract::Block object:

  $service_obj->Method(Att1 => { BlockType => $value, ..., TextType => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Textract::Block object:

  $result = $service_obj->Method(...);
  $result->Att1->BlockType

DESCRIPTION

A "Block" represents items that are recognized in a document within a group of pixels close to each other. The information returned in a "Block" object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables, and selection elements that are detected in the document.

An array of "Block" objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of "Block" objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.

For more information, see How Amazon Textract Works (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html).

ATTRIBUTES

BlockType => Str

The type of text item that's recognized. In operations for text detection, the following types are returned:

PAGE - Contains a list of the LINE "Block" objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.

In text analysis operations, the following types are returned:

PAGE - Contains a list of child "Block" objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE "Block" objects for linked text that's detected on a document page. Use the "EntityType" field to determine if a KEY_VALUE_SET object is a KEY "Block" object or a VALUE "Block" object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of "SelectionStatus" to determine the status of the selection element.

ColumnIndex => Int

The column in which a table cell appears. The first column position is 1. "ColumnIndex" isn't returned by "DetectDocumentText" and "GetDocumentTextDetection".

ColumnSpan => Int

The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. "ColumnSpan" isn't returned by "DetectDocumentText" and "GetDocumentTextDetection".

Confidence => Num

The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

EntityTypes => ArrayRef[Str|Undef]

The type of entity. The following can be returned:

KEY - An identifier for a field on the document.
VALUE - The field text.

"EntityTypes" isn't returned by "DetectDocumentText" and "GetDocumentTextDetection".

Geometry => Paws::Textract::Geometry

The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

Id => Str

The identifier for the recognized text. The identifier is only unique for a single operation.

Page => Int

The page on which a block was detected. "Page" is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of "Page" is always 1. Synchronous operations don't return "Page" because every input document is considered to be a single-page document.

Relationships => ArrayRef[Paws::Textract::Relationship]

A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:

0 - The block has no child blocks.
1 - The block has child blocks.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>