Package software.amazon.awssdk.services.textract.model

Class Block

java.lang.Object
software.amazon.awssdk.services.textract.model.Block
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Block.Builder,Block>
@Generated("software.amazon.awssdk:codegen") public final class Block extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Block.Builder,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.

See Also:

  • Method Details

    • blockType

      public final BlockType blockType()

      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.

      • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

      • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

      • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

      • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

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

      • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

      • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

      • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

      The following BlockTypes are only returned for Amazon Textract Layout.

      • LAYOUT_TITLE - The main title of the document.

      • LAYOUT_HEADER - Text located in the top margin of the document.

      • LAYOUT_FOOTER - Text located in the bottom margin of the document.

      • LAYOUT_SECTION_HEADER - The titles of sections within a document.

      • LAYOUT_PAGE_NUMBER - The page number of the documents.

      • LAYOUT_LIST - Any information grouped together in list form.

      • LAYOUT_FIGURE - Indicates the location of an image in a document.

      • LAYOUT_TABLE - Indicates the location of a table in the document.

      • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

      • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

      If the service returns an enum value that is not available in the current SDK version, blockType will return BlockType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blockTypeAsString().

      Returns:
      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.

      • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

      • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

      • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

      • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

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

      • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

      • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

      • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

      The following BlockTypes are only returned for Amazon Textract Layout.

      • LAYOUT_TITLE - The main title of the document.

      • LAYOUT_HEADER - Text located in the top margin of the document.

      • LAYOUT_FOOTER - Text located in the bottom margin of the document.

      • LAYOUT_SECTION_HEADER - The titles of sections within a document.

      • LAYOUT_PAGE_NUMBER - The page number of the documents.

      • LAYOUT_LIST - Any information grouped together in list form.

      • LAYOUT_FIGURE - Indicates the location of an image in a document.

      • LAYOUT_TABLE - Indicates the location of a table in the document.

      • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

      • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

      See Also:

    • blockTypeAsString

      public final String blockTypeAsString()

      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.

      • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

      • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

      • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

      • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

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

      • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

      • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

      • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

      The following BlockTypes are only returned for Amazon Textract Layout.

      • LAYOUT_TITLE - The main title of the document.

      • LAYOUT_HEADER - Text located in the top margin of the document.

      • LAYOUT_FOOTER - Text located in the bottom margin of the document.

      • LAYOUT_SECTION_HEADER - The titles of sections within a document.

      • LAYOUT_PAGE_NUMBER - The page number of the documents.

      • LAYOUT_LIST - Any information grouped together in list form.

      • LAYOUT_FIGURE - Indicates the location of an image in a document.

      • LAYOUT_TABLE - Indicates the location of a table in the document.

      • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

      • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

      If the service returns an enum value that is not available in the current SDK version, blockType will return BlockType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blockTypeAsString().

      Returns:
      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.

      • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

      • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

      • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

      • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

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

      • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

      • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

      • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

      The following BlockTypes are only returned for Amazon Textract Layout.

      • LAYOUT_TITLE - The main title of the document.

      • LAYOUT_HEADER - Text located in the top margin of the document.

      • LAYOUT_FOOTER - Text located in the bottom margin of the document.

      • LAYOUT_SECTION_HEADER - The titles of sections within a document.

      • LAYOUT_PAGE_NUMBER - The page number of the documents.

      • LAYOUT_LIST - Any information grouped together in list form.

      • LAYOUT_FIGURE - Indicates the location of an image in a document.

      • LAYOUT_TABLE - Indicates the location of a table in the document.

      • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

      • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

      See Also:

    • confidence

      public final Float 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.

      Returns:
      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.

    • text

      public final String text()

      The word or line of text that's recognized by Amazon Textract.

      Returns:
      The word or line of text that's recognized by Amazon Textract.

    • textType

      public final TextType textType()

      The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

      If the service returns an enum value that is not available in the current SDK version, textType will return TextType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textTypeAsString().

      Returns:
      The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
      See Also:

    • textTypeAsString

      public final String textTypeAsString()

      The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

      If the service returns an enum value that is not available in the current SDK version, textType will return TextType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textTypeAsString().

      Returns:
      The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
      See Also:

    • rowIndex

      public final Integer rowIndex()

      The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      Returns:
      The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

    • columnIndex

      public final Integer columnIndex()

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

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

    • rowSpan

      public final Integer rowSpan()

      The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      Returns:
      The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

    • columnSpan

      public final Integer columnSpan()

      The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      Returns:
      The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

    • geometry

      public final Geometry 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.

      Returns:
      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

      public final String id()

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

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

    • hasRelationships

      public final boolean hasRelationships()
      For responses, this returns true if the service returned a value for the Relationships property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • relationships

      public final List<Relationship> relationships()

      A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRelationships() method.

      Returns:
      A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up 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.

    • entityTypes

      public final List<EntityType> entityTypes()

      The type of entity.

      The following entity types can be returned by FORMS analysis:

      • KEY - An identifier for a field on the document.

      • VALUE - The field text.

      The following entity types can be returned by TABLES analysis:

      • COLUMN_HEADER - Identifies a cell that is a header of a column.

      • TABLE_TITLE - Identifies a cell that is a title within the table.

      • TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.

      • TABLE_FOOTER - Identifies a cell that is a footer of a table.

      • TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

      • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

      • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

      EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntityTypes() method.

      Returns:
      The type of entity.

      The following entity types can be returned by FORMS analysis:

      • KEY - An identifier for a field on the document.

      • VALUE - The field text.

      The following entity types can be returned by TABLES analysis:

      • COLUMN_HEADER - Identifies a cell that is a header of a column.

      • TABLE_TITLE - Identifies a cell that is a title within the table.

      • TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.

      • TABLE_FOOTER - Identifies a cell that is a footer of a table.

      • TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

      • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

      • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

      EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

    • hasEntityTypes

      public final boolean hasEntityTypes()
      For responses, this returns true if the service returned a value for the EntityTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • entityTypesAsStrings

      public final List<String> entityTypesAsStrings()

      The type of entity.

      The following entity types can be returned by FORMS analysis:

      • KEY - An identifier for a field on the document.

      • VALUE - The field text.

      The following entity types can be returned by TABLES analysis:

      • COLUMN_HEADER - Identifies a cell that is a header of a column.

      • TABLE_TITLE - Identifies a cell that is a title within the table.

      • TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.

      • TABLE_FOOTER - Identifies a cell that is a footer of a table.

      • TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

      • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

      • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

      EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntityTypes() method.

      Returns:
      The type of entity.

      The following entity types can be returned by FORMS analysis:

      • KEY - An identifier for a field on the document.

      • VALUE - The field text.

      The following entity types can be returned by TABLES analysis:

      • COLUMN_HEADER - Identifies a cell that is a header of a column.

      • TABLE_TITLE - Identifies a cell that is a title within the table.

      • TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.

      • TABLE_FOOTER - Identifies a cell that is a footer of a table.

      • TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

      • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

      • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

      EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

    • selectionStatus

      public final SelectionStatus selectionStatus()

      The selection status of a selection element, such as an option button or check box.

      If the service returns an enum value that is not available in the current SDK version, selectionStatus will return SelectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectionStatusAsString().

      Returns:
      The selection status of a selection element, such as an option button or check box.
      See Also:

    • selectionStatusAsString

      public final String selectionStatusAsString()

      The selection status of a selection element, such as an option button or check box.

      If the service returns an enum value that is not available in the current SDK version, selectionStatus will return SelectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectionStatusAsString().

      Returns:
      The selection status of a selection element, such as an option button or check box.
      See Also:

    • page

      public final Integer page()

      The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1.

      Returns:
      The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1.

    • query

      public final Query query()

      Returns:

    • toBuilder

      public Block.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Block.Builder,Block>
      Returns:
      a builder for type T

    • builder

      public static Block.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Block.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.