Document Understanding classic user guide

• 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^TM section.
• Enterprise licensed traffic - The consumption entitlement is displayed as a number of pages on the Licenses page within the Document Understanding^TM section. The size of documents that can be extracted is limited per page to 20 megapixels and 10MB, in JSON-Base64 format.
  Note:

  Public extraction endpoints (endpoints containing /ie, for example Invoices, https://du.uipath.com/ie/invoices) only work with documents that have up to 30 pages (or 30MB payload in total).

Tenant region-specific endpoints​

• cloud.uipath.com/<Org_ID>/<Tenant_ID>/ie/invoices for Invoices
• cloud.uipath.com/<Org_ID>/<Tenant_ID>/du_/ocr_/ocr for UiPath Document OCR

Retrieving document type information with APIs​

Prerequisites​

1. Create an external application in your cloud organization, that uses Document Understanding^TM as Resource. Visit Managing external applications to learn how to add and configure an external application.
2. 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.ApiRemember 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.

Steps​

1. To access the APIs in Swagger, go to the toolbar of the Document Understanding^TM service, search the REST APIs dropdown, and select Framework.
2. In Swagger, select Authorize, and log in with the App ID (Client ID) and Secret ID (Client secret) of the previously created external application.
3. 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.