API de automatización codificada de Document Understanding (vista previa)

API de automatización codificadas para el paquete de actividades de Document Understanding, que cubren la clasificación de documentos, la extracción de datos y los artefactos de validación.

UiPath.DocumentUnderstanding.Activities

API de flujo de trabajo codificado para clasificar documentos, extraer datos estructurados y crear y recuperar artefactos de validación de documentos. Estas API están disponibles al diseñar automatizaciones codificadas. Para obtener una introducción a las automatizaciones codificadas y cómo diseñarlas utilizando API, consulta Automatizaciones codificadas.

• Descriptor de acceso de servicio: du (tipo IDocumentUnderstandingService)
• Paquete requerido: "UiPath.DocumentUnderstanding.Activities": "*" en las dependencias project.json .

Espacios de nombres importados automáticamente

Los siguientes espacios de nombres están disponibles automáticamente en los flujos de trabajo codificados cuando se instala el paquete Document Understanding:

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

Descripción general del servicio

El servicio du expone cada operación de Document Understanding como una llamada de método directo. No hay conexión ni ámbito que abrir. Llamar a métodos en el descriptor de acceso de servicio directamente:

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

El servicio refleja las actividades Clasificar documento, Extraer datos de documento, Crear artefactos de validación de documentos y Recuperar artefactos de validación de documentos de Studio Web.

Versión o etiqueta del proyecto

El parámetro projectVersionOrTag se asigna al menú desplegable Versión única de Studio. Pasa un nombre de versión (por ejemplo, v3) o una etiqueta (por ejemplo, Production, Staging, live). El runtime resuelve el tipo que coincida con el proyecto. Para el proyecto predefinido, utiliza Production.

Parámetros comunes

• timeoutMs (Int): tiempo de espera en milisegundos para la clasificación y extracción. El valor predeterminado es 3600000 (1 hora).
• docType (String): el ID del tipo de documento. Pasa el nombre del tipo de documento para proyectos con varios tipos de documentos, o una cadena vacía para proyectos de estilo IXP que tienen un solo extractor por versión.

Clasificación

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

Clasifica un documento de una ruta de archivo local en comparación con un proyecto de Document Understanding. Devuelve un objeto DatosDeDocumento , incluido el tipo de documento predicho.

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

Clasifica el recurso de documento proporcionado. Acepta cualquier IResource, como la salida de la actividad Ruta existente u Obtener archivo o carpeta local .

Extracción de información

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

Extrae datos estructurados de un documento en una ruta de archivo local. Devuelve los campos extraídos como IDocumentData<DictionaryData>.

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

Extrae datos estructurados del recurso de documento proporcionado.

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

Extrae datos estructurados de un documento ya clasificado con ClassifyDocument, lo que evita volver a digitalizar el archivo. Cuando docType es null, se deriva del tipo de documento del documento clasificado.

Artefactos de validación

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

Carga los resultados de la extracción en el almacenamiento de Orchestrator y devuelve un identificador ContentValidationData . Utiliza el identificador para crear una acción de validación o para recuperar los resultados más tarde con RetrieveDocumentValidationArtifacts. Cuando orchestratorBucketName es null, se utiliza el depósito predeterminado.

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

Recupera resultados de extracción validados del almacenamiento. Cuando removeDataFromStorage es true, los artefactos de almacenamiento se eliminan después de la recuperación. Cuando returnAutomaticExtractionResults es true, se devuelven los resultados originales de extracción automática en lugar de los validados.

Relación con las actividades

La API codificada y las actividades XAML de Document Understanding se ejecutan en el mismo runtime, por lo que un flujo de trabajo codificado alcanza el mismo comportamiento de clasificación, extracción y artefacto de validación que las actividades Extraer datos del documento y Clasificar documento . La diferencia es la forma de la llamada: el servicio toma rutas de archivo simples o entradas IResource y devuelve objetos de Datos de documento directamente, y utilizas ordinario try/catch en lugar de la opción Continuar en caso de error de la actividad.

Patrones comunes

Clasificar y luego extraer

Este patrón clasifica un documento y luego reutiliza el resultado clasificado para extraer datos, lo que evita digitalizar el archivo por segunda vez.

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

Extraer y preparar datos para las tareas de la aplicación que contienen el control de validación

Este patrón extrae datos, los carga en el almacenamiento como artefactos de validación para su revisión en una tarea de aplicación y recupera los resultados validados después de que se complete la acción.

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