Paramètres du playbook

Les playbooks acceptent et émettent des informations de contexte à l'aide de paramètres explicitement définis. Les paramètres stockent les informations de conversation, telles que les sélections de l'utilisateur et les résultats des actions. 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 ont un nom, une description et l'un des types suivants :

• Chaîne
• Nombre
• 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 accès aux 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 possède 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, car il sert de point d'entrée pour les conversations utilisateur et n'a aucun moyen de les recevoir.

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, renvoi)

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 les playbooks déterminent la valeur de chaque paramètre de sortie. Par exemple, si un paramètre de sortie représentant un numéro de confirmation dérive sa valeur d'une sortie d'utilisation d'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

Remarque : Comme un playbook de tâche ne peut pas appeler un playbook de routine, ce scénario de transmission de paramètres n'est pas décrit dans les sections suivantes.

Contrairement aux flux, les playbooks ne permettent pas d'injecter des valeurs de paramètres avec une syntaxe particulière. À la place, les playbooks s'appuient sur des instructions et des exemples de requêtes few-shot pour déterminer comment les valeurs des paramètres doivent être utilisées et décidées.

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, qui deviennent des paramètres de session une fois le playbook de routine terminé.
• Utilisez les paramètres de session dans les flux.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Flux vers un playbook de routine

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

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

Playbook de tâche à flux

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

• Dans les paramètres du 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.

Playbook de flux vers tâche

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

• Dans les paramètres du 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 dans le playbook de tâche qui portent le même nom que les paramètres de session du 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 les paramètres d'entrée du playbook de la tâche en utilisant les mêmes noms.
• Incluez l'utilisation des paramètres dans les instructions et les exemples.

Exemple impliquant des outils

Supposons qu'un agent soit conçu pour la vente de billets d'événements avec les playbooks de tâches suivants :

• Un playbook nommé Ticket ordering qui passe des commandes à l'aide d'un outil nommé Ticket sales API.
  • Ce playbook accepte un paramètre d'entrée de type number nommé event_id.
  • L'outil Ticket sales API attend une requête incluant un event_id.
• 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 vous assurer que event_id est transmis de manière fiable de Event selection à Ticket ordering et de Ticket ordering à Ticket sales API, vous avez besoin de plusieurs exemples.

Le playbook Ticket ordering doit inclure plusieurs exemples qui :

• Spécifiez le paramètre d'entrée event_id avec une valeur réaliste qui diffère dans chaque exemple.
• Incluez 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 :

• Incluez un énoncé utilisateur dans lequel un événement avec un event_id réaliste est sélectionné, avec un ID différent dans chaque exemple.
• Incluez une invocation de playbook de Ticket ordering qui définit le paramètre event_id sur la même valeur event_id réaliste que celle déterminée par la sélection.

En plus d'ajouter des exemples, ajoutez des instructions spécifiques aux instructions, à l'objectif ou aux détails de l'outil expliquant comment les paramètres doivent être utilisés.

Par exemple, le playbook Ticket ordering peut inclure 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 playbook Ticket ordering. Ensuite, Ticket ordering transmet le même event_id dans le corps d'une requête à Ticket sales API. Les playbooks s'appuient sur des exemples avec des valeurs de paramètres distinctes pour les aider à déduire comment les paramètres sont utilisés.