Rufen Sie den Status der Dokumentanalyse ab

Retrieve the status of an Amazon Textract document analysis job using the Get Document Analysis Status activity.

Die Aktivität Get Document Analysis Status verwendet die Amazon Textract GetDocumentAnalysis- API, um den Status eines vorhandenen oder zuvor ausgeführten Dokumentanalyseauftrags (JobId) asynchron abzurufen.

After retrieving the document analysis, the activity returns the job status as a String value that you can use as a condition to run other activities (for example, Get Document Analysis).

To avoid overloading the Amazon Textract service with requests, it's recommended that you implement a delay between each execution of this activity (for example, add the Get Document Analysis Status and a Delay activity inside a Do While activity - see example section below)

Wie es funktioniert

Die folgenden Schritte und das Nachrichten-Sequence-Diagramm sind ein Beispiel dafür, wie die Aktivität von der Entwurfszeit (d. h. die Aktivitätsabhängigkeiten und Eingabe-/Ausgabeeigenschaften) bis zur Laufzeit funktioniert.

1. Schließen Sie die Einrichtungsschritte ab.
2. Fügen Sie die Aktivität Amazon Scope zu Ihrem Projekt hinzu.
3. Add an activity or run an external process that outputs a JobId value (for example, Start Document Analysis).
4. Fügen Sie den Get Document Analysis Status innerhalb der Aktivität Amazon Scope hinzu.
5. Geben Sie Werte für die Eingabeeigenschaften ein.
6. Erstellen und geben Sie eine String -Variable für Ihre Output- Eigenschaft ein.
7. Führen Sie die Aktivität aus.

   • Ihre Eingabeeigenschaften werden an die GetDocumentAnalysis -API gesendet.

   • Die API gibt den Wert String an Ihre Ausgabeeigenschaftsvariable 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	Get Document Analysis Status
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	Keine Angabe

Eingabe

JobId

Der Bezeichner, der dem Dokumentanalyseprozess zugewiesen ist, den Sie abrufen möchten.

Attribute	Details
Typ	String
Erforderlich	Nein (empfohlen, wenn Sie die Ausgabedaten in nachfolgenden Aktivitäten verwenden möchten)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein
Hinweise	Um den Wert Auftrags-ID String abzurufen, verwenden Sie einen externen Prozess oder eine Aktivität, die den Wert JobID in ihrer Ausgabe enthält (z. B. Startdokumentanalyse oder externer API-Aufruf).

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

JobStatus

Der Status der angegebenen JobId.

Attribute	Details
Typ	String
Erforderlich	Nein (empfohlen, wenn Sie die Ausgabedaten in nachfolgenden Aktivitäten verwenden möchten)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String -Variable ein
Hinweise	Es gibt 4 mögliche Statuswerte: IN_PROGRESS Erfolgreich Fehlgeschlagen PARTIAL_SUCCESS

Beispiel

Die folgende Abbildung zeigt ein Beispiel für die Aktivitätsabhängigkeitsbeziehung und Eingabe-/Ausgabe-Eigenschaftswerte.

Eine Schritt-für-Schritt-Anleitung und Beispiele finden Sie in den Schnellstartanleitungen .