Composant prédéfini de collecte d'adresses

Le composant prédéfini de collecte d'adresses collecte une adresse auprès de l'utilisateur final et utilise l'API Google Address Validation pour les valider.

Limites

Outre les limites courantes relatives aux composants prédéfinis, ce composant prédéfini présente les limites suivantes:

Fonctionnalités supplémentaires

Ce composant prédéfini fournit les fonctionnalités supplémentaires suivantes:

Exemples de boîtes de dialogue

Les exemples de boîtes de dialogue suivants illustrent les scénarios courants gérés par ce composant prédéfini. Les exemples de boîtes de dialogue illustrent le comportement du composant lorsque le composant est appelé par téléphone, ce qui déclenche l'intent d'accueil par défaut et la première réponse de l'agent au début de la conversation.

Adresse complète valide

L'utilisateur final fournit une adresse complète, et le composant de collecte d'adresses la valide.

Entrée utilisateur Réponse de l'agent
Veuillez me donner votre adresse complète pour commencer.
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, États-Unis
J'ai recueilli l'adresse finale : le numéro de rue est 1600, l'itinéraire est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043 et le pays est les États-Unis. Est-ce bien cela ? Veuillez répondre par oui ou par non.
oui
Fantastique, j'ai recueilli l'adresse.

Adresse partiellement valide avec éléments déduits

L'utilisateur final fournit une adresse partielle. L'agent identifie la partie manquante et la valide après confirmation de l'utilisateur final.

Entrée utilisateur Réponse de l'agent
Veuillez me donner votre adresse complète pour commencer.
1600 Amphitheatre Parkway
J'ai deviné une partie de l'adresse : la ville est Mountain View, le code postal est 94043, la région administrative est CA, le pays est les États-Unis.

J'ai recueilli l'adresse finale : le numéro de rue est 1600, l'itinéraire est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043, le pays est les États-Unis. Est-ce bien cela ? Veuillez répondre par oui ou par non.
Oui
Fantastique, j'ai recueilli l'adresse.

Adresse partiellement valide avec des éléments fournis par l'utilisateur

L'utilisateur final fournit une adresse partielle. L'agent devine la partie manquante, mais l'utilisateur final fournit sa propre entrée après avoir dit "non". L'agent accepte alors l'adresse.

Entrée utilisateur Réponse de l'agent
Veuillez me donner votre adresse complète pour commencer.
1600 Amphitheatre Parkway
J'ai deviné une partie de l'adresse : la ville est Mountain View, le code postal est 94043, la région administrative est CA, le pays est les États-Unis.

J'ai recueilli l'adresse finale : le numéro de rue est 1600, l'itinéraire est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043, le pays est les États-Unis. Est-ce bien cela ? Veuillez répondre par oui ou par non.
Non
D'accord. Veuillez m'indiquer la partie de l'adresse à modifier.
Code postal
Pouvez-vous m\'indiquer le code postal ?
94044
J'ai terminé cette mise à jour. Y a-t-il autre chose à modifier ? Veuillez répondre par oui ou par non.
0
Après validation, j'ai remplacé le code postal par 94043.

J'ai recueilli l'adresse finale : le numéro de rue est 1600, l'itinéraire est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043, le pays est les États-Unis. Est-ce bien cela ? Veuillez répondre par oui ou par non.
oui
Fantastique, j'ai recueilli l'adresse.

Entrée non reconnue

Le composant quitte le flux une fois que l'utilisateur final a fourni trois fois une entrée non reconnue.

Entrée utilisateur Réponse de l'agent
Veuillez me donner votre adresse complète pour commencer.
Satisfaisante
Désolé, je n'ai pas compris. Veuillez me donner votre adresse complète pour commencer.
Bien-être
Je n'ai toujours pas compris. Veuillez me donner votre adresse complète pour commencer.
formidable
Excusez-moi, je ne comprends pas votre réponse.

Adresse non acceptée

Le composant quitte le flux une fois que l'utilisateur final a fourni une adresse qui n'est actuellement pas compatible avec l'API Address Validation.

Entrée utilisateur Réponse de l'agent
Veuillez me donner votre adresse complète pour commencer.
Inde
Nous ne sommes malheureusement pas en mesure de valider des adresses dans cette région pour le moment.

Validation de l'adresse

Pour comprendre comment le composant de collecte d'adresses valide les adresses, consultez la présentation de l'API Address Validation.

Le composant de collecte d'adresses capture l'entrée de l'utilisateur final à l'aide de l'entité système@sys.address et envoie l'adresse capturée à l'API Address Validation afin d'extraire les éléments d'adresse en vue d'un traitement plus poussé.

Les éléments d'adresse suivants sont renvoyés par l'API Address Validation et permettent au composant de collecter et de valider une adresse complète:

  • administrative_area_level_1
  • archipel
  • pays
  • localité
  • postal_code [code_postal]
  • itinéraire
  • numéro_rue

Vous pouvez essayer la démonstration de la validation des adresses Google avec n'importe quelle adresse d'une région compatible.

Conventions de nommage

Ce composant prédéfini utilise les conventions d'attribution de noms suivantes:

Caractéristique Format Exemple
Flow [Nom du composant] Collecte d'adresses
Intent spécifique au composant composants_préconfigurés_[nom_composant]_[nom_intent] "prebuilt_components_address_collection_locality"
Paramètres [nom_param] adresse_fournie_par_utilisateur
Webhook composants_préconfigurés_[nom_composant]:[webhook_action] prebuilt_components_address_collection:address_validation

Paramètres d'entrée

Les paramètres d'entrée sont des paramètres utilisés pour configurer certains comportements du composant. Les paramètres seront utilisés par une ou plusieurs conditions du flux pour déterminer le comportement du composant. Les paramètres de portée flux doivent être définis sur la page d'accueil du composant, comme décrit ci-dessous. Les paramètres de portée session peuvent être définis par un flux d'appel ou sur la page d'accueil de ce composant.

Vous pouvez configurer les éléments d'adresse requis par ce composant en modifiant les préréglages de paramètres sur la page d'accueil du flux.

Ce composant prédéfini accepte les paramètres d'entrée suivants:

Nom du paramètre Description Format d'entrée
$flux.zip_code Si l'élément d'adresse du code postal est requis, définissez-le sur true ou sur false. booléen
$flow.city Si l'élément correspondant à l'adresse de la ville est requis, définissez-le sur true ou sur false dans le cas contraire. booléen
$flow.admin_area Si l'élément d'adresse de la région administrative est requis, définissez-le sur true ou false dans les autres cas. booléen
$flux.street_number Si l'élément correspondant au numéro de rue est requis, définissez-le sur true ou sur false. booléen
$flow.route Si l'élément d'adresse de l'itinéraire est requis, définissez-le sur true ou sur false dans le cas contraire. booléen
$flow.country Si l'élément d'adresse du pays est requis, définissez-le sur true ou sur false dans le cas contraire. booléen
$flow.island Si l'élément d'adresse de l'île est requis, définissez-le sur true ou false dans le cas contraire. booléen
$flow.retry_num Définit le nombre maximal de tentatives pour les appels webhook de l'API Maps Address Validation entier

Pour configurer les paramètres d'entrée de ce composant, développez la section pour obtenir des instructions.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Build (Compilation).
  5. Cliquez sur le composant importé dans la section Flux.
  6. Cliquez sur "Page d'accueil" dans la section Pages.
  7. Cliquez sur l'itinéraire true sur la page d'accueil.
  8. Dans la fenêtre "Route", modifiez les valeurs Parameter Presets (Préréglages de paramètres) si nécessaire.
  9. Cliquez sur Enregistrer.

Paramètres de sortie

Les paramètres de sortie sont des paramètres de session qui restent actifs après la fermeture du composant. Ces paramètres contiennent des informations importantes collectées par le composant. Ce composant prédéfini fournit des valeurs pour les paramètres de sortie suivants:

Nom du paramètre Description Format de sortie
address_collection_address [adresse_collection_adresses] Ce paramètre renvoie l'objet address si une adresse a été capturée par le composant.

{
"admin-area": string,
"city": string,
"country": string,
"island": string,
"route": string,
"zip-code": string,
"street-number": string
}
état de la collection d'adresses Ce paramètre renvoie l'état de l'adresse collectée. La valeur renvoyée est l'une des suivantes :

VALID_ADDRESS : l'adresse a été collectée et validée par l'API Address Validation.

INVALID_ADDRESS : l'adresse a été confirmée par l'utilisateur final, mais un ou plusieurs éléments n'ont pas été validés ou marqués comme UNCONFIRMED_BUT_PLAUSIBLE par l'API Address Validation.

MAPS_API_ERROR : l'adresse n'a pas été collectée en raison d'une erreur de région de l'API Address Validation.

COUNTRY_NOT_SUPPORTED : l'adresse n'a pas été collectée, car l'adresse de l'API Address Validation n'a pas été collectée.NO_USER_CONFIRMATION


string

Configuration de base

Pour configurer ce composant prédéfini:

  1. Importez le composant prédéfini.
  2. Activez l'API Address Validation.
  3. Configurez le webhook flexible fourni avec votre clé API Google Maps. Consultez la section "Configuration du webhook" ci-dessous.

Configuration du webhook

Pour valider les adresses à l'aide de l'API Address Validation, vous devez configurer le webhook flexible fourni avec les bons identifiants.

Webhook Address Validation

Ce webhook effectue les actions suivantes:

  1. Traite les paramètres Dialogflow capturés et les demandes de formulaire, et vérifie l'adresse à l'aide de l'API Address Validation.
  2. Extrait les éléments d'adresse confirmés, non confirmés, manquants et déduits de la réponse de l'API Google Address Validation.

Pour configurer le webhook pour ce composant, vous devez mettre à jour les paramètres du webhook avec votre clé API Google Maps.

  1. Pour récupérer votre clé API: accédez à Console Google Cloud Platform > API et services > Identifiants, sélectionnez votre clé API Google Maps et copiez le champ "Clé API".

Pour configurer le webhook:

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Gérer.
  5. Cliquez sur Webhooks.
  6. Sélectionnez le webhook prebuilt_components_address_collection:address_validation.
  7. Remplacez l'URL dans le champ URL du webhook Dialogflow par l'URL incluant votre clé API Google Maps: https://addressvalidation.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
  8. Dans les paramètres Authentication (Authentification), configurez le nom d'utilisateur sur key et le mot de passe sur votre clé API Google Maps.
  9. Cliquez sur Enregistrer.

Terminé

Votre agent et son webhook doivent maintenant être configurés et prêts à être testés.