[−][src]Struct rusoto_textract::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.
Fields
block_type: Option<String>
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. -
KEYVALUESET - Stores the KEY and VALUE
Block
objects for linked text that's detected on a document page. Use theEntityType
field to determine if a KEYVALUESET object is a KEYBlock
object or a VALUEBlock
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.
column_index: Option<i64>
The column in which a table cell appears. The first column position is 1. ColumnIndex
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.
column_span: Option<i64>
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: Option<f32>
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.
entity_types: Option<Vec<String>>
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: Option<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: Option<String>
The identifier for the recognized text. The identifier is only unique for a single operation.
page: Option<i64>
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: Option<Vec<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.
row_index: Option<i64>
The row in which a table cell is located. The first row position is 1. RowIndex
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.
row_span: Option<i64>
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
.
selection_status: Option<String>
The selection status of a selection element, such as an option button or check box.
text: Option<String>
The word or line of text that's recognized by Amazon Textract.
Trait Implementations
impl Clone for Block
[src]
impl Debug for Block
[src]
impl Default for Block
[src]
impl<'de> Deserialize<'de> for Block
[src]
pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<Block> for Block
[src]
impl StructuralPartialEq for Block
[src]
Auto Trait Implementations
impl RefUnwindSafe for Block
[src]
impl Send for Block
[src]
impl Sync for Block
[src]
impl Unpin for Block
[src]
impl UnwindSafe for Block
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,