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 la valider.
Limites
En plus des limites courantes des composants prédéfinis, ce composant prédéfini présente les limitations suivantes:
- Compatible uniquement avec les adresses des pays listés dans les Détails de la couverture de l'API Address Validation.
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 lorsque le composant est appelé via la téléphonie, 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 des adresses la valide.
Entrée utilisateur | Réponse de l'agent |
---|---|
Pour commencer, veuillez me donner votre adresse complète. | |
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, États-Unis | |
J'ai obtenu l'adresse finale : le numéro de rue est 1600, l'avenue 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 | |
Parfait. J'ai noté l'adresse. |
Adresse partiellement valide avec des éléments inférés
L'utilisateur final fournit une adresse partielle. L'agent devine la partie manquante et la valide après confirmation de l'utilisateur final.
Entrée utilisateur | Réponse de l'agent |
---|---|
Pour commencer, veuillez me donner votre adresse complète. | |
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, et le pays est les États-Unis. J'ai obtenu l'adresse finale. Le numéro de rue est 1600, l'adresse 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 | |
Parfait. J'ai noté 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 répondu "non". L'agent accepte alors l'adresse.
Entrée utilisateur | Réponse de l'agent |
---|---|
Pour commencer, veuillez me donner votre adresse complète. | |
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, et le pays est les États-Unis. J'ai obtenu l'adresse finale. Le numéro de rue est 1600, l'adresse 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. |
|
Non | |
D\'accord. Veuillez m\'indiquer quelle partie de l\'adresse doit être modifiée. | |
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. | |
non | |
Après validation, j'ai remplacé le code postal par 94043. J'ai obtenu l'adresse finale : le numéro de rue est 1600, l'avenue 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 | |
Parfait. J'ai noté l'adresse. |
Entrée non reconnue
Le composant quitte le flux après que l'utilisateur final a fourni trois fois une entrée non reconnue.
Entrée utilisateur | Réponse de l'agent |
---|---|
Pour commencer, veuillez me donner votre adresse complète. | |
C'est bon | |
Désolé, je n'ai pas compris. Pour commencer, veuillez me donner votre adresse complète. | |
nice | |
Je n'ai toujours pas compris. Pour commencer, veuillez me donner votre adresse complète. | |
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 pas actuellement prise en charge par l'API Address Validation.
Entrée utilisateur | Réponse de l'agent |
---|---|
Pour commencer, veuillez me donner votre adresse complète. | |
Inde | |
Malheureusement, je ne peux pas valider les 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 pour extraire les éléments d'adresse à traiter ultérieurement.
Les éléments d'adresse suivants sont renvoyés par l'API Address Validation et sont utilisés par le composant pour collecter et valider une adresse complète:
- administrative_area_level_1
- archipel
- country
- localité
- postal_code
- route
- street_number
Vous pouvez essayer la démo de validation d'adresse Google avec n'importe quelle adresse d'une région prise en charge.
Conventions d'attribution de noms
Ce composant prédéfini utilise les conventions d'attribution de noms suivantes:
Caractéristique | Format | Exemple |
---|---|---|
Flux | [Component Name] | Collecte d'adresses |
Intent spécifique au composant | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_address_collection_locality |
Paramètre | [param_name] | user_provided_address |
Webhook | prebuilt_components_[component_name]:[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 de flux doivent être définis sur la page de démarrage du composant, comme décrit ci-dessous. Les paramètres de portée de session peuvent être définis par un flux d'appel ou sur la page de démarrage 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 de démarrage du flux.
Ce composant prédéfini accepte les paramètres d'entrée suivants:
Nom du paramètre | Description | Format d'entrée |
---|---|---|
$flow.zip_code | Si l'élément d'adresse de code postal est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.city | Si l'élément d'adresse de ville est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.admin_area | Si l'élément d'adresse de l'région administrative est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.street_number | Si l'élément d'adresse de numéro de rue est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.route | Si l'élément d'adresse de la route est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.country | Si l'élément d'adresse du pays est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.island | Si l'élément d'adresse de l'île est obligatoire, définissez-le sur true , sinon sur false . |
booléen |
$flow.retry_num | Définit la limite maximale de tentatives pour les appels de webhook de l'API Maps Address Validation | entier |
Pour configurer les paramètres d'entrée de ce composant, développez cette section pour obtenir des instructions.
- Ouvrez la console Dialogflow CX.
- Choisissez votre projet Google Cloud.
- Sélectionnez votre agent.
- Sélectionnez l'onglet Compilation.
- Cliquez sur le composant importé dans la section Flux.
- Cliquez sur la page de démarrage dans la section Pages.
- Cliquez sur la route true (vraie) sur la page de démarrage.
- Dans la fenêtre "Itinéraire", modifiez les valeurs des préréglages de paramètres si nécessaire.
- Cliquez sur Enregistrer.
Paramètres de sortie
Les paramètres de sortie sont des paramètres de session qui restent actifs après la sortie 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 | Ce paramètre renvoie l'objet adresse si une adresse a été capturée par le composant. | { |
address_collection_status | 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 ont été 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 l'API Address Validation.COUNTRY_NOT_SUPPORTED : l'adresse n'a pas été collectée, car l'API Address Validation n'est pas compatible avec cette région.NO_USER_CONFIRMATION : l'adresse n'a pas été confirmée, car l'utilisateur final n'a pas confirmé d'adresse. |
string |
Configuration de base
Pour configurer ce composant prédéfini:
- Importez le composant prédéfini.
- Activez l'API Address Validation.
- Configurez le webhook flexible fourni avec votre clé API Google Maps. Pour en savoir plus, consultez la section "Configuration du webhook" ci-dessous.
Configuration du webhook
Pour utiliser l'API Address Validation afin de valider des adresses, vous devez configurer le webhook flexible fourni avec les identifiants appropriés.
Webhook de validation de l'adresse
Ce webhook effectue les actions suivantes:
- Traite les paramètres des agents de conversation (Dialogflow CX) capturés, crée une requête et vérifie l'adresse à l'aide de l'API Address Validation.
- Extraction des éléments d'adresse confirmés, non confirmés, manquants et inférés à partir de la réponse de l'API Google Address Validation.
Pour configurer le webhook de ce composant, vous devez mettre à jour ses paramètres avec votre clé API Google Maps.
- Pour récupérer votre clé API, accédez à la console Google Cloud Platform > API et services > Identifiants, sélectionnez votre clé API Google Maps, puis copiez le champ "Clé API".
Pour configurer le webhook:
- Ouvrez la console Dialogflow CX.
- Choisissez votre projet Google Cloud.
- Sélectionnez votre agent.
- Sélectionnez l'onglet Gérer.
- Cliquez sur Webhooks.
- Sélectionnez le webhook prebuilt_components_address_collection:address_validation.
- Remplacez l'URL dans le champ URL du webhook des agents conversationnels (Dialogflow CX) par l'URL incluant votre clé API Maps: https://addressvalidation.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
- Dans les paramètres Authentication (Authentification), configurez le nom d'utilisateur sur
key
et définissez le mot de passe sur votre clé API Google Maps. - Cliquez sur Enregistrer.
Terminé
Votre agent et son webhook sont maintenant configurés et prêts à être testés.