Automatically generate synthetic semi-structured documents (SSDs)

Generate semi-structured documents (invoices, payslips, and receipts). This repo is a Java implementation of the two papers mentioned in the acknowledgments.

_{Actual generated examples do not have blurring}

Automatically generate synthetic semi-structured documents (SSDs)
- Setup
- Running SSD generation

Setup

Download resources

Download common.zip, unzip and place under src/main/resources

Or download using gdown then unzip into the required path.

pip install gdown  # inside a python virtual or conda environment
gdown 1h6h5fSmRbCjMfanVFDWY03GOq-R4NZJS
unzip common.zip -d src/main/resources/
rm common.zip

Docker (Recommended)

Setup docker in the local system.

bash scripts/build_docker.sh
bash scripts/run_docker.sh -p EXPOSED_HTTP_PORT

Generating SSDs

The API will be hosted at http://localhost:EXPOSED_HTTP_PORT/api/ws/ that can be accessed with a default username: admin and password: admin.

Generate the desired SSD with the Generate Content button and refresh the page after a while. The generated documents will appear on the page.

The documents are also bulk saved in the generated_data/classes/invoices/sample directory which is created after running the docker container.

Local build

Requirements

Java Development Kit 11/12/13/14/15
Maven 3.8.6

Tested on MacOS Big Sur 11.6. The repository should function in Linux systems as well. Recommended to install from archived tar.gz files available from https://www.oracle.com/java/technologies/java-se-glance.html for JDK files and https://maven.apache.org/download.cgi for Maven.

Add the following the bash or the current editor profile/rc files.

# add java paths
export JAVA_HOME="/Users/jdk-15.0.1.jdk/Contents/Home"
export PATH="$PATH:$JAVA_HOME/bin"
# add apache maven paths
export M2_HOME="/Users/apache-maven-3.8.6"
export PATH="$PATH:${M2_HOME}/bin"

Running SSD generation

Web API Generation

Generate these documents via the API web interface by launching:

mvn quarkus:dev

The API will be hosted at http://localhost:9080/api/ws/ which can be accessed with a default username: admin and password: admin.

Testing and Generating SSDs

Maven Test

To run all the tests with Maven and generate example SSDs.

mvn test

To run tests for a particular test file inside src/test/java/com/ssdgen/generator/documents and generate the desired number of SSDs:

mvn test -Dtest=TestAmazonLayout
mvn test -Dntests=2  # Only run two tests and generate two examples for each layout
mvn test -Dtest=TestAmazonLayout -Dntests=2  # generate two examples for Amazon Layout

Diversity evaluation (Currently Disabled)

We can evaluate the diversity of the locally generated SSD datasets using 4 metrics:

Alignment, overlapping, SCR_score, and SELF-BLEU :
    TestDiversityLaunch

Annotations in Invoices GEDI File

Invoice Number - IN
Seller(Company) name - SN
Seller Address - SA
Seller Vat Number/TVA- SVAT
Seller Identifier Number(Siren) - SCID
Seller Siret - SSIRET
Seller TOA/APE - STOA
Seller RCS - SRCS
Seller Website - SWEB
Seller Email - SEMAIL
Seller Contact Number - SCN
Seller Fax Number - SFAX
E-commerce Platform Name(Like Amazon, Ebay, ...) - EN
E-commerce Platform Website - EWEB
E-commerce Order Reference - EOID
- Invoice Date - IDATE
- Tax Point Date (date of supply) - TPDATE
- Billing Name - BN
- Billing Address - BA
- Billing Contact Number - BCN
- Shipping Name - SHN
- Shipping Address - SHA Shipping Contact Number -SHCN
- Table (and its content) -TBL
- Client Number - CNUM
- Order Number - ONUM
- Payment Mode - PMODE
- Rest words - undefined

Development Support

Generating your own invoices and other SSDs with custom data.

Invoice
- Currency, Country, Language
- Country Addresses
  - Address CSV files acquired from https://results.openaddresses.io/
- Client Info: Bill To, Ship To
- Company Info
  - Required Fields for company info CSV file
    - name: Sign or name of the operation
    - address_l1: Address line 1
    - address_l2: Address line 2
    - postal_code
    - city Town/Municipality where the establishment
    - country: Country of the establishment
  - companies_ar.csv and companies_us.csv generated from 7-million Company Dataset. Postcodes were randomly generated from the Faker library
  - The French Companies Sirene Dataset csv format requires the same fields as above but named ENSEIGNE, L4_NORMALISEE, L5_NORMALISEE, CODPOS, LIBCOM, L7_NORMALISEE,
- Contact Info: Telephone, Fax
  - The Fields must be present in the Company Info CSV file
- ID Num Info: Tax Num
- Invoice Dates
- Invoice Numbers: Client, Invoice Num
- Logo Generation
  - JSON file
- Product Item Fields
- 1st Signatures dataset from Kaggle
- 2nd Signatures dataset from IEEE dataport
Payslip Specific
- Payment Info
- Payslip Date
Receipt Specific
- Product Receipt Fields
- Receipt Date

Relevant Structure & Information for Invoice Generation

Note: Files related to receipt and payslips are ignored

Under src/main/java/com/ssdgen/generator

  ├── Main.java
  ├── api
  │   └── WorkspaceResource.java     # Set Web API endpoints i.e. generate, delete or download SSDs
  ├── documents
  │   ├── InvoiceGenerator.java      # Invoice SSD entry point, build invoice layout, save XML, save JSON, save image
  │   ├── common
  │   │   └── VerifCharEncoding.java (For verifying ANSI Encoding & remove non ANSI chars)
  │   ├── data (Data classes to populate the layouts)
  │   │   ├── generator              # Master generation controls i.e. Country, Language, Locale, and Currency
  │   │   ├── helper                 # Utility classes
  │   │   └── model                  # Contains data classes for populating layouts
  │   │       ├── Address.java               # Stores address line1, line2, line3, zip, city & country
  │   │       ├── Client.java                # Stores client Bill+Ship name, head, address & IDNumbers (TIN, TRN, VAT Number)
  │   │       ├── Company.java               # Stores company name, Address, ContactNumber, idNumbers, Logo, Signature
  │   │       ├── ContactNumber.java         # Stores phone & fax label and regex values
  │   │       ├── IDNumbers.java             # Stores VAT/TRN/TIN labels and values along with French siret and TOA ids
  │   │       ├── InvoiceAnnotModel.java     # Class to store annotations for invoices
  │   │       ├── InvoiceDate.java           # Invoice date, Order date, Ship date, Payment date, and Payment Due date along with heads
  │   │       ├── InvoiceModel.java          # High-level container for invoices
  │   │       ├── InvoiceNumber.java         # Invoice number, Order number & Client number along with heads
  │   │       ├── Logo.java                  # Stores logo for each Company in the resources
  │   │       ├── Model.java                 # Stores language, locale, payment info, company, configMaps, client, product container
  │   │       ├── PaymentInfo.java           # Payment term, type, bank details, account name, and number
  │   │       ├── Product.java               # Stores one Product item Quantity, Code, Price, Discount, Tax
  │   │       ├── ProductContainer.java      # Stores Table header labels: vat, disc & total labels
  │   │       ├── Signature.java             # Stores signatures
  │   │       ├── Stamp.java                 # Stores stamp that aligns with existing companies
  │   ├── element                    # Drawing, structure & layout class elements
  │   │   ├── BoundingBox.java               # base bounding box element with xmin, ymin, xmax, ymax
  │   │   ├── ElementBox.java                # Abstract class that is extended by all other layout elements
  │   │   ├── HAlign.java                    # HAlign LEFT, CENTER, RIGHT enums
  │   │   ├── Padding.java                   # Padding element
  │   │   ├── VAlign.java                    # VAlign TOP, CENTER, BOTTOM enums
  │   │   ├── border
  │   │   │   └── BorderBox.java     # rectangle box with border stroke and fill colors
  │   │   ├── container
  │   │   │   ├── HorizontalContainer.java   # horizontal container which can add other SimpleTextBox, ImageBox elements
  │   │   │   ├── LayeredContainer.java
  │   │   │   └── VerticalContainer.java     # vertical container which can add other SimpleTextBox, ImageBox elements
  │   │   ├── footer
  │   │   │   ├── FootCompanyBox.java        # contains company name, address and information to be displayed at page bottom
  │   │   │   ├── StampBox.java              # Contains the company logo stamp ImageBox higher level API
  │   │   ├── head
  │   │   │   ├── BillingInfoBox.java        # Contains client/buyer Billing name and address
  │   │   │   ├── ShippingInfoBox.java       # Contains client/buyer shipping name and address
  │   │   │   └── VendorInfoBox.java         # Contains vendor/seller name and address
  │   │   ├── image
  │   │   │   └── ImageBox.java              # Wraps stream drawImage but allows for top left xmin,ymin anchoring
  │   │   ├── line
  │   │   │   ├── HorizontalLineBox.java     # Horizontal line
  │   │   │   └── VerticalLineBox.java       # Vertical line
  │   │   ├── payment
  │   │   │   └── PaymentInfoBox.java        # Contains client payment name, address, & bank details
  │   │   ├── product
  │   │   │   ├── ProductTableBox.java       # Contains item table header permutations
  │   │   ├── table
  │   │   │   └── TableRowBox.java           # Primary element box for table rows, needs a float array for column widths
  │   │   └── textbox
  │   │       └── SimpleTextBox.java         # Base text box for writing and displaying any text
  │   └── layout                             # Specific Layouts
  │       ├── amazon (DONE)
  │       ├── bdmobilier (DONE)
  │       ├── cdiscount (DONE)
  │       ├── darty (DONE)
  │       ├── ldlc (DONE)
  │       ├── macomp (DONE)
  │       ├── materielnet (DONE)
  │       ├── naturedecouvertes (DONE)
  ├── job                             # For handling API jobs
  │   ├── JobManager.java
  │   ├── entity
  │   │   └── Job.java                      # Job class
  │   └── handler
  │       ├── InvoiceGenerationHandler.java # Actual invoice generation file for java quarkus web API
  │       ├── JobHandler.java
  └── workspace
      ├── WorkspaceManager.java             # API functions for load, purge, bootstrap & deletePath
      └── entity                            # Base classes for java quarkus web API

Acknowledgements

Original facogen repo https://github.com/fairandsmart/facogen. Re-initialized to remove tracking of large resources.
Belhadj, D., Belaïd, Y., & Belaïd, A. (2021, September). Automatic Generation of Semi-structured Documents. In International Conference on Document Analysis and Recognition (pp. 191-205). Springer, Cham.
Blanchard, J., Belaïd, Y., & Belaïd, A. (2019, September). Automatic generation of custom corpora for invoice analysis and recognition. In 2019 International Conference on Document Analysis and Recognition Workshops (ICDARW). IEEE.
Xavier Lefevre xavier.lefevre@fairandsmart.com / FairAndSmart
Nicolas Rueff nicolas.rueff@fairandsmart.com / FairAndSmart
Alan Balbo alan.balbo@fairandsmart.com / FairAndSmart
Frederic Pierre frederic.pierre@fairandsmart.com / FairAndSmart
Victor Guillaume victor.guillaume@fairandsmart.com / FairAndSmart
Jérôme Blanchard jerome.blanchard@fairandsmart.com / FairAndSmart
Aurore Hubert aurore.hubert@fairandsmart.com / FairAndSmart
Kevin Meszczynski kevin.meszczynski@fairandsmart.com / FairAndSmart

SamSamhuns / invoice_gen_java