UiPath Documentation
document-understanding
2.2510
true
  • Erste Schritte
    • Überblick
    • Authentifizierung und Autorisierung
      • Verwenden der Anmeldeinformationen für HTTP-Anforderungen
      • Verwenden der Anmeldeinformationen in Swagger
    • Limits und Kontingente
  • Verwendungsbeispiele für Document Understanding™ API
  • Lizenzierung
  • Fehlersuche und ‑behebung
Wichtig :
Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.
UiPath logo, featuring letters U and I in white

Document Understanding API guide

Letzte Aktualisierung 6. Apr. 2026

Überblick

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

  • Erhalten Sie Informationen über das Projekt, die Extraktoren oder Klassifizierer, die im Projekt verwendet werden.
  • Verwenden Sie die Digitalisierungs-APIs.
  • Classify documents using specialized (Classifying a document example).
  • Extract document data using specialized (Start the extraction fields request example).
  • Validieren Sie Informationen, die zuvor digitalisiert, klassifiziert und/oder extrahiert wurden.

Je nach Anwendungsfall können Sie zwischen der Verwendung von asynchronen oder synchronen APIs wählen.

Verwenden Sie asynchrone APIs in folgenden Fällen:

  • Sie müssen mehrseitige Dokumente verarbeiten.
  • Sie müssen mehrere Vorgänge gleichzeitig ausführen. Asynchrone APIs ermöglichen die gleichzeitige Verarbeitung und vermeiden Leerlaufzeiten, was zu einem höheren Systemdurchsatz führt. Das bedeutet, dass Sie ein Dokument senden und zu einer anderen Aufgabe übergehen können, anstatt auf die Antwort zu warten.
  • Sie haben ein großes Dataset, das verarbeitet werden muss, was viel Zeit in Anspruch nimmt.

Verwenden Sie synchrone APIs in folgenden Fällen:

  • Sie müssen nur einseitige Bilder verarbeiten.
  • Sie benötigen Echtzeit-Interaktion auf Basis von Anforderung und Antwort, und Multitasking ist nicht erforderlich. Eine synchrone API kann andere Vorgänge blockieren, während auf eine Antwort gewartet wird.
  • Sie haben ein kleineres Dataset, das verarbeitet werden muss.

Die folgenden Status gelten für asynchrone APIs:

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

Verwenden Sie Document Understanding-APIs, um auf die Funktionen genauso zuzugreifen wie über RPA. Für die Nutzung der APIs können Sie jede Programmier-/Skriptsprache verwenden (da die Aufrufe mit HTTP erfolgen), einschließlich 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.

Screenshot der Auswahlliste REST-APIs.

Um die Funktionen auszuprobieren, verwenden Sie Swagger als Ihre Sandbox.

Sie können mit einem vordefinierten oder einem benutzerdefinierten Buildmodell arbeiten. Bei den benutzerdefinierten Modellen handelt es sich um die Modelle, die Sie mit Document Understanding erstellt haben. Ein vordefiniertes Modell ist bereits verfügbar und enthält vordefinierte, vorgefertigte Modelle.

Wichtig:

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.

Wichtig:

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

Je nach Vorgang verwenden Document Understanding-API-Aufrufe die folgenden Klassen:

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben