Update examples

Author: Belval

README.md

@@ -1,6 +1,6 @@
 ![Textractor](https://raw.githubusercontent.com/aws-samples/amazon-textract-textractor/5716c52e8a39c063f43e058e1637e4984a4b2da4/docs/source/textractor_cropped.png)
 
-[![Tests](https://github.com/aws-samples/amazon-textract-textractor/actions/workflows/tests.yml/badge.svg)](https://github.com/aws-samples/amazon-textract-textractor/actions/workflows/tests.yml) [![Documentation](https://github.com/aws-samples/amazon-textract-textractor/actions/workflows/documentation.yml/badge.svg)](https://aws-samples.github.io/amazon-textract-textractor/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Tests](https://github.com/aws-samples/amazon-textract-textractor/actions/workflows/tests.yml/badge.svg)](https://github.com/aws-samples/amazon-textract-textractor/actions/workflows/tests.yml) [![Documentation](https://github.com/aws-samples/amazon-textract-textractor/actions/workflows/documentation.yml/badge.svg)](https://aws-samples.github.io/amazon-textract-textractor/) [![PyPI version](https://badge.fury.io/py/amazon-textract-textractor.svg)](https://pypi.org/project/amazon-textract-textractor/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 **Textractor** is a python package created to seamlessly work with [Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/what-is.html) a document intelligence service offering text recognition, table extraction, form processing, and much more. Whether you are making a one-off script or a complex distributed document processing pipeline, Textractor makes it easy to use Textract.
 
@@ -65,9 +65,9 @@ document.tables[0].to_excel("output.xlsx")
 ### Analyze ID
 
 ```py
-document = extractor.analyze_id(file_source="tests/fixtures/fake_id.jpg")
+document = extractor.analyze_id(file_source="tests/fixtures/fake_id.png")
 print(document.identity_documents[0].get("FIRST_NAME"))
-# 'FAKEID'
+# 'MARIA'
 ```
 
 ### Receipt processing (Analyze Expense)

docs/source/notebooks/exporting_form_data.ipynb

@@ -44,7 +44,7 @@
     "document = extractor.start_document_analysis(\n",
     "    # Here we pass a Pillow image instead of path. This changes nothing as\n",
     "    # Textractor supports most input types.\n",
-    "    file_source=Image.open(\"../../../tests/fixtures/invoice1.png\"),\n",
+    "    file_source=Image.open(\"../../../tests/fixtures/form.png\"),\n",
     "    # We specify the features that we want, here, we only want keys and values\n",
     "    # therefore we use TextractFeatures.FORMS.\n",
     "    features=[TextractFeatures.FORMS],\n",

docs/source/notebooks/going_further.ipynb

@@ -36,7 +36,7 @@
     "\n",
     "extractor = Textractor(profile_name=\"default\")\n",
     "# This path assumes that you are running the notebook from docs/source/notebooks\n",
-    "document = extractor.analyze_expense(file_source=\"../../../tests/fixtures/invoice1.png\")"
+    "document = extractor.analyze_expense(file_source=\"../../../tests/fixtures/form.png\")"
    ]
   },
   {

docs/source/notebooks/interfacing_with_trp2.ipynb

@@ -31,7 +31,7 @@
     "\n",
     "extractor = Textractor(profile_name=\"default\")\n",
     "# This path assumes that you are running the notebook from docs/source/notebooks\n",
-    "document = extractor.detect_document_text(\"../../../tests/fixtures/invoice1.png\")"
+    "document = extractor.detect_document_text(\"../../../tests/fixtures/form.png\")"
    ]
   },
   {

docs/source/notebooks/simple_ocr.ipynb

@@ -39,7 +39,7 @@
     "\n",
     "extractor = Textractor(profile_name=\"default\")\n",
     "# This path assumes that you are running the notebook from docs/source/notebooks\n",
-    "document = extractor.detect_document_text(\"../../../tests/fixtures/invoice1.png\")"
+    "document = extractor.detect_document_text(\"../../../tests/fixtures/form.png\")"
    ]
   },
   {
@@ -121,7 +121,7 @@
     "extractor = Textractor(profile_name=\"default\")\n",
     "# This path assumes that you are running the notebook from docs/source/notebooks\n",
     "document = extractor.start_document_text_detection(\n",
-    "    \"../../../tests/fixtures/invoice1.png\",\n",
+    "    \"../../../tests/fixtures/form.png\",\n",
     "    s3_upload_path=\"s3://textract-ocr/temp/\",\n",
     ")"
    ]

docs/source/notebooks/using_analyze_id.ipynb

@@ -1 +1 @@
-{"IdentityDocuments": [{"DocumentIndex": 1, "IdentityDocumentFields": [{"Type": {"Text": "FIRST_NAME"}, "ValueDetection": {"Text": "FAKEID", "Confidence": 94.69052124023438}}, {"Type": {"Text": "LAST_NAME"}, "ValueDetection": {"Text": "GREAT", "Confidence": 98.74333953857422}}, {"Type": {"Text": "MIDDLE_NAME"}, "ValueDetection": {"Text": "", "Confidence": 99.57127380371094}}, {"Type": {"Text": "SUFFIX"}, "ValueDetection": {"Text": "", "Confidence": 99.6200180053711}}, {"Type": {"Text": "CITY_IN_ADDRESS"}, "ValueDetection": {"Text": "PHOENIX", "Confidence": 99.16668701171875}}, {"Type": {"Text": "ZIP_CODE_IN_ADDRESS"}, "ValueDetection": {"Text": "85007", "Confidence": 98.64995574951172}}, {"Type": {"Text": "STATE_IN_ADDRESS"}, "ValueDetection": {"Text": "AZ", "Confidence": 98.56987762451172}}, {"Type": {"Text": "STATE_NAME"}, "ValueDetection": {"Text": "ARIZONA", "Confidence": 98.91461944580078}}, {"Type": {"Text": "DOCUMENT_NUMBER"}, "ValueDetection": {"Text": "D12345678", "Confidence": 98.87849426269531}}, {"Type": {"Text": "EXPIRATION_DATE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 90.80914306640625}}, {"Type": {"Text": "DATE_OF_BIRTH"}, "ValueDetection": {"Text": "02/01/1957", "NormalizedValue": {"Value": "1957-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.23692321777344}}, {"Type": {"Text": "DATE_OF_ISSUE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.06478118896484}}, {"Type": {"Text": "ID_TYPE"}, "ValueDetection": {"Text": "DRIVER LICENSE FRONT", "Confidence": 99.15076446533203}}, {"Type": {"Text": "ENDORSEMENTS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.27373504638672}}, {"Type": {"Text": "VETERAN"}, "ValueDetection": {"Text": "", "Confidence": 99.668212890625}}, {"Type": {"Text": "RESTRICTIONS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.08118438720703}}, {"Type": {"Text": "CLASS"}, "ValueDetection": {"Text": "D", "Confidence": 99.11907196044922}}, {"Type": {"Text": "ADDRESS"}, "ValueDetection": {"Text": "123 MAIN STREET", "Confidence": 98.97272491455078}}, {"Type": {"Text": "COUNTY"}, "ValueDetection": {"Text": "", "Confidence": 99.62360382080078}}, {"Type": {"Text": "PLACE_OF_BIRTH"}, "ValueDetection": {"Text": "", "Confidence": 99.63812255859375}}]}], "DocumentMetadata": {"Pages": 1}, "AnalyzeIDModelVersion": "1.0", "ResponseMetadata": {"RequestId": "21ea950f-4ecf-4aad-af7e-4e5adff2b767", "HTTPStatusCode": 200, "HTTPHeaders": {"x-amzn-requestid": "21ea950f-4ecf-4aad-af7e-4e5adff2b767", "content-type": "application/x-amz-json-1.1", "content-length": "2292", "date": "Tue, 27 Sep 2022 18:12:15 GMT"}, "RetryAttempts": 0}}
+{"IdentityDocuments": [{"DocumentIndex": 1, "IdentityDocumentFields": [{"Type": {"Text": "FIRST_NAME"}, "ValueDetection": {"Text": "MARIA", "Confidence": 94.69052124023438}}, {"Type": {"Text": "LAST_NAME"}, "ValueDetection": {"Text": "GARCIA", "Confidence": 98.74333953857422}}, {"Type": {"Text": "MIDDLE_NAME"}, "ValueDetection": {"Text": "", "Confidence": 99.57127380371094}}, {"Type": {"Text": "SUFFIX"}, "ValueDetection": {"Text": "", "Confidence": 99.6200180053711}}, {"Type": {"Text": "CITY_IN_ADDRESS"}, "ValueDetection": {"Text": "PHOENIX", "Confidence": 99.16668701171875}}, {"Type": {"Text": "ZIP_CODE_IN_ADDRESS"}, "ValueDetection": {"Text": "85007", "Confidence": 98.64995574951172}}, {"Type": {"Text": "STATE_IN_ADDRESS"}, "ValueDetection": {"Text": "AZ", "Confidence": 98.56987762451172}}, {"Type": {"Text": "STATE_NAME"}, "ValueDetection": {"Text": "ARIZONA", "Confidence": 98.91461944580078}}, {"Type": {"Text": "DOCUMENT_NUMBER"}, "ValueDetection": {"Text": "D12345678", "Confidence": 98.87849426269531}}, {"Type": {"Text": "EXPIRATION_DATE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 90.80914306640625}}, {"Type": {"Text": "DATE_OF_BIRTH"}, "ValueDetection": {"Text": "02/01/1957", "NormalizedValue": {"Value": "1957-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.23692321777344}}, {"Type": {"Text": "DATE_OF_ISSUE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.06478118896484}}, {"Type": {"Text": "ID_TYPE"}, "ValueDetection": {"Text": "DRIVER LICENSE FRONT", "Confidence": 99.15076446533203}}, {"Type": {"Text": "ENDORSEMENTS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.27373504638672}}, {"Type": {"Text": "VETERAN"}, "ValueDetection": {"Text": "", "Confidence": 99.668212890625}}, {"Type": {"Text": "RESTRICTIONS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.08118438720703}}, {"Type": {"Text": "CLASS"}, "ValueDetection": {"Text": "D", "Confidence": 99.11907196044922}}, {"Type": {"Text": "ADDRESS"}, "ValueDetection": {"Text": "123 MAIN STREET", "Confidence": 98.97272491455078}}, {"Type": {"Text": "COUNTY"}, "ValueDetection": {"Text": "", "Confidence": 99.62360382080078}}, {"Type": {"Text": "PLACE_OF_BIRTH"}, "ValueDetection": {"Text": "", "Confidence": 99.63812255859375}}]}], "DocumentMetadata": {"Pages": 1}, "AnalyzeIDModelVersion": "1.0", "ResponseMetadata": {"RequestId": "21ea950f-4ecf-4aad-af7e-4e5adff2b767", "HTTPStatusCode": 200, "HTTPHeaders": {"x-amzn-requestid": "21ea950f-4ecf-4aad-af7e-4e5adff2b767", "content-type": "application/x-amz-json-1.1", "content-length": "2292", "date": "Tue, 27 Sep 2022 18:12:15 GMT"}, "RetryAttempts": 0}}

docs/source/notebooks/visualizing_results.ipynb

@@ -1 +1 @@
-{"IdentityDocuments": [{"DocumentIndex": 1, "IdentityDocumentFields": [{"Type": {"Text": "FIRST_NAME"}, "ValueDetection": {"Text": "FAKEID", "Confidence": 94.69052124023438}}, {"Type": {"Text": "LAST_NAME"}, "ValueDetection": {"Text": "GREAT", "Confidence": 98.74333953857422}}, {"Type": {"Text": "MIDDLE_NAME"}, "ValueDetection": {"Text": "", "Confidence": 99.57127380371094}}, {"Type": {"Text": "SUFFIX"}, "ValueDetection": {"Text": "", "Confidence": 99.6200180053711}}, {"Type": {"Text": "CITY_IN_ADDRESS"}, "ValueDetection": {"Text": "PHOENIX", "Confidence": 99.16668701171875}}, {"Type": {"Text": "ZIP_CODE_IN_ADDRESS"}, "ValueDetection": {"Text": "85007", "Confidence": 98.64995574951172}}, {"Type": {"Text": "STATE_IN_ADDRESS"}, "ValueDetection": {"Text": "AZ", "Confidence": 98.56987762451172}}, {"Type": {"Text": "STATE_NAME"}, "ValueDetection": {"Text": "ARIZONA", "Confidence": 98.91461944580078}}, {"Type": {"Text": "DOCUMENT_NUMBER"}, "ValueDetection": {"Text": "D12345678", "Confidence": 98.87849426269531}}, {"Type": {"Text": "EXPIRATION_DATE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 90.80914306640625}}, {"Type": {"Text": "DATE_OF_BIRTH"}, "ValueDetection": {"Text": "02/01/1957", "NormalizedValue": {"Value": "1957-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.23692321777344}}, {"Type": {"Text": "DATE_OF_ISSUE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.06478118896484}}, {"Type": {"Text": "ID_TYPE"}, "ValueDetection": {"Text": "DRIVER LICENSE FRONT", "Confidence": 99.15076446533203}}, {"Type": {"Text": "ENDORSEMENTS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.27373504638672}}, {"Type": {"Text": "VETERAN"}, "ValueDetection": {"Text": "", "Confidence": 99.668212890625}}, {"Type": {"Text": "RESTRICTIONS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.08118438720703}}, {"Type": {"Text": "CLASS"}, "ValueDetection": {"Text": "D", "Confidence": 99.11907196044922}}, {"Type": {"Text": "ADDRESS"}, "ValueDetection": {"Text": "123 MAIN STREET", "Confidence": 98.97272491455078}}, {"Type": {"Text": "COUNTY"}, "ValueDetection": {"Text": "", "Confidence": 99.62360382080078}}, {"Type": {"Text": "PLACE_OF_BIRTH"}, "ValueDetection": {"Text": "", "Confidence": 99.63812255859375}}]}], "DocumentMetadata": {"Pages": 1}, "AnalyzeIDModelVersion": "1.0", "ResponseMetadata": {"RequestId": "568d4209-a4fe-4bee-9e29-37bfdacaa71f", "HTTPStatusCode": 200, "HTTPHeaders": {"x-amzn-requestid": "568d4209-a4fe-4bee-9e29-37bfdacaa71f", "content-type": "application/x-amz-json-1.1", "content-length": "2292", "date": "Tue, 27 Sep 2022 18:12:19 GMT"}, "RetryAttempts": 0}}
+{"IdentityDocuments": [{"DocumentIndex": 1, "IdentityDocumentFields": [{"Type": {"Text": "FIRST_NAME"}, "ValueDetection": {"Text": "MARIA", "Confidence": 94.69052124023438}}, {"Type": {"Text": "LAST_NAME"}, "ValueDetection": {"Text": "GARCIA", "Confidence": 98.74333953857422}}, {"Type": {"Text": "MIDDLE_NAME"}, "ValueDetection": {"Text": "", "Confidence": 99.57127380371094}}, {"Type": {"Text": "SUFFIX"}, "ValueDetection": {"Text": "", "Confidence": 99.6200180053711}}, {"Type": {"Text": "CITY_IN_ADDRESS"}, "ValueDetection": {"Text": "PHOENIX", "Confidence": 99.16668701171875}}, {"Type": {"Text": "ZIP_CODE_IN_ADDRESS"}, "ValueDetection": {"Text": "85007", "Confidence": 98.64995574951172}}, {"Type": {"Text": "STATE_IN_ADDRESS"}, "ValueDetection": {"Text": "AZ", "Confidence": 98.56987762451172}}, {"Type": {"Text": "STATE_NAME"}, "ValueDetection": {"Text": "ARIZONA", "Confidence": 98.91461944580078}}, {"Type": {"Text": "DOCUMENT_NUMBER"}, "ValueDetection": {"Text": "D12345678", "Confidence": 98.87849426269531}}, {"Type": {"Text": "EXPIRATION_DATE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 90.80914306640625}}, {"Type": {"Text": "DATE_OF_BIRTH"}, "ValueDetection": {"Text": "02/01/1957", "NormalizedValue": {"Value": "1957-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.23692321777344}}, {"Type": {"Text": "DATE_OF_ISSUE"}, "ValueDetection": {"Text": "02/01/2018", "NormalizedValue": {"Value": "2018-02-01T00:00:00", "ValueType": "Date"}, "Confidence": 98.06478118896484}}, {"Type": {"Text": "ID_TYPE"}, "ValueDetection": {"Text": "DRIVER LICENSE FRONT", "Confidence": 99.15076446533203}}, {"Type": {"Text": "ENDORSEMENTS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.27373504638672}}, {"Type": {"Text": "VETERAN"}, "ValueDetection": {"Text": "", "Confidence": 99.668212890625}}, {"Type": {"Text": "RESTRICTIONS"}, "ValueDetection": {"Text": "NONE", "Confidence": 99.08118438720703}}, {"Type": {"Text": "CLASS"}, "ValueDetection": {"Text": "D", "Confidence": 99.11907196044922}}, {"Type": {"Text": "ADDRESS"}, "ValueDetection": {"Text": "123 MAIN STREET", "Confidence": 98.97272491455078}}, {"Type": {"Text": "COUNTY"}, "ValueDetection": {"Text": "", "Confidence": 99.62360382080078}}, {"Type": {"Text": "PLACE_OF_BIRTH"}, "ValueDetection": {"Text": "", "Confidence": 99.63812255859375}}]}], "DocumentMetadata": {"Pages": 1}, "AnalyzeIDModelVersion": "1.0", "ResponseMetadata": {"RequestId": "568d4209-a4fe-4bee-9e29-37bfdacaa71f", "HTTPStatusCode": 200, "HTTPHeaders": {"x-amzn-requestid": "568d4209-a4fe-4bee-9e29-37bfdacaa71f", "content-type": "application/x-amz-json-1.1", "content-length": "2292", "date": "Tue, 27 Sep 2022 18:12:19 GMT"}, "RetryAttempts": 0}}

tests/fixtures/fake_id.jpg

@@ -14,8 +14,8 @@ def setUp(self):
         # insert credentials and filepaths here to run test
         self.profile_name = "default"
         self.current_directory = os.path.abspath(os.path.dirname(__file__))
-        self.image_path = os.path.join(self.current_directory, "fixtures/fake_id.jpg")
-        self.image = PIL.Image.open(os.path.join(self.current_directory, "fixtures/fake_id.jpg"))
+        self.image_path = os.path.join(self.current_directory, "fixtures/fake_id.png")
+        self.image = PIL.Image.open(os.path.join(self.current_directory, "fixtures/fake_id.png"))
 
         if self.profile_name is None:
             raise InvalidProfileNameError(
@@ -39,8 +39,8 @@ def test_analyze_id_from_path(self):
         self.assertIsInstance(document, Document)
         self.assertEqual(len(document.identity_documents), 1)
         self.assertEqual(len(document.identity_documents[0].fields), 20)
-        self.assertEqual(document.identity_documents[0].get(AnalyzeIDFields.FIRST_NAME), "FAKEID")
-        self.assertEqual(document.identity_documents[0][AnalyzeIDFields.FIRST_NAME], "FAKEID")
+        self.assertEqual(document.identity_documents[0].get(AnalyzeIDFields.FIRST_NAME), "MARIA")
+        self.assertEqual(document.identity_documents[0][AnalyzeIDFields.FIRST_NAME], "MARIA")
 
     def test_analyze_id_from_image(self):
         # Testing local single image input
@@ -55,8 +55,8 @@ def test_analyze_id_from_image(self):
         self.assertIsInstance(document, Document)
         self.assertEqual(len(document.identity_documents), 1)
         self.assertEqual(len(document.identity_documents[0].fields), 20)
-        self.assertEqual(document.identity_documents[0].get("FIRST_NAME"), "FAKEID")
-        self.assertEqual(document.identity_documents[0]["FIRST_NAME"], "FAKEID")
+        self.assertEqual(document.identity_documents[0].get("FIRST_NAME"), "MARIA")
+        self.assertEqual(document.identity_documents[0]["FIRST_NAME"], "MARIA")
 
 if __name__ == "__main__":
     test = TestTextractorAnalyzeID()