Paramètres

Les paramètres sont utilisés pour capturer et mentionner des valeurs ayant été fournies par l'utilisateur final au cours d'une session. Chaque paramètre possède un nom et un type d'entité. Contrairement aux entrées utilisateur brutes, les paramètres sont des données structurées pouvant être utilisées pour exécuter une logique ou générer des réponses.

Les paramètres CX ressemblent aux paramètres ES, mais l'utilitaire et le champ d'application ont été étendus, et la syntaxe des paramètres de référence a changé.

Définir, référencer, régler et obtenir des paramètres

Il existe quatre façons générales d'utiliser les paramètres :

  • Définir au moment de la conception : lors de la conception, vous utilisez la console ou l'API pour définir les paramètres. Par exemple, vous pouvez définir un paramètre d'intent et l'utiliser dans une phrase d'entraînement pour indiquer une entrée d'utilisateur final à extraire.
  • Références au moment de la conception : les références de paramètres sont des variables contenant des valeurs de paramètre à extraire lors de l'exécution. Au moment de la conception, vous utilisez la console ou l'API pour référencer des paramètres dans différents types de données. Par exemple, vous pouvez référencer un paramètre de session dans une réponse de fulfillment statique pour une route.
  • Définition au moment de l'exécution : au moment de l'exécution, le service Dialogflow, votre service qui appelle l'API, et votre service de webhook peuvent tous définir des valeurs de paramètres. Par exemple, le service Dialogflow définit la valeur d'un paramètre d'intent lorsqu'une entrée d'utilisateur final correspond à l'intent et que cette entrée contient des données de paramètre.
  • Obtention au moment de l'exécution : au moment de l'exécution, vos références de paramètres contiennent les valeurs de paramètres qui ont été définies. Vous pouvez utiliser l'API ou un webhook pour les obtenir. Par exemple, lorsqu'un intent est mis en correspondance et que votre webhook est appelé, votre service de webhook reçoit les valeurs des paramètres de l'intent.

Paramètres d'intent

Les intents utilisent des paramètres pour extraire les données fournies par les utilisateurs finaux lorsque les intents sont mis en correspondance. Les données suivantes sont utilisées pour définir un paramètre d'intent :

  • Nom (également appelé ID ou Nom à afficher) : nom qui identifie le paramètre.
  • Type d'entité : type d'entité associé au paramètre.
  • Est une liste : si le paramètre est défini sur "vrai", le paramètre est traité comme une liste de valeurs.

Définir des paramètres d'intent

Les paramètres d'intent sont définis au moment de la conception lors de la création des données d'intent ou lors de l'annotation de phrases d'entraînement.

Paramètres d'intent de référence

Les références des paramètres d'intent peuvent être utilisées dans les messages de réponse de fulfillment statique des routes d'intents.

Lorsque du texte est mis en correspondance avec une entité particulière au moment de l'exécution, il est souvent converti en une valeur plus pratique pour le fulfillment. Par exemple, le mot "pommes" dans les entrées saisies par l'utilisateur final peut être extrait en tant que "pomme" pour une entité fruitière. Vous pouvez référencer la valeur original écrite ou prononcée par l'utilisateur final ou la valeur resolved extraite par l'entité.

Pour référencer un paramètre pour l'intent actuellement associé, utilisez l'un des formats suivants :

$intent.params.parameter-id.original
$intent.params.parameter-id.resolved

Par exemple, si l'ID de paramètre est date, vous pouvez référencer la valeur résolue au format suivant : $intent.params.date.resolved.

Vous pouvez également accéder au nom du type d'entité du paramètre :

$intent.params.parameter-id.type

Définir des paramètres d'intent

Lorsqu'une entrée d'utilisateur final correspond à un intent au moment de l'exécution, tout paramètre utilisé par une annotation pour la phrase d'entraînement associée est défini par Dialogflow.

Le fulfillment d'une route d'intent peut utiliser un préréglage des paramètres de fulfillment pour définir une valeur de paramètre d'intent au moment de l'exécution.

Obtenir des paramètres d'intent

Lors du tour de conversation dans lequel un intent est mis en correspondance, votre code peut accéder aux valeurs des paramètres d'intent.

Les interactions avec l'API renverront les valeurs du paramètre d'intent. Consultez le champ de réponse queryResult.parameters de la méthode detectIntent dans la .

Sélectionnez un protocole et une version pour la référence de session :

Protocole V3beta1
REST Ressource de session
RPC Interface de session

Le webhook reçoit les valeurs de paramètre de l'intent. Consultez le champ intentInfo.parameters dans la requête du webhook.

Paramètres de formulaire

Pour chaque page, vous pouvez définir un formulaire, qui est une liste de paramètres devant être collectés par l'utilisateur final pour la page. L'agent interagit avec l'utilisateur final pour plusieurs tours de conversation, jusqu'à ce qu'il ait collecté tous les paramètres du formulaire requis, également appelés paramètres de page Pour chaque paramètre du formulaire, vous fournissez également des invites que l'agent utilise pour demander ces informations à l'utilisateur final. Ce processus est appelé le remplissage du formulaire.

Par exemple, vous pouvez créer un formulaire qui recueille le nom et le numéro de téléphone de l'utilisateur final pour une page Collect Customer Info.

Le remplissage de formulaire CX ressemble au remplissage de cases ES.

Les données suivantes sont utilisées pour définir un paramètre de formulaire :

  • Nom (également appelé ID ou Nom à afficher) : nom qui identifie le paramètre.
  • Type d'entité : type d'entité associé au paramètre.
  • Est une liste : si le paramètre est défini sur "vrai", le paramètre est traité comme une liste de valeurs.
  • Obligatoire : indique si le paramètre est requis. Les paramètres facultatifs ne déclenchent pas d'invites. Toutefois, ils sont renseignés si l'utilisateur les spécifie. Les paramètres obligatoires doivent être renseignés avant la fin du remplissage du formulaire.
  • Valeur par défaut : valeur par défaut d'un paramètre facultatif. Si le paramètre est obligatoire, la valeur par défaut est ignorée.
  • Réponse à l'invite initiale : configurez-la avec un fulfillment utilisé lorsque l'agent doit initialement inviter l'utilisateur final à remplir le paramètre.
  • Nouvelles invites de gestionnaires : ils sont utilisés lorsque l'agent doit demander à nouveau à l'utilisateur final de remplir le paramètre en cas d'échec d'une tentative. Consultez la section Gestionnaires de nouvelles invites de remplissage de formulaires.

Définir des paramètres de formulaire

Les paramètres du formulaire sont définis au moment de la conception lors de la création d'une page.

Paramètres du formulaire de référence

Les références des paramètres du formulaire ne sont pas utilisées directement. Vous ne pouvez vérifier l'état de remplissage que pour les paramètres de formulaire individuels ou pour l'ensemble du formulaire. Vous pouvez utiliser ces références d'état du formulaire dans une exigence de condition d'une route de condition.

Pour vérifier si le formulaire de la page actuelle est rempli, utilisez la condition suivante :

$page.params.status = "FINAL"

Pour vérifier si un paramètre de formulaire particulier a été rempli lors du dernier tour, utilisez la condition suivante :

$page.params.parameter-id.status = "UPDATED"

Définir des paramètres de formulaire

Le fulfillment pour une route, un gestionnaire d'événements ou une nouvelle invite de formulaire peut utiliser un préréglage de paramètre de fulfillment pour définir une valeur de paramètre de formulaire au moment de l'exécution.

Votre webhook peut définir les valeurs des paramètres du formulaire au moment de l'exécution. Consultez le champ pageInfo.formInfo.parameterInfo dans la réponse Webhook.

Obtenir des paramètres de formulaire

Les interactions avec l'API renvoient les valeurs des paramètres de formulaire. Consultez le champ de réponse queryResult.parameters de la méthode detectIntent dans la .

Sélectionnez un protocole et une version pour la référence de session :

Protocole V3beta1
REST Ressource de session
RPC Interface de session

Le webhook reçoit les valeurs de paramètre du formulaire. Consultez le champ pageInfo.formInfo.parameterInfo dans la requête du webhook.

Gestionnaires de nouvelles invites de remplissage de formulaires

Lors du remplissage du formulaire, l'agent demande à l'utilisateur final de fournir des valeurs de paramètres. Si l'utilisateur final répond par une entrée inattendue, un événement sys.no-match-* ou sys.no-input-* est appelé. Vous pouvez définir des gestionnaires de répétition, également appelés gestionnaires d'événements au niveau du paramètre, afin de demander à l'utilisateur final de renvoyer la valeur du paramètre.

Comme d'autres gestionnaires d'événements, un gestionnaire de nouvelles invites est un type de gestionnaire d'état pouvant être configuré avec l'un des éléments suivants, ou les deux :

  • Un fulfillment pour fournir un message de nouvelle invite à l'utilisateur final et/ou un préréglage de paramètres.
  • Une cible de transition permettant de modifier la page actuelle

Paramètres de session

Lorsqu'un paramètre de n'importe quel type est défini au moment de l'exécution, il est écrit dans la session et devient un paramètre de session. Ces paramètres ne sont pas explicitement définis au moment de la conception. Vous pouvez référencer ces paramètres de session à tout moment au cours d'une session.

Paramètres de session de référence

Les références de paramètres de session peuvent être utilisées dans les messages de réponse statique pour les types de fulfillment suivants :

  • Fulfillment des entrées de page
  • Fulfillment de la route
  • Fulfillment du gestionnaire d'événements
  • Fulfillment d'invite de formulaire
  • Fulfillment de nouvelle invite de formulaire

Pour référencer un paramètre de session, utilisez les formats suivants :

Scalaire

Pour accéder à un paramètre avec un type d'entité scalaire, procédez comme suit :

$session.params.parameter-id

Par exemple, si l'ID de paramètre est date, vous pouvez référencer la valeur au format suivant : $session.params.date.

Composite

Pour accéder à un membre d'un paramètre avec un type d'entité composite, procédez comme suit :

$session.params.parameter-id.member-name

Par exemple, si l'ID de paramètre est location, vous pouvez référencer la valeur de membre zip-code au format suivant : $session.params.location.zip-code.

Liste

Pour accéder à l'énième élément d'un paramètre de liste :

$session.params.parameter-id[i]

Par exemple, si l'ID du paramètre de liste est colors, vous pouvez référencer la première valeur au format suivant : $session.params.colors[0].

Définir des paramètres de session

Une fois le formulaire rempli, les paramètres renseignés sont écrits dans la session par Dialogflow.

Le fulfillment pour une route, un gestionnaire d'événements ou une nouvelle invite de formulaire peut utiliser un préréglage de paramètre de fulfillment pour définir une valeur de paramètre de session au moment de l'exécution.

Votre webhook peut définir les valeurs des paramètres de session lors de l'exécution. Consultez le champ sessionInfo.parameters dans la réponse du webhook.

Les interactions avec l'API peuvent définir des valeurs de paramètres de session. Consultez le champ de requête queryParams.parameters de la méthode detectIntent dans la .

Sélectionnez un protocole et une version pour la référence de session :

Protocole V3beta1
REST Ressource de session
RPC Interface de session

Obtenir des paramètres de session

Les interactions avec l'API renverront les valeurs du paramètre de la session. Consultez le champ de réponse queryResult.parameters de la méthode detectIntent dans la .

Sélectionnez un protocole et une version pour la référence de session :

Protocole V3beta1
REST Ressource de session
RPC Interface de session

Le webhook reçoit les valeurs de paramètre de la session. Consultez le champ sessionInfo.parameters dans la requête du webhook.

Propagation des paramètres

Lorsqu'une entrée d'utilisateur final fournit une valeur de paramètre, le paramètre peut être propagé vers d'autres niveaux :

  • Lorsqu'un paramètre d'intent est défini par une correspondance d'intent, les paramètres de formulaire ayant un nom similaire de la page active sont définis sur la même valeur. Le type d'entité du paramètre est déterminé par la définition du paramètre d'intent.
  • Lorsqu'un paramètre d'intent est défini par une correspondance d'intent ou qu'un paramètre de formulaire est défini lors du remplissage du formulaire, le paramètre devient un paramètre de session.