public static interface Block.Builder extends SdkPojo, CopyableBuilder<Block.Builder,Block>
Modifier and Type | Method and Description |
---|---|
Block.Builder |
blockType(BlockType blockType)
The type of text item that's recognized.
|
Block.Builder |
blockType(String blockType)
The type of text item that's recognized.
|
Block.Builder |
columnIndex(Integer columnIndex)
The column in which a table cell appears.
|
Block.Builder |
columnSpan(Integer columnSpan)
The number of columns that a table cell spans.
|
Block.Builder |
confidence(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.
|
Block.Builder |
entityTypes(Collection<EntityType> entityTypes)
The type of entity.
|
Block.Builder |
entityTypes(EntityType... entityTypes)
The type of entity.
|
Block.Builder |
entityTypesWithStrings(Collection<String> entityTypes)
The type of entity.
|
Block.Builder |
entityTypesWithStrings(String... entityTypes)
The type of entity.
|
default Block.Builder |
geometry(Consumer<Geometry.Builder> geometry)
The location of the recognized text on the image.
|
Block.Builder |
geometry(Geometry geometry)
The location of the recognized text on the image.
|
Block.Builder |
id(String id)
The identifier for the recognized text.
|
Block.Builder |
page(Integer page)
The page on which a block was detected.
|
Block.Builder |
relationships(Collection<Relationship> relationships)
A list of child blocks of the current block.
|
Block.Builder |
relationships(Consumer<Relationship.Builder>... relationships)
A list of child blocks of the current block.
|
Block.Builder |
relationships(Relationship... relationships)
A list of child blocks of the current block.
|
Block.Builder |
rowIndex(Integer rowIndex)
The row in which a table cell is located.
|
Block.Builder |
rowSpan(Integer rowSpan)
The number of rows that a table cell spans.
|
Block.Builder |
selectionStatus(SelectionStatus selectionStatus)
The selection status of a selection element, such as an option button or check box.
|
Block.Builder |
selectionStatus(String selectionStatus)
The selection status of a selection element, such as an option button or check box.
|
Block.Builder |
text(String text)
The word or line of text that's recognized by Amazon Textract.
|
Block.Builder |
textType(String textType)
The kind of text that Amazon Textract has detected.
|
Block.Builder |
textType(TextType textType)
The kind of text that Amazon Textract has detected.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
Block.Builder blockType(String 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.
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.
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.
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.
BlockType
,
BlockType
Block.Builder blockType(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.
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.
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.
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.
BlockType
,
BlockType
Block.Builder confidence(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.
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.Block.Builder text(String text)
The word or line of text that's recognized by Amazon Textract.
text
- The word or line of text that's recognized by Amazon Textract.Block.Builder textType(String textType)
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
Block.Builder textType(TextType textType)
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
Block.Builder rowIndex(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
.
rowIndex
- The row in which a table cell is located. The first row position is 1. RowIndex
isn't
returned by DetectDocumentText
and GetDocumentTextDetection
.Block.Builder columnIndex(Integer columnIndex)
The column in which a table cell appears. The first column position is 1. ColumnIndex
isn't
returned by DetectDocumentText
and GetDocumentTextDetection
.
columnIndex
- The column in which a table cell appears. The first column position is 1. ColumnIndex
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.Block.Builder rowSpan(Integer rowSpan)
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
.
rowSpan
- 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
.Block.Builder columnSpan(Integer columnSpan)
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
.
columnSpan
- 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
.Block.Builder geometry(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.
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.default Block.Builder geometry(Consumer<Geometry.Builder> 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.
This is a convenience that creates an instance of theGeometry.Builder
avoiding the need to create
one manually via Geometry.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to geometry(Geometry)
.geometry
- a consumer that will call methods on Geometry.Builder
geometry(Geometry)
Block.Builder id(String id)
The identifier for the recognized text. The identifier is only unique for a single operation.
id
- The identifier for the recognized text. The identifier is only unique for a single operation.Block.Builder relationships(Collection<Relationship> 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.
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.
Block.Builder relationships(Relationship... 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.
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.
Block.Builder relationships(Consumer<Relationship.Builder>... 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.
List.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #relationships(List)
.relationships
- a consumer that will call methods on List.Builder
#relationships(List)
Block.Builder entityTypesWithStrings(Collection<String> entityTypes)
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
.
entityTypes
- 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
.
Block.Builder entityTypesWithStrings(String... entityTypes)
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
.
entityTypes
- 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
.
Block.Builder entityTypes(Collection<EntityType> entityTypes)
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
.
entityTypes
- 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
.
Block.Builder entityTypes(EntityType... entityTypes)
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
.
entityTypes
- 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
.
Block.Builder selectionStatus(String selectionStatus)
The selection status of a selection element, such as an option button or check box.
selectionStatus
- The selection status of a selection element, such as an option button or check box.SelectionStatus
,
SelectionStatus
Block.Builder selectionStatus(SelectionStatus selectionStatus)
The selection status of a selection element, such as an option button or check box.
selectionStatus
- The selection status of a selection element, such as an option button or check box.SelectionStatus
,
SelectionStatus
Block.Builder page(Integer 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.
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.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.