Formular analysieren

The Analyze Form activity uses the Form Recognizer Analyze Form API to extract key-value pairs and table data from a specified document (File Path or File URL) using a specified training model (Model Id).

After completing the analyze form operation, the activity outputs the results in an AnalyzeOperationResult object (Response Object) and a Page[] object (Pages). Both of these outputs can be used as input variables in subsequent activities (e.g., conditional logic).

Wie es funktioniert

The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.

1. Schließen Sie die Einrichtungsschritte ab.
2. Add the Azure Form Recognizer Scope activity to your project.
3. Add the Analyze Form activity inside the Azure Form Recognizer Scope activity.
4. Geben Sie Werte für die Eingabeeigenschaften ein.
5. Create and enter the AnalyzeOperationResult and Page[] variables for the Output properties.
6. Führen Sie die Aktivität aus.

   • Your input properties are sent to the Analyze Form API.

   • Die API gibt die Werte AnalyzeFormResponse und FormPage[] an Ihre Ausgabeeigenschaftsvariablen zurück.

     

Eigenschaften

Die Werte für die folgenden Eigenschaften werden beim Hinzufügen dieser Aktivität zu Ihrem Projekt in UiPath Studio angegeben.

Allgemein

DisplayName

Der Anzeigename der Aktivität.

Attribute	Details
Typ	String
Erforderlich	Ja
Standardwert	Formular analysieren
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	Keine Angabe

Zeitüberschreitung

Gibt die zu wartende Zeitspanne (in Millisekunden) bis zum Abschluss des Empfangsanalysevorgangs an, bevor ein Fehler ausgelöst wird.

Attribute	Details
Typ	Int32
Erforderlich	Ja
Standardwert	30000 ms ((30 Sekunden) nicht angezeigt)
Zulässige Werte	Geben Sie eine Int32 oder Int32 -Variable ein.
Hinweise	Keine Angabe

Eingabe

Dateipfad

Der lokale Pfad zum Formulardokument, das Sie analysieren möchten.

Attribute	Details
Typ	String
Erforderlich	Yes (if File URL is empty)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	Supported form document formats:.json,.pdf,.jpg,.png, and.tiff (all other format types are ignored).

DateiURL

Die URL des Formulardokuments, das Sie analysieren möchten.

Attribute	Details
Typ	String
Erforderlich	Yes (if File Path is empty)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	Supported form document formats:.json,.pdf,.jpg,.png, and.tiff (all other format types are ignored).

Modell-ID

Der Bezeichner des Trainingsmodells, das Sie zum Analysieren des Formulars verwenden möchten.

Attribute	Details
Typ	String
Erforderlich	Ja
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	To get the Model Id value, add an activity or run an external process that outputs the model identifier (e.g., Train Model, Get Models).

Optionen

IncludeTextDetails

Wenn diese Option ausgewählt ist, enthält das Ergebnis Textzeilen und Elementverweise.

Attribute	Details
Typ	Kontrollkästchen
Erforderlich	Nein
Standardwert	nicht ausgewählt
Zulässige Werte	Ausgewählt oder nicht ausgewählt
Hinweise	Keine Angabe

Sonstiges

Private

Falls ausgewählt werden die Werte von Variablen und Argumenten nicht mehr auf ausführlicher Ebene protokolliert.

Attribute	Details
Typ	Kontrollkästchen
Erforderlich	Nein
Standardwert	nicht ausgewählt
Zulässige Werte	Ausgewählt oder nicht ausgewählt
Hinweise	Keine Angabe

Ausgabe

Response Object

Die Vorgangsantwort als deserialisiertes Objekt.

Attribute	Details
Typ	AnalyzeOperationResult
Erforderlich	Nein (erforderlich, um die Ausgabedaten in nachfolgenden Aktivitäten zu verwenden)
Standardwert	Leer
Zulässige Werte	Geben Sie eine AnalyzeOperationResult -Variable ein
Hinweise	To get the JSON string representation, use the ToString method. If the model can't find a field, a null value is returned.

Seiten

Die Ergebnisse der Formularanalyse, einschließlich der von der Seite extrahierten Schlüssel-Wert-Paare und Tabelleninformationen.

Attribute	Details
Typ	Page[]
Erforderlich	Nein (erforderlich, um die Ausgabedaten in nachfolgenden Aktivitäten zu verwenden)
Standardwert	Leer
Zulässige Werte	Geben Sie eine Page[] -Variable ein
Hinweise	Jedes Page -Objekt enthält KeyValuePairs - und Tables -Eigenschaften.