Parse Data with the Document Analyzer - Python

This tutorial shows how to retrieve data from an unstructured document in a Python Console application using the LEADTOOLS SDK.

The data is extracted using a ruleset defined in a JSON file paired with the LEADTOOLS Document Analyzer.

Required Knowledge

Get familiar with the basic steps of creating a project by reviewing the Add References and Set a License tutorial, before working on the Parse Data Using Document Analyzer - Python tutorial.

Create the Project and Add LEADTOOLS References

Start with a copy of the project created in the Add References and Set a License tutorial. If the project is not available, follow the steps in that tutorial to create it.

The references needed depend upon the purpose of the project.

This tutorial requires the following DLLs:

• Leadtools.dll
• Leadtools.Document.dll
• Leadtools.Document.Analytics.dll
• Leadtools.Document.Unstructured.dll
• Leadtools.Ocr.dll

For a complete list of which DLL files are required for your application, refer to Files to be Included with your Application.

Set the License File

The License unlocks the features needed for the project. It must be set before any toolkit function is called. For details, including tutorials for different platforms, refer to Setting a Runtime License.

There are two types of runtime licenses:

• Evaluation license, obtained at the time the evaluation toolkit is downloaded. It allows the toolkit to be evaluated.
• Deployment license. If a Deployment license file and developer key are needed, refer to Obtaining a License.

Add the Code to Parse Unstructured Document Data

With the project created, the references added, and the license set, coding can begin.

In the Solution Explorer, open Project-Name.py and place the following references below the "Add references to LEADTOOLS" comment

# Add references to LEADTOOLS 
from leadtools import LibraryLoader 
LibraryLoader.add_reference("Leadtools") 
from Leadtools import * 
LibraryLoader.add_reference("Leadtools.Document") 
from Leadtools.Document import * 
LibraryLoader.add_reference("Leadtools.Document.Analytics") 
from Leadtools.Document.Analytics import * 
LibraryLoader.add_reference("Leadtools.Document.Unstructured") 
from Leadtools.Document.Unstructured import * 
LibraryLoader.add_reference("Leadtools.Ocr") 
from Leadtools.Ocr import * 
from Leadtools.Document.Data import * 

Add a new method named analyze_document(ruleset, input_file). Call the new method in the main() method as seen below:

def main(): 
 
    Support.set_license(os.path.join(DemosTools.get_root(), "C:/LEADTOOLS23/Support/Common/License")) 
 
    ruleset = r"C:\LEADTOOLS23\Resources\Images\Forms\Unstructured\MedicareCard.json" 
    input_file = r"C:\LEADTOOLS23\Resources\Images\Forms\Unstructured\MedicareCard.png" 
 
    analyze_document(ruleset, input_file) 

Add the following code to the analyze_document() method to initialize the IOcrEngine, load the unstructured document, and display the extracted data to the console using the DocumentAnalyzer class.

def analyze_document(ruleset, input_file): 
 
    ocr_engine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD) 
    ocr_engine.Startup(None, None, None, "C:\LEADTOOLS23\Bin\Common\OcrLEADRuntime") 
 
    document = DocumentFactory.LoadFromFile(input_file, LoadDocumentOptions()) 
    document.Text.OcrEngine = ocr_engine 
 
    # Create Analyzer 
    analyzer = DocumentAnalyzer() 
    analyzer.Reader = UnstructuredDataReader() 
    analyzer.QueryContext = FileRepositoryContext(ruleset) 
 
    options = DocumentAnalyzerRunOptions() 
    options.ElementQuery = RepositoryQuery() 
 
    results = analyzer.Run(document, options) 
    for result in results: 
        for item in result.Items: 
            print(item.Value) 

Run the Project

Run the project by pressing F5, or by selecting Debug -> Start Debugging.

If the steps were followed correctly, the console appears and the application displays the extracted data from an unstructured document. For the purposes of this tutorial, the below sample files were used for testing.

• Sample Document: <INSTALL_DIR>\LEADTOOLS23\Resources\Images\Forms\Unstructured\MedicareCard.png

• Sample Ruleset JSON: <INSTALL_DIR\LEADTOOLS23\Resources\Images\Forms\Unstructured\MedicareCard.json>

  

Wrap-up

This tutorial showed how to extract and display information about the unstructured document utilizing the DocumentAnalyzer with a JSON ruleset.

See Also

• LEADTOOLS IOcrEngine Documentation
• LEADTOOLS LEADDocument Documentation
• LEADTOOLS DocumentAnalyzer Documentation
• LEADTOOLS DocumentAnalyzerRunOptions Documentation
• LEADTOOLS SDK Download