Crear tu primer flujo de trabajo de API

El siguiente tutorial proporciona experiencia práctica con los conceptos clave detrás de la interfaz de flujo de trabajo de la API a través de un ejemplo simple utilizando la API pública de Petstore.

En este ejemplo, solicitas "Información de la mascota" de un modelo lingüístico (LLM) y utilizas esos datos para añadir mascotas a Swagger Petstore. La tienda de mascotas Swagger (https://petstore.swagger.io) ofrece puntos finales de API accesibles y fáciles de usar, disponibles con o sin autenticación.

Paso 1: llamar al LLM

1. En el lienzo del diseñador de flujo de trabajo de la API, selecciona Añadir (el icono más +).
2. Selecciona Conector > Actividades UiPath GenAI > Generación de contenido.
3. Configura o selecciona una conexión existente en el panel Propiedades .
4. Configura estas propiedades:
   • Modelo: gpt-4o-mini-2024-07-18

   • Prompt

     Para la tienda de mascotas swagger, crea los detalles de una nueva criatura de fantasía que se puede añadir a su inventario. Responda solo con json válido. Devuelve una matriz de 5 de estos".

5. Depura tu flujo de trabajo hasta este punto.
6. Consulta los resultados en el panel Salida . Deberías ver la entrada y la salida sin procesar de la llamada de actividad. La respuesta debe ser similar a la siguiente:

   {
     "cacheReadInputTokens": 0,
     "created": 1745444601,
     "usage": {
       "total_tokens": 741,
       "completion_tokens": 686,
       "prompt_tokens": 55,
       "cache_read_input_tokens": 0
     },
     "contextGroundingCitationsString": "[]",
     "totalTokens": 741,
     "promptTokens": 55,
     "model": "gpt-4o-mini-2024-07-18",
     "id": "chatcmpl-BPcADRRpy7ZDZpBOxp6XJYk0HOpaa",
     "text": "```json\n[\n    {\n        ....  \"A stealthy creature that blends into the shadows, highly elusive.\"\n    }\n]\n```",
     "choices": [
       {
         "index": 0,
         "finish_reason": "stop",
         "message": {
           "content": "```json\n[\n  ...ws, highly elusive.\"\n    }\n]\n```",
           "role": "assistant"
         }
       }
     ],
     "completionTokens": 686,
     "object": "chat.completion"
   }

Paso 2: utilizar Script para formatear correctamente la respuesta

La información que necesitas se encuentra dentro de la propiedad content.text , que no tiene el formato correcto.

1. A tu flujo de trabajo de API actual, añade la actividad Script .
2. Abre el editor de expresiones y escribe lo siguiente:

   const cleanedJsonStr = $context.outputs.v2_sub_generateChatCompletion_1.content.text
     .replace(/^```json\n/, '')
     .replace(/\n```$/, '');
   
   // Step 2: Parse into JSON
   let parsedObj;
   parsedObj = JSON.parse(cleanedJsonStr);
   return { aipet: parsedObj };

   Este código JavaScript analiza el objeto content.text y lo devuelve en un formato limpio.
3. Vuelve a depurar tu flujo de trabajo. Observa la respuesta con el formato correcto.

Paso 3: iterar sobre la matriz de respuesta

El LLM devolvió varios ejemplos favoritos en forma de matriz, como se indica en la solicitud del paso 1.

1. A tu flujo de trabajo de API actual, añade la actividad Bucle > ParaCada .

2. Configura la actividad Para cada de la siguiente manera:

   • En :

     $context.outputs.Javascript_1.aipet

   • Nombre del elemento : elemento actual
   • Acumular resultados : activado

   Este comando itera a través de cada elemento de la matriz de respuesta.

Paso 4: añadir la respuesta devuelta a Petstore

1. Dentro del cuerpo de la actividad Para cada , añade la actividad HTTP y configúrala de la siguiente manera:
   • Método : POST
   • URL de solicitud : https://petstore.swagger.io/v2/pet

   • Cuerpo de la solicitud : abre el editor de expresiones y solicita el campo Autopilot con: "Dentro de este foreach, transforma cada objeto para que pueda publicarse en la creación de mascotas de Swagger Petstore. Encuentra los valores para cada propiedad en el paso anterior".

     La respuesta de Autopilot debería ser similar a la siguiente (también puedes copiar este fragmento):

     {
       id: $currentItem.id,
       name: $currentItem.name,
       category: $currentItem.category,
       photoUrls: $currentItem.photoUrls,
       tags: $currentItem.tags,
       status: $currentItem.status,
       age: $currentItem.age,
       properties: $currentItem.properties
     }

2. Depura tu flujo de trabajo. En este punto, tu flujo de trabajo de API debería devolver un estado Correcto . Esto significa que los datos de la mascota se han publicado correctamente en la tienda de mascotas.

Paso 5: devolver una respuesta de flujo de trabajo

Este paso expone los resultados finales del flujo de trabajo a los consumidores externos en un formato limpio y simplificado.

1. A tu flujo de trabajo de API actual, añade la actividad Respuesta y configúrala de la siguiente manera:
   • Tipo : Correcto
   • Detalles : abre el editor de expresiones y escribe lo siguiente:

     $context.outputs.For_Each_1.results.map(result => ({
       id: result.content.id,
       name: result.content.name,
       description: result.content.description
     }))

     Este fragmento devuelve un JSON personalizado con los detalles mencionados.
2. Depura tu flujo de trabajo. Observa la respuesta final con los tres detalles.

Paso 6: definir esquemas de entrada y salida

Este paso pone los objetos de flujo de trabajo a disposición de los consumidores externos.

1. Para tu flujo de trabajo de API actual, abre el panel Gestor de datos .
2. Para la pestaña Entrada :
   • Añade una nueva propiedad y llámala "Género".
   • Establece el tipo en String.
   • Márcalo como obligatorio.
3. Para la pestaña Salida :
   • Añade tres propiedades y nómbralas "id", "nombre" y "tipo". Estas son las propiedades devueltas por el flujo de trabajo.
   • Establece su tipo en String.
4. Selecciona la actividad Generación de contenido en tu flujo de trabajo.

   1. Actualiza el campo Solicitud a:

      "Para la tienda de mascotas swagger, crea los detalles de una nueva " + $workflow.input.Genre + " criatura que se puede añadir a su inventario. Responda solo con un objeto json que contenga la información de la mascota".

      Esta nueva solicitud utiliza la propiedad $workflow.input.Genre definida en el Esquema de entrada.

5. Define una configuración de depuración y proporciona un valor para la propiedad Género:

   { Genre: "Fantasy" }

Paso 7: publicar y ejecutar

Ha llegado al final de una creación de flujo de trabajo correcta.

1. Publica el flujo de trabajo en tu carpeta Espacio de trabajo personal en Orchestrator.
2. Navega hasta la subcarpeta donde se creó el proceso correspondiente y selecciona Iniciar trabajo.

Orchestrator lee el esquema de entrada del flujo de trabajo y requiere que introduzcas un Género. Una vez que proporciones un valor, se iniciará el trabajo.