<!--Generated by WRITEME on 2023-10-13 17:49:17.701161 (UTC)-->
# Amazon Textract code examples for the SDK for Python

## Overview

Shows how to use the AWS SDK for Python (Boto3) to work with Amazon Textract.

<!--custom.overview.start-->
<!--custom.overview.end-->

*Amazon Textract enables you to add document text detection and analysis to your applications.*

## ⚠ Important

* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* Running the tests might result in charges to your AWS account.
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).

<!--custom.important.start-->
<!--custom.important.end-->

## Code examples

### Prerequisites

For prerequisites, see the [README](../../README.md#Prerequisites) in the `python` folder.

Install the packages required by these examples by running the following in a virtual environment:

```
python -m pip install -r requirements.txt
```

<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Single actions

Code excerpts that show you how to call individual service functions.

* [Analyze a document](textract_wrapper.py#L58) (`AnalyzeDocument`)
* [Detect text in a document](textract_wrapper.py#L32) (`DetectDocumentText`)
* [Get data about a document analysis job](textract_wrapper.py#L230) (`GetDocumentAnalysis`)
* [Start asynchronous analysis of a document](textract_wrapper.py#L193) (`StartDocumentAnalysis`)
* [Start asynchronous text detection](textract_wrapper.py#L138) (`StartDocumentTextDetection`)

### Cross-service examples

Sample applications that work across multiple AWS services.

* [Create an Amazon Textract explorer application](../../cross_service/textract_explorer)
* [Detect entities in text extracted from an image](../../cross_service/textract_comprehend_notebook)

## Run the examples

### Instructions


<!--custom.instructions.start-->
<!--custom.instructions.end-->


### Tests

⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `python` folder.


<!--custom.tests.start-->
<!--custom.tests.end-->

## Additional resources

* [Amazon Textract Developer Guide](https://docs.aws.amazon.com/textract/latest/dg/what-is.html)
* [Amazon Textract API Reference](https://docs.aws.amazon.com/textract/latest/dg/API_Reference.html)
* [SDK for Python Amazon Textract reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/textract.html)

<!--custom.resources.start-->
<!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0