Automatically Extracting Receipts Using the Mindee Client Libraries
The Node.js library implementation differs from our other supported languages, see the Node.js dedicated tutorial instead.
Overview
Just want to get to the full script? Jump to the relevant section.
When to Use This Feature
Use the Multi-Receipts Detector API when you have:
A single image containing multiple receipts
The need to process each receipt individually without manual separation
A desire to streamline receipt processing workflows
The Multi-Receipts Detector API scans the contents of a file, identifies the coordinates of individual receipts, and allows for their extraction and separate processing.
Note: For PDFs, the API applies this principle at a page level, treating each page as a separate image.
from mindee import Client, product
from mindee.extraction.multi_receipts_extractor.multi_receipts_extractor import (
extract_receipts,
)
mindee_client = Client(api_key="my-api-key-here")
# mindee_client = Client() # Optionally, set from env.
<?php
use Mindee\Client;
use Mindee\Extraction\ImageExtractor;
use Mindee\Input\PathInput;
use Mindee\Product\MultiReceiptsDetector\MultiReceiptsDetectorV1;
use Mindee\Product\Receipt\ReceiptV5;
$mindeeClient = new Client("my-api-key-here");
// $mindeeClient = new Client(); // Optionally, use an environment variable.
$inputPath = "path/to/your/file.ext";
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.extraction.ExtractedImage;
import com.mindee.extraction.ImageExtractor;
import com.mindee.parsing.common.PredictResponse;
import com.mindee.parsing.common.Page;
import com.mindee.product.multireceiptsdetector.MultiReceiptsDetectorV1;
import com.mindee.product.multireceiptsdetector.MultiReceiptsDetectorV1Document;
import com.mindee.product.receipt.ReceiptV5;
import java.io.File;
import java.io.IOException;
import java.util.List;
public class AutoMultiReceiptExtractionExample {
private static final String API_KEY = "my-api-key";
private static final MindeeClient mindeeClient = new MindeeClient(API_KEY);
public static void main(String[] args) throws IOException, InterruptedException {
String myFilePath = "/path/to/the/file.ext";
//...
}
}
using Mindee;
using Mindee.Extraction;
using Mindee.Input;
using Mindee.Product.MultiReceiptsDetector;
using Mindee.Product.Receipt;
var myFilePath = "path/to/my/file.ext";
var mindeeClient = new MindeeClient("my-api-key");
var inputSource = new LocalInputSource(filePath);
var resutlSplit = await mindeeClient.ParseAsync<MultiReceiptsDetectorV1>(inputSource).ConfigureAwait(false);
var imageExtractor = new ImageExtractor(inputSource);
foreach (var page in resutlSplit.Document.Inference.Pages)
{
var subImages = imageExtractor.ExtractImagesFromPage(
page.Prediction.Receipts, page.Id);
//...
}
for idx, receipt in enumerate(extracted_receipts, 1):
result_receipt = mindee_client.parse(product.ReceiptV5, receipt.as_source())
print(f"Receipt {idx}:")
print(result_receipt.document)
print("-" * 40)
# Uncomment to save each extracted receipt
# save_path = f"./receipt_{idx}.pdf"
# receipt.save_to_file(save_path)
<?php
foreach ($totalExtractedReceipts as $receipt) {
// Optional: save the extracted receipts to a file
// $receipt->writeToFile("output/path");
$result = $client->parse(ReceiptV5::class, $receipt->asInputSource());
echo $result->document . "\n";
}
images.each do |sub_image|
# Optional: Save the files locally
# sub_image.write_to_file("/path/to/my/extracted/file/folder")
result_receipt = mindee_client.parse(
sub_image.as_source,
Mindee::Product::Receipt::ReceiptV5,
close_file: false
)
puts result_receipt.document
end
for (ExtractedImage subImage : subImages) {
// Optionally: write to a file
// subImage.writeToFile("/path/to/my/extracted/file/folder");
PredictResponse<ReceiptV5> resultReceipt =
mindeeClient.parse(ReceiptV5.class, subImage.asInputSource());
System.out.println(resultReceipt.getDocument().toString());
}
foreach (var subImage in subImages)
{
// subImage.WriteToFile($"/path/to/my/extracted/file/folder"); // Optionally: write to a file
var resultReceipt = await mindeeClient.ParseAsync<ReceiptV5>(subImage.AsInputSource()).ConfigureAwait(false);
Console.WriteLine(resultReceipt.Document);
}
import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.extraction.ExtractedImage;
import com.mindee.extraction.ImageExtractor;
import com.mindee.parsing.common.PredictResponse;
import com.mindee.parsing.common.Page;
import com.mindee.product.multireceiptsdetector.MultiReceiptsDetectorV1;
import com.mindee.product.multireceiptsdetector.MultiReceiptsDetectorV1Document;
import com.mindee.product.receipt.ReceiptV5;
import java.io.File;
import java.io.IOException;
import java.util.List;
public class AutoMultiReceiptExtractionExample {
private static final String API_KEY = "my-api-key";
private static final MindeeClient mindeeClient = new MindeeClient(API_KEY);
public static void main(String[] args) throws IOException, InterruptedException {
String myFilePath = "/path/to/the/file.ext";
processMultiReceipts(myFilePath);
}
private static void processMultiReceipts(String filePath) throws IOException, InterruptedException {
LocalInputSource inputSource = new LocalInputSource(new File(filePath));
PredictResponse<MultiReceiptsDetectorV1> resultSplit =
mindeeClient.parse(MultiReceiptsDetectorV1.class, inputSource);
ImageExtractor imageExtractor = new ImageExtractor(inputSource);
for (Page<MultiReceiptsDetectorV1Document> page : resultSplit.getDocument().getInference().getPages()) {
List<ExtractedImage> subImages = imageExtractor.extractImagesFromPage(
page.getPrediction().getReceipts(),
page.getPageId()
);
for (ExtractedImage subImage : subImages) {
// Optionally: write to a file
// subImage.writeToFile("/path/to/my/extracted/file/folder");
PredictResponse<ReceiptV5> resultReceipt =
mindeeClient.parse(ReceiptV5.class, subImage.asInputSource());
System.out.println(resultReceipt.getDocument().toString());
}
}
}
}
using Mindee;
using Mindee.Extraction;
using Mindee.Input;
using Mindee.Product.MultiReceiptsDetector;
using Mindee.Product.Receipt;
var myFilePath = "path/to/my/file.ext";
var mindeeClient = new MindeeClient("my-api-key");
async Task processReceipts(string filePath)
{
var inputSource = new LocalInputSource(filePath);
var resutlSplit = await mindeeClient.ParseAsync<MultiReceiptsDetectorV1>(inputSource).ConfigureAwait(false);
var imageExtractor = new ImageExtractor(inputSource);
foreach (var page in resutlSplit.Document.Inference.Pages)
{
var subImages = imageExtractor.ExtractImagesFromPage(page.Prediction.Receipts, page.Id);
foreach (var subImage in subImages)
{
// subImage.WriteToFile($"/path/to/my/extracted/file/folder"); // Optionally: write to a file
var resultReceipt = await mindeeClient.ParseAsync<ReceiptV5>(subImage.AsInputSource()).ConfigureAwait(false);
Console.WriteLine(resultReceipt.Document);
}
}
}
await processReceipts(myFilePath).ConfigureAwait(false);
