API d'automatisation codée Document Understanding (aperçu)

API d'automatisation codée pour le package d'activités Document Understanding, couvrant la classification des documents, l'extraction de données et les artefacts de validation.

UiPath.DocumentUnderstanding.Activities

API de workflow codé pour la classification des documents, l'extraction des données structurées et la création et la récupération d'artefacts de validation de documents. Ces API sont disponibles lors de la conception d'automatisations codées. Pour obtenir une introduction aux automatisations codées et à leur conception à l'aide d'API, consultez la section Automatisations codées.

• Accéder au service: du (type IDocumentUnderstandingService)
• Package requis: "UiPath.DocumentUnderstanding.Activities": "*" dans les dépendances project.json .

Espaces de noms importés automatiquement

Les espaces de noms suivants sont automatiquement disponibles dans les workflows codés lorsque le package Document Understanding est installé:

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

Vue d’ensemble du service

Le service du expose chaque opération Document Understanding sous forme d'appel de méthode direct. Il n’y a aucune connexion ni étendue à ouvrir. Appelez directement des méthodes sur l’accesseur du service:

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

Le service reflète les activités Classer un document, Extraire les données du document, Créer des artefacts de validation de document et Récupérer les artefacts de validation de document .

Version ou balise du projet

Le paramètre projectVersionOrTag correspond à la liste déroulante Version unique de Studio. Transmettez un nom de version (par exemple, v3) ou une balise (par exemple, Production, Staging, live). Le runtime résout quel type correspond au projet. Pour le projet prédéfini, utilisez Production.

Paramètres communs

• timeoutMs (Int): délai d'attente en millisecondes pour la classification et l'extraction. La valeur par défaut est 3600000 (1 heure).
• docType (String): l'ID du type de document. Saisissez le nom du type de document pour les projets comportant plusieurs types de documents, ou bien une chaîne vide pour les projets de type IXP disposant d'un seul extracteur par version.

Classification

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

Classe un document à partir d’un chemin de fichier local par rapport à un projet Document Understanding. Renvoie un objet DonnéesDocument , y compris le type de document prédit.

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

Classe la ressource de document fournie. Accepte tous les éléments IResource, tels que la sortie de l'activité Chemin d'accès existant ou Obtenir le fichier/dossier local .

Extraction de données

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

Extrait les données structurées d’un document au niveau d’un chemin d’accès local. Renvoie les champs extraits sous la forme IDocumentData<DictionaryData>.

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

Extrait les données structurées à partir de la ressource de document fournie.

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

Extrait les données structurées d’un document déjà classé avec ClassifyDocument, ce qui évite de procéder à une nouvelle numérisation du fichier. Lorsque la valeur docType est null, elle est dérivée du type de document du document classifié.

Artefacts de validation

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

Charge les résultats d'extraction dans le stockage Orchestrator et renvoie un handle ContentValidationData . Utilisez le handle pour créer une action de validation ou pour récupérer les résultats ultérieurement avec RetrieveDocumentValidationArtifacts. Lorsque orchestratorBucketName est null, le compartiment par défaut est utilisé.

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

Récupère les résultats d'extraction validés à partir du stockage. Lorsque la valeur removeDataFromStorage est true, les artefacts de stockage sont supprimés après la récupération. Lorsque la valeur returnAutomaticExtractionResults est true, les résultats d’extraction automatique d’origine sont renvoyés au lieu des résultats validés.

Relation avec les activités

L'API codée et les activités XAML de Document Understanding s'exécutent sur le même runtime, de sorte qu'un workflow codé atteint le même comportement de classification, d'extraction et d'artefact de validation que les activités Extraire les données du document et Classifier un document . La différence est la forme d'appel: le service prend des chemins de fichiers bruts ou des entrées IResource et renvoie directement les objets Données du document , et vous utilisez standard try/catch au lieu de l'option ContinuerSurErreur .

Modèles communs

Classer, puis extraire

Ce modèle classe un document, puis réutilise le résultat classifié pour extraire des données, ce qui évite de numériser le fichier une seconde fois.

[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");
}

Extraire et préparer les données pour les tâches d’application contenant le contrôle de validation

Ce modèle extrait les données, les charge dans le stockage sous forme d'artefacts de validation à des fins d'examen dans une tâche d'application et récupère les résultats validés une fois l'action terminée.

[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);
}