Subscribe

UiPath Document Understanding

UiPath Document Understanding

Taxonomy Manager

The Taxonomy Manager can be used to create and edit a Taxonomy file specific to your current automation project. This Taxonomy file contains user-defined document types, sorted by Groups and Categories.

You can further use the Taxonomy file by converting it into a .NET data type with the Load Taxonomy activity, and then passing it as input for activities such as:

The Taxonomy Manager can be accessed only after installing a UiPath.IntelligentOCR.Activities package higher or equal to v1.6.0 as a dependency for your project. Once the package is installed, a Taxonomy Manager button appears on the Ribbon, in the Wizards section.

Using Taxonomy Manager

The Taxonomy Manager window lets you create document types, sorted by groups and categories. When opened for the first time in a project, no groups, categories, or document types are defined.

The first step is to create a group and a category for the document type you want to create. This is done by using the Add Group button next to the Any Group drop-down. Once you have chosen a name for your group, you can save it by using the Save button or by simply hitting Enter.

Once a group is defined, the Add Category button appears next to the Any Category drop-down. By using the same steps as above, you can create a category.

You can Edit the name of any group or category that you have created. This can be done by selecting one of the groups or categories and clicking on the Edit Group button.

Groups and categories can also be deleted. This can be done by clicking on the Remove Group button. A popup is displayed asking you to confirm the deleting action. Click Yes to approve the action.

Once the group and category are defined, we can move on to creating the Document Type. This can be done by clicking the Add New Document Type button. Doing this displays the Document Type Details tab, which enables you to choose a name, a group, a category, and a document type code, as well as add fields to the document type.

Clicking the New Field button displays the Edit Field tab, which lets you choose a name for the field, specify whether it is multi-value (Is Multi-Value) or if it allows for values with no evidence in the document to be processed (Requires Reference), and choose its type.

The available field types are:

  • Text
  • Number
  • Date - Choosing this type also lets you specify an expected format, which is optional.

📘

Note:

If you want to add an expected format, use an MSDN-compliant format.
This format may be used by extractors and is used by the Data Extraction Scope activity when trying to parse a Date into its constituent Day, Month, and Year parts.

  • Name
  • Address
  • Keyword
  • Set - Choosing this type lets you add multiple values to the field.
  • Boolean
  • Table - Choosing this type lets you edit the structure of the table, as you can add columns and edit their name and type.

Once you have configured your field accordingly, clicking Save closes the Edit Field tab and adds the field in the Document Type Details tab. You can repeat this action multiple times, adding as many fields as you need.

Created fields can be edited by clicking them in the Document Type Details tab, and they can also be deleted and reordered by using the buttons that appear next to them when hovered.

Once the Document Type configuration is complete, clicking Save closes the Document Type Details tab and displays the newly created document type in the main tab.

Retracing these steps, you can create multiple groups, categories, and document types, which you can then sort by using the Search by name field.

Once a document type is saved, a Document Type ID is generated for it. Opening the document for editing displays the ID in the Document Type Details tab. The Document Type ID has a structure of the type Group.Category.Document.

📘

Note:

The changes you make in the Taxonomy Manager are automatically saved into the taxonomy.json file specific to your project. Once a Document Type is created, simply closing the wizard is enough to save your changes.

Updated 25 days ago


Taxonomy Manager


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.