Le composant prédéfini de collecte d'adresses collecte une adresse auprès de l'utilisateur final et utilise l'API Address Validation de Google pour valider les adresses.
Limites
En plus des limites communes des composants prédéfinis, ce composant prédéfini présente les limites suivantes :
- Seules les adresses des pays listés dans Détails de la couverture de l'API Address Validation sont acceptées.
Fonctionnalités supplémentaires
Ce composant prédéfini fournit les fonctionnalités supplémentaires suivantes :
Exemples de dialogues
Les exemples de boîtes de dialogue suivants illustrent des 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é par téléphonie, ce qui déclenche l'intent de bienvenue 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 m'indiquer votre adresse complète pour commencer. | |
| 1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, États-Unis | |
| J'ai collecté l'adresse finale : le numéro de rue est 1600, la rue est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043 et le pays est USA. Est-ce bien cela ? Veuillez dire "Oui" ou "Non". | |
| oui | |
| Super, j'ai bien enregistré l'adresse. |
Adresse valide partielle avec éléments déduits
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 |
|---|---|
| Veuillez m'indiquer 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 et le pays est USA. J'ai collecté l'adresse finale : le numéro de rue est 1600, la rue est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043 et le pays est USA. Est-ce bien cela ? Veuillez dire "Oui" ou "Non". |
|
| Oui | |
| Super, j'ai enregistré 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 saisie après avoir dit "non", et l'agent accepte l'adresse.
| Entrée utilisateur | Réponse de l'agent |
|---|---|
| Veuillez m'indiquer 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 et le pays est USA. J'ai collecté l'adresse finale : le numéro de rue est 1600, la rue est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043 et le pays est USA. Est-ce bien cela ? Veuillez dire "Oui" ou "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 dire "Oui" ou "Non". | |
| non | |
| Après validation, j'ai remplacé le code postal par 94043. J'ai collecté l'adresse finale : le numéro de rue est 1600, la rue est Amphitheatre Parkway, la ville est Mountain View, la région administrative est CA, le code postal est 94043, le pays est USA. Est-ce bien cela ? Veuillez dire "Oui" ou "Non". |
|
| oui | |
| Super, j'ai bien enregistré l'adresse. |
Entrée non reconnue
Le composant quitte le flux après que l'utilisateur final a fourni une entrée non reconnue trois fois.
| Entrée utilisateur | Réponse de l'agent |
|---|---|
| Veuillez m'indiquer votre adresse complète pour commencer. | |
| C'est bon | |
| Désolé, je n'ai pas compris. Veuillez m'indiquer votre adresse complète pour commencer. | |
| nice | |
| Hmm, je n'ai toujours pas compris. Veuillez m'indiquer votre adresse complète pour commencer. | |
| formidable | |
| Désolé, 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 compatible avec l'API Address Validation.
| Entrée utilisateur | Réponse de l'agent |
|---|---|
| Veuillez m'indiquer votre adresse complète pour commencer. | |
| Inde | |
| Malheureusement, je ne peux pas valider d'adresses dans cette région pour le moment. |
Validation d'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 les entrées 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 en vue d'un traitement ultérieur.
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
- locality
- postal_code
- route
- street_number
Vous pouvez essayer la démo de Google Address Validation 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 :
| Fonctionnalité | Format | Exemple |
|---|---|---|
| Flow | [Component Name] | Collecte d'adresses |
| Intention 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 limités au flux doivent être définis sur la page de démarrage 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 de démarrage de ce composant.
Vous pouvez configurer les éléments d'adresse requis par ce composant en modifiant les préréglages des 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 du code postal est obligatoire, définissez-le sur true, sinon sur false. |
booléen |
| $flow.city | Si l'élément d'adresse de la ville est obligatoire, définissez-le sur true, sinon sur false. |
booléen |
| $flow.admin_area | Si l'élément d'adresse de la région administrative est obligatoire, définissez-le sur true, sinon sur false. |
booléen |
| $flow.street_number | Si l'élément d'adresse "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 l'itinéraire 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 nouvelles 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 la 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 Flows (Flux).
- Cliquez sur la page de démarrage dans la section Pages.
- Cliquez sur la route true (vrai) sur la page d'accueil.
- Dans la fenêtre "Route", modifiez les valeurs des préréglages des paramètres si nécessaire.
- Cliquez sur Enregistrer.
Paramètres de sortie
Les paramètres de sortie sont des paramètres de session qui resteront 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 d'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 (voir "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 Address Validation
Ce webhook effectue les actions suivantes :
- Traite les paramètres Dialogflow CX capturés, demande des formulaires et valide l'adresse à l'aide de l'API Address Validation.
- Extrait les éléments d'adresse confirmés, non confirmés, manquants et déduits de la réponse de l'API Address Validation de Google.
Pour configurer le webhook pour ce composant, vous devez mettre à jour les paramètres du webhook avec votre clé API Google Maps.
- Pour récupérer votre clé API, accédez à 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 de webhook de Dialogflow CX par l'URL incluant votre clé API Google Maps : https://addressvalidation.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
- Dans les paramètres Authentication (Authentification), configurez le nom d'utilisateur sur
keyet définissez le mot de passe sur votre clé API Google Maps. - Cliquez sur Enregistrer.
Terminé
Votre agent et son webhook devraient maintenant être configurés et prêts à être testés.