- Introdução
- Exemplos usando a API do Document Understanding™
- Licenciamento
- Solução de problemas

Document Understanding API guide
Visão geral
Document UnderstandingTM APIs can be an alternative to the RPA approach. By initiating an API call, you can:
- Saiba mais sobre o projeto, extratores ou classificadores usados dentro do projeto.
- Use as APIs de digitalização.
- Classify documents using specialized (Classifying a document example).
- Extract document data using specialized (Start the extraction fields request example).
- 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: job was created and it's waiting to be processed.
- Running: job was created, was picked up, and is currently being worked on
- Failed: job finished but failed.
- Succeeded: job finished and succeeded.
Classification & Extraction APIs are available for both synchronous and asynchronous consumption. The synchronous consumption supports multi-page documents, up to 5 pages, while the asynchronous consumption posts the request via a start method and retrieves the result via polling.
Use APIs do Document Understanding para acessar os recursos da mesma maneira que faria por meio de RPA. Para consumir as APIs, você pode usar qualquer linguagem de programação/script (pois as chamadas são feitas usando HTTP), incluindo RPA.
You can access the APIs via Swagger: In the toolbar of the Document UnderstandingTM service, look for the Rest API dropdown, and click Framework.

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.
The data received from calling the Digitization endpoint is retained for seven days. In this timeframe, the result is available via the received document ID. Afterwards, you would need to submit a new digitization request.
The data received from calling the asynchronous Classification and Extraction endpoints is retained for one day (24 hours).
Dependendo da operação, as chamadas de API do Document Understanding usam as seguintes classes:
- Document Class for digitized documents.
- Extraction Result for extraction results.
- Classification Result for classification results.