PREVIEW

Classify Document - Preview

UiPath.IntelligentOCR.StudioWeb.Activities.ClassifyDocument

Description

You can use this activity to classify documents, by selecting a desired classifier, and a document that you would like to classify.

Note: The Classify Document activity uses public endpoints.

Known limitations

The Generative Predefined project type and the corresponding extractors are not available in Automation Suite.

Project compatibility

Windows | Cross-platform

Configuration

Designer panel

• Input - Provide the input file or the Document Data object.
  Important: The maximum numbers of pages a file can have is 500. Files exceeding this limit fail to be classified.
  Tip: When your files aren't stored as an IResource type variable, there's an option to perform a conversion. Use LocalResource.FromPath(<reference_to_the_file>) in the Input property field for this.

  Consider a scenario where you are iterating through a list of files using a For Each activity. Suppose currentItem is your iterating variable. To convert currentItem into IResource, paste LocalResource.FromPath(currentItem) into the Input field.
• Document Understanding project - Requires you to select your Document Understanding project from the drop-down menu. The available options are:
  • Predefined - Project that uses pre-trained specialized models recommended for standard scenarios.
  • Generative Predefined - Project that uses pre-trained generative models accepting instructions as input for classification or extraction of document data.
  • Existent project from the tenant and folder you are connected to
  • You can create a new project by selecting the + icon.
  Note: If you have created more than 500 projects on your tenant and use the Classify Document activity, UiPath Studio or Studio Web will not display any projects beyond the initial 500. Therefore, those projects cannot be used.
• Classifier - If you are using the Predefined project, then you can select your desired Document Understanding classifier from the drop-down menu.
  Note: The data sent to the Generative Classifier will be sent to an LLM Model instance which is not publicly available, will not leave it, and once processed, it will not be stored or used for training.
  • For the Predefined project you have two options:
    • ML Classification – ML-based classifier.
    • Generative Classifier – The generative classifier type.
      Important:

      This feature is currently part of an audit process and is not to be considered part of the FedRAMP Authorization until the review is finalized. See here the full list of features currently under review.

      • Document Type Details - Instructions to identify Document Types, provided as key-value pairs, where the key represents the name of the Document Type and the value a description for it, helping the classifier identify such documents.
        • Key - Provide the name of the document type to be used as classification result (30-character limit).
        • Value - Requires you to provide instructions for the Generative Classifier on how to identify the document type. The maximum number of characters allowed is 1000.
  • For the Generative Predefined project you can only use the Generative Classifier.
• Version (Preview) - Use this property when using an existing Document Understanding modern project. Select the tag that corresponds to the project version from which you want to process data. For instance, if you choose the Production tag assigned to Version 3, the activity processes data from Version 3 of your project in the production environment.

  The default value for Version is Staging. If the Staging tag doesn't exist in your selected project, then the default value is Production.

  After selecting a tag, the activity displays a list of supported document types for that version.

Properties panel

Advanced Options

• Minimum confidence - Specify the minimum confidence threshold based on which a document type is assigned during classification. If a document's confidence score falls below this threshold, its Document Type is reported as "unknown".
  Tip: Most document types generate a prediction with a confidence level. Setting this property prevents false positives by only considering the predictions with a confidence level above the threshold. You can identify an optimal confidence level by testing various documents within your workflow, recording the results in an Excel spreadsheet, for example, and then analyze what threshold value is the most accurate.

  Design-time external connection

  The design-time external connection allows you to leverage the activity using Document Understanding resources from other projects or tenants. Before configuring these properties, ensure you have fulfilled the prerequisites mentioned in the Configuring runtime external connection page. Once these steps are completed, you can then proceed to configure the runtime external connection.

  • App ID: Enter the App ID of the external application you previously created.
  • App secret: Enter the App secret of the external application you previously created.
  • Tenant URL: Enter the URL of the tenant where you created the external application. This is the tenant from where you will use resources at design-time.
    The URL should be in the following format: https://<baseURL>/<OrganizationName>/<TenantName>.

Input

• Timeout (seconds) - Maximum execution time (in seconds) for the call to the generative model. If the operation exceeds this timeout, it is automatically terminated to prevent delays or hangs. This property is only displayed if the Generative Classifier is selected as a classifier.

Output

• Document Data - All the validated extracted field data from the file.

Runtime external connection

The runtime external connection allows you to execute the activity via on-premises robots. Before configuring these properties, ensure you have fulfilled the prerequisites mentioned in the Configuring runtime external connection page. Once these steps are completed, you can then proceed to configure the runtime external connection.

• Runtime Credentials Asset - Use this field when you need to access Document Understanding resources while the robot is connected to a local Orchestrator, or from a different tenant. You can choose to enter a Credential Asset, for authentication purposes, in one of the following ways:
  • From the dropdown list, select the desired Credential Asset from the Orchestrator to which the UiPath® Robot is connected to.
  • Manually enter the path to the Orchestrator Credential Asset where you store the external application credentials for accessing the project.
    The format of the path should be: <OrchestratorFolderName>/<AssetName>.
• Runtime Tenant Url - Use this field, alongside the Runtime Credentials Asset field. Enter the URL of the tenant that the robot will connect to in order to execute the classification. The URL should be in the following format: https://<baseURL>/<OrganizationName>/<TenantName>.

Using the generative classifier

To quickly get started with the generative capabilities of the Classify Document activity, perform the following steps:

1. Add a Classify Document activity
2. From the Project dropdown list, select Predefined or Generative Predefined.
3. For Classifier, select Generative Classifier.

   The Document Type Details property appears in the body of the activity.

4. In the Document Type Details collection, provide your instructions as Dictionary key-value pairs, where:
   • Key represents the Document Type (example: CV).
   • Value represents the Generative prompt: The description used by the generative classifier to identify the document types.

     For example, check the following table for a sample of key-value pairs:

     Table 1. Key-value pairs used as a prompt for the generative classifier

     Key	Value
     CV	"Find common CV keywords such as "Education", "Skills", and "Experience"."
     Invoice	"Find common field names such as "Invoice number" "Bill to" or "Total Amount"."

   Figure 1. Key-value pairs used as a prompt for the generative classifier