Escopo da Extração de Dados

UiPath.IntelligentOCR.Activities.DataExtraction.DataExtractionScope

Description

Fornece um escopo para as atividades do extrator, permitindo configurá-las de acordo com os tipos de documento definidos em sua taxonomia. A saída da atividade é armazenada em uma variável ExtractionResult , contendo todos os dados extraídos automaticamente e pode ser usada como entrada para a atividade Exportar resultados de extração . Esta atividade também apresenta um assistente Configurar extratores , que permite especificar exatamente quais campos dos tipos de documentos definidos na taxonomia você deseja extrair.

Compatibilidade do projeto

Windows - Legado | Windows

Configuração

Painel do Designer

Entrada

• CaminhoDoDocumento — o caminho para o documento que você deseja validar. Esse campo é compatível apenas com strings e variáveis string.
  Nota: Os tipos de arquivo suportados para este campo de propriedade são .png, .gif, .jpe, .jpg, .jpeg, .tiff, .tif, .bmpe .pdf.
• DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only strings and String variables.
• DocumentObjectModel - The Document Object Model you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only Document variables.
• Taxonomia — a taxonomia contra a qual o documento será processado, armazenada em uma variável DocumentTaxonomy . Esse objeto pode ser obtido usando uma atividade Carregar taxonomia . Este campo é compatível apenas com variáveis DocumentTaxonomy .
• ClassificationResults - Os resultados da execução de uma atividade do classificador no documento especificado, armazenados em um objeto ClassificationResult . Este campo é opcional se você especificar um DocumentTypeId . Este campo suporta apenas ClassificationResult variáveis.
• DocumentTypeID - The Document Type ID, as found in the Taxonomy Manager. This field is optional if you specify a file in the ClassificationResults field. This field supports only strings and String variables.

Saída

• ResultadosDaExtração — os resultados da extração do processo de extração de dados, armazenados em uma variável ExtractionResult.
  Nota: Se o intervalo de páginas para extração de dados indicar que apenas uma parte do arquivo original é direcionada, o Escopo de extração de dados gera um arquivo na pasta do projeto TEMP que é passado para os extratores. O arquivo temporário contém apenas o intervalo de páginas que os extratores devem receber para o processamento do documento.

Painel de Propriedades

Authentication (Preview)

The Authentication properties of this activity allow you to perform auto-validation via on-premises robots. Before configuring these properties, ensure you have fulfilled the prerequisites mentioned in the Configuring Authentication page . Once these steps are completed, you can then proceed to fill in the Authentication properties of the activity.

• Runtime Credentials Asset - Use this field when you need to access Document Understanding auto-validation features while the robot is connected to a local Orchestrator, or from a different tenant. You can choose to enter a Credential Asset, for authentication purposes, in one of the following ways:
  • Na lista suspensa, selecione o Ativo de credencial desejado do Orchestrator ao qual o UiPath® Robot está conectado.
  • Manually enter the path to the Orchestrator Credential Asset where you store the external application credentials for accessing the auto-validation features.
    O formato do caminho deve ser: <OrchestratorFolderName>/<AssetName>.
• Runtime Tenant Url - Use this field, alongside the Runtime Credentials Asset field. Enter the URL of the tenant that the robot will connect to in order to execute the auto-validation. The URL should be in the following format: https://<baseURL>/<OrganizationName>/<TenantName>.

Comum

• NomeDeExibição - o nome de exibição da atividade.

Entrada

• ApplyAutoValidation - Adjust confidence using generative extraction cross-checking. Confidences for reported values that are confirmed by generative AI will be increased to 99%. Enabling this feature has additional AI Unit consumption.
• ClassificationResults - Os resultados da execução de uma atividade do classificador no documento especificado, armazenados em um objeto ClassificationResult . Este campo é opcional se você especificar um DocumentTypeId . Este campo suporta apenas ClassificationResult variáveis.
• DocumentObjectModel - The Document Object Model you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only Document variables.
• CaminhoDoDocumento — o caminho para o documento que você deseja validar. Esse campo é compatível apenas com strings e variáveis string.
  Nota: Os tipos de arquivo suportados para este campo de propriedade são .png, .gif, .jpe, .jpg, .jpeg, .tiff, .tif, .bmpe .pdf.
• DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only strings and String variables.
• DocumentTypeID - The Document Type ID, as found in the Taxonomy Manager. This field is optional if you specify a file in the ClassificationResults field. This field supports only strings and String variables.
• FormatoValoresSePossíveis — especifica que se um valor tiver partes derivadas relatadas, ele não será substituído pelo escopo de extração de dados. Porém, se não tiver partes derivadas, o escopo de extração de dados tentará calculá-lo. Se a opção estiver definida como False , os valores não serão formatados.
• AutoValidationConfidenceThreshold - Limite de confiança para validação generativa. Apenas valores de campo com confiança abaixo desse limite serão validados. Se os valores forem confirmados, a confiança deles será definida para este limite.
• Taxonomia — a taxonomia contra a qual o documento será processado, armazenada em uma variável DocumentTaxonomy . Esse objeto pode ser obtido usando uma atividade Carregar taxonomia . Este campo é compatível apenas com variáveis DocumentTaxonomy .

Diversos

• Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

Saída

• ResultadosDaExtração — os resultados da extração do processo de extração de dados, armazenados em uma variável ExtractionResult.
  Nota: Se o intervalo de páginas para extração de dados indicar que apenas uma parte do arquivo original é direcionada, o Escopo de extração de dados gera um arquivo na pasta do projeto TEMP que é passado para os extratores. O arquivo temporário contém apenas o intervalo de páginas que os extratores devem receber para o processamento do documento.

Usando o assistente de configuração do extrator

O Assistente para configurar extratores pode ser acessado por meio do Escopo de Extração de Dados e permite que você escolha quais extratores são aplicados para cada tipo de documento e campo.

From the body of the activity, select Configure Extractors. The wizard button becomes available after dragging at least one extractor activity into the body of the Data Extraction Scope activity. This wizard displays all the document types defined in the taxonomy and their respective fields, and enables you to choose which extractor you want to use for each.

Figure 1. Overview of the Configure Extractors wizard

Cada tipo de documento pode ser expandido e seus campos podem ser visualizados no assistente e selecionados para extração.

Figure 2. The selection of an extractor for a document type in the Configure Extractors wizard

The Framework Alias field can be used to map an extractor to one or more trainers. For instance, you can give a Machine Learning Extractor the alias R2D2 and then you can use the same alias for a Machine Learning Extractor Trainer. This creates a link between the extractor and the trainer and has training purposes for the extractor. Each extractor has a unique alias while multiple trainers can share the same alias.

You can configure the Minimum Confidence field to allow a confidence threshold between 0 and 100. The predicted value for a field is considered only if the prediction's confidence score is equal or higher than the configured Minimum confidence. If a prediction's confidence score is less than the Minimum confidence threshold, the predicted value is not stored in the output of the Data Extraction Scope activity.

Tip: You can identify an optimal confidence level by testing various documents within your workflow, recording the results in an Excel spreadsheet, for example, and then analyze what threshold value is the most accurate.

Select Get of refresh extractor capabilities, for the extractors that support this functionality, to easily map your taxonomy fields with the available extractor fields or refresh them in case the extractor fields have changed.

The check boxes next to each field in any column, if selected, cause the Data Extractor Scope to request that particular field from the extractor. If the check box is unchecked, Data Extractor Scope does not request a value for that field from the extractor.

The text inputs next to each field enable you to map fields defined in your Taxonomy with the fields defined in the extractor's internal taxonomy, if any. For regular fields, add in the text input the identifier for target field from the extractor's internal taxonomy. For table fields, the parent table field is mapped at the table level, and the corresponding columns are mapped individually.

Note: When using the Machine Learning Extractor in a setup with defined Column Fields, these can be mapped to a table field from your Taxonomy. They will be displayed under a collection called items.

O número de colunas no assistente varia de acordo com o número de extratores presentes na atividade do escopo. O nome de cada coluna é fornecido pelo nome de exibição de cada atividade do extrator.

Figure 3. Multiple extractors present in the Configure Extractors wizard

If multiple extractors are used in the activity, the order of the extractors in the scope defines their priority. For example, let's consider three extractors. Extractor 1 returns an acceptable value (which is above the Minimum Confidence level) for a particular requested field, then that field is not requested when Extractor 2 and Extractor 3 are executed. If Extractor 1 and Extractor 2 return values below the Minimum Confidence level for that particular field, or return nothing at all, the results from Extractor 3 are taken into account, if they satisfy the confidence acceptability conditions.

Integração de Compreensão de Documentos

A atividade Data Extraction Scope faz parte das Document Understanding Solutions. Acesse o Guia do Document Understanding para obter mais informações.