document-understanding
2024.10
true
  • Primeros pasos
    • Información general
      • Uso de las credenciales para las solicitudes HTTP
      • Uso de las credenciales en Swagger
    • Límites y cuotas
  • Ejemplos de uso de la API de Document Understanding™
  • Licencia
  • Solución de problemas
UiPath logo, featuring letters U and I in white
Guía de la API de Document Understanding
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 11 de nov. de 2024

Información general

Las API de Document UnderstandingTM pueden ser una alternativa al enfoque RPA. Al iniciar una llamada a la API, puedes:

  • Encuentra información sobre el proyecto, los extractores o los clasificadores utilizados dentro del proyecto.
  • Utiliza las API de digitalización.
  • Clasificar documentos utilizando un ejemplo especializado (Clasificar un documento ).
  • Extraer datos del documento utilizando un ejemplo especializado (Iniciar la solicitud de campos de extracción ).
  • 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: el trabajo se creó y está esperando a ser procesado.
  • En ejecución: se creó el trabajo, se recogió y actualmente se está realizando
  • Error: trabajo finalizado pero falló.
  • Correcto: trabajo finalizado y correcto.

Las API de clasificación y extracción están disponibles tanto para el consumo síncrono como para el asíncrono. El consumo síncrono admite documentos multipáginas, de hasta 5 páginas, mientras que el consumo asíncrono envía la solicitud a través de un método de inicio y recupera el resultado mediante sondeo.

Utiliza las 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 mediante HTTP), incluido RPA.

Puedes acceder a las API a través de Swagger: en la barra de herramientas del servicio Document UnderstandingTM , busca el menú desplegable API Rest y haz clic en Marco.


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.
Importante: Los datos recibidos de la llamada al punto final de digitalización se conservan durante siete días. Durante este período de tiempo, el resultado está disponible a través del ID del documento recibido. Después, tendrás que enviar una nueva solicitud de digitalización.
Importante: los datos recibidos de las llamadas a los puntos finales asíncronos de clasificación y extracción se conservan durante un día (24 horas).
Dependiendo de la operación, las llamadas a la API de Document Understanding utilizan las siguientes clases:
  • Clase de documento para documentos digitalizados.
  • Resultado de extracción para los resultados de extracción.
  • Resultado de la clasificación para los resultados de la clasificación.

¿Te ha resultado útil esta página?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Uipath Logo White
Confianza y seguridad
© 2005-2024 UiPath. Todos los derechos reservados.