AWS SDK Version 3 for .NET
API Reference

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.

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

For more information, see Document Text Detection.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDetectDocumentText and EndDetectDocumentText.

Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<DetectDocumentTextResponse> DetectDocumentTextAsync(
         DetectDocumentTextRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Textract.Model.DetectDocumentTextRequest

Container for the necessary parameters to execute the DetectDocumentText service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DetectDocumentText service method, as returned by Textract.

Exceptions

ExceptionCondition
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.
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.

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

See Also