Cargar taxonomía

UiPath.IntelligentOCR.Activities.TaxonomyManagement.LoadTaxonomy

Convierte el archivo taxonomy.json creado con la ayuda del Gestor de taxonomía en una variable que puede ser utilizada posteriormente con otras actividades.

Propiedades

Común

• NombreParaMostrar: el nombre de la actividad para ser mostrado.

Otros

• Privado : si se selecciona, los valores de variables y argumentos ya no se registran en el nivel Detallado.

Salida

• Taxonomía : la taxonomía que quieres cargar, almacenada en una variable DocumentTaxonomy . Esta salida se puede usar posteriormente en actividades que reciban una taxonomía como entrada.
  Importante: Si utilizas una GPU Intel Xe y Gestor de taxonomía no se muestra correctamente te recomendamos actualizar el controlador gráfico a la versión más reciente. Para obtener más información, visita esta página.

Métodos de extensión de taxonomía

• Serialize(): llamado en un objeto DocumentTaxonomy, el método Serialize() devuelve una representación JSON del objeto, para que pueda almacenarse y recuperarse para su uso posterior.
• Deserialize(String): la extensión estática DocumentTaxonomy.Deserialize(jsonString) devuelve un objeto DocumentTaxonomy, hidratado con los datos codificados JSON pasados como parámetro.
• GetFields(String): llamado en un objeto DocumentTaxonomy , el método GetFields() llamado con una cadena DocumentTypeId devuelve una lista de campos definidos dentro de ese tipo de documento.

El Gestor de taxonomía se puede usar para crear y editar un archivo de Taxonomía específico para tu proyecto de automatización actual. Este archivo de Taxonomía contiene tipos de documentos definidos por el usuario, organizados en Grupos y Categorías.

Puedes seguir usando el archivo de Taxonomía convirtiéndolo en un tipo de datos .NET con la actividad Cargar taxonomía, y luego pasarlo como entrada para actividades como:

• Clasificar ámbito de documento
• Entrenar el alcance de los clasificadores
• Entrenar el alcance de los Extractores
• Mostrar Estación de Validación

Al Gestor de taxonomía solo se puede acceder después de instalar un paquete UiPath.IntelligentOCR.Activities superior o igual a v1.6.0 como dependencia para tu proyecto. Una vez instalado el paquete, aparecerá el botón Gestor de taxonomía en la cinta de opciones, en la sección de Asistentes.

Figura 1. Descripción general del Gestor de taxonomía en la cinta de Studio

Usar Gestor de taxonomía

La ventana del Gestor de taxonomía te permite crear tipos de documentos organizados por grupos y categorías. Cuando se abre por primera vez en un proyecto, no se define ningún grupo, categoría o tipo de documento.

Figura 2. El Gestor de taxonomía antes de asignar cualquier tipo de documento o campo

Establecer la estructura

El primer paso consiste en crear un grupo o un tipo de documento. La diferencia entre ambos es que un grupo implica una estructura jerárquica, mientras que un tipo de documento puede crearse como un archivo único. Un proyecto complejo implica la creación de grupos, categorías y tipos de documentos, mientras que un proyecto sencillo puede requerir solo uno o dos tipos de documentos.

Crear un grupo

Cuando se crea un grupo, también es necesaria una categoría para el tipo de documento que se desea crear en el grupo. Esto se consigue utilizando el botón Grupo. Una vez que hayas elegido un nombre para tu grupo, puedes guardarlo utilizando el botón Guardar o utilizando la tecla Intro.

Crear una categoría

Una vez que se define y selecciona un grupo, puedes crear una Categoría y/o un Tipo de documento dentro del grupo, utilizando sus botones correspondientes.Selecciona Guardar o utiliza la tecla Intro para guardar la configuración.

Crear un tipo de documento

Un Tipo de documento puede crearse como parte de un grupo o como documento único. Cuando se crea dentro de un grupo, asegúrate de seleccionar el grupo y luego selecciona Tipo de documento.

Si el Tipo de Documento se crea como un único archivo, asegúrate de que no se selecciona ningún grupo y selecciona Tipo de Documento.Después de seleccionar Tipo de Documento, introduce un nombre para el archivo y selecciona Guardar.

Nota: cuando se envía una acción de Document Understanding desde Orchestrator mientras se utiliza la versión 2020.10 de Studio, asegúrate de que la taxonomía no tenga tipos de documentos creados sin categoría.

Si seleccionas un tipo de documento ya creado, podrás cambiar su nombre, copiar su ID único al portapapeles, reasignarlo a otro grupo o categoría, o a ninguno de ellos. También puedes introducir un código para el tipo de documento.

Una vez que se guarda un tipo de documento, se genera un ID de tipo de documento para él. Al abrir el documento para editarlo, se muestra el ID junto a la pestaña Nombre del tipo de documento . El ID del tipo de documento tiene una estructura del tipo Group.Category.Document y se puede copiar en el portapapeles. El código de ID del tipo de documento es una funcionalidad opcional y se puede utilizar para encontrar sus documentos o asignar sus documentos a los tipos de documentos que defina en la taxonomía.

Crear campos

Cuando se selecciona el Tipo de Documento, el botón Campo aparece disponible para que puedas crear un nuevo campo.Una vez que se selecciona el botón Campo, puedes introducir un nombre para él y seleccionar su tipo en la lista desplegable.

La categoría Campo tiene dos pestañas: Detalles y Reglas. La pestaña Detalles proporciona información sobre el campo seleccionado, como Nombre del campo, la tecla de acceso rápido asignada o el tipo de campo, mientras que la pestaña Reglas te permite crear reglas que deben cumplirse por el resultado de extracción para el campo.

Los tipos de campo disponibles son los siguientes:

• Texto
• Número
• Fecha: elegir este tipo también te permite especificar un formato esperado, que es opcional.
  Nota:

  Si deseas añadir un formato esperado, utiliza un formato compatible con MSDN (MicroSoft Developer Network).

  Este formato lo pueden utilizar los extractores y la actividad Ámbito de extracción de datos lo utiliza cuando intenta analizar una fecha en sus componentes: día, mes y año.

• Nombre
• Address
• Conjunto: elegir este tipo te permite añadir varios valores al campo de una lista preestablecida.
• Booleano
• Tabla: elegir este tipo te permite editar la estructura de la tabla, ya que puedes añadir columnas y editar su nombre y tipo.

Pestaña Detalles

Después de crear el nuevo campo, selecciónalo para ver más información. De forma predeterminada, al abrir un campo, se muestra la pestaña Detalles que te permite modificar el nombre, el color o la tecla de acceso rápido del campo. También puedes especificar si es multivalor (Es multivalor) o si permite que se procesen valores sin evidencia en el documento (Requiere referencia). La opción multivalor permite que un campo tenga varios valores, sin estar restringido a una lista específica.

Para obtener más información sobre cómo utilizar los dos campos, consulta las siguientes descripciones:

• Es multivalor: si un campo se establece como multivalor, puedes tener más de un valor informado para ese campo en particular. Por ejemplo, deseas extraer una "Lista de directores" donde puedes tener un número variable de entradas. Imagina un campo multivalor como una tabla de una sola columna.
• Requiere referencia: cuando un campo requiere referencia, puedes añadirle un valor solo si seleccionas algo del documento que ves en Estación de Validación.Para los campos especiales en los que deseas capturar valores que quizás no sean visibles en el documento, puedes cambiar Requiere referencia a Desactivado.El efecto será que el usuario pueda añadir un valor sin especificar un lugar del documento de donde provienen esos valores.

También puedes seleccionar el Tipo de Campo de la lista desplegable o añadir un valor predeterminado.Utiliza el campo Valor Predeterminado para definir valores que se rellenarán en el resultado de la extracción, en caso de que no haya valor para el campo identificado en el documento.

Figura 3. Descripción general de la pestaña Detalles de un campo

Puedes elegir habilitar las notas del validador desde la pestaña Detalles . Al configurar las notas del validador, el validador humano puede añadir notas sobre la decisión que ha tomado durante la validación. Puedes configurar los siguientes ajustes:

• Solo lectura: si se habilita, el validador humano puede ver cualquier nota del validador establecida en el campo ResultadoDeExtracción en la Estación de validación, como un mensaje. Si está deshabilitado (estado predeterminado), el validador humano también puede editar esa nota en la Estación de validación y, por lo tanto, comunicar al robot información sobre la decisión tomada.
• Texto: si se selecciona Texto , la nota del validador se muestra como un mensaje de texto (o texto editable cuando la edición está habilitada) en la Estación de validación. El validador humano puede ver, editar o añadir un mensaje de hasta 200 caracteres en la Estación de validación.
• Opciones: si seleccionas Opciones, puedes configurar una serie de botones de radio que el validador humano puede ver y, si no es de solo lectura, seleccionar en la Estación de validación. Puedes añadir un máximo de 10 opciones.

Consejo: consulta la página Clase de ResultadoDeExtracción en la sección UiPath.DocumentProcessing.Contracts para obtener más información sobre los dos métodos relacionados con las notas del validador GetFieldValidatorNotes(<fieldId>)y SetFieldValidatorNotes(<fieldId>, <validatorNote>).

Los campos creados pueden eliminarse mediante el botón Eliminar que aparece junto a ellos o reordenarse mediante la función de arrastrar y soltar.

Un campo también puede eliminarse desde la ventana Detalles seleccionando Eliminar.

Volviendo sobre estos pasos puedes crear múltiples grupos, categorías y tipos de documento, que podrás filtrar utilizando el campo Buscar.

Pestaña de reglas

Las reglas de campo te ayudan a optimizar los resultados de extracción y validarlos automáticamente al ejecutar su flujo de trabajo.Su rol es aumentar la eficiencia de extracción y ayudarte a validar fácilmente los campos que necesitan atención en la Estación de validación, resaltándolos.Puedes crear varias reglas que se apliquen a un campo.

Una regla se define estableciendo el tipo de evaluador y el nivel de severidad.

Tipo de evaluador

Utilice el Tipo de evaluador para especificar cómo deben evaluarse las reglas definidas. Hay dos tipos de evaluadores entre los que puede elegir: Y, O.

Tabla 1. Tabla que muestra los tipos de evaluadores, sus descripciones y ejemplos de ellos.

Tipo de evaluador	Descripción	Ejemplo
AND	Utilice este tipo de evaluador cuando sea necesario ejecutar todas las reglas.	Regla : el número de factura comienza con A y termina con X. Resultado válido : el valor de campo válido es A123X. Resultado no válido: el valor del campo válido es A123.
O	Solo es necesario ejecutar una de las reglas.	Regla : el número de factura que comienza con A OR es 123. Resultado válido: el valor del campo válido es A123, 123. Resultado no válido: el valor del campo válido es 234, 1A23.

Nivel de severidad

Indica la severidad de todas las reglas definidas para un campo. No puede establecer un nivel MUST si se ha incumplido la regla en la sesión de la Estación de validación. Hay dos niveles de severidad entre los que puede elegir: MUST, SHOULD.

La regla creada se activa una vez que se identifica el nivel de severidad establecido.

Cuando desee enviar una regla, una regla MUST requiere un 100% de éxito; de lo contrario, la operación de envío fallará. Una regla SHOULD le permite Enviarla incluso si la regla se ha incumplido.

Siempre puedes comprobar si se rompe una regla utilizando el método auxiliar de la clase de ExtractionResult, que reside en el paquete de actividades UiPath.DocumentProcessing.Contracts.

Tabla 2. Tabla que muestra los niveles de criticidad y sus descripciones

	Descripción
MUST	Utilice este nivel de severidad cuando la regla creada sea imprescindible para incluirla en el proceso de extracción del resultado.
SHOULD	Utiliza este nivel de severidad cuando la regla creada sea opcional.

Una vez que haya seleccionado el tipo de evaluador y el nivel de severidad, debe establecer un tipo aplicable a su regla recién creada. Hay varias opciones. Aquí hay una lista completa con todos los disponibles:

• No esta vacío
• Valores posibles
• Comienza con
• Termina en
• Contiene
• Longitud fija
• Es un correo electrónico
• Expresiones regulares
  Nota: el tipo de campo para el cual creaste una regla dicta el número de tipos de reglas posibles entre los que puedes seleccionar uno.Por ejemplo, un campo de tipo Texto muestra todos los tipos de reglas posibles, mientras que un campo de tipo Fecha muestra solo dos tipos de reglas, No está vacío y Valores posibles.

Tipo de reglas

La siguiente tabla muestra detalles para cada tipo de regla disponible, clasificadas dependiendo del nivel de criticidad y el tipo de evaluador.

Tabla 3. Tipos de reglas y sus descripciones, dependiendo del nivel de criticidad y el tipo de evaluador.

	Descripción	Tipo de campo	Nivel de severidad	Tipo de evaluador
No esta vacío	El valor extraído no puede estar vacío, por lo que el campo es obligatorio. Si falta el valor, requiere validación / entrada manual.	Aplicable a campos de los siguientes tipos: Número text Fecha Dirección name ESTABLECER Booleano	MUST SHOULD	AND O
Valores posibles	El usuario define todos los valores posibles y los datos extraídos son uno de los valores añadidos como entrada al crear la regla (por ejemplo, Tipo de Empleador es "tiempo completo", "tiempo parcial" o "pasantía").	Aplicable a campos de los siguientes tipos: Número text Fecha	MUST SHOULD	AND O
Expresión	Definir expresiones matemáticas que actúen como regla para extraer datos.	Aplicable a campos de tipo número. Se requiere una condición al configurar la regla. Elija una de las siguientes opciones: Es igual a No es igual a Es mayor que Es mayor que o igual a Es menor que o igual a Se requiere una expresión matemática. Utiliza los operadores predefinidos para definir tu expresión. Consulta los siguientes ejemplos: Suma cantidad * Precio unitario neto \ n- Total = Subtotal + Entrega Descuento: el operador de suma recopila todos los valores de la columna de una tabla.	MUST SHOULD	AND O
Comienza con	Esta es una regla fija, lo que significa que el valor extraído debe comenzar con uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Termina en	Esta es una regla fija que significa que el valor extraído debe terminar con uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Contiene	Esta es una regla fija, lo que significa que el valor extraído debe contener uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Longitud fija	Esta es una regla fija, lo que significa que el valor extraído debe tener una longitud fija determinada.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Es un correo electrónico	Esta es una regla fija que significa que el valor extraído debe escribirse en un formato de correo electrónico.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O
Expresiones regulares	Esta es una regla fija que significa que el valor extraído debe contener una expresión regular similar a uno de los valores añadidos por el usuario.	Aplicable a campos de los siguientes tipos: text Dirección name	MUST SHOULD	AND O

Usando reglas

Tomemos un ejemplo práctico para comprender mejor la aplicabilidad de estas reglas. Crearemos un conjunto de reglas para el campo Dirección del documento. Consulta los siguientes pasos de ejemplo para aprender a crear una nueva regla o un conjunto de reglas para un campo:

1. Selecciona un campo en el panel de Taxonomía.
2. Ve a la pestaña Reglas.
3. Selecciona Añadir nuevo, para añadir una nueva regla.
4. Escribe en la regla full address, para la que el Tipo es Contiene, y la Expresión es st, str, street.
5. Elige el tipo de evaluador.

   En este ejemplo, selecciona OR.

6. Elige el nivel de criticidad.

   En este ejemplo, selecciona MUST.

7. Selecciona Añadir nuevo.
8. Escribe en la regla phone number, para la que el Tipo es No está vacío.
9. Selecciona Añadir nuevo.
10. Escribe en la regla city or state, para la que el Tipo es Contiene, y la Expresión es city, state.

La siguiente imagen animada muestra los pasos descritos anteriormente.

Figura 4. Imagen animada que muestra cómo añadir tres reglas para un campo

Otras opciones

Edición

Puedes editar el nombre de cualquier grupo, categoría o tipo de documento que hayas creado. Para ello, selecciona uno de los tres niveles de configuración y edita el campo Nombre.

Eliminación

También se pueden eliminar grupos, categorías y tipos de documentos. Hay dos opciones disponibles:

• Selecciona Eliminar , en el elemento principal del objeto que deseas eliminar.
• Selecciona Eliminar mientras seleccionas el objeto que deseas eliminar.

En ambos casos, se muestra una ventana emergente pidiéndote que confirmes la acción de eliminación. Selecciona Eliminar para aprobar la acción.

Personalización y accesibilidad

Automáticamente, se asignan una tecla de acceso rápido y un color al campo recién creado. Puedes utilizarlos para una mejor visibilidad y una navegación más rápida a través de tu taxonomía. Puedes personalizarlos haciendo clic en la tecla de acceso rápido o en el campo de código de color.

Un campo personalizado con color y tecla de acceso rápido puede indicar a la Estación de validación y al Gestor de plantillas que utilicen el color asignado al mostrar el campo y que utilicen la tecla de acceso rápido asignada como método abreviado para proporcionar valores a los campos. Visita la Estación de Validación para obtener más información sobre cómo utilizar los accesos directos de campo para asignar valores a un campo.

Para asignar un color y una tecla de acceso rápido para un campo, selecciona el campo, elige un código de color en el campo Color y luego selecciona una tecla de acceso rápido específica en el menú de Tecla de acceso rápido.

Navega por el Gestor de taxonomía utilizando los atajos de teclado. Selecciona Mostrar atajos de teclado disponibles y activa la opción Activar/desactivar atajos de teclado para evitar la activación accidental de los atajos de teclado.Los nodos también pueden contraerse.

Nota: Los cambios que realices en el Gestor de taxonomía se guardan automáticamente en el archivo taxonomy.json específico de tu proyecto.