Paramètres du playbook

Les playbooks peuvent accepter et émettre des informations contextuelles à l'aide de paramètres définis de manière explicite. Les paramètres sont utilisés pour stocker des informations sur une conversation, telles que 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 (lecture) et des paramètres de sortie (écriture).

Les paramètres comportent 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 (lecture)

Pour chaque playbook, vous pouvez définir des paramètres d'entrée, également appelés paramètres de lecture, qui permettent aux playbooks d'utiliser les valeurs transmises par les 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 n'ont pas visibilité sur les autres types de paramètres de la console Dialogflow CX par défaut. Lorsqu'un flux passe à un playbook, les paramètres de page et de session sont propagés au playbook si le playbook cible comporte un paramètre d'entrée portant le 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.

Remarque : Le playbook par défaut n'accepte pas les paramètres d'entrée. Le playbook par défaut sert de point d'entrée pour les conversations utilisateur. Il n'a donc aucun moyen de recevoir des paramètres d'entrée.

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 Transmettre des paramètres.

Paramètres de sortie (écriture, retour)

Pour chaque playbook, vous pouvez définir des paramètres de sortie, également appelés paramètres d'écriture et paramètres de retour, qui 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 un playbook peut 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 façon 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 de la sortie d'une utilisation d'outil, créez des exemples dans lesquels la sortie de l'utilisation de l'outil correspond à la valeur du paramètre de sortie du playbook.

Transmettre des paramètres

Remarque : Un playbook de tâche ne peut pas appeler un playbook de routine. Ce scénario de transmission de paramètres n'est donc pas décrit ci-dessous.

Contrairement aux flux, les playbooks ne sont pas compatibles avec l'injection de valeurs de paramètres avec une syntaxe particulière. Au lieu de cela, les playbooks s'appuient sur des instructions et quelques exemples de prompts pour déterminer comment les valeurs des paramètres doivent être utilisées et comment les valeurs doivent être décidées lors de la spécification des valeurs des paramètres.

Playbook de routine vers flux

Pour transmettre des paramètres d'un playbook de routine à un flux :

• Définissez des paramètres d'écriture pour le playbook de routine. Ces paramètres deviendront des paramètres de session.
• Les flux peuvent utiliser les paramètres de session.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Flux vers playbook de routine

Pour transmettre des paramètres d'un flux à un playbook de routine :

• Les flux écrivent les paramètres de session.
• Définissez des paramètres de lecture pour le playbook de routine portant les mêmes noms.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Playbook de tâche vers flux

Pour transmettre des paramètres d'un playbook de tâche à un flux :

• Dans les paramètres de flux, définissez des paramètres d'entrée portant les mêmes noms.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Flux vers playbook de tâche

Pour transmettre des paramètres d'un flux à un playbook de tâche parent :

• Dans les paramètres de flux, définissez des paramètres de retour.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Pour transmettre des paramètres d'un flux à un playbook de tâche enfant :

• Définissez des paramètres d'entrée de tâche portant le même nom que les paramètres de session dans le flux.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Playbook de routine vers playbook de tâche

Pour transmettre des paramètres d'un playbook de routine à un playbook de tâche :

• Définissez des paramètres d'entrée pour le playbook de tâche portant les mêmes noms.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Exemple impliquant des outils

Prenons l'exemple d'un agent conçu pour la vente de billets d'événements avec les playbooks de tâches 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 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 :

• ont le paramètre d'entrée event_id spécifié avec une valeur réaliste, différente dans chaque exemple.
• incluent une action d'utilisation d'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 :

• incluent un énoncé utilisateur dans lequel l'utilisateur sélectionne un événement avec un event_id réaliste, différent dans chaque exemple.
• incluent un appel de playbook de Ticket ordering qui définit le paramètre event_id sur le même event_id réaliste que celui décidé par la sélection de l'utilisateur.

En plus d'ajouter des exemples, essayez d'ajouter des instructions spécifiques aux instructions, objectif, ou détails de l'outil expliquant comment les paramètres doivent être utilisés. 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écide correctement d'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 au Ticket ordering playbook. Ensuite, Ticket ordering transmet le même event_id dans le corps d'une requête à l'Ticket sales API. Les playbooks dépendent d'exemples avec des valeurs de paramètres distinctes pour les aider à déduire comment les paramètres doivent être utilisés.