Composant prédéfini de collecte d'adresses

Le composant prédéfini de collecte d'adresses collecte l'adresse d'un client et la valide à l'aide de l'API Address Validation de Google.

Limites

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

Autres fonctionnalités

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

Exemples de dialogues

Les exemples de boîtes de dialogue illustrent des scénarios courants gérés par ce composant prédéfini. Ils illustrent le comportement lorsque l'utilisateur appelle le composant par téléphone, 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.

Validation de l'adresse complète

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

Entrée utilisateur Réponse de l'agent
Veuillez d'abord m'indiquer votre adresse complète.
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

  1. L'utilisateur fournit une adresse partielle.
  2. L'agent devine la partie manquante et la vérifie après confirmation de l'utilisateur.
Entrée utilisateur Réponse de l'agent
Veuillez d'abord m'indiquer 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 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 bien enregistré l'adresse.

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

  1. L'utilisateur fournit une adresse partielle.
  2. L'utilisateur rejette la partie devinée et fournit sa propre entrée.
  3. L'agent accepte l'entrée fournie par l'utilisateur et demande une nouvelle confirmation.
  4. L'utilisateur accepte l'adresse finale.
Entrée utilisateur Réponse de l'agent
Veuillez d'abord m'indiquer 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 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 route 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.

Entrée non reconnue

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

Entrée utilisateur Réponse de l'agent
Veuillez d'abord m'indiquer votre adresse complète.
C'est bon
Désolé, je n'ai pas compris. Veuillez d'abord m'indiquer votre adresse complète.
nice
Hmm, je n'ai toujours pas compris. Veuillez d'abord m'indiquer votre adresse complète.
formidable
Désolé, je ne comprends pas votre réponse.

Adresse non acceptée

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

Entrée utilisateur Réponse de l'agent
Veuillez d'abord m'indiquer votre adresse complète.
Inde
Malheureusement, je ne peux pas valider d'adresses dans cette région.

Validation d'adresse

Pour en savoir plus sur la façon dont 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 utilisateur à 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.

L'API Address Validation renvoie les éléments d'adresse suivants, que vous pouvez utiliser pour collecter et valider une adresse complète :

  • administrative_area_level_1
  • archipelago
  • 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 à un 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 configurent certains comportements du composant. Une ou plusieurs conditions du flux utilisent ces paramètres pour déterminer le comportement du composant. Vous devez définir des paramètres limités au flux sur la page de démarrage du composant. Vous pouvez définir des paramètres de portée session à l'aide d'un flux d'appel ou sur la page de démarrage de ce composant.

L'utilisateur peut 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 "code postal" est obligatoire, définissez-le sur true. Sinon, définissez-le sur false. booléen
$flow.city Si l'élément d'adresse de la ville est obligatoire, définissez-le sur true. Sinon, définissez-le 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, définissez-le 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, définissez-le sur false. booléen
$flow.route Si l'élément d'adresse de la route est obligatoire, définissez-le sur true. Sinon, définissez-le sur false. booléen
$flow.country Si l'élément d'adresse du pays est obligatoire, définissez-le sur true. Sinon, définissez-le sur false. booléen
$flow.island Si l'élément d'adresse de l'île est obligatoire, définissez-le sur true. Sinon, définissez-le 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.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Build (Créer).
  5. Cliquez sur le composant importé dans la section Flows (Flux).
  6. Cliquez sur la page de démarrage dans la section Pages.
  7. Cliquez sur la route true sur la page d'accueil.
  8. Dans la fenêtre "Route", modifiez les valeurs des préréglages des 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 sortie du composant. Ces paramètres contiennent des informations importantes collectées par le composant.

Le composant prédéfini fournit 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.
{
"admin-area": string,
"city": string,
"country": string,
"island": string,
"route": string,
"zip-code": string,
"street-number": string
}
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, 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 n'a pas confirmé d'adresse.
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. Pour en savoir plus, consultez la section Configuration du webhook.

Configuration du webhook

Pour valider des adresses avec l'API Address Validation, configurez le webhook flexible fourni avec les identifiants appropriés.

Webhook Address Validation

Ce webhook effectue les actions suivantes :

  1. Traite les paramètres Dialogflow CX capturés, forme la requête et valide 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 Address Validation.

Mettez à jour les paramètres du webhook avec la clé API Google Maps appropriée pour configurer le webhook pour ce composant.

Pour récupérer votre clé API, accédez à Google Cloud Console > API et services > Identifiants, sélectionnez votre clé API Google Maps, puis copiez le champ de la clé API.

Pour configurer le webhook :

  1. Accédez à la console Dialogflow CX.
  2. Sélectionnez 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 de webhook de Dialogflow CX par l'URL incluant votre clé API Google Maps : https://addressvalidation.googleapis.com/v1:validateAddress?key=<var>MAPS_API_KEY</var>.
  8. Dans les paramètres Authentication (Authentification), configurez le nom d'utilisateur sur key et définissez le mot de passe de votre clé API Google Maps.
  9. Cliquez sur Enregistrer.

Terminé

Le composant prédéfini et son webhook sont maintenant configurés et prêts à être testés.