amazon-textract-textractor

What's Changed

• Fix s3 client instantiation in _get_document_images_from_path by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/423

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.9.0...v1.9.1

What's Changed

• Add function to split larger element at table insertion by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/417
• Replace logging calls with module logger by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/419
• Fix short ids using long ids and vice-versa by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/418
• Add separator parameter to kv_to_csv by @DGarbs51 in https://github.com/aws-samples/amazon-textract-textractor/pull/407
• export_kv_to_pandas by @Chuukwudi in https://github.com/aws-samples/amazon-textract-textractor/pull/405

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.8.5...v1.9.0

What's Changed

• Fix bug in convert that caused an exception on empty pages.

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.8.4...v1.8.5

What's Changed

• Add check for None bounding boxes for AnalyzeExpense by @Belval
• Allow Custom Separator in Document.export_kv_to_csv() by @Chuukwudi
• Update analyze_document type hint by @ryangamble
• Fix invalid escape in BoundingBox docstring by @simonschmidt in https://github.com/aws-samples/amazon-textract-textractor/pull/395

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.8.3...v1.8.4

What's Changed

• Id in html output by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/386
• Escape html output by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/387
• Fix table indexing returning too many cells

:warning: Breaking changes

• To support ids in HTML, layout Table created for TABLE predictions will no longer share the same ID as the table.

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.8.2...v1.8.3

What's Changed

• Fix pypdfium2 failing to parse PDFs in bytearray format by @Belval

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.8.1...v1.8.2

What's Changed

• Fix .to_markdown() raising an exception on missing local config by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/381

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.8.0...v1.8.1

What's Changed

• Improve HTML linearization
  • Add HTML table linearization format that uses merged cells information for colspan and rowspan
  • Add prefix and suffix for LAYOUT_FOOTER and LAYOUT_ENTITY
  • Add <html><body>...</body></html> to the output when calling Document.to_html()
• Use pypdfium2 for PDF rasterization when available instead of pdf2image. This allows for better portability as the former does not have a dependency on OS libraries and should work out of the box with Lambda and SageMaker.
• Fix expenses with no summary fields
• Replace region mismatch with invalid S3 object exception

Backward-incompatible changes

• This update removes s3_output_path from the synchronous functions as s3_output_path is not a supported parameter for the Textract Synchronous API
• This update changes the exception raised by the textractor.py functions which will no longer raise RegionMismatchError (which is however kept in textractor.exceptions for backward compatibility.
• This update removes confidence_score from KeyValue entities in favour of _confidence which is used for all other entities.

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.12...v1.8.0

What's Changed

• Fix issue where tables linearized to plaintext that contained merge cells would duplicate the text over the entire table.

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.11...v1.7.12

What's Changed

• Add figure layout prefix and suffix by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/362
• Add confidence scores at the DocumentEntity level by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/363

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.10...v1.7.11

What's Changed

• Use AWS_REGION and AWS_DEFAULT_REGION environment variables in Textractor when available
• Fix missing figure layouts

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.9...v1.7.10

What's Changed

• Set JPEG compression parameters by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/342

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.8...v1.7.9

What's Changed

• Handle None Relationships when parsing LAYOUT_FIGURE

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.7...v1.7.8

What's Changed

• Handle None bounding box when parsing Queries by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/340

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.6...v1.7.7

What's Changed

• Add CITATION.cff by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/332
• Add missing entities in docs by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/334
• Handle null EntityTypes by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/339

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.5...v1.7.6

What's Changed

• Make KeyValue.key an EntityList by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/320
• Remove numpy from explicit dependencies by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/324
• Hide key value layouts by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/325
• Return query and query answer with get_text() by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/329
• Convert image to RGB in EntityList for Jupyter compatibility by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/330
• Support for Python 3.12 by @tb102122 in https://github.com/aws-samples/amazon-textract-textractor/pull/311

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.4...v1.7.5

What's Changed

• Fix table title .get_text() by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/314
• Fix .to_pandas() raising an exception by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/315

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.3...v1.7.4

What's Changed

• Table linearization improvements by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/313

  • Add .get_text(), .to_html() and .to_markdown() functions to Linearizable which is now implemented by Document, Page, DocumentEntity and EntityList
  • Add HTMLLinearizationConfig and MarkdownLinearizationConfig as pre-configured TextLinearizationConfig
  • Add the follow parameters to TextLinearizationConfig
    • duplicate_text_in_merged_cells duplicates the text in merge cells to preserve row-level alignment
    • table_flatten_headers combines multi-row headers into a single row, duplicating the merged cells horizontally as needed
    • table_tabulate_remove_extra_hyphens removes extra hyphens '-' in markdown tables to reduce context length
    • max_number_of_consecutive_spaces defines the maximum number of contiguous whitespace characters, similar to max_number_of_consecutive_new_lines

• Fixes:

  • Fix trailing whitespace in cell text
  • Fix table_column_separator being hardcoded as '\t'
  • Fix table_row_separator being hardcoded as '\n'
  • Resets BytesIO buffer to 0 position by @abest0 in https://github.com/aws-samples/amazon-textract-textractor/pull/310

New Contributors

• @abest0 made their first contribution in https://github.com/aws-samples/amazon-textract-textractor/pull/310

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.2...v1.7.3

What's Changed

• Fix for page objects not always having an image attached, causing an exception on .visualize()

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.1...v1.7.2

What's Changed

• Fix issue where a table within a container layout could be duplicated in the .get_text() output.

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.7.0...v1.7.1

What's Changed

• Loosen XlsxWriter version constraints by @mdscruggs in https://github.com/aws-samples/amazon-textract-textractor/pull/292
• Rework the linearization heuristic to ensure that no words are missing or duplicated
• Fix KeyValues being assigned twice on overlapping table cells, going forward KVs inside a tables are ignored (table structure takes precedence)
• Hardens parser code against missing children in layouts or KeyValues with missing keys
• Fix markdown tables not having header rows when one of the cell is empty
• Add support for Python 3.11 and 3.12 in the GitHub action workflows
• Add textractor.__version__ to allow easier identification of the installed Textractor version in code
• Added hide_table_layout
• Remove amazon-textract-response-parser as a dependency as its use for validating the input schema could add +200 ms of latency in some cases. Textractor-only parsing takes <30ms.

Breaking changes

• Remove linearize_table and linearize_key_value from TextLinearizationConfig as both were not used
• Remove the s3_output_path parameter from analyze_expense as the API does not support outputting to S3

New Contributors

• @mdscruggs made their first contribution in https://github.com/aws-samples/amazon-textract-textractor/pull/292

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.6.1...v1.7.0

What's new

• Fix bug in table to markdown

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.6.0...v1.6.1

What's Changed

• Fix selection elements in table by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/289

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.5.0...v1.6.0

What's Changed

• Add GetResult from S3 in LazyDocument
• Add more linearization formatting options
• Fix exception thrown when a CHILD relationships maps to a non-existent LINE

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.4.5...v1.5.0

What's Changed

• Fix missing words in get_text_and_words by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/270

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.4.4...v1.4.5

What's Changed

• Add page_layout property to Page object by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/268

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.4.3...v1.4.4

What's Changed

• Raise exception on export-to-markdown without pandas by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/261
• Add page number prefix and suffix to linearization config by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/266
• Fix table post-processing by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/267

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v.1.4.2...v1.4.3

What's Changed

• Fix: #257, adjust versions for caller by @schadem in https://github.com/aws-samples/amazon-textract-textractor/pull/258

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.4.1...v.1.4.2

What's Changed

• Fix signature token not being added to the linearized text
• Fix but where empty pages raise an exception when linearized

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.4.0...v1.4.1

What's Changed

Version 1.4.0 introduces text linearization, powered by the new Amazon Textract Layout feature. Layout prediction enables the conversion of documents to text while preserving their reading order. See our layout prediction notebook for an example.

• Add layout support by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/252

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.7...v1.4.0

What's Changed

• Fix STRUCTURED and SEMI_STRUCTURED table types not being properly parsed

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.6...v1.3.7

What's Changed

• Fix Levenshtein distance not returning the most similar key by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/245

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.5...v1.3.6

What's Changed

• Add support for Python 3.11

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.4...v1.3.5

What's Changed

• Pass region_name as argument to Textract client when provided by @alanmohan in https://github.com/aws-samples/amazon-textract-textractor/pull/229
• Fix for PDF-filename suffix is hardcoded as .pdf by @Paike in https://github.com/aws-samples/amazon-textract-textractor/pull/225
• Fix ExpenseField value.bbox is None causing Error by @syanng in https://github.com/aws-samples/amazon-textract-textractor/pull/241

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v.1.3.3...v1.3.4

What's Changed

• Fix bbox denormalization breaking visualizations by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/242

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.2...v.1.3.3

What's Changed

• Fix assertion error on empty line item rows by @vinyasmusic in https://github.com/aws-samples/amazon-textract-textractor/pull/224
• Add type check before S3 prefix check by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/227

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.1...v1.3.2

What's Changed

• fix: ordering of paginated files on S3 OutputConfig by @schadem in https://github.com/aws-samples/amazon-textract-textractor/pull/208
• Fix empty bounding box in QUERY_RESULT block raising exception by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/211
• Fix missing bounding box for empty values by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/212
• Add Python 3.10 by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/213

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.3.0...v1.3.1

What's Changed

• Significant improvement to response validation time by @krzim in https://github.com/aws-samples/amazon-textract-textractor/pull/203
• Drop support for Python 3.7 as the End-of-Life is in June 2023 and amazon-textract-response-parser has already dropped support

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.2.0...v1.3.0

What's Changed

• Add support for titles, footers and cell types by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/197
• Set save_image=False in CLI by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/189
• Remove line implying that async APIs take List[PIL.Image] as file_source by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/190
• chore: add tests for Signature by @schadem in https://github.com/aws-samples/amazon-textract-textractor/pull/159
• feat: adding pretty-print for signatures by @schadem in https://github.com/aws-samples/amazon-textract-textractor/pull/194

What's Changed

• Update examples.rst by @ThomasDelteil in https://github.com/aws-samples/amazon-textract-textractor/pull/183
• fixing queries call in async mode by @ThomasDelteil in https://github.com/aws-samples/amazon-textract-textractor/pull/185

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.1.0...v1.1.1

What's Changed

• Add new lambda layer with pandas by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/177
• upgrade requirement versions by @tb102122 in https://github.com/aws-samples/amazon-textract-textractor/pull/164
• Improving analyze expense support by @ThomasDelteil in https://github.com/aws-samples/amazon-textract-textractor/pull/181

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.24...v1.1.0

What's Changed

• Add lambda and signature detection example by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/157
• Ignore elements with SIGNATURE BlockType when building Value Objects by @rudolfsberzins in https://github.com/aws-samples/amazon-textract-textractor/pull/147

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.23...v1.0.24

What's Changed

• Fix XlsxWriter raising an exception on overlapping merged cells by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/153

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.22...v1.0.23

What's Changed

• Use editdistance instead of pyxDamerauLevenshtein by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/144

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.21...v1.0.22

What's Changed

• Add support for Signatures in the CLI

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.20...v1.0.21

What's Changed

• Fix word ordering by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/137
• Add support for Signatures by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/138

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.18...v1.0.20

What's Changed

• Fix start_analyze_expense raising exception by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/124
• Parse words and lines in AnalyzeID by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/125
• Fix AnalyzeExpense visualization by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/126

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.17...v1.0.18

What's Changed

• Fix wrong parameter name in Session instantiation by @kkourmousis in https://github.com/aws-samples/amazon-textract-textractor/pull/115
• Fix selection element breaking forms API by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/118
• Add queries to visualizer output by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/116

Full Changelog: https://github.com/aws-samples/amazon-textract-textractor/compare/v1.0.16...v1.0.17

What's Changed

• Textractor refactoring by @Belval in https://github.com/aws-samples/amazon-textract-textractor/pull/108
• Bump numpy from 1.21.6 to 1.22.0 by @dependabot in https://github.com/aws-samples/amazon-textract-textractor/pull/109
• Fix bug for assignment of words to value fields by @ThomasDelteil in https://github.com/aws-samples/amazon-textract-textractor/pull/110
• Fix bug in visualization by @ThomasDelteil in https://github.com/aws-samples/amazon-textract-textractor/pull/111