Skip to content

🔖 Version 4.23.0 #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sebastianMindee merged 1 commit into from
Dec 13, 2024
Merged

🔖 Version 4.23.0 #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Mindee Java API Library Changelog

## v4.23.0 - 2024-12-12
### Changes
* :sparkles: allow local downloading of remote sources
* :coffin: remove support for (FR) Carte Vitale V1 in favor of French Health Card V1
### Fixes
* :memo: fix technical documentation.


## v4.22.0 - 2024-11-28
### Changes
* :sparkles: add support for workflows
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ For example USA-specific classes will be in the `com.mindee.product.us` package:
import com.mindee.product.us.bankcheck.BankCheckV1;
```

### Custom Documents (API Builder)
### Custom Documents (docTI & Custom APIs)
```java
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.PredictResponse;
import com.mindee.product.custom.CustomV1;
import com.mindee.product.generated.GeneratedV1;
import com.mindee.http.Endpoint;
import java.io.File;
import java.io.IOException;
Expand All @@ -95,7 +95,7 @@ public class SimpleMindeeClient {
"src/main/resources/invoices/invoice1.pdf"
);
// Parse the file
Document<CustomV1> customDocument = mindeeClient.parse(
Document<GeneratedV1> customDocument = mindeeClient.enqueueAndParse(
localInputSource,
endpoint
);
Expand Down Expand Up @@ -221,7 +221,7 @@ Complete details on the working of the library are available in the following gu
* [Java EU Driver License OCR](https://developers.mindee.com/docs/java-eu-driver-license-ocr)
* [Java FR Bank Account Detail OCR](https://developers.mindee.com/docs/java-fr-bank-account-details-ocr)
* [Java FR Carte Grise OCR](https://developers.mindee.com/docs/java-fr-carte-grise-ocr)
* [Java FR Carte Vitale OCR](https://developers.mindee.com/docs/java-fr-carte-vitale-ocr)
* [Java FR Health Card OCR](https://developers.mindee.com/docs/java-fr-health-card-ocr)
* [Java FR ID Card OCR](https://developers.mindee.com/docs/java-fr-carte-nationale-didentite-ocr)
* [Java US Bank Check OCR](https://developers.mindee.com/docs/java-us-bank-check-ocr)
* [Java US W9 OCR](https://developers.mindee.com/docs/java-us-w9-ocr)
Expand Down
2 changes: 1 addition & 1 deletion docs/custom_v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: 622b805aaec68102ea7fcbc2
slug: java-api-builder
parentDoc: 631a062c3718850f3519b793
---
> 🚧 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/java-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/java-generated-ocr).

## Quick Start

Expand Down
6 changes: 3 additions & 3 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,12 +268,12 @@ PredictResponse<ReceiptV4> receiptV4Inference = mindeeClient.parse(ReceiptV4.cla

For more fine-grained control over parsing the documents you can have a look on the `parse` override method.

#### Custom Documents
#### Custom Documents (docTI)

In this case, you will have two ways to handle them.

The first one enables the possibility to use a class object which represents a kind of dictionary where,
keys will be the name of each field define in your Custom API model (on the Mindee platform).
keys will be the name of each field define in your Custom API model (`docTI` section on the Mindee platform).

It also requires that you instantiate a new `Endpoint` object to define the information of your custom API built.

Expand All @@ -284,7 +284,7 @@ CustomEndpoint endpoint = new CustomEndpoint(
"1.0" // optional
);

PredictResponse<CustomV1> customDocument = mindeeClient.parse(localInputSource, endpoint);
PredictResponse<GeneratedV1> customDocument = mindeeClient.enqueueAndParse(localInputSource, endpoint);
```

The second one is using your own class.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>com.mindee.sdk</groupId>
<artifactId>mindee-api-java</artifactId>
<version>4.22.0</version>
<version>4.23.0</version>
<modelVersion>4.0.0</modelVersion>
<name>Mindee Java Helper Library</name>
<description>Java Library to call Mindee's Off-The-Shelf and Custom APIs</description>
Expand Down
Loading