Skip to content

Commit 27fd979

Browse files
🔖 Version 3.18.0 (#133)
1 parent d0d4b7c commit 27fd979

File tree

5 files changed

+19
-11
lines changed

5 files changed

+19
-11
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Mindee Ruby API Library Changelog
22

3+
## v3.18.0 - 2024-12-13
4+
### Changes
5+
* :sparkles: allow local downloading of remote sources
6+
* :coffin: remove support for (FR) Carte Vitale V1 in favor of French Health Card V1
7+
### Fixes
8+
* :bug: fix tax-extraction script
9+
10+
311
## v3.17.0 - 2024-11-28
412
### Changes
513
* :sparkles: add support for workflows

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ result = mindee_client.parse(
116116
puts result.document
117117
```
118118

119-
### Custom Document (API Builder)
119+
### Custom Documents (docTI & Custom APIs)
120120

121121
```ruby
122122
require 'mindee'
@@ -131,9 +131,9 @@ endpoint = mindee_client.create_endpoint(
131131
# Load a file from disk
132132
input_source = mindee_client.source_from_path('/path/to/the/file.ext')
133133

134-
result = mindee_client.parse(
134+
result = mindee_client.enqueue_and_parse(
135135
input_source,
136-
Mindee::Product::Custom::CustomV1,
136+
Mindee::Product::Generated::GeneratedV1,
137137
endpoint: endpoint
138138
)
139139

@@ -181,7 +181,7 @@ customize the experience.
181181
* [EU Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-eu-driver-license-ocr)
182182
* [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-account-details-ocr)
183183
* [FR Bank Statement OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-statement-ocr)
184-
* [FR Carte Vitale OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-vitale-ocr)
184+
* [FR Health Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-health-card-ocr)
185185
* [FR ID Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-nationale-didentite-ocr)
186186
* [US Bank Check OCR Ruby](https://developers.mindee.com/docs/ruby-us-bank-check-ocr)
187187
* [US Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-us-driver-license-ocr)

docs/custom_v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ category: 622b805aaec68102ea7fcbc2
44
slug: ruby-api-builder-ocr
55
parentDoc: 6294d97ee723f1008d2ab28e
66
---
7-
> 🚧 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).
7+
> 🚧 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).
88
99
# Quick-Start
1010

docs/getting_started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -226,20 +226,20 @@ result = mindee_client.parse(
226226
)
227227
```
228228

229-
### Custom Documents
229+
### Custom Documents (docTI)
230230
For custom documents, the endpoint to use must also be set, and it must take in an `endpoint_name`:
231231

232232
```ruby
233-
endpoint = mindee_client.create_endpoint(endpoint_name: 'wnine')
233+
endpoint = mindee_client.create_endpoint(endpoint_name: 'wnine', account_name: 'my-account')
234234

235-
result = mindee_client.parse(
235+
result = mindee_client.enqueue_and_parse(
236236
input_source,
237-
Mindee::Product::Custom::CustomV1,
237+
Mindee::Product::Generated::GeneratedV1,
238238
endpoint: endpoint
239239
)
240240
```
241241

242-
This is because the `CustomV1` class is enough to handle the return processing, but the actual endpoint needs to be specified.
242+
This is because the `GeneratedV1` class is enough to handle the return processing, but the actual endpoint needs to be specified.
243243

244244
## Process the Result
245245
The response object is common to all documents, including custom documents. The main properties are:

lib/mindee/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Mindee
44
module Mindee
55
# Current version.
6-
VERSION = '3.17.0'
6+
VERSION = '3.18.0'
77

88
# Finds and return the current platform.
99
# @return [String]

0 commit comments

Comments
 (0)