2023-03-31 05:36:53 -07:00
# Amazon Textract code examples for the SDK for Python
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
## Overview
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
Shows how to use the AWS SDK for Python (Boto3) to work with Amazon Textract.
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.overview.start-->
<!--custom.overview.end-->
2024-01-05 10:05:03 -05:00
_ Amazon Textract enables you to add document text detection and analysis to your applications. _
2023-03-31 05:36:53 -07:00
## ⚠ Important
2024-01-05 10:05:03 -05:00
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing ](https://aws.amazon.com/pricing/ ) and [Free Tier ](https://aws.amazon.com/free/ ).
2023-03-31 05:36:53 -07:00
* 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-->
2021-02-22 16:22:36 -08:00
2021-11-08 11:38:29 -08:00
## Code examples
2023-04-13 11:38:14 -07:00
### 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-->
2023-03-31 05:36:53 -07:00
### Single actions
2021-11-08 11:38:29 -08:00
2023-03-31 05:36:53 -07:00
Code excerpts that show you how to call individual service functions.
2021-02-22 16:22:36 -08:00
2024-04-30 12:22:08 -07:00
- [AnalyzeDocument ](textract_wrapper.py#L61 )
- [DetectDocumentText ](textract_wrapper.py#L34 )
- [GetDocumentAnalysis ](textract_wrapper.py#L255 )
- [StartDocumentAnalysis ](textract_wrapper.py#L207 )
- [StartDocumentTextDetection ](textract_wrapper.py#L145 )
2021-11-08 11:38:29 -08:00
2024-08-21 13:27:36 -07:00
### Scenarios
2023-03-31 05:36:53 -07:00
2024-08-21 13:27:36 -07:00
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.
2021-02-22 16:22:36 -08:00
2024-08-27 14:32:38 -04:00
- [Create an Amazon Textract explorer application ](../../cross_service/textract_explorer )
- [Detect entities in text extracted from an image ](../../cross_service/textract_comprehend_notebook )
2024-01-05 10:05:03 -05:00
<!--custom.examples.start-->
<!--custom.examples.end-->
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
## Run the examples
2021-02-22 16:22:36 -08:00
2023-04-13 11:38:14 -07:00
### Instructions
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.instructions.start-->
<!--custom.instructions.end-->
2021-02-22 16:22:36 -08:00
2023-04-13 11:38:14 -07:00
2024-08-21 13:27:36 -07:00
#### Create an Amazon Textract explorer application
This example shows you how to explore Amazon Textract output through an interactive application.
<!--custom.scenario_prereqs.cross_TextractExplorer.start-->
<!--custom.scenario_prereqs.cross_TextractExplorer.end-->
<!--custom.scenarios.cross_TextractExplorer.start-->
<!--custom.scenarios.cross_TextractExplorer.end-->
#### Detect entities in text extracted from an image
This example shows you how to use Amazon Comprehend to detect entities in text extracted by Amazon Textract from an image that is stored in Amazon S3.
<!--custom.scenario_prereqs.cross_TextractComprehendDetectEntities.start-->
<!--custom.scenario_prereqs.cross_TextractComprehendDetectEntities.end-->
<!--custom.scenarios.cross_TextractComprehendDetectEntities.start-->
<!--custom.scenarios.cross_TextractComprehendDetectEntities.end-->
2023-03-31 05:36:53 -07:00
### Tests
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
⚠ 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.
2021-02-22 16:22:36 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.tests.start-->
<!--custom.tests.end-->
## Additional resources
2024-01-05 10:05:03 -05:00
- [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 )
2023-03-31 05:36:53 -07:00
<!--custom.resources.start-->
<!--custom.resources.end-->
2021-02-22 16:22:36 -08:00
---
2023-03-31 05:36:53 -07:00
2021-02-22 16:22:36 -08:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2023-03-31 05:36:53 -07:00
SPDX-License-Identifier: Apache-2.0