Classify Document

UiPath.IntelligentOCR.StudioWeb.Activities.ClassifyDocument

Allows you to classify documents using classification models.

Project compatibility: Cross-platform

Tip: Unless this activity is the first Document Understanding activity part of a Studio workflow, the input should be Document Data. File should only be used as input if the activity is the first Document Understanding one part of a Studio workflow.

The supported languages for the generative models are the same as the used OCR engine used. For more information, check the OCR Supported languages page.

Properties

• Project - Requires you to select your Document Understanding project from the drop-down menu. The available options are:
  • Predefined - The default project type
  • You can create a new project by clicking the + icon.
• Classifier - Requires you to select your Document Understanding classifier from the drop-down menu.
  • Predefined - The default project type
  • Generative Classifier - The generative classifier type
    • Prompt - Prompt 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.
      • Document Type - Provide the name of the document type to be used as classification result (30-character limit).
      • Generative prompt - Requires you to provide the prompt as input for the Generative Classifier. (500-character limit)
• Input - Provide the input file or the Document Data object.

Advanced Options

• Minimum confidence - Specify the minimum confidence score based on which to assign a classification result. If the confidence score is below the set value, the Document Type will be reported as "unknown".

Input

• Timeout (seconds) (Preview) - 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.

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.

Note: The Classify Document activity uses public endpoints.