- Primeros pasos
- Ejemplos de uso de la API de Document Understanding™
- Licencia
- Solución de problemas
Document Understanding API guide
Información general
Document UnderstandingTM APIs can be an alternative to the RPA approach. By initiating an API call, you can:
- Encuentra información sobre el proyecto, los extractores o los clasificadores utilizados dentro del proyecto.
- Utiliza las API de digitalización.
- Classify documents using specialized (Classifying a document example).
- Extract document data using specialized (Start the extraction fields request example).
- Validar la información que se digitalizó, clasificó y, o extraída previamente.
Dependiendo de tu caso de uso, puedes elegir entre utilizar API asíncronas o síncronas.
Utiliza las API asíncronas cuando:
- Debas procesar grandes documentos, con más de cinco páginas.
- Debas gestionar varias operaciones simultáneamente. Las API asíncronas permiten el procesamiento simultáneo y evitan el tiempo de inactividad, lo que da lugar a un mayor rendimiento del sistema. Esto significa que puedes enviar un documento y pasar a otra tarea en lugar de esperar la respuesta.
- Tengas un gran conjunto de datos que necesita procesamiento, que lleva un tiempo significativo.
Utiliza las API síncronas cuando:
- Debas procesar documentos más pequeños con un máximo de cinco páginas.
- Necesites interacción en tiempo real, en forma de solicitud y respuesta, y no necesites la multitarea. Una API síncrona puede bloquear otras operaciones mientras espera una respuesta.
- Tengas un conjunto de datos más pequeño que necesita procesamiento.
Los siguientes estados se aplican a las API así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.
Utilizar la API de Document Understanding para acceder a las capacidades de la misma manera que lo harías a través de RPA.Para consumir las API, puedes utilizar cualquier lenguaje de programación/scripting (ya que las llamadas se realizan utilizando HTTP), incluido 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 probar las capacidades, use Swagger como sandbox.
Puedes elegir trabajar con un modelo de creación predefinido o personalizado. Los modelos creados a medida son los que crea mientras utiliza Document Understanding. Ya está disponible un modelo predefinido para consumir, que incluye modelos predefinidos listos para usar.
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).
Dependiendo de la operación, las llamadas a la API de Document Understanding utilizan las siguientes clases:
- Document Class for digitized documents.
- Extraction Result for extraction results.
- Classification Result for classification results.