- Getting Started
- Framework Components
- Taxonomy Overview
- Taxonomy Manager
- Taxonomy Related Activities
- Document Understanding in AI Center
- Pipelines
- ML Packages
- Data Manager
- OCR Services
- Licensing
- References
Taxonomy Overview
The Taxonomy is the metadata that the Document Understanding framework considers in each of its steps.
A Taxonomy is a collection of Document Types.
- A Document Type is the definition of a logical type of document, different business processes must handle that. Examples of Document Types are Invoices, Medical Records, IRS Forms W-2, Contracts, etc. A document type, besides a name, group, and category (for easier handling), usually contains a collection of Fields.
- A Field is one piece of information that is expected to be found and captured from a specific Document Type.
As seen above, a Taxonomy is a hierarchical structure that contains the schema of the information the Document Understanding framework will use throughout. Each entity definition (for document types or fields) found in the Taxonomy has a unique ID.
If you want to classify incoming files into different document types, then the taxonomy should contain the document types you want to specifically treat. These will allow you to configure your document understanding processes based on a uniform data schema: the structure of your taxonomy.
If you want to extract data from certain document types, then the taxonomy will contain the list of fields that you are targeting for automatic data extraction. These will allow the configuration of various extraction methods and rules, again, based on a single source of truth data schema: the structure of your document type.
A Field may have derived parts: formatted information extracted or edited from the underlying textual value found in a document.
|
Field Type |
Allows Multi-Value |
Purpose |
Derived Parts for Formatting |
Additional Information |
|---|---|---|---|---|
|
Text |
Yes |
Textual information |
N/A |
N/A |
|
Number |
Yes |
Numeric values |
|
N/A |
|
Date |
Yes |
Dates |
|
N/A |
|
Name |
Yes |
Person names |
|
N/A |
|
Address |
Yes |
Addresses |
|
N/A |
|
Set |
Yes |
Information that has strict reported values from a predefined set |
N/A |
A Set field must define the allowed options as values. These are reflected in the Validation Station. |
|
Boolean |
Yes |
Yes/No values |
N/A |
A Boolean field can only have Yes or No as possible values, and is reflected in the Validation Station. |
|
Table |
No |
Tabular data |
N/A |
A Table field contains the definition of the columns. |
|
Table Column |
No |
Each cell in the table. |
N/A |
Table Columns in a Table field are defined as one of the regular fields in the Components list. They cannot be of Table type. |
und) is recommended to be added, to support exceptional cases.
DocumentTaxonomy object, the Serialize() method returns a JSON representation of the object, so that it can be stored and retrieved for later usage.
DocumentTaxonomy.Deserialize(jsonString) static extension returns a DocumentTaxonomy object, hydrated with the JSON encoded data passed as a parameter.
Once the UiPath.IntelligentOCR.Activities package is installed in your project in UiPath Studio, a Taxonomy Manager button appears in the main ribbon of Studio's Design tab. Use the Taxonomy Manager wizard to edit your project taxonomy.
taxonomy.json file.
The file is automatically created when you first open the Taxonomy Manager wizard. You can see the exact location of the file in the Taxonomy Manager, by hovering over the 
button. Alternatively, each time you open the Taxonomy Manager, a pop-up message will appear in the upper right corner, informing you of the location of the file. When a project is published
from Studio, the taxonomy will be published as well as an artifact of the project.
taxonomy.json file is unique to each project, but it can be reused if you manually copy it over to a new project. To do so, you must simply
create a new project, then go to the project folder and copy the file with the taxonomy of your choice in the right location
(in the DocumentProcessing folder).
The taxonomy for document understanding is required as an Object throughout the Document Understanding framework.
The simplest and most convenient way to load your object is by using the Load Taxonomy activity. Once your taxonomy object is loaded, you can use it in all subsequent framework components requiring it.
-
If you choose to store your taxonomy in a different location, you can still load it in your project (once you obtain the string content of the taxonomy file, let's say in a
myTaxonomyContentStringvariable), by using a simple Assign activity, as follows:myTaxonomy = DocumentTaxonomy.Deserialize(myTaxonomyContentString) - If your use case demands it, remember the Taxonomy is a POCO (plain old class object) that, when needed, can be edited even at run-time.
- What Is a Taxonomy
- How Does It Help in Document Classification?
- How Does It Help in Data Extraction?
- Field Types and Details
- Other Information Captured in the Taxonomy
- Taxonomy Extension Methods
- Serialize()
- Deserialize(String)
- GetFields(String)
- How to Create and Edit Your Project's Taxonomy
- How to Use Your Taxonomy Within Your Project
- Advanced Use Cases
