document-understanding
latest
false
- Overview
- Building models
- Consuming models
- ML packages
- 1040 - ML package
- 1040 Schedule C - ML package
- 1040 Schedule D - ML package
- 1040 Schedule E - ML package
- 1040x - ML package
- 3949a - ML package
- 4506T - ML package
- 709 - ML package
- 941x - ML package
- 9465 - ML package
- ACORD131 - ML package
- ACORD140 - ML package
- ACORD25 - ML package
- Bank Statements - ML package
- Bills Of Lading - ML package
- Certificate of Incorporation - ML package
- Certificate of Origin - ML package
- Checks - ML package
- Children Product Certificate - ML package
- CMS 1500 - ML package
- EU Declaration of Conformity - ML package
- Financial Statements - ML package
- FM1003 - ML package
- I9 - ML package
- ID Cards - ML package
- Invoices - ML package
- Invoices Australia - ML package
- Invoices China - ML package
- Invoices Hebrew - ML package
- Invoices India - ML package
- Invoices Japan - ML package
- Invoices Shipping - ML package
- Packing Lists - ML package
- Payslips - ML package
- Passports - ML package
- Purchase Orders - ML package
- Receipts - ML Package
- Remittance Advices - ML package
- UB04 - ML package
- Utility Bills - ML package
- Vehicle Titles - ML package
- W2 - ML package
- W9 - ML package
- Public endpoints
- Supported languages
- Data and security
- Licensing and Charging Logic
- How to
Document Understanding User Guide
Monitor
You can check the performance metrics for your Document UnderstandingTM
automations from the Monitor section in the following main areas:
- Processed documents and the corresponding Document Details
Tip: Check the Role-based access control page for detailed
information on user permissions for the Monitor section.
The Processed Documents tab provides a list of documents which have been processed with the selected project, either via APIs or the activities part
of the UiPath.DocumentUnderstanding.Activities package. If the document has at least been digitized via APIs or in any way processed via the activities referencing the
project, it will appear here. The following metrics are available:
- File name: the name of the processed document. Click the document name to go to the Document Details view.
- Document type: the document type of the processed document.
- Consumer:
- API: consumer which has digitized at least one page using the selected project. Hover your mouse over the field to view the AppId, configured when setting up the external application, to uniquely identify the consumer.
- RPA: Studio Desktop or Studio Web projects containing at least one Document Understanding activity referencing the current project. Hover your mouse over the field to view the process name.
- Modified Date: date when the last operation on the document occurred.
- Validator: username of the user who validated the task. If there is no validation task created for the respective document, N/A will be displayed in the field.
- AI Units: number of AI Units consumed.
Use the search bar to search for a processed document by file name.
Note: Documents are available in the Processed Documents tab
for six months.
Select a file name from the Processed Documents tab to get to the Document Details
view. This view provides the following information:
- Processing overview:
- Total consumption: the number of AI Units consumed by the document.
- Creation time: the date and time when the document processing started. In the case of RPA (Studio or Studio Web), this is the time the workflow started running. For APIs, this is the time of the digitization call.
- Completion time: the date and time when the document processing finished. In the case of RPA (Studio or Studio Web), this is the time the workflow finished running. For APIs, this is the time of the get classification, extraction, or validation call.
- Consumer: the name of the workflow created in an RPA project, or the API ID or project name in case of APIs.
- Filename: the name of the processed document.
- File type: the type of the file (PDF, JPEG, etc.).
- Classification:
- Project version: the version of the project used for classifying the document.
- Pre-validation document type: the document type determined automatically by the classifier.
- Confidence: the confidence score determined by the classifier.
- Post-validation document type: if changed manually, the document type after validation. If the document type was not changed after validation, the value will be N/A.
- Extraction:
- Project version: the version of the project used for extraction.
- Model: the extraction model used.
- Extracted fields:
information related to each field of the document type:
- Predicted value: the value predicted by the model.
- Extraction confidence: the confidence score determined by the extractor.
- OCR Confidence: the confidence score determined by the OCR engine.
- Post-validation value: if changed manually, the value after validation. If the document type was not changed after validation, the value will be N/A.
- Validation tasks:
- Task name: the name of the validation task.
- Task type: the type of the validation task. Possible values: Classification or Extraction.
- Assignee: the assignee of the validation task (Unassigned if there is no user assigned yet).
- Status: the status of the task in Action Center.
- Criticality: the priority level of the validation task.
- Task creation date: the date when the validation task was created.
- Task completion date: the date when the validation task was completed.
- Task outcome: the result of the task, approved or document rejected, including exception message.
- Idle time: the time the document has spent waiting to be validated.
- Validation time: the time the validator user has spent in Validation Station. Multiple sessions are summed up.
- Valid fields: the number of validated fields after human-in-the-loop (marked as valid).
- Modified fields: the number of modified fields after human-in-the-loop.
