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 les valide à l'aide de l'API Google Address Validation.

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 offre les fonctionnalités supplémentaires suivantes:

Exemples de boîtes de dialogue

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é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 m'indiquer votre adresse complète pour commencer.
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, États-Unis
J'ai obtenu 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 USA. 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 devine la pièce 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é qu'une partie de l'adresse est Mountain View, le code postal est 94043, la région administrative est CA, le pays est USA.

J'ai obtenu l'adresse finale ; le numéro de rue est 1600, le chemin 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 répondre par oui ou par non.
Oui
Fantastique, j'ai recueilli l'adresse.

Adresse partiellement valide avec é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 m'indiquer votre adresse complète pour commencer.
1600 Amphitheatre Parkway
J'ai deviné qu'une partie de l'adresse est Mountain View, le code postal est 94043, la région administrative est CA, le pays est USA.

J'ai obtenu l'adresse finale ; le numéro de rue est 1600, le chemin 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 répondre par oui ou par non.
Non
D'accord. Veuillez m'indiquer la partie de l'adresse à modifier.
Code postal
Pouvez-vous me communiquer 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 récupéré 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.

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 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.
Bien-être
Je n'ai toujours pas compris. Veuillez m'indiquer 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 m'indiquer votre adresse complète pour commencer.
Inde
Je suis désolé, mais je ne suis actuellement pas en mesure de valider des adresses dans cette région.

Validation de l'adresse

Pour comprendre comment le composant de collecte d'adresses valide les adresses, consultez la page 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 afin d'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
  • pays
  • Localité
  • postal_code
  • itinéraire
  • street_number

Vous pouvez essayer la démonstration de Google Address Validation avec n'importe quelle adresse d'une région disponible.

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 prebuilt_components_[component_name]_[intent_name] prebuilt_components_address_collection_locality
Paramètres [nom_param] 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 dans le 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 correspondant à l'adresse du code postal est requis, définissez-le sur true, sinon false. boolean
$flow.city Si l'élément correspondant à l'adresse de la ville est requis, définissez-le sur true, sinon false. boolean
$flow.admin_area Si l'élément d'adresse de la région administrative est requis, définissez-le sur true dans le cas contraire, sinon false. boolean
$flux.street_number Si l'élément correspondant au numéro de rue est requis, définissez-le sur true, sinon false. boolean
$flow.route Si l'élément d'adresse de l'itinéraire est requis, définissez-le sur true, sinon false. boolean
$flow.country Si l'élément correspondant à l'adresse du pays est requis, définissez-le sur true, sinon false. boolean
$flow.island Si l'élément d'adresse de l'île est requis, définissez-le sur true, sinon false. boolean
numéro_flux.retry Définit le nombre maximal de nouvelles 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 les 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 true Route 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 avoir quitté le 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 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
}
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 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'adresse de l'API Address Validation n'a pas été confirmé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 "Configurer un webhook" ci-dessous.

Configuration du webhook

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

Webhook de validation d'adresse

Ce webhook effectue les actions suivantes:

  1. Traite les paramètres Dialogflow capturés, envoie une requête par formulaire 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 Google Address Validation.

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

  1. 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 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 devraient maintenant être configurés et prêts à être testés.

Précédent
Relevé de compte
Suivant
Collection alphanumérique