Outils côté client

Les outils côté client s'exécutent sur le navigateur ou l'application hôte de l'utilisateur, permettant l'accès aux données locales du client et aux fonctionnalités de périphérique non disponibles côté serveur.

Les outils côté client s'exécutent sur l'interface client (le navigateur de l'utilisateur ou l'application hôte) plutôt que sur le serveur UiPath. Lorsque l’agent appelle un outil côté client, le runtime s’interrompt, délégue l’appel de l’outil au client et reprend une fois que le client renvoie un résultat.

Utilisez des outils côté client lorsque l’agent a besoin d’accéder à des données ou à des fonctionnalités qui n’existent que sur le client, telles que l’état de l’application, les données locales ou les actions de l’IU qui ne peuvent pas être effectuées côté serveur.

Quand utiliser les outils côté client

Utilisez des outils côté client lorsque l’agent doit:

• Accéder aux données locales du client - Lire les informations de l'application hôte qui ne sont pas disponibles pour le serveur, telles que le contenu d'un tableau de tâches, les champs de formulaire ou l'état spécifique à la session.
• Déclencher des actions côté client - Effectuez des actions dans l'application hôte, telles que naviguer vers une page, ouvrir une boîte de dialogue, créer un enregistrement dans l'interface utilisateur locale ou mettre à jour un composant.
• Exploiter des fonctionnalités spécifiques au client - Utilisez des fonctionnalités de l'appareil ou du navigateur qui ne sont pas accessibles depuis le serveur, telles que l'accès au presse-papiers, le stockage local ou la géolocalisation.

Remarque :

Les outils côté client sont disponibles uniquement pour les Agents conversationnels déployés via une interface qui prend en charge la gestion des outils côté client, telle que le SDK TypeScript UiPath ou toute interface qui implémente le protocole de conversation UiPath. L'interface doit enregistrer un gestionnaire pour chaque outil côté client; les outils sans gestionnaire enregistré renvoient une erreur à l'agent.

Configuration des outils côté client

Pour ajouter un outil côté client à votre agent conversationnel:

1. Dans le concepteur d’agent, sélectionnez Ajouter un outil.

2. Sélectionnez la catégorie Outils côté client .

3. Remplissez les champs suivants :

   • Nom de l'outil - Un nom unique pour l'outil. Doit commencer par une lettre ou un tiret bas et ne peut contenir que des lettres, des chiffres, des espaces et des tirets bas.
   • Description : décrivez ce que fait l'outil et quand l'utiliser. Cette description guide la décision de l’agent d’appeler l’outil.
   • Schéma d'entrée — Un objet Schéma JSON définissant les paramètres que l'agent transmet au client lors de l'appel de l'outil.
   • Schéma de sortie — Un objet Schéma JSON définissant la structure du résultat que le client renvoie à l'agent.

   

4. Sélectionnez Créer.

Après avoir créé l’outil, vous pouvez configurer des paramètres supplémentaires dans le panneau Propriétés de l’outil:

• Modifiez le nom, la description et les schémas de l'outil.
• Appliquez des garde-fous pour appliquer les politiques de Runtime.
• Activez les confirmations d'appel d'outil pour nécessiter l'approbation de l'utilisateur avant l'exécution.

Schémas d’entrée et de sortie

Les deux schémas sont requis et doivent être des objets de schéma JSON valides. Elles définissent le contrat entre l’agent et le client:

• Le schéma d’entrée spécifie les données que l’agent envoie au client lorsqu’il appelle l’outil. L'agent remplit les valeurs d'entrée en fonction du contexte de la conversation et de la définition du schéma.
• Le schéma de sortie spécifie les données que le client renvoie à l'agent après l'exécution de l'outil. L’agent utilise ce résultat pour poursuivre son raisonnement.

Exemples de schémas

Pour un outil qui lit les tâches à partir d'un panneau de projet:

Schéma d’entrée:

{
  "type": "object",
  "properties": {
    "boardId": {
      "type": "string",
      "description": "The ID of the task board to read from"
    },
    "status": {
      "type": "string",
      "enum": ["todo", "in-progress", "done"],
      "description": "Filter tasks by status"
    }
  },
  "required": ["boardId"]
}

Schéma de sortie:

{
  "type": "object",
  "properties": {
    "tasks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "title": { "type": "string" },
          "status": { "type": "string" },
          "assignee": { "type": "string" }
        }
      }
    }
  }
}

Comportement sur les interfaces prédéfinies

Sur des interfaces prédéfinies telles que la gestion des instances et l'intégration iFrame, les outils côté client affichent un formulaire pour l'utilisateur en fonction du schéma de sortie. L'utilisateur remplit les champs manuellement et soumet le résultat à l'agent.

La valeur complète des outils côté client est réalisée sur des interfaces personnalisées créées avec le SDK UiPath TypeScript, où l’application hôte gère les appels d’outils par programmation — lecture des données, déclenchement des actions ou interaction avec les systèmes locaux sans intervention manuelle de l’utilisateur.

Fonctionnement des outils côté client au moment de l’exécution

Lorsque l’agent appelle un outil côté client au cours d’une conversation:

1. L’agent décide d’utiliser l’outil en fonction du contexte de la conversation et de la description de l’outil.
2. Si les confirmations d'appel d'outil sont activées, l'utilisateur examine et approuve l'entrée proposée avant que l'outil ne continue.
3. Le runtime envoie l'appel de l'outil, y compris le nom de l'outil, les valeurs d'entrée et les schémas d'entrée/de sortie, vers l'interface client.
4. L’interface client exécute son gestionnaire enregistré pour l’outil à l’aide de l’entrée fournie.
5. Le client renvoie le résultat au runtime.
6. L'agent reçoit le résultat et poursuit son raisonnement.

Confirmations d'appel d'outil

Vous pouvez demander la confirmation de l'utilisateur avant l'exécution d'un outil côté client. Cela est utile pour les outils qui effectuent des actions avec des effets secondaires visibles, tels que la création d'une tâche, la mise à jour d'un enregistrement ou la navigation hors de la page actuelle.

Pour activer la confirmation d'un outil côté client:

1. Sélectionnez l'outil côté client dans le concepteur d'agent.
2. Dans les propriétés de l'outil, activez Exiger la confirmation.

Lorsque cette option est activée, l’agent s’interrompt avant d’exécuter l’outil et affiche les paramètres d’entrée proposés à l’utilisateur. L'utilisateur peut approuver, modifier les entrées ou rejeter l'appel de l'outil.

Exemple: assistant de planification de projet

Pensez à un assistant de planification de projet intégré à une application de gestion des tâches. L'agent dispose de deux outils côté client:

• Read_board_tasks - Lit les tâches actuelles du tableau des tâches de l'utilisateur dans l'application hôte.
• create_task - Crée une nouvelle tâche sur le tableau de l'utilisateur.

Lecture des données du client: lorsqu'un utilisateur demande « Que dois-je travailler ensuite?», l'agent appelle read_board_tasks. L'application hôte lit l'état du tableau et renvoie les données de la tâche. L'agent analyse ensuite les tâches et suggère un ordre de priorité en fonction du statut, des échéances et des dépendances.

Écrire des données au client: lorsque l'utilisateur demande « Ajouter une tâche pour examiner le rapport T3 avant le vendredi», l'agent appelle create_task avec le titre, la description et la date d'échéance. Si la confirmation est activée, l’utilisateur examine d’abord les détails de la tâche proposée. L’application hôte crée la tâche sur le tableau et l’agent confirme qu’elle a été créée.

Limitations

• L’exécution de l’outil côté client dépend de la disponibilité et de la réactivité de l’interface client. Si le client se déconnecte pendant l’exécution de l’outil, l’appel de l’outil peut échouer.
• L'interface client doit enregistrer un gestionnaire pour chaque outil côté client défini par l'agent. Si un gestionnaire est manquant, l’appel d’outil renvoie une erreur à l’agent.