JSON output

The following table describes various available output JSON file types. The Skill type column lists the skill types that can generate a particular type of JSON file.

File type Export option Description Skill type File name JSON schema
Fields (JSON) Values, metadata, and field structure for each document A file contaning classification results (if Classification skill was applied), full data extraction results (if Document skill was applied), rule errors, document and transaction registration parameters (if available), and other metadata.
  • Document
  • Classification
  • Process
<Applied_skill_name>.json * JSON schema
Values only A file containing field values and rule errors.
  • Document
  • Process
<Applied_skill_name>_fields.json * Depends on the Document skill used. Currently not available for download.
Text (JSON) Text only

This mode is suitable for extracting all text from the input image, including small text areas of low quality. The document appearance and structure are ignored, pictures and tables are not detected. It is designed for the situations when you need to retrieve the data from the image for some further processing on your side, such as extracting data from bills, receipts or invoices.

Selecting this mode makes export to DOCX and XLSX impossible.

OCR <First_source_file_name>.json ** OCR skill schema
Process <Applied_skill_name>_text.json *
Preserve document structure This mode is focused on retaining the original document structure and appearance, including font styles, pictures, background color, etc., and is more focused on documents like agreements, contracts, specifications. OCR <First_source_file_name>.json **
Process <Applied_skill_name>_text.json *

*<Applied_skill_name> will be one of the following:

  • The name of the skill if a transaction was created for a Document or Classification skill.
  • If a transaction was created for a Process skill:
    • the name of the last Document skill applied to the document
    • the name of the last Classification skill applied to the document if no Document skills were applied
    • "Unknown" if no Document and Classification skills were applied, while at least one of them exists in the Process skill flow.

**<First_source_file_name> will be the name of the first file used to assemble the document, e.g. "IMG_12234".

The Document skill always generates both Fields (JSON) files. Process skill settings allow you to select one Fields (JSON) file and/or one Text (JSON) file. OCR skill settings allow you to select one Text (JSON) file.

If a transaction fails, you can get information about the error in JSON format via the Vantage API. The JSON string contains information about the transaction, the error message, as well as names and identifiers of all source files in the transaction. This string will also be exported to the Error.json file in the output shared folder if you configure the Output activity of a Process skill accordingly.

12/22/2023 12:36:42 PM

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.