APIs de automação codificadas do Document Understanding (visualização)

APIs de automação codificadas para o pacote de atividades do Document Understanding, cobrindo classificação de documentos, extração de dados e artefatos de validação.

UiPath.DocumentUnderstanding.Activities

API de fluxo de trabalho codificada para classificar documentos, extrair dados estruturados e criar e recuperar artefatos de validação de documentos. Essas APIs estão disponíveis ao projetar automações codificadas. Para obter uma introdução a automações codificadas e como projetá-las usando APIs, consulte Automações codificadas.

• Acessador de serviço: du (tipo IDocumentUnderstandingService)
• Pacote obrigatório: "UiPath.DocumentUnderstanding.Activities": "*" nas dependências project.json .

Namespaces importados automaticamente

Os seguintes namespaces estão disponíveis automaticamente em fluxos de trabalho codificados quando o pacote Document Understanding está instalado:

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

Visão geral do serviço

O du serviço expõe cada operação do Document Understanding como uma chamada de método direta. Não há conexão ou escopo para abrir. Chame métodos no acessador de serviço diretamente:

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

O serviço espelha as atividades Studio Web Classify Document, Extract Document Data, Create Document Validation Artefatos e Retrieve Document Validation Artefatos .

Versão ou tag do projeto

O parâmetro projectVersionOrTag mapeia o menu suspenso Versão única do Studio. Passe um nome de versão (por exemplo, v3) ou uma tag (por exemplo, Production, Staging, live). O runtime resolve o tipo correspondente ao projeto. Para o projeto predefinido, use Production.

Parâmetros comuns

• timeoutMs (Int) - Tempo limite em milissegundos para classificação e extração. O padrão é 3600000 (1 hora).
• docType (String) - O ID do tipo de documento. Passe o nome do tipo de documento para projetos com vários tipos de documento ou uma string vazia para projetos no estilo de Extração e Processamento Inteligente (IXP) que têm um único extrator por versão.

Classificação

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

Classifica um documento de um caminho de arquivo local em relação a um projeto do Document Understanding. Retorna um objeto DocumentData , incluindo o tipo de documento previsto.

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

Classifica o recurso de documento fornecido. Aceita qualquer IResource, como a saída da atividade Path Exists ou Get Local File or Folder .

Extração de Dados

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

Extrai dados estruturados de um documento em um caminho de arquivo local. Retorna os campos extraídos como IDocumentData<DictionaryData>.

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

Extrai dados estruturados do recurso de documento fornecido.

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

Extrai dados estruturados de um documento já classificado com ClassifyDocument, o que evita uma nova digitalização do arquivo. Quando docType é null, ele é derivados do tipo de documento do documento classificado.

Artefatos de validação

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

Carrega os resultados da extração no armazenamento do Orchestrator e retorna um identificador ContentValidationData . Use o identificador para criar uma ação de validação ou para recuperar os resultados posteriormente com RetrieveDocumentValidationArtifacts. Quando orchestratorBucketName é null, o bucket padrão é usado.

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

Recupera os resultados da extração validados do armazenamento. Quando removeDataFromStorage é true, os artefatos de armazenamento são excluídos após a recuperação. Quando returnAutomaticExtractionResults é true, os resultados da extração automática original são retornados em vez dos validados.

Relacionamento com as atividades

A API codificada e as atividades XAML do Document Understanding são executadas no mesmo runtime, portanto, um fluxo de trabalho codificado atinge a mesma classificação, extração e comportamento de artefato de validação que as atividades Extract Document Data e Classify Document . A diferença está no formato da chamada: o serviço segue caminhos de arquivos simples ou entradas IResource e retorna objetos de Dados do Documento diretamente, e você usa try/catch comum em vez da opção Continuar com erro da atividade.

Padrões comuns

Classificar e depois extrair

Esse padrão classifica um documento e, em seguida, reutiliza o resultado classificado para extrair dados, o que evita a digitalização do arquivo uma 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");
}

Extrair e preparar dados para tarefas de aplicativo que contêm o controle de validação

Esse padrão extrai dados, os carrega para o armazenamento como artefatos de validação para revisão em uma tarefa de aplicativo e recupera os resultados validados após a ação ser concluída.

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