Skip to content

Latest commit

Β 

History

History
606 lines (436 loc) Β· 16.2 KB

CHANGELOG.md

File metadata and controls

606 lines (436 loc) Β· 16.2 KB

Mindee Python API Library Changelog

v4.18.0 - 2025-02-21

Changes

  • ✨ add support for image and pdf compression
  • ♻️ increase async retry timers

v4.17.0 - 2024-12-13

Changes

  • ✨ add support for us mail v3
  • 🎨 linting fixes

v4.16.0 - 2024-12-13

Changes

  • ✨ allow local downloading of remote sources
  • ⚰️ remove support for (FR) Carte Vitale V1 in favor of French Health Card V1

v4.15.1 - 2024-11-28

Changes

  • ⬆️ update pylint

v4.15.0 - 2024-11-28

Changes

  • ✨ add support for workflows
  • ✨ add support for French Health Card V1
  • ✨ add support for Driver License V1
  • ✨ add support for Payslip FR V3

v4.14.2 - 2024-11-26

Fixes

  • πŸ› fix circular imports error on install

v4.14.1 - 2024-11-22

Changes

  • ⚰️ remove support for international ID V1
  • ♻️ update import syntax
  • ⬆️ loosen dependency pinning on requests

Fixes

  • πŸ› fix potential circular import issues

v4.14.0 - 2024-11-14

Changes

  • ✨ add support for business cards V1
  • ✨ add support for delivery note V1.1
  • ✨ add support for indian passport V1
  • ✨ add support for resume V1.1

Fixes

  • ♻️ adjust default values for async delays
  • ⬆️ fully migrate project to pyproject.toml

v4.13.0 - 2024-10-11

Changes

  • ✨ add support for Financial Document v1.10
  • ✨ add support for Invoice v4.8

v4.12.0 - 2024-09-18

Changes

  • ✨ add support for BillOfLadingV1
  • ✨ add support for (US) UsMailV2
  • ✨ add support for (FR) EnergyBillV1
  • ✨ add support for (FR) PayslipV1
  • ✨ add support for NutritionFactsLabelV1

Fixes

  • πŸ› fixed a bug that prevented longer decimals from appearing in the string representation of some objects
  • πŸ› fixed a bug that caused non-table elements to unexpectedly appear truncated when printed to the console
  • πŸ› fix full text ocr extra not properly parsing
  • πŸ“ fix a few documentation errors & typos
  • πŸ”§ updated CI dependencies

v4.11.0 - 2024-09-04

Changes

  • ✨ add support for full text OCR extra
  • ✨ add support for invoice splitter auto-extraction

Fixes

  • πŸ“ add sample code example for image splitter auto-extraction
  • ♻️ refactor image_extraction and change name to extraction
  • πŸ“ update documentation
  • ♻️ fix many typos in product internals
  • ♻️ add a few missing __init__.py files

v4.10.0 - 2024-07-24

Changes

  • ✨ add support for Healthcare Card V1
  • ✨ add support for Invoice V4.7
  • ✨ add support for Financial Document V1.9
  • ✨ add support for BooleanField
  • ♻️ update company registration display format
  • ♻️ switch default image save format to PNG for image extractor

Fixes

  • πŸ› fix invalid display when trying to cast null amount fields to string

v4.9.0 - 2024-06-17

Changes

  • ✨ add support for complete multi-receipt extraction (#240)
  • ✨ add support for OCR text print in CLI tool (#239)

Fixes

  • ♻️ fix miscellaneous typos (#241)

v4.8.0 - 2024-05-24

Changes

  • ✨ add support for webhooks responses & HMAC validation
  • ♻️ replaced PikePDF with PyPdfium2

v4.7.0 - 2024-05-16

Changes

  • ✨ update receipt to 5.2 and financial document to 1.7

v4.6.0 - 2024-04-30

Changes

  • ✨ add support for financial document v1.6 and invoice 4.6

v4.5.0 - 2024-03-15

Changes

  • ✨ update Invoice to v4.5

Fixes

  • πŸ› fix invalid error code handling for some errors (#227)

v4.4.1 - 2024-03-05

Changes

  • ♻️ update error handling to account for future evolutions
  • πŸ“ update some documentation

v4.4.0 - 2024-02-21

Changes

  • ✨ add support for Resume V1
  • ✨ add support for EU Driver License V1
  • ✨ add support for International ID V2

Fixes

  • πŸ“ fix miscellaneous documentation issues

v4.3.0 - 2024-01-30

Changes

  • ⬆️ update invoices to v4.4
  • ✨ add support for raw_value in string fields

v4.2.0 - 2024-01-18

Changes

  • ✨ add support for International ID V1
  • ✨ add support for Generated APIs
  • ✨ add custom associated classes & namespace for Generated APIs
  • πŸ“ update sample codes for default usage
  • πŸ“ add documentation for Generated APIs

Fixes

  • πŸ› fix sphinx doc from mistakenly looking for static files
  • πŸ› fix default async config to avoid timeouts on larger files
  • πŸ› fix for build badges

v4.1.0 - 2023-10-17

Changes

  • πŸ§ͺ optimize CI + add retry mechanism
  • ♻️ homogenize typing & classes
  • ⬆️ upgrade support for python 3.12
  • ✨ add n_pages attribute to document
  • πŸ§ͺ ✨ add experimental pdf-fixing utility

Fixes

  • πŸ“ fix invoice-splitter doc
  • πŸ”§ fix wrongful instance variable assignments
  • πŸ”§ rework custom internals & fix custom page_id

v4.0.2 - 2023-10-11

Fixes

  • πŸ› fix crashes when trying to parse from newer custom APIs

v4.0.1 - 2023-10-30

Fixes

  • πŸ› add missing internal imports for some products

v4.0.0 - 2023-10-30

Β‘Breaking Changes!

  • 🎨 πŸ’₯ harmonize response types & syntax with other libraries
  • 🎨 πŸ’₯ change endpoint management & syntax
  • 🎨 πŸ’₯ move products to product module

Changes

  • ✨ add support for auto-poll asynchronous parsing
  • ✨ add support for products with both sync & async modes
  • ✨ add support for async custom products
  • ✨ πŸ“ add auto-generated md doc
  • ♻️ πŸ“ update rst doc
  • ⬆️ update dependencies
  • πŸ§ͺ add experimental support for feedback API
  • ⬆️ improved support for custom Line Items reconstruction
  • ⬆️ update error management system
  • ♻️ update unit-tests
  • ⬆️ implement regression testing
  • ♻️ update CLI
  • ♻️ re-organize geometry module
  • ⚰️ remove support for ReceiptV3
  • ⚰️ remove support for InvoiceV3

Fixes

  • πŸ› fix raw_http attribute displaying a python dict instead of raw JSON

v3.13.2 - 2023-10-18

Changes

  • ⬆️ update urllib & pillow dependencies

v3.13.1 - 2023-10-03

Changes

  • ⬆️ update urllib, charset-normalizer & package dependencies

v3.13.0 - 2023-09-21

Changes

  • ✨ add support for Multi Receipts Detector V1
  • ✨ add support for Barcode Reader V1
  • ✨ add support for US W9 V1
  • ♻️ small internal tweaks to accomodate for new products

v3.12.0 - 2023-09-15

Changes

  • ✨ add support for FR ID card v2

v3.11.1 - 2023-07-13

Changes

  • ⬆️ GitHub CI and mypy updates
  • ⬆️ update requests to 2.31

Fixes

  • πŸ› fix full_name for multiple given names
  • πŸ› fix for parsing OCR response in CLI

v3.11.0 - 2023-07-03

Changes

  • ✨ add basic support for line items
  • ✨ add support for FR bank account details v2

v3.10.0 - 2023-06-26

Changes

  • ⚰️ remove support for Shipping Container
  • ✨ add OpenAPI GET request
  • ✨ add OCR output in CLI
  • ✨ add support for material certificate v1

Fixes

  • πŸ› fix potential problem where the words can be re-arranged by the user when calculating lines.

v3.9.1 - 2023-06-07

Changes

  • πŸ“ add documentation for OCR extraction

v3.9.0 - 2023-06-06

Changes

  • ✨ add support for financial documents v1.1
  • ✨ add support for handling OCR return
  • ♻️ update printing of receipt, invoice, financial doc

v3.8.2 - 2023-05-23

Changes

  • ♻️ add a specific class for classifications, which are never None

Fixes

  • πŸ› fix for tax base amount

v3.8.1 - 2023-05-11

Fixes

  • πŸ› fix naming of job ID property

v3.8.0 - 2023-05-10

Changes

  • ✨ add support for Invoice Splitter V1
  • ✨ add support for asynchronous requests

v3.7.1 - 2023-04-20

Fixes

  • πŸ› fix EU imports, use short imports in tests

v3.7.0 - 2023-04-18

Changes

  • ✨ add support for receipt v5
  • βœ… use code samples for integration testing

v3.6.0 - 2023-03-10

Changes

  • ✨ add an URL input source
  • πŸ“ add proof of address documentation

Fixes

  • πŸ› fix file extension for sample code inclusion

v3.5.0 - 2023-02-17

Changes

  • 🦺 make sure CI is run on various OSes
  • ⬆️ general update to all dependencies
  • ✨ add support for FR carte vitale v1
  • ✨ add support for FR ID card v1
  • ✨ add support for shipping container v1
  • ✨ add EU license plate v1
  • πŸ“ add sample code for all supported APIs

Fixes

  • πŸ› fix for null classification field on custom APIs

v3.4.0 - 2023-02-01

Changes

  • ✨ add support for: financial document v1
  • ✨ add support for: proof of address v1

Deprecations

The FinancialV1 class is now deprecated.

It's still usable with no code modifications but will be removed in a future release.

All users are encouraged to move to FinancialDocumentV1 which has much better performance. Also field names in FinancialDocumentV1 now match those of Invoice and Receipt.

v3.3.0 - 2023-01-27

Changes

  • sparkles: Add French carte grise v1 support

v3.2.1 - 2023-01-18

Changes

  • ⬆️ Update pikepdf
  • ✨ Add support for Python 3.11

Fixes

  • πŸ› Fix misleading docstrings

v3.2.0 - 2023-01-06

Changes

  • ✨ add version option in CLI
  • ♻️ harmonize printing of float values
  • ✨ add support for Invoice 4.1
  • ✨ add support for Receipt v4.1
  • πŸ“ reorganize docs a bit
  • ⬆️ update dependencies

v3.1.1 - 2022-12-02

Fixes

  • πŸ› fix for invoice v4 URL

v3.1.0 - 2022-12-01

Changes

  • ✨ allow setting base URL from env
  • ✨ add some helper functions for BBox
  • ✨ Add orientation info on all pages
  • ✨ add Cropper support
  • ✨ allow setting timeout value from env
  • ✨ Add Invoice V4 (clearer field names, line items) (#107)

Fixes

  • πŸ› page_n should always be set when available (#106)

v3.0.0 - 2022-11-07

Β‘Breaking Changes!

  • ✨ New PDF cut/merge system, allowing specifying exactly which pages to use.
  • ♻️ PDF documents are no longer cut by default, use the page_options parameter in the parse method.
  • ✨ Document (endpoints) are now versioned, providing better backward-compatible support.
  • ✨ Pass the document class instead of a string to specify how to parse input sources.
  • ♻️ Some methods and parameters renamed for better clarity.
  • ✨ Results from Custom documents are now deserialized into objects, rather than dict.

Changes

  • ✨ Add support for expense receipts V4.
  • ♻️ minor improvements to geometry functions.

Fixes

  • πŸ› Make sure the user is specified when calling custom docs on CLI
  • πŸ› Add default timeout of 120 seconds for endpoints.

v2.6.0 - 2022-10-10

Fixes

  • πŸ› don't print "None" when filename is empty

Changes

  • πŸ—‘οΈ deprecate setting singular and plural names for docs (#98)
  • ✨ add x-axis geometry functions (#99)
  • ✨ add getting bounding box for multiple polygons (#100)
  • ✨ add support for classifications in custom docs
  • ✨ allow setting only the MINDEE_API_KEY environment variable
  • ⬆️ update pikepdf

v2.5.1 - 2022-08-30

Fixes

  • πŸ› never use mutable defaults in class definitions (#96)

v2.5.0 - 2022-08-11

Changes

  • πŸ’„ improve string output of documents
  • ⬆️ general dependencies upgrade (#92)
  • ✨ add functions for working with centroids (#93)
  • ✨ Add bank checks documents (beta, US only) (#94)

v2.4.0 - 2022-06-20

Fixes

  • πŸ› πŸ“ custom docs names refer to the API, not the type.
  • πŸ› words should be separated when printing custom documents
  • πŸ› empty date should return passport not in validity

Changes

  • ✨ Add TIFF and HEIC support
  • ✨ Add real bounding boxes
  • πŸ“ publish documentation to pages

v2.3.0 - 2022-05-23

Fixes

  • πŸ› make sure the 'Token' keyword is sent in the auth headers

Changes

  • ✨ now possible to read file contents at any time
  • πŸ”¨ run mypy in pre-commit
  • ⬆️ upgrade pikepdf
  • ♻️ minor cleanup / refactor
  • πŸ“ Add basic automated class documentation

v2.2.0 - 2022-03-24

Fixes

  • πŸ› πŸ’₯ fix for customer_company_registration being a list of values

Changes

  • ✨ allow specifying file closing behavior
  • ⬆️ loosen setup.py requirements; update pinned dependencies
  • βœ… better testing of PDF pages

v2.1.1 - 2022-03-15

Fixes

  • πŸ› fix for locale constructor
  • πŸ› fix custom document in CLI
  • 🏷️ declare type info to mypy
  • πŸ› fix for dumping JSON in CLI

Changes

  • 🏷️ set stricter pylint and mypy settings
  • πŸ§‘β€πŸ’» add pre-commit to ensure proper code formatting
  • 🎨 fixes to import order (isort) and documentation (pydocstyle)

v2.1.0 - 2022-03-02

Changes

  • ✨ update to Invoices API v3
  • ♻️ refactor Endpoint classes and document building
  • ⬆️ Update PikePDF to 5.0.1
  • ✨ add a basic logger

v2.0.2 - 2022-02-21

Fixes

  • πŸ› fix sending financial document via the CLI

Changes

  • ✨ allow getting OCR return in CLI
  • ✨ Make sure all document information is printed

v2.0.1 - 2022-02-15

Fixes

  • πŸ› fix for invoice to string
  • πŸ› fix for counting empty PDF pages

Changes

  • ⬆️ Update PikePDF to 4.5.0
  • ⬆️ Update Pillow to 9.0.1 (security fix)

v2.0.0 - 2022-02-14

New Features

  • ✨ Allow using custom documents (API builder)

πŸ’₯ Breaking Changes

  • ♻️ probability renamed to confidence in the return fields to match API return
  • ♻️ Client initialization reworked to be more extensible
  • ♻️ Document loading and parsing reworked to separate arguments

Changes

v1.3.1 - 2022-02-03

Fixes

  • πŸ› fix probabilities not loaded from API #49

Changes

  • ✨ add CLI tool for testing

v1.3.0 - 2022-01-17

Fixes

  • πŸ› Fixed URLs not built properly on Windows OS #33
  • πŸ› fixed API error when using base64 #45

Changes

  • ✨ Add user-agent header with SDK and Python versions
  • ✨ Use pikepdf to replace pyMuPDF
  • πŸ‘· Pass all code through Black
  • πŸ“Œ use pip-tools and setup.py to pin all dependencies
  • πŸ“„ change to MIT license

v1.2.3 - 2021-12-22

Fixes

  • ⬆️ upgrade pymupdf to 1.18.17
  • πŸ› handle few PDF files considered blank
  • βœ… re-initialize file cursor in test

v1.2.2 - 2021-10-11

Fixes

  • πŸ› Fixed #15

Changes

  • ✨ Added pdf page number parameter for multi-pages pdfs
  • ✨ Added a blank pages only PDF detection & error raising

v1.2.1 - 2021-09-23

Fixes

  • πŸ› Forward uploaded file name for file verification rules
  • πŸ› Change token management for new header format

v1.2.0 - 2021-08-25

Changes

  • ✨ Adapted SDK to the new Mindee API endpoint
  • ⚑ Single page object reconstruction is now server-side
  • βž– Removed Numpy dependency
  • βœ… Updated tests with new data

v1.1.3 - 2021-02-21

Fixes

  • ⚑ FinancialDoc attributes have same type from invoice or receipt

v1.1.2 - 2021-02-19

Fix

  • πŸ› Fixed FinancialDoc invoice version and reconstruction

v1.1.1 - 2021-01-31

Changes

  • Updated total tax reconstruction for invoice

v1.1.0 - 2020-12-02

Changes

  • Updated invoice API endpoint to V2

v1.0.2 - 2020-12-01

Fix

  • Fixed null tax rate issue

v1.0.0 - 2020-10-28

  • πŸŽ‰ First release!