startDocumentTextDetection method

Future<StartDocumentTextDetectionResponse> startDocumentTextDetection({ required DocumentLocation documentLocation, String? clientRequestToken, String? jobTag, String? kMSKeyId, NotificationChannel? notificationChannel, OutputConfig? outputConfig, })

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection.

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

Parameter documentLocation : The location of the document to be processed.

Parameter clientRequestToken : The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Parameter jobTag : An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Parameter kMSKeyId : The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Parameter notificationChannel : The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Parameter outputConfig : Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Implementation

Future<StartDocumentTextDetectionResponse> startDocumentTextDetection({
  required DocumentLocation documentLocation,
  String? clientRequestToken,
  String? jobTag,
  String? kMSKeyId,
  NotificationChannel? notificationChannel,
  OutputConfig? outputConfig,
}) async {
  ArgumentError.checkNotNull(documentLocation, 'documentLocation');
  _s.validateStringLength(
    'clientRequestToken',
    clientRequestToken,
    1,
    64,
  );
  _s.validateStringLength(
    'jobTag',
    jobTag,
    1,
    64,
  );
  _s.validateStringLength(
    'kMSKeyId',
    kMSKeyId,
    1,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Textract.StartDocumentTextDetection'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DocumentLocation': documentLocation,
      if (clientRequestToken != null)
        'ClientRequestToken': clientRequestToken,
      if (jobTag != null) 'JobTag': jobTag,
      if (kMSKeyId != null) 'KMSKeyId': kMSKeyId,
      if (notificationChannel != null)
        'NotificationChannel': notificationChannel,
      if (outputConfig != null) 'OutputConfig': outputConfig,
    },
  );

  return StartDocumentTextDetectionResponse.fromJson(jsonResponse.body);
}