Documentation
Log inGet started

Getting Started

Suggest Edits

This guide will help you get started with the Mindee PHP OCR SDK to easily extract data from your documents.

The PHP OCR SDK supports invoice, passport, receipt OCR APIs and custom-built API from the API Builder.

You can view the source code on GitHub, and the package on PyPI.

Prerequisite

  • Download and install PHP. This library is officially supported on PHP 7.4 to 8.2.
  • Download and install Composer.

Installation

To quickly get started with the PHP OCR SDK anywhere, the preferred installation method is via composer.

composer require mindee/mindee

Development Installation

If you'll be modifying the source code, you'll need to install the development requirements to get started.

  1. First clone the repo.
git clone [email protected]:mindee/mindee-api-php.git
  1. Then navigate to the cloned directory and install all development requirements.
cd mindee-api-php
composer install

Updating the Version

It is important to always check the version of the Mindee OCR SDK you are using, as new and updated features won’t work on old versions.

To check the installed version:

composer show mindee/mindee

To get the latest version:

composer require mindee/mindee

To install a specific version:

composer require mindee/mindee:<your_version>

Usage

To get started with Mindee's APIs, you need to create a Client and you're ready to go.

Let's take a deep dive into how this works.

Initializing the Client

The Client centralizes document configurations in a single object.

The Client requires your API key.

You can either pass these directly to the constructor or through environment variables.

Pass the API key directly

<?php
use Mindee\Client;

// Init a new client
$mindeeClient = new Client("my-api-key");

Set the API key in the environment

API keys should be set as environment variables, especially for any production deployment.

The following environment variable will set the global API key:

MINDEE_API_KEY="my-api-key"

Then in your code:

use Mindee\Client;

// Init a new client
$mindeeClient = new Client();

Setting the Request Timeout

The request timeout can be set using an environment variable:

MINDEE_REQUEST_TIMEOUT=200

Loading a Document File

Before being able to send a document to the API, it must first be loaded.

You don't need to worry about different MIME types, the library will take care of handling
all supported types automatically.

Once a document is loaded, interacting with it is done in exactly the same way, regardless
of how it was loaded.

There are a few different ways of loading a document file, depending on your use case:

Path

Load from a file directly from disk. Requires an absolute path, as a string.

$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

File Object

A normal PHP file object. Must be in binary mode.

$myFile = file("/path/to/the/file.ext");
$inputSource = $mindeeClient->sourceFromFile($myFile);

Base64

Requires a base64 encoded string.

Note: The original filename is required when calling the method.

$b64String = "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLD....";
$inputSource = $mindeeClient->sourceFromB64($b64String, "receipt.jpg");

Bytes

Requires raw bytes.

Note: The original filename is required when calling the method.

$rawBytes = b"%PDF-1.3\n%\xbf\xf7\xa2\xfe\n1 0 ob...";
$inputSource = $mindeeClient->sourceFromBytes($rawBytes, "receipt.jpg");

URL

Allows sending a URL directly.

$remoteInputSource = $mindeeClient->sourceFromUrl("https://www.example.com/invoice.pdf");

Note: The server will reject files behind a private URL or a redirection, so you can also download those file into
a byte object before loading them as a local input source.

This also allows you to apply transformations to files before sending them.

$remoteInputSource = $mindeeClient->sourceFromUrl("https://www.example.com/invoice.pdf");
$localInputSource = $remoteInputSource->asLocalInputSource();

Sending a File

To send a file to the API, we need to specify how to process the document.
This will determine which API endpoint is used and how the API return will be handled internally by the library.

More specifically, we need to set a Mindee\Product class as the first parameter of the parse method.

This is because the parse method's return type depends on its first argument.

Product classes inherit from the base Mindee\Parsing\Common\Inference class.

More information is available in each document-specific guide.

Off-the-Shelf Documents

Simply setting the correct class and passing the input document is enough:

$result = $mindeeClient->parse(InvoiceV4::class, $inputSource);

Custom Documents (docTI & Custom APIs)

The endpoint to use must be created beforehand and subsequently passed to the endpoint argument of the enqueueAndParse method:

// Create a custom endpoint
$customEndpoint = $mindeeClient->createEndpoint(
    "my-endpoint",
    "my-account",
//  "my-version" // Optional
);

// Add the custom endpoint to the prediction options.
$predictOptions = new PredictMethodOptions();
$predictOptions->setEndpoint($customEndpoint);

// Parse the file
$apiResponse = $mindeeClient->enqueueAndParse(GeneratedV1::class, $inputSource, $predictOptions);

This is because the GeneratedV1 class is enough to handle the return processing, but the actual endpoint needs to be specified.

Processing the Response

Results of a prediction can be retrieved in two different places:

Document Level Prediction

The document attribute is an object specific to the type of document being processed.
It is an instance of the Document class, to which a generic type is given.

It contains the data extracted from the entire document, all pages combined.
It's possible to have the same field in various pages, but at the document level only the highest confidence field data will be shown (this is all done automatically at the API level).

Usage:

echo $result->document;

A document's fields (attributes) can be accessed through it's prediction attribute, which have types that can vary from one product to another.
These attributes are detailed in each product's respective guide.

Page Level Prediction

The pages attribute is a list of Page objects. Page is a wrapper around elements that extend the Document class.
The prediction of a Page inherits from the product's own Document, and adds all page-specific fields to it.

The order of the elements in the list matches the order of the pages in the document.

All response objects have a pages property, regardless of the number of pages.
Single-page documents will have a single entry.

Iteration over pages is done like with any list, for example:

foreach ($response->pages as $page){
    echo $page;
}

Questions?

Join our Slack

Updated 8 days ago