UiPath Documentation
document-understanding
2.2510
true
  • Démarrage
    • Vue d'ensemble (Overview)
    • Authentification et autorisation
    • Limites et quotas
  • Exemples d’utilisation de l’API Document Understanding™
  • Licences
  • Résolution des problèmes
Important :
La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.
UiPath logo, featuring letters U and I in white

Document Understanding API guide

Dernière mise à jour 6 avr. 2026

Vue d'ensemble (Overview)

Document UnderstandingTM APIs can be an alternative to the RPA approach. By initiating an API call, you can:

  • Obtenir des informations sur le projet, les extracteurs ou les classifieurs utilisés dans le projet.
  • Utiliser les API de numérisation.
  • Classify documents using specialized (Classifying a document example).
  • Extract document data using specialized (Start the extraction fields request example).
  • valider les informations précédemment numérisées, classées et/ou extraites.

Selon votre cas d’utilisation, vous pouvez choisir entre utiliser des API asynchrones ou synchrones.

Utilisez des API asynchrones lorsque :

  • Vous devez traiter des documents de plusieurs pages.
  • Vous devez gérer plusieurs opérations simultanément. Les API asynchrones permettent un traitement simultané et évitent les temps d’inactivité, ce qui entraîne un débit système plus élevé. Cela signifie que vous pouvez envoyer un document et passer à une autre tâche au lieu d’attendre la réponse.
  • Vous avez un ensemble de données volumineux qui doit être traité, ce qui prend beaucoup de temps.

Utilisez des API synchrones lorsque :

  • Vous devez traiter uniquement les images d’une page.
  • Vous avez besoin d’une interaction en temps réel sur le mode demande-réponse, et le multitâche n’est pas nécessaire. Une API synchrone permet de bloquer d’autres opérations en attendant une réponse.
  • Vous devez traiter un ensemble de données plus réduit.

Les statuts suivants s’appliquent aux API asynchrones :

  • NotStarted: job was created and it's waiting to be processed.
  • Running: job was created, was picked up, and is currently being worked on
  • Failed: job finished but failed.
  • Succeeded: job finished and succeeded.

Classification & Extraction APIs are available for both synchronous and asynchronous consumption. The synchronous consumption supports multi-page documents, up to 5 pages, while the asynchronous consumption posts the request via a start method and retrieves the result via polling.

Utilisez les API Document Understanding pour accéder aux capacités de la même manière que vous le feriez via RPA. Pour utiliser les API, vous pouvez utiliser n’importe quel langage de programmation/script (puisque les appels sont effectués via HTTP), y compris la RPA.

You can access the APIs via Swagger: In the toolbar of the Document UnderstandingTM service, look for the Rest API dropdown, and select Framework.

Capture d'écran de la liste déroulante API REST.

Pour tester ces capacités, utilisez Swagger comme sandbox.

Vous pouvez choisir de travailler avec un modèle prédéfini ou personnalisé. Les modèles personnalisés sont ceux que vous avez créés en utilisant Document Understanding. Un modèle prédéfini est déjà disponible pour être utilisé et il comprend des modèles prédéfinis prêts à l'emploi.

Important :

The data received from calling the Digitization endpoint is retained for seven days. In this timeframe, the result is available via the received document ID. Afterwards, you would need to submit a new digitization request.

Important :

The data received from calling the asynchronous Classification and Extraction endpoints is retained for one day (24 hours).

Selon l’opération, les appels d’API Document Understanding utilisent les classes suivantes :

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour