Struct aws_sdk_textract :: types :: builders :: BlockBuilder Copy item path

impl BlockBuilder

pub fn block_type(self, input: BlockType) -> Self

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.

pub fn set_block_type(self, input: Option<BlockType>) -> Self

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.

pub fn get_block_type(&self) -> &Option<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.

pub fn confidence(self, input: f32) -> Self

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.

pub fn set_confidence(self, input: Option<f32>) -> Self

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.

pub fn get_confidence(&self) -> &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.

pub fn text(self, input: impl Into<String>) -> Self

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

pub fn set_text(self, input: Option<String>) -> Self

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

pub fn get_text(&self) -> &Option<String>

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

pub fn text_type(self, input: TextType) -> Self

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

pub fn set_text_type(self, input: Option<TextType>) -> Self

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

pub fn get_text_type(&self) -> &Option<TextType>

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

pub fn row_index(self, input: i32) -> Self

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

pub fn set_row_index(self, input: Option<i32>) -> Self

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

pub fn get_row_index(&self) -> &Option<i32>

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

pub fn column_index(self, input: i32) -> Self

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

pub fn set_column_index(self, input: Option<i32>) -> Self

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

pub fn get_column_index(&self) -> &Option<i32>

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

pub fn row_span(self, input: i32) -> Self

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

pub fn set_row_span(self, input: Option<i32>) -> Self

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

pub fn get_row_span(&self) -> &Option<i32>

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

pub fn column_span(self, input: i32) -> Self

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

pub fn set_column_span(self, input: Option<i32>) -> Self

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

pub fn get_column_span(&self) -> &Option<i32>

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

pub fn geometry(self, input: Geometry) -> Self

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.

pub fn set_geometry(self, input: Option<Geometry>) -> Self

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.

pub fn get_geometry(&self) -> &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.

pub fn id(self, input: impl Into<String>) -> Self

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

pub fn set_id(self, input: Option<String>) -> Self

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

pub fn get_id(&self) -> &Option<String>

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

pub fn relationships(self, input: Relationship) -> Self

Appends an item to relationships.

To override the contents of this collection use set_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.

pub fn set_relationships(self, input: Option<Vec<Relationship>>) -> Self

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.

pub fn get_relationships(&self) -> &Option<Vec<Relationship>>

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.

pub fn entity_types(self, input: EntityType) -> Self

Appends an item to entity_types.

To override the contents of this collection use set_entity_types.

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.

pub fn set_entity_types(self, input: Option<Vec<EntityType>>) -> Self

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.

pub fn get_entity_types(&self) -> &Option<Vec<EntityType>>

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.

pub fn selection_status(self, input: SelectionStatus) -> Self

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

pub fn set_selection_status(self, input: Option<SelectionStatus>) -> Self

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

pub fn get_selection_status(&self) -> &Option<SelectionStatus>

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

pub fn page(self, input: i32) -> Self

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.

pub fn set_page(self, input: Option<i32>) -> Self

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.

pub fn get_page(&self) -> &Option<i32>

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.

pub fn build(self) -> Block

Consumes the builder and constructs a Block.

Trait Implementations§

impl Clone for BlockBuilder

fn clone(&self) -> BlockBuilder

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for BlockBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for BlockBuilder

fn default() -> BlockBuilder

Returns the “default value” for a type. Read more

impl PartialEq for BlockBuilder

fn eq(&self, other: &BlockBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BlockBuilder

Auto Trait Implementations§

impl Freeze for BlockBuilder

impl RefUnwindSafe for BlockBuilder

impl Send for BlockBuilder

impl Sync for BlockBuilder

impl Unpin for BlockBuilder

impl UnwindSafe for BlockBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more