class Aws::Textract::Types::Block

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].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works.html

@!attribute [rw] block_type

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.
@return [String]

@!attribute [rw] confidence

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.
@return [Float]

@!attribute [rw] text

The word or line of text that's recognized by Amazon Textract.
@return [String]

@!attribute [rw] text_type

The kind of text that Amazon Textract has detected. Can check for
handwritten text and printed text.
@return [String]

@!attribute [rw] row_index

The row in which a table cell is located. The first row position is
1. `RowIndex` isn't returned by `DetectDocumentText` and
`GetDocumentTextDetection`.
@return [Integer]

@!attribute [rw] column_index

The column in which a table cell appears. The first column position
is 1. `ColumnIndex` isn't returned by `DetectDocumentText` and
`GetDocumentTextDetection`.
@return [Integer]

@!attribute [rw] row_span

The number of rows that a table cell spans. Currently this value is
always 1, even if the number of rows spanned is greater than 1.
`RowSpan` isn't returned by `DetectDocumentText` and
`GetDocumentTextDetection`.
@return [Integer]

@!attribute [rw] column_span

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`.
@return [Integer]

@!attribute [rw] 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.
@return [Types::Geometry]

@!attribute [rw] id

The identifier for the recognized text. The identifier is only
unique for a single operation.
@return [String]

@!attribute [rw] relationships

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.
@return [Array<Types::Relationship>]

@!attribute [rw] entity_types

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`.
@return [Array<String>]

@!attribute [rw] selection_status

The selection status of a selection element, such as an option
button or check box.
@return [String]

@!attribute [rw] page

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.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/Block AWS API Documentation

Constants

SENSITIVE