document-understanding
2024.10
true
  • Introdução
    • Visão geral
      • Usando as credenciais para solicitações de HTTP
      • Usando as credenciais no Swagger
    • Limites e cota
  • Exemplos de uso da API do Document Understanding™
  • Licenciamento
  • Solução de problemas
UiPath logo, featuring letters U and I in white
Guia da API do Document Understanding
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 11 de nov de 2024

Visão geral

As APIs do Document UnderstandingTM podem ser uma alternativa à abordagem de RPA. Ao iniciar uma chamada de API, você pode:

  • Saiba mais sobre o projeto, extratores ou classificadores usados dentro do projeto.
  • Use as APIs de digitalização.
  • Classifique documentos usando produtos especializados ( Exemplo de classificação de um documento ).
  • Extrair dados de documentos usando recursos especializados (Exemplo de Iniciar solicitação de campos de extração ).
  • Validar informações que foram digitalizadas, classificadas e ou extraídas anteriormente.

Dependendo de seu caso de uso, você pode escolher entre o uso de APIs assíncronas ou síncronas.

Use APIs assíncronas quando:
  • Você precisa processar documentos grandes, com mais de cinco páginas.
  • Você precisa lidar com várias operações simultaneamente. As APIs assíncronas permitem o processamento simultâneo e evitam o tempo ocioso, levando a uma maior taxa de transferência do sistema. Isso significa que você pode enviar um documento e passar para outra tarefa, em vez de esperar pela resposta.
  • Você tem um grande conjunto de dados que precisa de processamento, levando um tempo significativo.
Use APIs assíncronas quando:
  • Você precisa processar documentos menores com no máximo cinco páginas.
  • Você precisa de interação em tempo real, com base em solicitação e resposta, e a multitarefa não é necessária. Uma API síncrona pode bloquear outras operações enquanto aguarda uma resposta.
  • Você tem um conjunto de dados menor, que precisa de processamento.
Os seguintes status se aplicam a APIs assíncronas:
  • NotStarted: o trabalho foi criado e está aguardando para ser processado.
  • Execução: o trabalho foi criado, foi escolhido e está sendo trabalhado no momento
  • Falha: trabalho concluído, mas falhou.
  • Sucesso: trabalho concluído e bem-sucedido.

As APIs de classificação e extração estão disponíveis para consumo síncrono e assíncrono. O consumo síncrono suporta documentos de várias páginas, até 5 páginas, enquanto o consumo assíncrono publica a solicitação por meio de um método de início e recupera o resultado por meio de pesquisa.

Use APIs do Document Understanding para acessar os recursos da mesma forma que você faria por meio de RPA. Para consumir as APIs, você pode usar qualquer linguagem de programação/script (já que as chamadas são feitas usando HTTP), incluindo RPA.

Você pode acessar as APIs por meio do Swagger: na barra de ferramentas do serviço Document UnderstandingTM , procure o menu suspenso Rest API e clique em Estrutura.


Para experimentar os recursos, use o Swagger como seu sandbox.

Você pode optar por trabalhar com um modelo de compilação predefinido ou personalizado. Os modelos construídos personalizados são aqueles criados por você durante o uso do Document Understanding. Um modelo predefinido já está disponível para ser consumido e inclui modelos predefinidos prontos para uso.
Importante: os dados recebidos ao chamar o endpoint de digitalização são mantidos por sete dias. Nesse período, o resultado fica disponível por meio do ID do documento recebido. Depois, você precisaria enviar uma nova solicitação de digitalização.
Importante: os dados recebidos ao chamar os endpoints de Classificação e Extração assíncronos são mantidos por um dia (24 horas).
Dependendo da operação, as chamadas de API do Document Understanding usam as seguintes classes:

Esta página foi útil?

Obtenha a ajuda que você precisa
Aprendendo RPA - Cursos de automação
Fórum da comunidade da Uipath
Uipath Logo White
Confiança e segurança
© 2005-2024 UiPath. Todos os direitos reservados.