- Overview
- Getting started
- Activities
- Insights dashboards
- Document Understanding Process
- Quickstart tutorials
- Framework components
- ML packages
- Overview
- Document Understanding - ML package
- DocumentClassifier - ML package
- ML packages with OCR capabilities
- 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
- 990 - ML package
- ACORD125 - ML package
- ACORD126 - 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
- Other Out-of-the-box ML Packages
- Public endpoints
- Traffic limitations
- OCR Configuration
- Pipelines
- OCR services
- Supported languages
- Deep Learning
- Licensing
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&q=100)
Public endpoints
- Community licensed traffic - The size of documents that can be extracted is limited to 2 pages and 4MB and there is a rate-limiting per account at 50
requests per hour. When an account reaches the rate limit, the server responds with
429 - Too Many Requests
error status. Community Edition license of Document Understanding has no quantity displayed on the Licenses page within the Document Understanding section. - Enterprise licensed traffic - The consumption entitlement is displayed as a number of pages on the Licenses page within the Document Understanding section. The size of documents that can be extracted is limited per page to 20 megapixels and 10MB, in
JSON-Base64
format.
/ie
, for example Invoices, https://cloud.uipath.com/ie/invoices
) only work with documents that have up to 30 pages (or 30MB payload in total).
Make sure you connect your activity to the correct endpoint according to each server region.
Public endpoint | West Europe |
Australia |
USA |
Canada |
Japan |
Singapore | United Kingdom | India | ||
---|---|---|---|---|---|---|---|---|---|---|
UiPathDocumentOCR |
|
|
|
|
|
|
|
| ||
Uipath Extended Languages OCR (Preview) |
| N/A | N/A | N/A |
|
| N/A | N/A | ||
ChineseJapaneseKoreanOCR |
|
N/A |
N/A |
N/A |
|
| N/A | N/A | ||
Invoices |
| N/A | N/A | N/A | N/A | N/A |
|
| ||
InvoicesAustralia Note: Deprecated:
model has been merged into the Invoices model. See the Invoices
model page for details.
|
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
InvoicesIndia |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
InvoicesJapan |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
InvoicesChina |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Invoices Hebrew - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Invoices Shipping |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Receipts |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
PurchaseOrders |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
UtilityBills |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
IDCards |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Passports |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Pay slips |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
ML Classification |
| N/A | N/A | N/A | N/A | N/A |
|
| ||
RemittanceAdvices |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
BillsOfLading |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
UB04 - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
W2 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
W9 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
ACORD125 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
I9 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
709 - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
941x - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
990 - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
3949a - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
4506T |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
9465 - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
ACORD25 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
1040 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
1040 Schedule C - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
1040 Schedule D - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
1040 Schedule E - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
1040x - ML package - Preview |
| N/A | N/A | N/A | N/A | N/A | N/A | |||
Checks |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | |||
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | |||
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | |||
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | |||
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | |||
BankStatements |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
FinancialStatements |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
PackingLists |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Acord131 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Acord140 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
VehicleTitles |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
Acord126 |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A | ||
FM1003 - Preview |
| N/A | N/A | N/A | N/A |
N/A | N/A | N/A | ||
FormExtractor |
|
|
|
|
|
| N/A | N/A | ||
IntelligentKeywordClassifier |
|
|
|
|
|
| N/A | N/A |
You can retrieve document type information for out-of-the-box extraction models, such as invoices, receipts, passports, and others, using the Discovery APIs from Swagger.
- Create an external application in
your cloud organization, that uses Document Understanding as
Resource.
Visit Managing external applications to learn how to add and configure an external application.
- Depending on the information that
you want to retrieve, you must add one of the following application scopes to
the external application:
- Du.Digitization.Api
- Du.Classification.Api
- Du.Extraction.Api
- Du.Validation.Api
Remember your App ID and Secret ID, because you will use these to log in to Swagger.
Visit Managing external applications to learn how to create and configure an external application.
- To access the APIs in Swagger, go to the toolbar of the Document Understanding service, search the REST APIs dropdown, and select Framework.
- In Swagger, select Authorize, and log in with the App ID (Client ID) and Secret ID (Client secret) of the previously created external application.
- Depending on your use case, try out the following APIs:
GET/projects/{projectId}/document-types/{documentTypeId}
: Retrieve details about a specific document type.GET/projects/{projectId}/classifiers/{classifierId}
: Retrieve details about a specific classifier.GET/projects/{projectId}/extractors/{extractorId}
: Retrieve details about a specific extractor.