Paramètres du playbook

Les playbooks peuvent accepter et émettre des informations contextuelles à l'aide de paramètres définis explicitement. Les paramètres permettent de stocker des informations sur une conversation, comme les sélections de l'utilisateur, les résultats des actions, etc. Vous pouvez transmettre les valeurs de ces paramètres entre les playbooks et les flux.

Déclaration de paramètre

Vous pouvez définir des paramètres d'entrée et des paramètres de sortie.

Lorsque vous utilisez la console de l'Agent Builder, vous pouvez définir des paramètres sur la page de l'éditeur d'agents.

Lorsque vous utilisez la console Dialogflow CX, les paramètres sont définis par playbook à l'aide de l'onglet Paramètres une fois que vous avez créé un playbook.

Les paramètres ont un nom, une description et l'un des types suivants:

• Chaîne
• Number
• Booléen
• Type de paramètre spécifique à l'outil

Vous pouvez également spécifier si un paramètre est une liste.

Paramètres d'entrée

Les paramètres d'entrée permettent aux playbooks d'utiliser les valeurs transmises à partir de flux et d'autres playbooks. Par exemple, un playbook peut recevoir le nom préféré d'un utilisateur en tant que paramètre et l'utiliser pour le remercier personnellement, ou il peut recevoir un identifiant de commande en tant que paramètre et l'utiliser pour récupérer les détails de la commande à l'aide d'un outil.

Les paramètres d'entrée sont définis par playbook, et les playbooks ne sont pas visibles par défaut pour les autres types de paramètres de la console Dialogflow CX. Lorsqu'un flux passe à un playbook, les paramètres de page et de session sont propagés vers le playbook si le playbook cible comporte un paramètre d'entrée du même nom. Pour communiquer des informations d'un flux à un playbook lors d'une transition, définissez des paramètres d'entrée de playbook portant le même nom qu'un paramètre de session ou de page présent avant la transition.

Créez des exemples pour contrôler l'impact de la valeur du paramètre d'entrée sur les actions. Par exemple, si un paramètre d'entrée doit affecter la façon dont l'agent fait référence à l'utilisateur, créez des exemples qui définissent une valeur pour le paramètre, puis utilisez la même valeur dans les actions d'énoncé de l'exemple. Pour en savoir plus, consultez la section Transmettre des paramètres.

Paramètres de sortie

Les paramètres de sortie permettent aux playbooks d'émettre des informations à utiliser par d'autres flux ou playbooks. Par exemple, un playbook peut collecter un numéro de commande auprès d'un utilisateur et l'émettre via un paramètre de sortie, ou utiliser un outil pour réserver un vol et émettre le numéro de confirmation via un paramètre de sortie.

Créez des exemples pour contrôler la manière dont le playbook doit déterminer la valeur de chaque paramètre de sortie. Par exemple, si un paramètre de sortie représentant un numéro de confirmation doit dériver sa valeur à partir de la sortie d'un outil, créez des exemples où la sortie de l'outil correspond à la valeur du paramètre de sortie du playbook.

Transmettre des paramètres

Contrairement aux flux, les playbooks n'acceptent pas l'injection de valeurs de paramètre avec une syntaxe particulière. Au lieu de cela, les playbooks s'appuient sur des instructions et des exemples d'invites à utiliser pour déterminer comment les valeurs de paramètre doivent être utilisées et comment les valeurs doivent être déterminées lors de la spécification des valeurs de paramètre.

Prenons l'exemple d'un agent conçu pour la vente de billets d'événements avec les playbooks suivants:

1. Un playbook nommé Ticket ordering qui passe des commandes à l'aide d'un outil nommé Ticket sales API.
   1. Ce playbook accepte un paramètre d'entrée de type number et de nom event_id.
   2. L'outil Ticket sales API attend une requête incluant un event_id.
2. Un playbook nommé Event selection qui aide les utilisateurs à sélectionner un événement, puis les redirige vers Ticket ordering avec le paramètre event_id pour qu'ils puissent acheter des billets.

Dans cet exemple, pour s'assurer que event_id est transmis de manière fiable de Event selection à Ticket ordering et de Ticket ordering à Ticket sales API, plusieurs exemples sont nécessaires.

Le playbook Ticket ordering doit inclure plusieurs exemples qui:

• Spécifiez le paramètre d'entrée event_id avec une valeur réaliste, différente dans chaque exemple.
• Incluez une action d'utilisation d'un outil avec un corps de requête qui inclut la même valeur event_id réaliste que celle spécifiée dans le paramètre d'entrée.

Le playbook Event selection doit inclure plusieurs exemples qui:

• Incluez une déclaration de l'utilisateur dans laquelle il sélectionne un événement avec des event_id réalistes, différents dans chaque exemple.
• Incluez une invocation de playbook de Ticket ordering qui définit le paramètre event_id sur le event_id réaliste identique que celui choisi par l'utilisateur.

En plus d'ajouter des exemples, essayez d'ajouter des instructions spécifiques aux instructions, à l'objectif ou aux détails de l'outil pour expliquer comment utiliser les paramètres. Par exemple, le playbook Ticket ordering inclut l'instruction suivante:

- Use parameter event_id to send a buy_tickets request with ${TOOL: Ticket sales API}

Avec les exemples et les instructions décrits, le playbook Event selection détermine correctement un event_id en fonction de la sélection de l'utilisateur et le transmet en tant que paramètre d'entrée nommé event_id à Ticket ordering playbook. Ensuite, Ticket ordering transmet le même event_id dans le corps d'une requête à Ticket sales API. Les playbooks reposent sur des exemples avec des valeurs de paramètre distinctes pour les aider à inférer comment les paramètres doivent être utilisés.