Skip to content

Latest commit

 

History

History
638 lines (490 loc) · 18.2 KB

File metadata and controls

638 lines (490 loc) · 18.2 KB

Mindee .NET Client Library Changelog

v4.2.1 - 2026-04-28

Fixes

  • 🐛 fix package symbol errors when publishing CLI NuGet (#400)

v4.2.0 - 2026-04-22

Changes

  • ✨ add nuGet support for CLI

Fixes

  • 🐛 fix CLI sometimes crashing if V2 key wasn't provided
  • 🐛 fix CLI loading slowly

v4.2.0-rc1 - 2026-04-22

Changes

  • ✨ add nuGet support for CLI

Fixes

  • 🐛 fix CLI sometimes crashing if V2 key wasn't provided

v4.1.0 - 2026-04-20

Changes

  • ✨ add support for V2 crop and split file operations

Fixes

  • 📝 fix a few typos in changelog

v4.0.1 - 2026-04-03

Changes

♻️ uniformize Mindee HTTP errors with other libs

v4.0.0 - 2026-03-27

Changes

  • ✨ Add support for Classification, Crop, OCR and Split utilities.
  • ✨ Add Strong Name support
  • ✨ Add full CLI support for V1 & V2
    • ⬆️ add support for .NET 4.7.2/4.8
  • ✨ Add ability to search for models through Client and CLI
  • ♻️ Make proper classes & methods static and/or private
  • ⬆️ Mutualize and bump most dependencies
  • ♻️ mutualize framework targeting

Fixes

  • 🐛 Fix V1 CLI
  • ♻️ Fix Logging using improper syntax
  • 🐛 Fix dependency injections not functioning properly for .NET versions 4.7.2 and 4.8

¡Breaking Changes!

  • 💥 ♻️ Refactor V1
    • ♻️ move V1-exclusive internals to dedicated V1 namespace
    • ⚰️ Remove support for deprecated products:
      • CustomV1
      • Bill of Lading
      • Business Card
      • Delivery Notes
      • Driver License
      • FR Energy Bill
      • Indian Passport
      • Nutrition Facts
      • Resume
      • US Healthcare Card
      • US Mail
  • 💥 ♻️ Refactor V2
    • ♻️ move V2-exclusive internals to dedicated V2 namespace
    • ♻️ rename Inference V2 product to Extraction
  • 💥 :refactor: move polling options outside product parameters

v4.0.0-rc2 - 2026-03-23

Changes

  • ♻️ mutualize framework targeting

v4.0.0-rc1 - 2026-03-19

Changes

  • 💥 :refactor: move polling options outside product parameters
  • ♻️ harmonize v1 and v2 polling options

v4.0.0-beta1 - 2026-03-16

Changes

  • ✨ Add support for Classification, Crop, OCR and Split utilities.
  • ✨ Add Strong Name support
  • ✨ Add full CLI support for V1 & V2
    • ⬆️ add support for .NET 4.7.2/4.8
  • ✨ Add ability to search for models through Client and CLI
  • ♻️ Make proper classes & methods static and/or private
  • ⬆️ Mutualize and bump most dependencies

Fixes

  • 🐛 Fix V1 CLI
  • ♻️ Fix Logging using improper syntax
  • 🐛 Fix dependency injections not functioning properly for .NET versions 4.7.2 and 4.8

¡Breaking Changes!

  • 💥 ♻️ Refactor V1
    • ♻️ move V1-exclusive internals to dedicated V1 namespace
    • ⚰️ Remove support for deprecated products:
      • CustomV1
      • Bill of Lading
      • Business Card
      • Delivery Notes
      • Driver License
      • FR Energy Bill
      • Indian Passport
      • Nutrition Facts
      • Resume
      • US Healthcare Card
      • US Mail
  • 💥 ♻️ Refactor V2
    • ♻️ move V2-exclusive internals to dedicated V2 namespace
    • ♻️ rename Inference V2 product to Extraction

v3.39.0 - 2026-03-02

Changes

  • ✨ add job information to inference

v3.38.0 - 2026-02-11

Changes

  • ✨ add missing accessors & fix broken simplefields accessors

Fixes

  • 🐛 fix improper handling of .NET 10

v3.37.2 - 2026-01-19

Fixes

  • 🐛 fix some older .NET versions not compiling properly

v3.37.1 - 2026-01-15

Changes

  • 🧹 add code quality checks & reformat entire codebase

v3.37.0 - 2026-01-06

Changes

  • ✨ add loading local input source from base64
  • ✨ add support for data schema parameter

v3.36.1 - 2025-12-15

Changes

  • ✅ add initial testing on .NET 10
  • ✅ test loading webP files

Fixes

  • 🐛 allow retrieval of the inference ID

v3.36.0 - 2025-12-02

Changes

  • ✨ add support for text_context in active options return

v3.35.0 - 2025-11-19

Changes

  • 📝 update readme links
  • ✨ add RAG metadata in V2 results
  • ✨ improved v2 error messages and exceptions
  • ✨ add text_context option on V2 enqueue

Fixes

  • 🐛 fix for C# 14 and .NET 10

v3.34.0 - 2025-10-01

Changes

  • 🔊 better logging for v2
  • ✨ allow comparing v2 field confidence score

v3.33.0 - 2025-09-25

Fixes

  • 🐛 fix for setting inference options
  • 🐛 ensure consistent number formatting

¡Breaking Changes!

  • ⚰️ remove obsolete US Mail V2
  • 🐛 make sure DI uses separate services for v1 and v2 clients
    • ♻️ 💥 Use dedicated settings class for v2 (normally not used directly)
    • ♻️ 💥 Use dedicated settings section for v2 (normally not used directly)

v3.32.0 - 2025-09-03

Changes

  • ✨ add inference options

¡Breaking Changes!

  • ♻️ 💥 update raw text output from server

v3.31.0 - 2025-08-27

Changes

  • ✨ add typed properties to list and object

Fixes

  • 📝 fix page options doc

v3.30.0 - 2025-08-04

Changes

  • ✨ add support for page count & mime type, fix v2 field naming conventions

Fixes

  • 🐛 fix for field attributes being at the wrong level

v3.29.0 - 2025-07-29

Changes

  • ✨ Add support for mindee API V2 client & features
  • 🔧 Tweak CI & testing
  • ♻️ Uniformize variable naming across files

v3.29.0-rc4 - 2025-07-22

Changes

  • ✨ add support for field locations & confidence score
  • ♻️ change name of main calling methods (e.g. EnqueueAndParseAsync becomes EnqueueAndGetInferenceAsync)
  • ✨ 💥 upgrade page options usage to match other SDKs (page indexes now start at 0)

Fixes

  • 🐛 fix tests
  • ♻️ update internal syntaxes

v3.29.0-rc3 - 2025-07-09

Changes

  • ✨ merge enqueue parameters into a single object

Fixes

  • ♻️ field property of ObjectFields now deserializes into an InferenceFields instance.
  • ♻️ remove redundant logic
  • 📝 fix documentation typos
  • ♻️ fix code sample

v3.29.0-rc2 - 2025-07-03

Changes

  • ✨ add very basic printing of results

Fix

  • ⚰️ remove unneeded V2 classes
  • ♻️ use an abstract class for the API to harmonize JSON parsing, logging
  • 🐛 use correct route for GET on job

v3.29.0-rc1 - 2025-06-30

Changes

  • ⚗️ add experimental support for V2 API
  • ⚗️ add experimental support for V2 inferences
  • 📝 add sample codes
  • 🔧 add proper logging in V2 HTTP calls
  • ⬆️ bump all MS dependencies
  • ♻️ tweak the way sanity testing is done

Fix

  • ♻️ fix some issues with logging
  • ⬆️ update some testing dependencies
  • ♻️ add fallback support for logging on older windows installs

v3.28.0 - 2025-06-03

Changes

  • ✨ add support for address fields
  • ✨ add support for Financial Document V1.12
  • ✨ add support for Invoices V4.10
  • ✨ add support for US Healthcare Cards V1.2
  • ♻️ add support for nullable confidence scores

v3.27.0 - 2025-04-22

Changes

  • ✨ add support for workflow polling (#304)

Fixes

  • Fix improper deserialization of date formats in workflow execution.

v3.26.0 - 2025-04-16

Changes

  • ✨ add support for RAG parameter in workflow executions (#299)

v3.25.0 - 2025-04-08

Changes

  • ✨ add support for Financial Document V1.12
  • ✨ add support for Invoices V4.10
  • ✨ add support for US Healthcare Cards V1.2
  • ✨ add support for FR EnergyBill V1.2
  • ✨ allow asynchronous custom products in CLI
  • ⚰️ deprecate EU License Plate
  • ⚰️ deprecate EU Driver License
  • ⚰️ deprecate Proof of Address
  • ⚰️ deprecate US W9
  • ⚰️ deprecate US Driver License

Fixes

  • ♻️ upgrade descriptions, documentation & CLI products
  • ♻️ update data structure for Invoice Splitter

v3.24.3 - 2025-02-13

Changes

  • ♻️ harmonise platform names with other client libs
  • ⬆️ add official support for .NET 9.0

v3.24.2 - 2025-01-09

Changes

  • ♻️ increase async retry timers

Fixes

  • 🐛 fix classifications not having a confidence score

v3.24.1 - 2025-01-08

Changes

  • 📝 update reference documentation

Fixes

  • 🐛 fix missing boolean accessor for generated object

v3.24.0 - 2024-12-26

Changes

  • ✨ add support for us mail v3

v3.23.0 - 2024-12-12

Changes

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

v3.22.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
  • ⚰️ remove support for international id V1

v3.21.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

v3.20.1 - 2024-10-21

Fixes

🐛 fix worker services losing API settings & API key after an HTTP call

v3.20.0 - 2024-10-11

Changes

  • ✨ add support for Financial Document v1.10
  • ✨ add support for Invoice v4.8
  • ✨ add support for image compression & resize
  • ✨ add support for PDF compression

Fixes

  • ⬆️ bump dependencies

v3.19.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
  • ✨ add support for full text OCR response

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
  • 📝 add classification detail to guide documentation

v3.18.4 - 2024-08-30

Changes

  • ⬆️ update Restsharp dependency to cover vulnerability
  • ♻️ remove unused code

v3.18.3 - 2024-07-23

Fixes

  • 🐛 fix broken reference on worker service initialization

v3.18.2 - 2024-07-22

Fixes

  • 🐛 fix RestSharp's restclient being given improper scope for use in workers

v3.18.1 - 2024-07-19

Fixes

  • 🐛 fix issue that prevented the API from working in workers without manually adding RestClient as a dependency.

v3.18.0 - 2024-07-18

Changes

  • ✨ add support for US Healthcare card
  • ✨ add support for Us Mail V2
  • ✨ update financial document to v1.9
  • ✨ update invoice to v4.7

Fixes

  • 🐛 fix restsharp dependency issue (#219)
  • 🐛 fix uncommon bug where api calls would sometime stay opened for too long & cause timeouts
  • 🐛 fix image not loading properly when using the PDF Extraction feature
  • ♻️ better notifications in case of hanging connections
  • ⬆️ update System.Text.Json to cover vulnerability
  • ♻️ update many tests

v3.17.0 - 2024-06-26

Changes

  • ✨ add support for invoice splitter auto-extraction
  • ✨ add support for multi-receipts auto-extraction
  • ✨ add support for getting the raw OCR as a string in CLI

Fixes

  • 🐛 fix pdf indexes being improperly flagged as invalid in some splitPdf configurations
  • ♻️ fix company registration display to include version
  • ♻️ update image/pdf handling & System.text.json dependencies

v3.16.0 - 2024-06-10

Changes

  • ✨ add support for getting the raw OCR as a string

v3.15.0 - 2024-05-28

Changes

  • ✨ add support for US Mail

v3.14.0 - 2024-05-16

Changes

  • ✨ update receipt to 5.2 and financial document to 1.7

v3.13.0 - 2024-04-30

Changes

  • ✨ update invoice to 4.6 and financial doc to 1.6

v3.12.0 - 2024-04-08

Changes

  • ✨ add support for loading webhook responses

v3.11.1 - 2024-04-05

Changes

  • ⚡ increase max retries in CLI to 60

Fixes

  • 🐛 fix for writing custom classes to JSON

v3.11.0 - 2024-03-26

Changes

  • ✅ compatibility with .NET 8.0
  • ✨ update Invoice to v4.5
  • ✨ add support for generated documents

v3.10.0 - 2024-03-06

Changes

  • ✨ add support for error in job processing
  • ✨ add resume v1
  • ✨ add EU driver license v1
  • ✨ add International ID v2
  • ✨ add FR Carte Grise v1

v3.9.0 - 2024-01-30

Changes

  • ✨ add RawValue to string fields
  • ⬆️ update invoice to 4.4

v3.8.0 - 2023-12-20

Changes

  • :recycle tweak default async sample delays & retry
  • ✨ add International ID

v3.7.0 - 2023-11-22

Changes

  • ✨ add ability to parse URLs

Fixes

  • 🐛 properly throw exceptions on predict_async API route

v3.6.0 - 2023-11-17

Changes

  • ✨ add NPages property to Document class
  • ✨ add pageId to custom doc values

v3.5.0 - 2023-11-13

Changes

  • ✨ add support for us payroll check register

v3.4.0 - 2023-10-20

Changes

  • ✨ add string helper functions to custom documents

Fixes

  • 🐛 add missing confidence and polygon data to line items

v3.3.0 - 2023-09-22

Changes

  • ♻️ simplify async product example
  • ✨ add raw string response in response object
  • 🔊 add global logging system
  • ✨ add support for barcode reader v1
  • ✨ add support for multi receipt detector v1

Fixes

  • 🐛 fix for parsing invalid dates
  • 🐛 fix for empty elements in PositionField

v3.2.0 - 2023-09-13

Changes

  • ✨ add support for FR ID card v2
  • ✨ add support for US W9 v1
  • ✨ add built-in async call polling
  • ✨ add DecimalField
  • 🔊 better logging
  • ✨ add a dateObject property to DateField class

Fixes

  • 🐛 fix for alignment issues on ToString
  • 🐛 StringField value should be null in case of empty string

v3.1.0 - 2023-08-08

Changes

  • ✨ add support for US driver license v1

v3.0.0 - 2023-07-28

¡Breaking Changes!

  • 🎨 💥 harmonize response type with other libraries
  • 🎨 💥 change appsettings main key to 'Mindee'
  • 🎨 💥 separate HTTP classes, move products to Product namespace
  • 🔥 🎨 💥 init of client should be done directly
  • ♻️ 🎨 💥 send inputSource instances directly to parse methods
  • ♻️ 💥 seal product classes
  • ♻️ 💥 use PredictOptions object to allow more flexibility in the client API

Changes

  • ⚰️ remove shipping container
  • ✨ support async and invoice splitter v1
  • 🎨 rework CLI
  • ✨ update to latest version of passport, invoice, receipt, financial doc
  • ✨ add support for fr bank account details v2
  • ✅ add tests for empty responses
  • ✅ add more relevent integration tests

Fixes

  • 🐛 fix page output in us bank check

v2.2.1 - 2023-05-30

Changes

  • ⬆️ update RestSharp to 109.0.1

v2.2.0 - 2023-03-16

Changes

  • 🚸 Improve the UX when in CLI
  • 📝 prediction class documentation updates
  • ✨ add support for FR bank account details
  • ✨ adding summary for table in custom document
  • ♻️ major rework of line items detection and generation

Fixes

  • 🐛 fix running sample code

v2.1.2 - 2023-03-09

Fixes

  • 🐛 custom document default version must be '1', not '1.0'

v2.1.1 - 2023-03-08

Fixes

  • 🐛 fix trouble with .NET 4.8/4.7.2 usage

v2.1.0 - 2023-02-20

¡Breaking Changes!

  • 💥 some properties renaming for French ID card and Carte Vitale

Changes

  • ✨ support lines items post processing reconstruction for API Builder
  • ✨ support Polygon object for field coordinates
  • ✨ support Math Bbox concept

Fixes

  • 🐛💥 details property in Error become an object because it can handle both string and object
  • 🐛⬆️ update RestSharp to fix a bug on .NET 7 #120

v2.0.0 - 2023-02-02

¡Breaking Changes!

  • 💥 drop Invoice v3 support
  • 💥 prediction model classes must be replaced by inference model to use OTS APIs
  • 💥 renaming Date to DateField

Changes

  • ✨ support Financial Document V1
  • ✨ support Proof of Address V1
  • ✨ enable the use of custom time out when calling Mindee API
  • ✨ improve MindeeClient by using IPredictable instead of instance of MindeeApi
  • ✨ expose a static helper to instantiate a new MindeeClient
  • ✨ improve summaries
  • ✨ support classification type for custom document
  • ♻️ renaming AllWord to Word

Fixes

  • 🐛! Details property in Error become an object because it can handle both string and object

v1.4.0 - 2023-01-04

Changes

  • ✨ Support Receipt V4.1
  • ✨ Support Invoice V4.1

v1.3.0 - 2022-12-22

Changes

  • ✅ Cropper API summary
  • ✨ Adding total taxes amount in Invoice V3 and V4
  • ✨ Adding Value in Locale for Receipt
  • ✨ Add Mrz and FullName on Passport
  • ✨ Support FR ID Card V1
  • ✨ Support Shipping Container V1
  • ✨ Support US Bank Check V1
  • ✨ Support EU License plates V1

v1.2.0 - 2022-12-07

Changes

  • ✨ Add Invoice V4 support

v1.1.0 - 2022-11-28

Changes

  • 💥 Changing the settings section name from MindeeApiSettings to MindeeSettings.
  • 💥 IConfiguration is replaced by IOptions in MindeeClient.
  • ✨ Add cropper support
  • 📝 Publish technical documentation on GitHub pages

v1.0.0 - 2022-11-17

  • 🎉 First release