Container for the parameters to the AnalyzeDocument operation. 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 KEYBlockobject and a VALUEBlockobject. 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
Blockobject contains information about a detected table. A CELLBlockobject is returned for each cell in a table. -
Lines and words of text. A LINE
Blockobject contains one or more WORDBlockobjects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value ofFeatureTypes). -
Signatures. A SIGNATURE
Blockobject 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Textract.AmazonTextractRequest
Amazon.Textract.Model.AnalyzeDocumentRequest
Namespace: Amazon.Textract.Model
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
Syntax
public class AnalyzeDocumentRequest : AmazonTextractRequest IAmazonWebServiceRequest
The AnalyzeDocumentRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AnalyzeDocumentRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AdaptersConfig | Amazon.Textract.Model.AdaptersConfig |
Gets and sets the property AdaptersConfig. Specifies the adapter to be used when analyzing a document. |
|
|
Document | Amazon.Textract.Model.Document |
Gets and sets the property 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 |
|
|
FeatureTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property FeatureTypes.
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 |
|
|
HumanLoopConfig | Amazon.Textract.Model.HumanLoopConfig |
Gets and sets the property HumanLoopConfig. Sets the configuration for the human in the loop workflow for analyzing documents. |
|
|
QueriesConfig | Amazon.Textract.Model.QueriesConfig |
Gets and sets the property QueriesConfig. Contains Queries and the alias for those Queries, as determined by the input. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5