Document Understanding-codierte Automatisierungs-APIs (Vorschau)

Codierte Automatisierungs-APIs für das Document Understanding-Aktivitätspaket, die Dokumentklassifizierung, Datenextraktion und Validierungsartefakte abdecken.

UiPath.DocumentUnderstanding.Activities

Codierte Workflow-API zum Klassifizieren von Dokumenten, Extrahieren strukturierter Daten und Erstellen und Abrufen von Artefakten zur Dokumentvalidierung. Diese APIs sind beim Entwerfen von codierten Automatisierungen verfügbar. Eine Einführung in codierte Automatisierungen und deren Entwerfen mithilfe von APIs finden Sie unter Codierte Automatisierungen.

• Dienstzugriff: du (Typ IDocumentUnderstandingService)
• Erforderliches Paket: "UiPath.DocumentUnderstanding.Activities": "*" in den project.json -Abhängigkeiten.

Automatisch importierte Namensräume

Die folgenden Namespaces sind automatisch in codierten Workflows verfügbar, wenn das Document Understanding-Paket installiert wird:

• UiPath.DocumentUnderstanding.Activities.Api
• UiPath.Platform.ResourceHandling
• UiPath.DocumentProcessing.Contracts.Actions
• UiPath.IntelligentOCR.StudioWeb.Activities.DataExtraction
• UiPath.IntelligentOCR.StudioWeb.Activities.DocumentClassification

Serviceübersicht

Der du -Dienst macht jeden Document Understanding-Vorgang als direkten Methodenaufruf verfügbar. Es ist keine Verbindung oder kein Scope zum Öffnen vorhanden. Aufrufmethoden für den Dienstzugriff direkt:

var extracted = du.ExtractDocumentData(@"C:\invoices\invoice.pdf", "Invoices", "Production", "invoice");

Der Dienst spiegelt die Aktivitäten Studio Web Classify Document, Extract Document Data, Create Document Validation Artifacts und Retrieve Document Validation Artifacts wider .

Projektversion oder Tag

Der Parameter projectVersionOrTag ist dem Dropdownmenü Version von Studio zugeordnet. Übergeben Sie entweder einen Versionsnamen (z. B. v3) oder ein Tag (z. B. Production, Staging, live). Die Laufzeit löst die Art auf, die dem Projekt entspricht. Verwenden Sie für das vordefinierte Projekt Production.

Allgemeine Parameter

• timeoutMs (Int) – Timeout in Millisekunden für Klassifizierung und Extraktion. Die Standardeinstellung ist 3600000 (1 Stunde).
• docType (String) – Die Dokumenttyp-ID. Übergeben Sie den Namen des Dokumententyps für Projekte mit mehreren Dokumenttypen oder eine leere Zeichenfolge für Projekte im Intelligente Datenextraktion und Verarbeitung (IXP)-Stil, die nur einen Extraktor pro Version haben.

Klassifizierung

DocumentData ClassifyDocument(string documentPath, string projectName, string projectVersionOrTag, int timeoutMs = 3600000)

Klassifiziert ein Dokument aus einem lokalen Dateipfad gegen ein Document Understanding-Projekt. Gibt ein Dokumentdatenobjekt zurück, einschließlich des vorhergesagten Dokumenttyps.

DocumentData ClassifyDocument(IResource file, string projectName, string projectVersionOrTag, int timeoutMs = 3600000)

Klassifiziert die angegebene Dokumentressource. Akzeptiert alle IResource, wie z. B. die Ausgabe der Aktivität Path Exists oder Get Local File or Folder .

Datenextraktion

IDocumentData<DictionaryData> ExtractDocumentData(string documentPath, string projectName, string projectVersionOrTag, string docType, int timeoutMs = 3600000)

Extrahiert strukturierte Daten aus einem Dokument in einem lokalen Dateipfad. Gibt die extrahierten Felder als IDocumentData<DictionaryData> zurück.

IDocumentData<DictionaryData> ExtractDocumentData(IResource file, string projectName, string projectVersionOrTag, string docType, int timeoutMs = 3600000)

Extrahiert strukturierte Daten aus der angegebenen Dokumentressource.

IDocumentData<DictionaryData> ExtractDocumentData(DocumentData classifiedDocument, string projectName, string projectVersionOrTag, string docType = null, int timeoutMs = 3600000)

Extrahiert strukturierte Daten aus einem Dokument, das bereits mit ClassifyDocument klassifiziert wurde, wodurch eine erneute Digitalisierung der Datei vermieden wird. Wenn docType gleich null ist, wird er vom Dokumenttyp des klassifizierten Dokuments abgeleitet.

Validierungsartefakte

ContentValidationData CreateDocumentValidationArtifacts(IDocumentData<DictionaryData> automaticExtractionResults, string orchestratorFolderName, string orchestratorBucketName = null)

Lädt Extraktionsergebnisse in den Orchestrator-Speicher hoch und gibt ein ContentValidationData -Handle zurück. Verwenden Sie das Handle, um eine Validierungsaktion zu erstellen oder die Ergebnisse später mit RetrieveDocumentValidationArtifacts abzurufen. Wenn orchestratorBucketName gleich null ist, wird der Standard-Bucket verwendet.

IDocumentData<DictionaryData> RetrieveDocumentValidationArtifacts(ContentValidationData contentValidationData, object completedAppAction = null, bool removeDataFromStorage = false, bool returnAutomaticExtractionResults = false)

Ruft validierte Extraktionsergebnisse aus dem Speicher ab. Wenn removeDataFromStorage gleich true ist, werden die Speicherartefakte nach dem Abrufen gelöscht. Wenn returnAutomaticExtractionResults auf true festgelegt ist, werden die ursprünglichen Ergebnisse der automatischen Extraktion anstelle der validierten zurückgegeben.

Beziehung zu den Aktivitäten

Die codierten API- und die Document Understanding XAML-Aktivitäten werden in derselben Laufzeit ausgeführt, sodass ein codierter Workflow das gleiche Klassifizierungs-, Extraktions- und Validierungsartefakt-Verhalten erreicht wie die Aktivitäten Extract Document Data und Classify Document . Der Unterschied ist die Aufrufform: Der Service nimmt einfache Dateipfade oder IResource -Eingaben und gibt Dokumentdatenobjekte direkt zurück, und Sie verwenden die gewöhnliche try/catch anstelle der Aktivität Bei Fehler fortsetzen .

Häufige Muster

Klassifizieren und dann extrahieren

Dieses Muster klassifiziert ein Dokument und verwendet dann das klassifizierte Ergebnis zum Extrahieren von Daten wieder, wodurch die Digitalisierung der Datei ein zweites Mal vermeidet.

[Workflow]
public void Execute()
{
    var classified = du.ClassifyDocument(@"C:\docs\file.pdf", "MyProject", "Production");
    Log($"Document type: {classified.DocumentType.DisplayName}");

    // Reuses the classified document, so the file is not digitized again.
    var extracted = du.ExtractDocumentData(classified, "MyProject", "Production");
}

Extrahieren und Vorbereiten von Daten für App-Aufgaben, die das Validierungssteuerelement enthalten

Dieses Muster extrahiert Daten, lädt sie als Validierungsartefakte zur Überprüfung in einer App-Aufgabe in den Speicher hoch und ruft die validierten Ergebnisse nach Abschluss der Aktion ab.

[Workflow]
public void Execute()
{
    var extracted = du.ExtractDocumentData(@"C:\docs\invoice.pdf", "Invoices", "Production", "invoice");

    // Upload the results so they can be reviewed in Action Center.
    var artifacts = du.CreateDocumentValidationArtifacts(extracted, "Shared");

    // After the Action Center validation action completes, retrieve the validated results.
    var validated = du.RetrieveDocumentValidationArtifacts(artifacts, removeDataFromStorage: true);
}