AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to AnalyzeDocumentAsync.
Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
public virtual AnalyzeDocumentResponse AnalyzeDocument( AnalyzeDocumentRequest request )
Container for the necessary parameters to execute the AnalyzeDocument service method.
Exception | Condition |
---|---|
AccessDeniedException | You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. |
BadDocumentException | Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits. |
DocumentTooLargeException | The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. |
HumanLoopQuotaExceededException | Indicates you have exceeded the maximum number of active human in the loop workflows available |
InternalServerErrorException | Amazon Textract experienced a service issue. Try your call again. |
InvalidParameterException | An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again. |
InvalidS3ObjectException | Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3 |
ProvisionedThroughputExceededException | The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. |
ThrottlingException | Amazon Textract is temporarily unable to process the request. Try your call again. |
UnsupportedDocumentException | The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. |
.NET Framework:
Supported in: 4.5 and newer, 3.5