Retour aux outils et actions

Dans cet article

Étape 1 : Définir le nom et la description

Commencez par donner à votre outil un nom clair et descriptif qui reflète son objectif. Ce nom apparaîtra dans la liste des outils et lors de son attribution aux agents.

Exigences de nommage :

  • Doit commencer par une lettre minuscule
  • Ne peut contenir que des lettres et des chiffres (pas d'espaces ni de caractères spéciaux)
  • Doit être descriptif et concis (par exemple, recupererDossierPatient, verifierDisponibiliteCalendrier)

Ensuite, ajoutez une description détaillée expliquant ce que fait l'outil. C'est crucial car :

  • Cela aide les autres à comprendre l'objectif et la fonctionnalité de l'outil
  • L'IA utilise cette description pour déterminer quand et comment utiliser l'outil pendant les conversations

Rédigez votre description comme si vous expliquiez quand et comment l'IA devrait utiliser cet outil, en incluant les déclencheurs et actions potentiels.

Exemples de bonnes descriptions :

  • Vérifie le calendrier de la clinique pour les créneaux de rendez-vous disponibles à une date spécifique
  • Récupère les coordonnées du patient depuis le système DPI en utilisant un identifiant patient
  • Envoie des notifications de rappel de rendez-vous via le système SMS de la clinique

Étape 2 : Configurer le point d'accès API

Définissez comment votre outil se connectera au système externe :

1. Sélectionnez la méthode HTTP :

Choisissez la méthode appropriée pour votre requête API :

  • GET : Pour récupérer des données (par exemple, obtenir des dossiers patients, vérifier les créneaux disponibles)
  • POST : Pour créer des données ou envoyer des commandes (par exemple, réserver des rendez-vous, envoyer des messages)
  • PUT : Pour mettre à jour des données existantes (par exemple, modifier des informations patient)
  • DELETE : Pour supprimer des données (par exemple, annuler des rendez-vous)

2. Définir l'URL :

Saisissez l'URL complète du point d'accès API. Vous pouvez utiliser des espaces réservés pour des variables (entre accolades) qui seront remplis lors de l'exécution.

Exemple : https://api.maclinique.com/patients/{patientId}/rendez-vous

Les variables dans le chemin URL seront remplacées par des valeurs réelles pendant l'exécution.

Étape 3 : Définir le mode d'exécution

Décidez comment l'agent doit gérer l'exécution de l'outil :

Synchrone vs. Asynchrone :

  • Synchrone (par défaut) : L'agent attend la réponse de l'outil avant de poursuivre la conversation. Idéal pour les appels API rapides où l'agent a besoin des données immédiatement pour répondre à l'appelant.
  • Asynchrone : L'agent peut continuer la conversation tout en attendant la réponse de l'API. Mieux adapté pour les opérations qui pourraient prendre plus de temps, permettant à l'agent de maintenir l'engagement avec l'appelant.

Activez 'Exécution asynchrone' si vous souhaitez que l'agent continue la conversation pendant que l'outil s'exécute en arrière-plan.

Étape 4 : Configurer les en-têtes de requête

De nombreuses API nécessitent des en-têtes HTTP spécifiques à envoyer avec chaque requête :

En-têtes courants :

  • Content-Type : Généralement défini sur 'application/json' pour l'envoi de données JSON
  • Accept : Défini sur 'application/json' pour indiquer que vous attendez une réponse JSON

Pour ajouter un en-tête :

  1. Cliquez sur 'Ajouter un en-tête</li><li>Saisissez le nom de len-tête (par exemple, 'Content-Type')
  2. Saisissez la valeur de l'en-tête (par exemple, 'application/json')

Vous pouvez ajouter autant d'en-têtes que nécessaire pour vos exigences API spécifiques.

Étape 5 : Configurer le corps de la requête

Pour les requêtes POST et PUT, vous devrez généralement envoyer des données dans le corps de la requête :

Format du corps JSON :

Saisissez la structure JSON que votre API attend. Vous pouvez inclure des variables qui seront remplacées par des valeurs réelles.

Exemple :

Votre JSON pourrait ressembler à ceci :

  • "nomPatient": "VARIABLE_NOM_PATIENT"
  • "dateRendezVous": "VARIABLE_DATE"
  • "heureRendezVous": "VARIABLE_HEURE"
  • "notes": "VARIABLE_NOTES"

Pendant une conversation, l'agent remplacera ces variables d'espace réservé par des valeurs réelles collectées auprès de l'appelant ou issues du contexte.

Étape 6 : Configurer les variables

Définissez les variables que votre outil utilisera en configurant les paramètres que l'agent peut extraire de la conversation :

  1. Ajoutez chaque variable requise (par exemple, 'patientId', 'dateRendezVous')
  2. Définissez le type de données attendu (chaîne, nombre, booléen, etc.)
  3. Indiquez si la variable est obligatoire ou facultative

Ces variables seront dynamiquement remplies avec des données recueillies pendant la conversation et insérées dans votre requête API (URL, en-têtes ou corps).

Étape 7 : Configurer l'authentification

La connexion sécurisée aux API externes est vitale. Accédez à la section 'Authentification' pour configurer la méthode appropriée :

  • Clé API : Pour une authentification simple basée sur une clé
  • Jeton Bearer : Pour une authentification basée sur des jetons JWT ou OAuth
  • Authentification basique : Pour une authentification par nom d'utilisateur/mot de passe

Consultez le guide 'Configurer l'authentification des outils' pour des instructions détaillées sur la configuration de chaque méthode.