Outils client

Les outils client permettent à votre assistant d’exécuter des fonctions côté client. Contrairement aux outils webhook, les outils client permettent à l’assistant d’effectuer des actions telles que le déclenchement d’événements de navigateur, l’exécution de fonctions côté client ou l’envoi de notifications à une interface.

Vue d’ensemble

Les applications peuvent nécessiter que les assistants interagissent directement avec l’environnement de l’utilisateur. Les outils côté client permettent à votre assistant d’effectuer des opérations côté client.

Voici quelques exemples où les outils client peuvent être utiles :

• Déclencher des événements d’interface : permettez à un assistant de déclencher des événements de navigateur, comme des alertes, des fenêtres modales ou des notifications.
• Interagir avec le DOM : permettez à un assistant de manipuler le Document Object Model (DOM) pour mettre à jour dynamiquement le contenu ou guider les utilisateurs dans des interfaces complexes.

Guide

Prérequis

• Un compte ElevenLabs
• Un agent conversationnel ElevenLabs configuré (créez-en un ici)

from elevenlabs import ElevenLabs
from elevenlabs.conversational_ai.conversation import Conversation, ClientTools
def log_message(parameters):
    message = parameters.get("message")
    print(message)
client_tools = ClientTools()
client_tools.register("logMessage", log_message)
conversation = Conversation(
    client=ElevenLabs(api_key="your-api-key"),
    agent_id="agent_7101k5zvyjhmfg983brhmhkd98n6",
    requires_auth=True,
    client_tools=client_tools,
    # ...
)
conversation.start_session()

Transmettre les résultats d’un outil client au contexte de la conversation

Lorsque vous souhaitez que votre agent reçoive des données d’un outil client, veillez à cocher l’option Attendre la réponse dans la configuration de l’outil.

Une fois l’outil client ajouté, lorsque la fonction est appelée, l’agent attend sa réponse et l’ajoute au contexte de la conversation.

def get_customer_details():
    # Fetch customer details (e.g., from an API or database)
    customer_data = {
        "id": 123,
        "name": "Alice",
        "subscription": "Pro"
    }
    # Return the customer data; it can also be a JSON string if needed.
    return customer_data
client_tools = ClientTools()
client_tools.register("getCustomerDetails", get_customer_details)
conversation = Conversation(
    client=ElevenLabs(api_key="your-api-key"),
    agent_id="agent_7101k5zvyjhmfg983brhmhkd98n6",
    requires_auth=True,
    client_tools=client_tools,
    # ...
)
conversation.start_session()

Dans cet exemple, lorsque l’agent appelle getCustomerDetails, la fonction s’exécute sur le client et l’agent reçoit les données renvoyées, qui sont ensuite utilisées dans le contexte de la conversation. Les valeurs de la réponse peuvent également être affectées à des variables dynamiques, comme avec les outils webhook. Notez que les outils système ne peuvent pas mettre à jour les variables dynamiques.

Résolution des problèmes

Bonnes pratiques

Nommez les outils de manière intuitive, avec des descriptions détaillées

Si vous constatez que l’assistant n’appelle pas les bons outils, vous devrez peut-être mettre à jour les noms et descriptions de vos outils afin qu’il comprenne plus clairement quand sélectionner chaque outil. Évitez d’utiliser des abréviations ou des acronymes pour raccourcir les noms des outils et des arguments.

Vous pouvez également inclure des descriptions détaillées indiquant quand un outil doit être appelé. Pour les outils complexes, incluez des descriptions pour chacun des arguments afin d’aider l’assistant à savoir ce qu’il doit demander à l’utilisateur pour recueillir cet argument.

Nommez les paramètres des outils de manière intuitive, avec des descriptions détaillées

Utilisez des noms clairs et descriptifs pour les paramètres des outils. Le cas échéant, précisez dans la description le format attendu pour un paramètre, par exemple YYYY-mm-dd ou dd/mm/yy pour une date.

Envisagez de fournir des informations supplémentaires sur la manière et le moment d’appeler les outils dans le prompt système de votre assistant

Des instructions claires dans votre prompt système peuvent améliorer considérablement la précision des appels d’outils de l’assistant. Par exemple, guidez l’assistant avec des instructions comme celles-ci :

Use `check_order_status` when the user inquires about the status of their order, such as 'Where is my order?' or 'Has my order shipped yet?'.

Fournissez du contexte pour les scénarios complexes. Par exemple :

Before scheduling a meeting with `schedule_meeting`, check the user's calendar for availability using check_availability to avoid conflicts.

Sélection du LLM

Il est important de noter que le choix du LLM est déterminant pour la réussite des appels de fonction. Certains LLM peuvent rencontrer des difficultés à extraire les paramètres pertinents de la conversation.