UiPath Activities Guide

Classify Document Scope

UiPath.IntelligentOCR.Activities.DocumentClassification.ClassifyDocumentScope

Provides a scope for classifier activities, providing all of the necessary files needed to perform document classification. Accepts at least one classifier, and brokers between them, ensuring all parameters are forwarded to the child classification activities.

Properties

Common

  • DisplayName - The display name of the activity.

Input

  • DocumentObjectModel - The Document Object Model you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity. Please see the documentation of the activity for more information on how to do this. This field supports only Document variables.

  • DocumentPath - The path to the document you want to validate. This field supports only strings and String variables.

Note:

The supported file types for this property field are .png, .gif, .jpe, .jpg, .jpeg, .tiff, .tif, .bmp, and .pdf.

  • DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity. Please see the documentation of the activity for more information on how to do this. This field supports only strings and String variables.
  • Taxonomy - The Taxonomy against which the document is to be processed, stored in a DocumentTaxonomy variable. This field supports only DocumentTaxonomy variables.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

  • ClassificationResults - The results of running the classifier files on the specified file, stored in a IReadOnlyList<ClassificationResult> object. This field supports only IReadOnlyList<ClassificationResult> variables.

The ClassificationResult object contains:

  • DocumentTypeId - The ID corresponding to the document type matched from the Taxonomy.
  • DocumentId - The file name of the processed document.
  • ContentType - The type of content contained in the processed document.
  • Confidence - Classification confidence, displayed as a numeric value between 0 and 1.
  • OcrConfidence - OCR confidence for the characters that are part of the reported reference, displayed as a numeric value between 0 and 1.
  • Reference - Evidencing for the classification, both in the text version of the document (through TextStartIndex and TextLength), and in the Document Object Model (through Tokens and the highlight boxes for each page from which the evidencing is selected).
  • DocumentBounds - Information on what part of the document the classification pertains to, with StartPage (Int32, 0-based), PageCount (Int32), TextStartIndex (Int32, 0-based), TextLength (Int32).
  • ClassifierName - Automatically populated by the Classify Document Scope activity with the display name of the classifier reporting the current ClassificationResult.

Note:

The ClassificationResults has all the content sorted in descending order by confidence score, which means the one at the top has the highest confidence.


Classify Document Scope


Suggested Edits are limited on API Reference Pages

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