aws-textract-helper
v1.0.0-beta.5
Published
Library for creating forms and tables from Amazon Textract responses
Downloads
1,077
Readme
AWS Textract Helper
This is a JavaScript library that provides an easy to use methods for extracting structured data from Amazon Textract APIs.
Prerequisites
You need to have a basic knowledge of AWS and Textract APIs. For a quick introduction, please refere to this article and repository example to help you getting started.
Installation
npm i aws-textract-helper
Documentation
| Method | Description | | ------------- | ------------- | | createForm | Analyze blocks returned by Textract and creates a key-value object that represents a form in an image | | createTables | Analyze blocks returned by Textract and creates an array of tables that represents all the tables in an image |
Examples
Create a form
const textractHelper = require('aws-textract-helper')
const form = textractHelper.createForm(dataFromTextract)
It will analyze all blocks and return a JSON object representing a form
{
"First Name": "Muhi",
"Last Name": "Masri",
"Address": "Planet Earth"
}
Create tables
const textractHelper = require('aws-textract-helper')
const tables = textractHelper.createTables(dataFromTextract)
It will analyze all blocks and return an array of tables
[{
"1": {
"1": "Memberld",
"2": "First Name",
"3": "Last Name",
"4": "Address"
},
"2": {
"1": "111",
"2": "Muhi",
"3": "Masri",
"4": "Planet Earth"
},
"3": {
"1": "222",
"2": "John",
"3": "Smith",
"4": "Planet Mars"
}
}]
Extra options
You can use a trimChar config option to remove unwanted characters in form keys such as a colon or extra spaces
const form = textractHelper.createForm(dataFromTextract, { trimChars: [':', ' '] })