Crear el flujo de trabajo de la API

Cree un flujo de trabajo de la API de Monster Query que llame al SRD de D&D 5e y devuelva datos de monstruos estructurados.

Paso 1: crea el flujo de trabajo de la API de Monster Query

Un flujo de trabajo de API es un flujo de trabajo ligero publicado como punto final de API. Creas uno que envuelve la búsqueda de monstruos SRD de Open5e D&D 5e: una entrada, una solicitud HTTP, una salida. Una vez publicado, aparece en el Agent Builder como una herramienta a la que tu agente puede llamar.

Este paso tiene seis pasos secundarios; asigna entre 10 y 15 minutos para completarlo.

Crear un nuevo proyecto de flujo de trabajo de API

Selecciona Crear nuevo en tu espacio de trabajo de Cloud y elige Flujo de trabajo de API como tipo de proyecto.

Cambia el nombre de la solución y el flujo de trabajo predeterminado. Abre el menú contextual para cada nombre en el explorador de proyectos y selecciona Cambiar nombre:

• Nombre de la solución: Monster Query - 5e SRD
• Nombre del flujo de trabajo: API Query - 5e Monsters

Configurar entradas y salidas

Selecciona Data Manager (icono del portapapeles en la barra izquierda) para acceder a las variables de datos para el flujo de trabajo.

Añade un argumento de entrada al flujo de trabajo:

Nombre	Tipo	Obligatorio	Descripción
searchName	Cadena	Sí	El nombre del monstruo o el nombre parcial que se buscará

Añade un argumento de salida:

Nombre	Tipo	Obligatorio	Descripción
monsterResults	Matriz	Sí	Lista de resultados de Monster

Añadir la solicitud HTTP

1. En el lienzo del flujo de trabajo, selecciona + entre actividades para abrir el menú de actividades. Selecciona Solicitud HTTP.
2. Abre el menú contextual de la actividad y selecciona Cambiar nombre. Nómbralo HTTP Request - Open5e Monster Query.
3. En el panel Propiedades , establece Autenticación en Autenticación manual.
4. Establece Método en GET.
5. Establezca la URL en https://api.open5e.com/v1/monsters/.
6. Cambia el nombre de la salida de la actividad a searchResults.

Establece la propiedad Parámetros de consulta:

Abre la propiedad Parámetros de consulta y añade los siguientes campos:

Clave	Valor
name__icontains	@searchName
document__slug	wotc-srd
limit	10
fields	slug,name,desc,type,size,cr,challenge_rating,alignment,v2_converted_path

Qué hace cada parámetro:

• name__icontains: coincidencia parcial que no distingue entre mayúsculas y minúsculas; dragon devuelve "Dragón rojo adulto", "Dragón azul joven" y otros
• document__slug: wotc-srd: filtra el SRD oficial de D&D 5e; sin él, los resultados incluyen contenido de terceros
• limit: 10: limita los candidatos a 10; suficiente para que el agente razone sin inundar su contexto
• fields: limita la respuesta a solo los campos que necesita el agente; el objeto de monstruo Open5e completo es mucho más grande y desperdiciaría el presupuesto de tokens

Referencia de propiedad de solicitud HTTP

La actividad expone los bloques de construcción HTTP estándar. La mayoría de los que configurarás para cada API que llames; algunas las omitirás para API públicas como esta:

• Autenticación: opciones prediseñadas para OAuth 2.0, clave API y autenticación básica. Establezca aquí como "Autenticación manual" porque Open5e no requiere ninguna. Para las API autenticadas, elige la opción adecuada y proporciona las credenciales.
• Encabezados: pares clave/valor enviados con cada solicitud. Usos comunes: Authorization: Bearer <token> para API basadas en token, Accept: application/json para controlar el formato de respuesta y encabezados de versiones de API.
• Cuerpo: se utiliza con solicitudes POST, PUT y PATCH para enviar JSON, datos de formulario o contenido sin procesar. No aplicable a las solicitudes GET, que llevan parámetros en la URL a través de parámetros de consulta.
• Parámetros de consulta: pares clave/valor anexados a la URL. La sintaxis @variableName hace referencia a los argumentos del flujo de trabajo por nombre; @searchName extrae el argumento de entrada searchName definido en el Gestor de datos. Consulta configurar actividades para obtener más información sobre variables y expresiones en Studio Web.
• Salida (renombrado a searchResults): recibe la respuesta HTTP completa, incluido el código de estado, los encabezados y el cuerpo. Cambiar el nombre desde el predeterminado mantiene legible la expresión Establecer respuesta.

Añadir la respuesta

1. En el lienzo del flujo de trabajo, selecciona + después de la solicitud HTTP y selecciona Establecer respuesta.

   Establecer respuesta define lo que el flujo de trabajo de la API devuelve a su autor de la llamada (en este caso, lo que recibe la herramienta del agente cuando invoca el flujo de trabajo). Lo que pongas en el cuerpo de la respuesta aquí se convierte en la salida de la herramienta sobre la que razona el agente.

2. Establece el cuerpo de la respuesta en:

   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   

$context.outputs contiene todas las salidas con nombre de las actividades de este flujo de trabajo. searchResults es la variable de salida que has cambiado de nombre en la actividad Solicitud HTTP; .content.results navega en el sobre de respuesta en el que Open5e envuelve sus datos, hasta la matriz real de entradas de monstruos. Para obtener más información, consulta la documentación de UiPath sobre el uso de Javascript para acceder a los datos del flujo de trabajo.

Probar el flujo de trabajo

1. Selecciona Depurar en la barra de herramientas.
2. En el panel de entrada, establece searchName como dragon o goblin y ejecuta el flujo de trabajo.
3. Verifique que la respuesta incluya una matriz monsterResults con entradas de monstruos antes de continuar.

Una respuesta correcta contiene hasta 10 entradas, cada una con campos como name, type, cr y slug. Si ve una matriz vacía, pruebe con un término de búsqueda diferente; no todos los nombres de criaturas tienen una coincidencia exacta en el SRD.

Publicar en su fuente

La publicación registra el flujo de trabajo como un proceso implementable en Orchestrator. Esto es lo que lo hace reconocible en la lista de recursos disponibles del Agent Builder: el creador muestra los flujos de trabajo publicados desde tu espacio de trabajo, no los borradores guardados localmente en Studio Web.

1. Selecciona Publicar en la barra de herramientas.
2. En el cuadro de diálogo de publicación, selecciona Para mí publicar en tu fuente de espacio de trabajo personal. Una fuente de espacio de trabajo personal es un repositorio de paquetes privado vinculado a tu espacio de trabajo de Orchestrator; publicar "Para mí" hace que este flujo de trabajo sea visible solo para ti, que es el ámbito correcto para el desarrollo y las pruebas. Consulta Espacios de trabajo personales en los documentos de UiPath para obtener más información.
3. Selecciona Publicar para confirmar.

Nota:

¿El flujo de trabajo no aparece en Recursos disponibles en el paso 3? El flujo de trabajo debe publicarse (no solo guardarse) antes de que sea visible como herramienta. Si no aparece, vuelve aquí y confirma que la publicación se ha completado correctamente y, a continuación, actualiza Agent Builder.

---

Con el flujo de trabajo publicado, está disponible en el Agent Builder como herramienta conectable en la siguiente sección.