From debfd7778964785a86439f5657003d521a524eb1 Mon Sep 17 00:00:00 2001
From: sebastianMindee <130448732+sebastianMindee@users.noreply.github.com>
Date: Wed, 23 Jul 2025 17:28:01 +0200
Subject: [PATCH] :bookmark: Version 4.33.0-rc3
---
CHANGELOG.md | 8 ++
README.md | 241 +++++++--------------------------------------------
pom.xml | 2 +-
3 files changed, 42 insertions(+), 209 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index da4debe07..f0502c1d9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,13 @@
# Mindee Java Client Library Changelog
+## v4.33.0-rc3 - 2025-07-23
+### Changes
+* :sparkles: add support for URL input sources
+### Fixes
+* :bug: fix improper deserialization types for simple fields
+* :bug: fix rst display
+
+
## v4.33.0-rc2 - 2025-07-18
### Changes
* :wrench: tweak CI & testing
diff --git a/README.md b/README.md
index 8514509a4..e9bd29317 100644
--- a/README.md
+++ b/README.md
@@ -3,214 +3,39 @@
# Mindee Client Library for Java
Quickly and easily connect to Mindee's API services using Java.
-## Quick Start
-Here's the TL;DR of getting started.
-
-First, get an [API Key](https://developers.mindee.com/docs/create-api-key)
-
-Include the following maven dependency in your project to use the helper library:
-```xml
-
- mindee-api-java
- com.mindee.sdk
- ${mindee.sdk.version}
-
-```
-
-Where `${mindee.sdk.version}` is the version shown here:
-
-
-
-
-## Loading a File and Parsing It
-The `MindeeClient` class is the entry point for most of the helper library features.
-
-## Synchronously Parsing a File
-This is the easiest and fastest way to integrate into the Mindee API.
-
-However, not all products are available in synchronous mode.
-
-### Global Documents
-These classes are available in the `com.mindee.product` package:
-
-```java
-import com.mindee.MindeeClient;
-import com.mindee.input.LocalInputSource;
-import com.mindee.parsing.common.PredictResponse;
-import com.mindee.product.invoice.InvoiceV4;
-import java.io.File;
-import java.io.IOException;
-
-public class SimpleMindeeClient {
- public static void main(String[] args) throws IOException {
-
- // Init a new client
- MindeeClient mindeeClient = new MindeeClient("my-api-key");
-
- // Load a file from disk
- LocalInputSource localInputSource = new LocalInputSource(
- "/path/to/the/file.ext"
- );
- // Parse the file
- Document response = mindeeClient.parse(
- InvoiceV4.class,
- localInputSource
- );
- // Print a summary of the parsed data
- System.out.println(response.getDocument().toString());
- }
-}
-```
-
-**Note for Region-Specific Documents:**
-
-Each region will have its own package within the general `com.mindee.product` package.
-
-For example USA-specific classes will be in the `com.mindee.product.us` package:
-```java
-import com.mindee.product.us.bankcheck.BankCheckV1;
-```
-
-### Custom Documents (docTI & Custom APIs)
-```java
-import com.mindee.MindeeClient;
-import com.mindee.PredictOptions;
-import com.mindee.input.LocalInputSource;
-import com.mindee.parsing.common.PredictResponse;
-import com.mindee.product.generated.GeneratedV1;
-import com.mindee.http.Endpoint;
-import java.io.File;
-import java.io.IOException;
-
-public class SimpleMindeeClient {
- public static void main(String[] args) throws IOException {
-
- // Init a new client
- MindeeClient mindeeClient = new MindeeClient("my-api-key");
-
- // Init the endpoint for the custom document
- Endpoint endpoint = new Endpoint("my-endpoint", "my-account");
-
- // Load a file from disk
- LocalInputSource localInputSource = new LocalInputSource(
- "src/main/resources/invoices/invoice1.pdf"
- );
- // Parse the file
- Document customDocument = mindeeClient.enqueueAndParse(
- localInputSource,
- endpoint
- // PredictOptions.builder().build(),
- );
- }
-}
-```
-
-## Asynchronously Parsing a File
-This allows for easier handling of bursts of documents sent.
-
-Some products are only available asynchronously, check the example code
-directly on the Mindee platform.
-
-### Enqueue and Parse a File
-The client library will take care of handling the polling requests for you.
-
-This is the easiest way to get started.
-
-```java
-import com.mindee.MindeeClient;
-import com.mindee.PredictOptions;
-import com.mindee.input.LocalInputSource;
-import com.mindee.parsing.common.AsyncPredictResponse;
-import com.mindee.product.internationalid.InternationalIdV2;
-import java.io.File;
-import java.io.IOException;
-
-public class SimpleMindeeClient {
-
- public static void main(String[] args) throws IOException, InterruptedException {
- String apiKey = "my-api-key";
- String filePath = "/path/to/the/file.ext";
-
- // Init a new client
- MindeeClient mindeeClient = new MindeeClient(apiKey);
-
- // Load a file from disk
- LocalInputSource inputSource = new LocalInputSource(new File(filePath));
-
- // Parse the file asynchronously
- AsyncPredictResponse response = mindeeClient.enqueueAndParse(
- InternationalIdV2.class,
- inputSource
- // PredictOptions.builder().build(),
- );
-
- // Print a summary of the response
- System.out.println(response.toString());
- }
-}
-```
-
-### Enqueue and Parse a Webhook Response
-This is an optional way of handling asynchronous APIs.
-
-```java
-import com.mindee.MindeeClient;
-import com.mindee.input.LocalInputSource;
-import com.mindee.input.LocalResponse;
-import com.mindee.input.WebhookSource;
-import com.mindee.product.internationalid.InternationalIdV2;
-import java.io.IOException;
-
-public class SimpleMindeeClient {
- public static void main(String[] args) throws IOException {
-
- // Init a new client
- MindeeClient mindeeClient = new MindeeClient("my-api-key");
-
- // Load a file from disk
- LocalInputSource localInputSource = new LocalInputSource(
- "/path/to/the/file.ext"
- );
- // Enqueue the file
- String jobId = client.enqueue(InternationalIdV2.class, localInputSource)
- .getJob().getId();
-
- // Load the JSON string sent by the Mindee webhook POST callback.
- //
- // Reading the callback data will vary greatly depending on your HTTP server.
- // This is therefore beyond the scope of this example.
- String jsonData = myHttpServer.getPostBodyAsString();
- LocalResponse localResponse = new LocalResponse(jsonData);
-
- // Verify the HMAC signature.
- // You'll need to get the "X-Mindee-Hmac-Signature" custom HTTP header.
- String hmacSignature = myHttpServer.getHeader("X-Mindee-Hmac-Signature");
- boolean isValid = localResponse.isValidHmacSignature(
- "obviously-fake-secret-key", hmacSignature
- );
- if (!isValid) {
- throw new MyException("Bad HMAC signature! Is someone trying to do evil?");
- }
-
- // You can also use a File object as the input.
- //LocalResponse localResponse = new LocalResponse(new File("/path/to/file.json"));
-
- // Deserialize the response into Java objects
- AsyncPredictResponse response = mindeeClient.loadPrediction(
- InternationalIdV2.class,
- localResponse
- );
-
- // Print a summary of the parsed data
- System.out.println(response.getDocument().toString());
- }
-}
-```
-
-You can view the source code on [GitHub](https://github.com/mindee/mindee-api-java).
-
-You can also take a look at the
-**[Reference Documentation](https://mindee.github.io/mindee-api-java/)**.
+
+
+## Mindee API Versions
+This client library has support for both Mindee platform versions.
+
+### Latest - V2
+This is the new platform located here:
+
+https://app.mindee.com
+
+It uses **API version 2**.
+
+Consult the
+**[Latest Documentation](https://docs.mindee.com/integrations/client-libraries-sdk)**
+
+
+### Legacy - V1
+This is the legacy platform located here:
+
+https://platform.mindee.com/
+
+It uses **API version 1**.
+
+Consult the
+**[Legacy Documentation](https://developers.mindee.com/docs/java-ocr-getting-started)**
+
+## Additional Information
+
+**[Source Code](https://github.com/mindee/mindee-api-java)**
+
+**[Reference Documentation](https://mindee.github.io/mindee-api-java/)**
+
+**[Feedback](https://feedback.mindee.com/)**
## License
Copyright © Mindee
diff --git a/pom.xml b/pom.xml
index c72af5400..30526f9f5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -383,7 +383,7 @@
- 4.33.0-rc2
+ 4.33.0-rc3
2.15.4
2.15.4