Créer votre premier workflow d’API

Le tutoriel suivant propose une expérience pratique des concepts clés derrière l’interface de workflow d’API à travers un exemple simple en utilisant l’API publique Petstore.

Dans cet exemple, vous demandez « Informations sur les nombres » à partir d’un modèle de langage (LLM) et utilisez ces données pour ajouter des activités à l'activité Swagger Petstore. Le magasin Swagger (https://petstore.swagger.io) propose des points de terminaison d’API accessibles et simples à utiliser, disponibles avec ou sans authentification.

Étape 1 : Appel du LLM

1. Sur votre canevas de conception de workflow d'API, sélectionnez Ajouter (l'icône plus +).
2. Sélectionnez Connecteur > Activités UiPath GenAI > Génération de contenu.
3. Configurez ou sélectionnez une connexion existante dans le panneau Propriétés .
4. Configurez ces propriétés :
   • Modèle—gpt-4o-mini-2024-07-18
   • Invite: « Pour le magasin Swagger Petstore, créez les détails d’une nouvelle création de simulation qui pourra être ajoutée à son inventaire. Répondez uniquement avec un json valide. Renvoyez un tableau de 5 de ces éléments. »
5. Déboguez votre workflow jusqu'à ce point.
6. Consultez les résultats dans le panneau Sortie . Vous devriez voir l'entrée et la sortie brutes de l'appel d'activité. La réponse doit ressembler à ceci :

   {
     "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"
   }
   

Étape 2 : utilisation du script pour formater correctement la réponse

Les informations dont vous avez besoin se trouvent dans la propriété content.text , qui n'est pas correctement formatée.

1. Ajoutez l'activité Script à votre workflow d'API actuel.
2. Ouvrez l' éditeur d'expressions et écrivez ce qui suit :

   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 };
   

Ce code JavaScript analyse l'objet content.text et le renvoie dans un format propre.

3. Déboguez à nouveau votre workflow. Observez une réponse correctement formatée.

Étape 3 : Parcourir le tableau des réponses

Le LLM a renvoyé plusieurs exemples d’animations sous la forme d’un tableau, comme indiqué dans l’invite à l’étape 1.

1. À votre workflow d’API actuel, ajoutez l’activité Boucle > PourChaque .
2. Configurez l'activité For Each comme suit :
   • Dans—

     $context.outputs.Javascript_1.aipet
     

   • Nom de l’élément—currentItem
   • Cumul des résultats—Activé. Cette commande parcourt plusieurs éléments du tableau de réponses.

Étape 4 : ajouter la réponse renvoyée à Petstore

1. Dans le corps de l'activité Pour chaque , ajoutez l'activité HTTP et configurez-la comme suit :
   • Méthode—PUBLIER
   • URL de la demande—https://petstore.swagger.io/v2/pet
   • Corps de la demande : ouvrez l’éditeur d’expressions et invitez le champ Autopilot avec : « Dans cette recherche, transformez chaque objet afin qu’il puisse être publié dans la création Swagger Petstore. Recherchez les valeurs de chaque propriété à l'étape précédente. » La réponse d’Autopilot doit ressembler à ceci :

      {
       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. Déboguez votre workflow. À ce stade, votre workflow d’API devrait renvoyer un statut Réussi . Cela signifie que les données de l'animation ont été publiées correctement dans le magasin d'animations.

Étape 5 : renvoyer une réponse de workflow

Cette étape expose les résultats finaux du workflow aux consommateurs externes dans un format clair et simplifié.

1. À votre workflow d’API actuel, ajoutez l’activité Réponse et configurez-la comme suit :
   • Type—Réussite
   • Détails : ouvrez l’éditeur d’expressions et écrivez ce qui suit :

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

Cet extrait renvoie un fichier JSON personnalisé avec les détails mentionnés. 2. Déboguez votre workflow. Notez la réponse finale avec les trois détails.

Étape 6 : définition des schémas d'entrée et de sortie

Cette étape rend les objets de workflow disponibles pour les consommateurs externes.

1. Pour votre workflow d’API actuel, ouvrez le panneau Data manager .
2. Pour l'onglet Entrée :
   • Ajoutez une nouvelle propriété et nommez-la « Générer ».
   • Définissez le type sur Chaîne.
   • Marquez-le comme obligatoire.
3. Pour l'onglet Sortie :
   • Ajoutez trois propriétés et nommez-les « id », « nom » et « type ». Il s'agit des propriétés renvoyées par le workflow.
   • Définissez leur type sur String.
4. Sélectionnez l’activité Génération de contenu dans votre workflow.
   1. Mettez à jour le champ Invite sur : "Pour le Swagger Petstore, créez les détails d'une nouvelle création " + $workflow.input.Genre + " qui pourra être ajoutée à leur inventaire. Répondez uniquement avec un objet json contenant les informations du pet. » Cette nouvelle invite utilise la propriété $workflow.input.Genre définie dans le schéma d'entrée.
5. Définissez une configuration de débogage et fournissez une valeur pour la propriété Genre :

   { Genre: "Fantasy" }
   

Étape 7 : publication et exécution

Vous avez atteint la fin d’une création de workflow réussie.

1. Publiez le workflow dans votre dossier Espace de travail personnel dans Orchestrator.
2. Accédez au sous-dossier dans lequel le processus correspondant a été créé et sélectionnez Start job.

Orchestrator lit le schéma d'entrée du workflow et vous demande de saisir un Genre. Une fois que vous avez fourni une valeur, la tâche démarre.