caruccio/Cloudmersive.APIClient.PHP.OCR

PHP API Client for Cloudmersive OCR APIs

cloudmersive_ocr_api_client

The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.

Cloudmersive OCR API provides advanced machine learning capabilities for converting scanned documents and photos of documents and receipts to text.

• API version: v1
• Package version: 3.0.3

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cloudmersive/cloudmersive_ocr_api_client.git"
    }
  ],
  "require": {
    "cloudmersive/cloudmersive_ocr_api_client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_ocr_api_client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\ImageOcrApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$image_file = "/path/to/file.txt"; // \SplFileObject | Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.
$language = "language_example"; // string | Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
$preprocessing = "preprocessing_example"; // string | Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).

try {
    $result = $apiInstance->imageOcrImageLinesWithLocation($image_file, $language, $preprocessing);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageOcrApi->imageOcrImageLinesWithLocation: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
ImageOcrApi	imageOcrImageLinesWithLocation	POST /ocr/image/to/lines-with-location	Convert a scanned image into words with location
ImageOcrApi	imageOcrImageWordsWithLocation	POST /ocr/image/to/words-with-location	Convert a scanned image into words with location
ImageOcrApi	imageOcrPhotoRecognizeBusinessCard	POST /ocr/photo/recognize/business-card	Recognize a photo of a business card, extract key business information
ImageOcrApi	imageOcrPhotoRecognizeForm	POST /ocr/photo/recognize/form	Recognize a photo of a form, extract key fields and business information
ImageOcrApi	imageOcrPhotoRecognizeFormAdvanced	POST /ocr/photo/recognize/form/advanced	Recognize a photo of a form, extract key fields using stored templates
ImageOcrApi	imageOcrPhotoRecognizeReceipt	POST /ocr/photo/recognize/receipt	Recognize a photo of a receipt, extract key business information
ImageOcrApi	imageOcrPhotoToText	POST /ocr/photo/toText	Convert a photo of a document into text
ImageOcrApi	imageOcrPhotoWordsWithLocation	POST /ocr/photo/to/words-with-location	Convert a photo of a document or receipt into words with location
ImageOcrApi	imageOcrPost	POST /ocr/image/toText	Convert a scanned image into text
PdfOcrApi	pdfOcrGetAsyncJobStatus	GET /ocr/pdf/get-job-status	Returns the result of the Async Job - possible states can be STARTED or COMPLETED
PdfOcrApi	pdfOcrPdfToLinesWithLocation	POST /ocr/pdf/to/lines-with-location	Convert a PDF into text lines with location
PdfOcrApi	pdfOcrPdfToWordsWithLocation	POST /ocr/pdf/to/words-with-location	Convert a PDF into words with location
PdfOcrApi	pdfOcrPost	POST /ocr/pdf/toText	Converts an uploaded PDF file into text via Optical Character Recognition.
PreprocessingApi	preprocessingBinarize	POST /ocr/preprocessing/image/binarize	Convert an image of text into a binarized (light and dark) view
PreprocessingApi	preprocessingBinarizeAdvanced	POST /ocr/preprocessing/image/binarize/advanced	Convert an image of text into a binary (light and dark) view with ML
PreprocessingApi	preprocessingGetPageAngle	POST /ocr/preprocessing/image/get-page-angle	Get the angle of the page / document / receipt
PreprocessingApi	preprocessingUnrotate	POST /ocr/preprocessing/image/unrotate	Detect and unrotate a document image
PreprocessingApi	preprocessingUnrotateAdvanced	POST /ocr/preprocessing/image/unrotate/advanced	Detect and unrotate a document image (advanced)
PreprocessingApi	preprocessingUnskew	POST /ocr/preprocessing/image/unskew	Detect and unskew a photo of a document
ReceiptsApi	receiptsPhotoToCSV	POST /ocr/receipts/photo/to/csv	Convert a photo of a receipt into a CSV file containing structured information from the receipt

Documentation For Models

• BusinessCardRecognitionResult
• FieldResult
• FormDefinitionTemplate
• FormFieldDefinition
• FormRecognitionResult
• FormTableColumnDefinition
• FormTableDefinition
• GetPageAngleResult
• ImageToLinesWithLocationResult
• ImageToTextResponse
• ImageToWordsWithLocationResult
• OcrLineElement
• OcrPageResult
• OcrPageResultWithLinesWithLocation
• OcrPageResultWithWordsWithLocation
• OcrPhotoTextElement
• OcrWordElement
• PdfToLinesWithLocationResult
• PdfToTextResponse
• PdfToWordsWithLocationResult
• PhotoToWordsWithLocationResult
• Point
• ReceiptLineItem
• ReceiptRecognitionResult
• TableCellResult
• TableResult
• TableRowResult

Documentation For Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header

Author