Extract Document Data

UiPath.IntelligentOCR.StudioWeb.Activities.ExtractDocumentDataWithDocumentData<UiPath.IntelligentOCR.StudioWeb.Activities.DataExtraction.ExtendedExtractionResultForDocumentData>

Description

Extrai dados de um arquivo de entrada ou objeto de dados de documento e armazena os resultados em um objeto de dados de documento.

Antes de começar

Pré-requisitos

A atividade Extract Document Data requer objetos de entrada do tipo Dados do documento ou Arquivo. Um possível caso de uso para usar essa atividade é precedê-la com uma atividade Classificar Documento, que gera um objeto do tipo Dados do documento.

Opções de Entrada

A atividade Extract Document Data recebe como entrada uma das seguintes opções:

Dados do Documento - da atividade Classify Document
Arquivo - das atividades Get File/Folder ou Get Newest Email

Idiomas compatíveis com modelos generativos

Os idiomas compatíveis com os modelos generativos são os mesmos que o mecanismo de OCR usado, que depende do projeto. Para projetos predefinidos, o Mecanismo de OCR usado é o UiPath Document OCR. Para obter mais informações, acesse a página Idiomas compatíveis com OCR.

Modelos usados pela atividade

A atividade Extract Document Data usa o seguinte:

Endpoints públicos para modelos prontos para uso.
Modelos de ML personalizados implantados em projetos do aplicativo Document Understanding.
Modelo de extração generativo.

Compatibilidade do projeto

Windows | Multiplataforma

Configuração

Painel do Designer

Projeto - Requer que você selecione seu projeto do Document Understanding na lista suspensa. As opções disponíveis são:
- Predefinido - O projeto padrão
- Você pode criar um projeto personalizado acessando o Document Understanding.
Observação: se você tiver criado mais de 500 projetos em seu tenant e usar a atividade Extract Document Data, o UiPath Studio ou Studio Web não exibirá nenhum projeto além dos 500 iniciais.Portanto, esses projetos não podem ser usados.

Extrator - Selecione um extrator de seu projeto atual.
- Para o projeto Predefinido, você tem duas escolhas:
  - Selecione um pacote de ML. Acesse Modelos prontos para uso para obter uma lista de modelos pré-treinados que você pode usar.
    Observação: a atividade Extract Document Data substitui o tipo de documento com o extrator selecionado. Isso não é aplicável para modelos generativos.
  - Selecione o extrator Generativo.
    Observação: as informações enviadas para o Extrator generativo vão para uma instância do Modelo LLM. Essa instância não está publicamente disponível, não armazena os dados enviados e não os usa para fins de treinamento.
    
    Importante:
    Essa funcionalidade faz parte atualmente de um processo de auditoria e não deve ser considerada parte da Autorização do FedRAMP até que a revisão seja finalizada. Veja aqui a lista completa das funcionalidades atualmente em revisão.
Prompt - esse campo é exibido se você escolher a opção Generativo. Solicitação para identificar os campos a serem extraídos, fornecidos como pares de valor-chave, em que a chave representa o nome do campo e o valor, uma descrição para ele, ajudando o extrator a identificar o valor correspondente.Clique no campo e você receberá um prompt com as seguintes opções, fornecidas em pares:
- Nome do campo - Requer que você insira o nome do campo a ser extraído (Ex. Data de vencimento) (Limite de 30 caracteres)
- Solicitação generativa - Requer que você forneça a solicitação como entrada para o extrator generativo. O número máximo de caracteres permitidos é 1000. A resposta, resultado da extração, também chamada de Conclusão, tem um limite de 700 palavras. Isso é limitado a 700 palavras. Isso significa que você não pode extrair mais de 700 palavras de um único prompt. Se seus requisitos de extração excederem esse limite, você poderá dividir o documento em várias páginas, processá-las individualmente e mesclar os resultados posteriormente.
Dica: para obter boas práticas sobre como usar solicitações generativas, consulte a página Extrator generativo - Boas práticas .
Entrada - Requer que você especifique o próprio arquivo ou dados do documento, caso você tenha usado outras atividades do Document Understanding antes em seu fluxo de trabalho, (por exemplo, Classify Document).
Importante: o número máximo de páginas que um arquivo pode ter é 500. Os arquivos que excedem esse limite não são extraídos.

Painel de Propriedades

Entrada

Tempo limite (segundos) - Tempo máximo de execução (em segundos) para a chamada para o modelo generativo. Se a operação exceder esse tempo limite, ela será encerrada automaticamente para evitar atrasos ou travamentos. Essa propriedade é exibida apenas se o Extrator generativo estiver selecionado como extrator.
Validação automática — use esta opção para habilitar a validação automática, um recurso que ajuda a validar os resultados obtidos para a extração de dados em relação a um modelo generativo. O valor padrão do campo Validação automática é False.
- Limite de confiança — esse campo fica visível assim que você habilita a Validação automática. Os resultados da extração que ficam abaixo do limite são comparados ao modelo de extração generativo. Se corresponderem, o sistema ajustará a confiança da extração para atender ao valor limite. Os possíveis valores de limite variam de 0 a 100.
  Se o valor for definido como 0, nenhuma validação é aplicada. No entanto, se você definir um valor específico (de 0 a 100), o sistema verificará todos os resultados de extração abaixo desse valor. Por exemplo, se você definir um limite de confiança de 80%, o sistema aplicará a validação generativa para campos com confiança abaixo de 80%.
  
  Observação: a validação automática está disponível apenas para modelos de extração especializados.
Gerar Tipo de Dados - Se definido como True, indica que a saída deve ser gerada com base no extrator selecionado, resultando em um objeto IDocumentData<ExtractorType>.Ou então, se definido como False, indica que a geração de dados deve ser ignorada, resultando em um objeto IDocumentData<DictionaryData> genérico.
Acesse Dados do documento para obter detalhes adicionais e limitações disponíveis para os dois tipos de objeto.

Saída

Dados do documento - Todos os dados de campo extraídos do arquivo. Informações também podem ser recebidas de Classify Document.
Acesse Dados do documento para saber como os Dados do documento funcionam e como consumir os resultados extraídos para campos de valor único e múltiplo.

Usando o extrator generativo

Para começar rapidamente com os recursos generativos da atividade Extract Document Data, execute as seguintes etapas:

Adicione uma atividade Extract Document Data .
Na lista suspensa Projeto , selecione Predefinido.
Para Extrator, selecione Extrator generativo.
A propriedade Prompt aparece no corpo da atividade.

No campo Solicitação , forneça suas instruções como Pares de valor de chave de dicionário, onde:

A chave representa o nome do campo (exemplo: endereço de e-mail).
O valor representa o Prompt generativo: a descrição usada pelo extrator generativo para identificar o valor correspondente.
Por exemplo, verifique a tabela a seguir para obter uma amostra de pares de chave-valor: