Struct aws_sdk_textract::operation::analyze_document::builders::AnalyzeDocumentFluentBuilder

pub struct AnalyzeDocumentFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AnalyzeDocument.

Analyzes an input document for relationships between detected items.

The types of information returned are as follows:

• Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).

• Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of Block objects.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

For more information, see Document Text Analysis.

Implementations

impl AnalyzeDocumentFluentBuilder

pub fn as_input(&self) -> &AnalyzeDocumentInputBuilder

Access the AnalyzeDocument as a reference.

pub async fn send( self ) -> Result<AnalyzeDocumentOutput, SdkError<AnalyzeDocumentError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<AnalyzeDocumentOutput, AnalyzeDocumentError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn document(self, input: Document) -> Self

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

pub fn set_document(self, input: Option<Document>) -> Self

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

pub fn get_document(&self) -> &Option<Document>

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

pub fn feature_types(self, input: FeatureType) -> Self

Appends an item to FeatureTypes.

To override the contents of this collection use set_feature_types.

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

pub fn set_feature_types(self, input: Option<Vec<FeatureType>>) -> Self

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

pub fn get_feature_types(&self) -> &Option<Vec<FeatureType>>

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

pub fn human_loop_config(self, input: HumanLoopConfig) -> Self

Sets the configuration for the human in the loop workflow for analyzing documents.

pub fn set_human_loop_config(self, input: Option<HumanLoopConfig>) -> Self

Sets the configuration for the human in the loop workflow for analyzing documents.

pub fn get_human_loop_config(&self) -> &Option<HumanLoopConfig>

Sets the configuration for the human in the loop workflow for analyzing documents.

pub fn queries_config(self, input: QueriesConfig) -> Self

Contains Queries and the alias for those Queries, as determined by the input.

pub fn set_queries_config(self, input: Option<QueriesConfig>) -> Self

Contains Queries and the alias for those Queries, as determined by the input.

pub fn get_queries_config(&self) -> &Option<QueriesConfig>

Contains Queries and the alias for those Queries, as determined by the input.

pub fn adapters_config(self, input: AdaptersConfig) -> Self

Specifies the adapter to be used when analyzing a document.

pub fn set_adapters_config(self, input: Option<AdaptersConfig>) -> Self

Specifies the adapter to be used when analyzing a document.

pub fn get_adapters_config(&self) -> &Option<AdaptersConfig>

Specifies the adapter to be used when analyzing a document.

Trait Implementations

impl Clone for AnalyzeDocumentFluentBuilder

fn clone(&self) -> AnalyzeDocumentFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnalyzeDocumentFluentBuilder

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

Formats the value using the given formatter.