diff --git a/CHANGELOG.md b/CHANGELOG.md index b06609136..5526d8cf8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 1508bb77a..909b26f0b 100644 --- a/README.md +++ b/README.md @@ -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; @@ -95,7 +95,7 @@ public class SimpleMindeeClient { "src/main/resources/invoices/invoice1.pdf" ); // Parse the file - Document customDocument = mindeeClient.parse( + Document customDocument = mindeeClient.enqueueAndParse( localInputSource, endpoint ); @@ -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) diff --git a/docs/custom_v1.md b/docs/custom_v1.md index 21e82460d..18a4c05a6 100644 --- a/docs/custom_v1.md +++ b/docs/custom_v1.md @@ -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 diff --git a/docs/getting_started.md b/docs/getting_started.md index e88102798..eea1887ec 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -268,12 +268,12 @@ PredictResponse 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. @@ -284,7 +284,7 @@ CustomEndpoint endpoint = new CustomEndpoint( "1.0" // optional ); -PredictResponse customDocument = mindeeClient.parse(localInputSource, endpoint); +PredictResponse customDocument = mindeeClient.enqueueAndParse(localInputSource, endpoint); ``` The second one is using your own class. diff --git a/pom.xml b/pom.xml index 539e2a0a1..61ddd53ad 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ com.mindee.sdk mindee-api-java - 4.22.0 + 4.23.0 4.0.0 Mindee Java Helper Library Java Library to call Mindee's Off-The-Shelf and Custom APIs