Article
Améliorer la documentation de ses workflows Alteryx grâce à Open AI
Article rédigé par Yohan Mathis – Consultant BI Actinvision
Alteryx est une plateforme d’automatisation des processus d’analyse, d’exploration et de traitement de la donnée. Cette plateforme s’adresse à toutes les personnes ayant une appétence pour la donnée et s’appuie sur des outils intuitifs pour donner aux collaborateurs les moyens de produire plus vite de meilleures analyses.
Toujours dans l’objectif de faciliter et d’accélérer l’utilisation de sa plateforme, Alteryx propose depuis l’été dernier un connecteur OpenAI, l’intelligence artificielle à l’origine de ChatGPT. Parmi les nombreuses possibilités qu’offre ce connecteur, nous avons testé la documentation de flux de données.
Pourquoi documenter un flux de données Alteryx ?
La collaboration autour du workflow est déjà une des forces de l’outil Alteryx. Une bonne documentation va accroître cette capacité de l’outil à faciliter la transmission entre les membres d’une même équipe.
La maintenance et les évolutions doivent être possibles rapidement. Bien que les workflows Alteryx sont déjà intuitifs et visuels, une documentation claire et exhaustive permet de minimiser le temps à comprendre les développements déjà effectués.
Quelle est la documentation déjà proposée par Alteryx ?
Alteryx propose des annotations d’outils directement générées dans le logiciel, ce qui permet aux utilisateurs d’accéder rapidement à des informations contextuelles. Ces annotations sont souvent techniques et peuvent parfois apporter de la confusion. Il est souvent nécessaire pour l’utilisateur de les modifier manuellement pour apporter de la clarté dans le workflow.
Exemple d’un projet dans l’interface Alteryx
Les outils Conteneur permettent d’organiser visuellement les composants d’un workflow en les regroupant en ensemble. Souvent, ils délimitent des zones spécifiques d’un workflow pour isoler des étapes : Connexion aux données, Préparation, Enrichissement, etc.
Complémentaires et souvent accolés aux conteneurs, les commentaires sont des éléments textes et visuels pour organiser, documenter, expliquer et suivre les modifications.
Ces trois outils intégrés nativement facilitent grandement la communication et la documentation des workflows.
Enfin, chaque workflow dispose de ses Méta-Infos. Souvent négligées, ces informations, disponibles dans l’onglet Workflow > Méta-Infos, permettent à l’utilisateur d’avoir rapidement un résumé du workflow en question.
Lors de la publication du workflow sur le serveur Alteryx, plateforme de collaboration et de planification des workflows, ce sont d’ailleurs ces Méta-Infos, qui s’affichent dans la description du workflow.
Quels sont les ajouts de l’outil Workflow Summary tool, utilisant la technologie d’OpenAI ?
C’est justement sur ce dernier point, les Méta-Infos, que l’outil Workflow Summary va apporter toute sa valeur ajoutée. Les Méta-Infos sont aujourd’hui rentrées manuellement par le créateur du workflow.
Workflow Summary a la capacité de lire un workflow et de proposer un titre ainsi qu’une description résumée des différentes étapes du workflow.
Le résumé est disponible directement en sortie de l’outil Workflow Summary et peut être automatiquement ajouté aux Méta-Infos des workflow concernés.
L’outil peut prendre en entrée un workflow ou un répertoire de workflows pour analyser chaque workflow individuellement.
Il est important de préciser que l’outil Workflow Summary ne va pas exécuter le workflow, mais seulement lire l’enchaînement des outils présents et leur configuration.
Les résultats proposés pour deux workflows testés :
#########Workflow Summary-Generated Description #########
Topic: Strava Activities
Headline: Download and summarize the last 200 activities from Strava
Summary: This workflow downloads the last 200 activities from Strava and summarizes them. The key inputs are the Strava API credentials and the desired number of activities per page. The key outputs are a summary of the activities and a refreshed access token. The workflow follows these logical steps:
1. Retrieve the API credentials and number of activities per page.
2. Generate the URL for token retrieval.
3. Download the token using the API credentials.
4. Parse the downloaded JSON data.
5.Filter and select the access token.
6. Append the access token to the URL for activity download.
7. Download the activities using the access token.
8. Parse the downloaded JSON data.
9. Split the JSON data into columns.
10. Perform a cross-tabulation to summarize the activities.
11. Convert the start date to a DateTime format.
12. Select the necessary fields for output.
13. Save the summarized activities to an Excel file.
14. Generate a workflow summary report.
#########Workflow Summary-Generated Description #########
Topic: API Integration
Headline: Retrieving results from another workflow using Alteryx Server API
Summary: This workflow uses the Alteryx Server API to retrieve the results of another workflow that was executed on the server. The key inputs are the client ID and client secret, as well as the workflow ID. The key outputs are the job details and the output files in CSV format. The workflow follows these logical steps: obtaining an API token, listing the jobs of a workflow, listing the outputs of a job, and retrieving the output files. The specific workflow used in this example is « Finances KPI.yxmd » from the FINANCES collection.
Comment fonctionne Workflow Summary tool ?
Comme beaucoup d’instruments IA, c’est fait pour être simple, accessible et payant.
L’outil Workflow Summary est disponible en téléchargement libre sur le site Alteryx : Workflow Summary Tool powered by Generative AI
Coté Open AI, il est nécessaire de créer un compte et une clé secrète API sur la plateforme Open AI . Le compte doit être approvisionné en crédits pour utiliser pour cette fonctionnalité (10 requêtes ≈ 0.05$).
Sur Alteryx Designer, il faut autoriser le DCM mode avec SDK (mode all access) dans ses paramètres utilisateurs et la connexion à Open AI est à configurer comme une connexion de données dans DCM. Open AI se trouve dans SDK tool pour les nouvelles versions d’Alteryx.
Vous retrouverez un tutoriel plus approfondi sur la Communauté Alteryx : How to Use The Workflow Summary Tool
Quels sont les limitations de l’outil Workflow Summary tool ?
L’outil Workflow Summary offre un résumé du workflow cependant il présente également certaines limitations techniques, notamment :
Complexité du workflow : si le workflow est très complexe avec de nombreuses étapes et connexions, le résumé peut devenir difficile à interpréter
Absence d’interactivité : la documentation générée ne permet pas pour le moment d’interagir avec le workflow.
Outil dépendant à Alteryx Designer : le résumé est statique dans les Meta-Infos et est consultable uniquement dans l’environnement Alteryx, ce qui peut limiter le partage avec les parties prenantes
Enfin, il est toujours nécessaire d’être prudent quant aux données envoyées pour alimenter Open AI. Ainsi, supprimer toutes les informations confidentielles, notamment les informations de connexion, est une bonne pratique avant de solliciter l’IA dans un workflow. Cela n’influe pas sur la bonne interprétation de l’outil.
Quel futur pour l’IA générative de la documentation dans Alteryx ?
Le Workflow Summary Tool par Open AI était une des fonctionnalités les plus attendues par les nombreux utilisateurs Alteryx, car la documentation reste souvent la partie fastidieuse et négligée de tout développement.
Les limitations mentionnées plus haut, comme l’interopérabilité ou l’interactivité, permettent d’entrevoir le champ des possibles des améliorations de l’outil.
Aussi, maintenant, que l’IA intègre de telles informations, il est fort probable qu’Alteryx, toujours à la pointe de l’IA générative, puisse nous proposer de demander à cette IA de nous aider dans le choix du prochain meilleur outil lors de la construction d’un workflow.
