detectDocumentText method

Future<DetectDocumentTextResponse> detectDocumentText({
  1. required Document document,
})

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 an image in JPEG or PNG format. 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.

May throw InvalidParameterException. May throw InvalidS3ObjectException. May throw UnsupportedDocumentException. May throw DocumentTooLargeException. May throw BadDocumentException. May throw AccessDeniedException. May throw ProvisionedThroughputExceededException. May throw InternalServerError. May throw ThrottlingException.

Parameter 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 or PNG 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.

Implementation

Future<DetectDocumentTextResponse> detectDocumentText({
  required Document document,
}) async {
  ArgumentError.checkNotNull(document, 'document');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Textract.DetectDocumentText'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Document': document,
    },
  );

  return DetectDocumentTextResponse.fromJson(jsonResponse.body);
}