README

Simple AWS Textract (OCR Software, Data Extraction Tool) wrapper for Laravel

Features

Analyze Document
Analyze ID card
Analyze Invoice
Query-based extraction
Signature detection

Installation

You can install the package via composer:

composer require franckitho/laravel-aws-textract

You can publish the config file with:

php artisan vendor:publish --tag="laravel-aws-textract-config"

This is the contents of the published config file:

return  [
    'region' => env('AWS_REGION', 'us-east-1'),
    'version' => env('AWS_TEXTRACT_VERSION', 'latest'),
    'credentials' => [
        'key' => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
    ],
];

Usage

With local file or url

use franckitho\Textract\AnalyseDocument;

$document = AnalyseDocument::features('LAYOUT')->file('path/to/file')->analyze();

With S3 Bucket (need S3 permission)

use franckitho\Textract\AnalyseDocument;

$document = AnalyseDocument::features('LAYOUT')->s3('bucket', 'file')->analyze();

For showing metadata

use franckitho\Textract\AnalyseDocument;

$document = AnalyseDocument::features('LAYOUT')->file('path/to/file')->withMetaData()->analyze();

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

franckitho / laravel-aws-textract

Maintainers

Details