Endpoints públicos

Dependendo da sua licença, verificada com base na sua chave de API, há dois tipos de limitações disponíveis para cada pacote de ML:

• Tráfego licenciado Community - O tamanho dos documentos que podem ser extraídos é limitado a 2 páginas e 4 MB e há um limite de taxa por conta em 50 solicitações por hora. Quando uma conta atinge o limite de taxa, o servidor responde com o status de erro 429 - Too Many Requests. A licença Community Edition do Document Understanding não traz a quantidade exibida na página Licenças, seção Document Understanding.
• Tráfego licenciado Enterprise - O direito de consumo é exibido como um número de páginas na página Licenças, seção Document Understanding. O tamanho dos documentos que podem ser extraídos é limitado por página a 20 megapixels e 10 MB, no formato JSON-Base64.

Observação: endpoints públicos de extração (endpoints que contêm /ie, por exemplo, Faturas, https://cloud.uipath.com/ie/invoices) funcionam apenas com documentos que têm até 30 páginas (ou 30 MB de carga no total).

Certifique-se de conectar sua atividade ao endpoint correto de acordo com cada região do servidor.

Endpoint público	Europa Ocidental	Austrália	EUA	Canadá	Japão	Singapura
Faturas	https://du.uipath.com/ie/invoices	N/A	N/A	N/A	N/A	N/A
Faturas da Austrália Deprecated: model has been merged into the Invoices model. See the Invoices model page for details.	https://du.uipath.com/ie/invoices_au	N/A	N/A	N/A	N/A	N/A
Faturas da Índia	https://du.uipath.com/ie/invoices_india	N/A	N/A	N/A	N/A	N/A
Faturas do Japão	https://du.uipath.com/ie/invoices_japan	N/A	N/A	N/A	N/A	N/A
Faturas da China	https://du.uipath.com/ie/invoices_china	N/A	N/A	N/A	N/A	N/A
Envio de Notas Fiscais	https://du.uipath.com/ie/invoices_shipping	N/A	N/A	N/A	N/A	N/A
Recebimentos	https://du.uipath.com/ie/receipts	N/A	N/A	N/A	N/A	N/A
Ordens de compra	https://du.uipath.com/ie/purchase_orders	N/A	N/A	N/A	N/A	N/A
Contas de serviços	https://du.uipath.com/ie/utility_bills	N/A	N/A	N/A	N/A	N/A
Cartões de ID	https://du.uipath.com/ie/id_cards	N/A	N/A	N/A	N/A	N/A
Passaportes	https://du.uipath.com/ie/passports	N/A	N/A	N/A	N/A	N/A
Contracheques	https://du.uipath.com/ie/payslips	N/A	N/A	N/A	N/A	N/A
Avisos de remessas	https://du.uipath.com/ie/remittance_advices	N/A	N/A	N/A	N/A	N/A
Conhecimentos de embarque	https://du.uipath.com/ie/bills_of_lading	N/A	N/A	N/A	N/A	N/A
UB04 - Pacote de ML - Visualização	https://du.uipath.com/ie/ub04	N/A	N/A	N/A	N/A	N/A
W2	https://du.uipath.com/ie/w2	N/A	N/A	N/A	N/A	N/A
W9	https://du.uipath.com/ie/w9	N/A	N/A	N/A	N/A	N/A
ACORD125	https://du.uipath.com/ie/acord125	N/A	N/A	N/A	N/A	N/A
I9	https://du.uipath.com/ie/i9	N/A	N/A	N/A	N/A	N/A
990 - Prévia	https://du.uipath.com/ie/990	N/A	N/A	N/A	N/A	N/A
4506T	https://du.uipath.com/ie/4506t	N/A	N/A	N/A	N/A	N/A
Acord 25	https://du.uipath.com/ie/acord25	N/A	N/A	N/A	N/A	N/A
1040	https://du.uipath.com/ie/1040	N/A	N/A	N/A	N/A	N/A
1040 Schedule C - Pacote de ML - Visualização	https://du.uipath.com/ie/1040_schedule_c	N/A	N/A	N/A	N/A	N/A
1040 Schedule D - Pacote de ML - Visualização	https://du.uipath.com/ie/1040_schedule_d	N/A	N/A	N/A	N/A	N/A
1040 Schedule E - Pacote de ML - Visualização	https://du.uipath.com/ie/1040_schedule_e	N/A	N/A	N/A	N/A	N/A
Verificações	https://du.uipath.com/ie/checks	N/A	N/A	N/A	N/A	N/A
Certificado de Constituição/ Situação Regular	https://du.uipath.com/ie/certificates_incorporation	N/A	N/A	N/A	N/A	N/A
Certificado de origem	https://du.uipath.com/ie/certificates_origin	N/A	N/A	N/A	N/A	N/A
Certificado de produto infantil	https://du.uipath.com/ie/children_product_certificates	N/A	N/A	N/A	N/A	N/A
CMS1500	https://du.uipath.com/ie/cms1500	N/A	N/A	N/A	N/A	N/A
Declaração de Conformidade da UE	https://du.uipath.com/ie/eu_declaration_conformity	N/A	N/A	N/A	N/A	N/A
Extratos bancários	https://du.uipath.com/ie/bank_statements	N/A	N/A	N/A	N/A	N/A
Demonstrações financeiras	https://du.uipath.com/ie/financial_statements	N/A	N/A	N/A	N/A	N/A
Listas de embalagem	https://du.uipath.com/ie/packing_lists	N/A	N/A	N/A	N/A	N/A
Acordo131	https://du.uipath.com/ie/acord131	N/A	N/A	N/A	N/A	N/A
Acordo140	https://du.uipath.com/ie/acord140	N/A	N/A	N/A	N/A	N/A
Títulos de veículos	https://du.uipath.com/ie/vehicle_titles	N/A	N/A	N/A	N/A	N/A
Acordo126	https://du.uipath.com/ie/acord126	N/A	N/A	N/A	N/A	N/A
FM1003 - Prévia	https://du.uipath.com/ie/fm1003	N/A	N/A	N/A	N/A	N/A
Form Extractor	https://du.uipath.com/svc/formextractor	https://du-au.uipath.com/svc/formextractor	https://du-us.uipath.com/svc/formextractor	https://du-ca.uipath.com/svc/formextractor	https://du-jp.uipath.com/svc/formextractor	https://du-sg.uipath.com/svc/formextractor
Intelligent Keyword Classifier	https://du.uipath.com/svc/intelligentkeywords	https://du-au.uipath.com/svc/intelligentkeywords	https://du-us.uipath.com/svc/intelligentkeywords	https://du-ca.uipath.com/svc/intelligentkeywords	https://du-jp.uipath.com/svc/intelligentkeywords	https://du-sg.uipath.com/svc/intelligentkeywords

Importante: ter um plano de licenciamento Enterprise no seu Automation Cloud^TM não implica que você tenha acesso ao tráfego licenciado Enterprise para o Document Understanding. O acesso ao tráfego licenciado Enterprise está sujeito a uma licença separada e diferente.

Retrieving document type information with APIs

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.

Pré-requisitos

1. 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.

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.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.

Etapas

1. To access the APIs in Swagger, go to the toolbar of the Document Understanding 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.