custom_parser.md

NOTE This guide is intended for engineers extending smart-docs-parser for their custom use-case. If you think this could be benificial to the community then please contribute to smart-docs-parser source-code using the generic guide here.

Usage

Code

// ES6 import statement
import SmartDocuments from 'smart-docs-parser';

// Sample Request
const extractedDocumentDetails = await SmartDocuments.extractDocumentDetailsFromImage({
    document_url: 'https://avatars2.githubusercontent.com/u/20634933?s=40&v=4',
    document_type: 'your-document-type',
    ocr_library: 'google-vision',
    custom_parser_path: '/path/to/parser_file.js'
});

Parser Implementation

/path/to/parser_file.js

Module

Your parser should expose a function called parseDocumentDetails

// ******************************************************* //
// Logic for API handlers starts here                      //
// ******************************************************* //
const parseDocumentDetails  = ({ raw_text: rawText }) => {
  ....
  ....
  ....
  return {
    is_document_valid: true,
    document_details: parsedDetails
  };
};
// ******************************************************* //
// Logic for API handlers ends here                        //
// ******************************************************* //

module.exports = { parseDocumentDetails };

Request

Your parser should accept { raw_text: Array<string>} as input.

Response

Your parser should return { is_document_valid: boolean, document_details: object } as output.

Example

Please refer to sample_parser.js