From 52c030e7a87f5cd2f94ebd5d37c578a2066ac788 Mon Sep 17 00:00:00 2001 From: sebastianMindee Date: Fri, 13 Dec 2024 10:15:15 +0100 Subject: [PATCH] :bookmark: Version 3.18.0 --- CHANGELOG.md | 8 ++++++++ README.md | 8 ++++---- docs/custom_v1.md | 2 +- docs/getting_started.md | 10 +++++----- lib/mindee/version.rb | 2 +- 5 files changed, 19 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a39c770..327ae1dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Mindee Ruby API Library Changelog +## v3.18.0 - 2024-12-13 +### Changes +* :sparkles: allow local downloading of remote sources +* :coffin: remove support for (FR) Carte Vitale V1 in favor of French Health Card V1 +### Fixes +* :bug: fix tax-extraction script + + ## v3.17.0 - 2024-11-28 ### Changes * :sparkles: add support for workflows diff --git a/README.md b/README.md index 47d5d5a2..559efae7 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ result = mindee_client.parse( puts result.document ``` -### Custom Document (API Builder) +### Custom Documents (docTI & Custom APIs) ```ruby require 'mindee' @@ -131,9 +131,9 @@ endpoint = mindee_client.create_endpoint( # Load a file from disk input_source = mindee_client.source_from_path('/path/to/the/file.ext') -result = mindee_client.parse( +result = mindee_client.enqueue_and_parse( input_source, - Mindee::Product::Custom::CustomV1, + Mindee::Product::Generated::GeneratedV1, endpoint: endpoint ) @@ -181,7 +181,7 @@ customize the experience. * [EU Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-eu-driver-license-ocr) * [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-account-details-ocr) * [FR Bank Statement OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-statement-ocr) -* [FR Carte Vitale OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-vitale-ocr) +* [FR Health Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-health-card-ocr) * [FR ID Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-nationale-didentite-ocr) * [US Bank Check OCR Ruby](https://developers.mindee.com/docs/ruby-us-bank-check-ocr) * [US Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-us-driver-license-ocr) diff --git a/docs/custom_v1.md b/docs/custom_v1.md index 74c9d7c6..0d5c34c8 100644 --- a/docs/custom_v1.md +++ b/docs/custom_v1.md @@ -4,7 +4,7 @@ category: 622b805aaec68102ea7fcbc2 slug: ruby-api-builder-ocr parentDoc: 6294d97ee723f1008d2ab28e --- -> 🚧 This product is still supported, but is considered to be deprecated. If you are looking for the DocTI API documentation, you can find it [here](https://developers.mindee.com/docs/ruby-generated-ocr). +> 🚧 This product is still supported, but is considered to be deprecated. If you are looking for the docTI API documentation, you can find it [here](https://developers.mindee.com/docs/ruby-generated-ocr). # Quick-Start diff --git a/docs/getting_started.md b/docs/getting_started.md index c2bcc48e..796c128d 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -226,20 +226,20 @@ result = mindee_client.parse( ) ``` -### Custom Documents +### Custom Documents (docTI) For custom documents, the endpoint to use must also be set, and it must take in an `endpoint_name`: ```ruby -endpoint = mindee_client.create_endpoint(endpoint_name: 'wnine') +endpoint = mindee_client.create_endpoint(endpoint_name: 'wnine', account_name: 'my-account') -result = mindee_client.parse( +result = mindee_client.enqueue_and_parse( input_source, - Mindee::Product::Custom::CustomV1, + Mindee::Product::Generated::GeneratedV1, endpoint: endpoint ) ``` -This is because the `CustomV1` class is enough to handle the return processing, but the actual endpoint needs to be specified. +This is because the `GeneratedV1` class is enough to handle the return processing, but the actual endpoint needs to be specified. ## Process the Result The response object is common to all documents, including custom documents. The main properties are: diff --git a/lib/mindee/version.rb b/lib/mindee/version.rb index 0394437a..ecbc8096 100644 --- a/lib/mindee/version.rb +++ b/lib/mindee/version.rb @@ -3,7 +3,7 @@ # Mindee module Mindee # Current version. - VERSION = '3.17.0' + VERSION = '3.18.0' # Finds and return the current platform. # @return [String]