Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window. Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window.

Address collection prebuilt component

The address collection prebuilt component collects an address from the end-user, and it uses the Google Address Validation API to validate addresses.

Limitations

In addition to the common prebuilt component limitations, this prebuilt component has the following limitations:

Only supports addresses from countries listed at Address Validation API coverage details.

Additional functionalities

The following additional functionalities are provided by this prebuilt component:

Sample dialogs

The following sample dialogs demonstrate common scenarios handled by this prebuilt component. The sample dialogs demonstrate behavior when the component is called via telephony, which triggers the Default Welcome Intent and the first agent response at the start of the conversation.

Full valid address

End-user provides a complete address and the address collection component successfully verifies it.

User input	Agent response
	Please tell me your full address to start.
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, USA
	I have collected the final address; the street number is 1600, the route is Amphitheatre Parkway, the city is Mountain View, the administrative area is CA, the postal code is 94043, the country is USA. Is that correct? Please say yes or no.
yes
	Fantastic, I've collected the address.

Partial valid address with inferred elements

End-user provides a partial address; agent guesses the missing part and successfully verifies it after confirmation from the end-user.

User input	Agent response
	Please tell me your full address to start.
1600 Amphitheatre Parkway
	I have guessed some part of the address, the city is Mountain View, postal code is 94043, administrative area is CA, country is USA. I have collected the final address; the street number is 1600, the route is Amphitheatre Parkway, the city is Mountain View, the administrative area is CA, the postal code is 94043, the country is USA. Is that correct? Please say yes or no.
Yes
	Fantastic, I've collected the address.

Partial valid address with user-provided elements

End-user provides a partial address; agent guesses the missing part but the end-user provides their own input after saying "no", and the agent successfully accepts the address.

User input	Agent response
	Please tell me your full address to start.
1600 Amphitheatre Parkway
	I have guessed some part of the address, the city is Mountain View, postal code is 94043, administrative area is CA, country is USA. I have collected the final address; the street number is 1600, the route is Amphitheatre Parkway, the city is Mountain View, the administrative area is CA, the postal code is 94043, the country is USA. Is that correct? Please say yes or no.
No
	Okay. Please tell me which part of the address needs to be changed.
Postal code
	Can you please share the postal code?
94044
	I'm done with this update. Is there anything else to be changed? Please say yes or no.
no
	After validation I have replaced the postal code as 94043. I have collected the final address; the street number is 1600, the route is Amphitheatre Parkway, the city is Mountain View, the administrative area is CA, the postal code is 94043, the country is USA. Is that correct? Please say yes or no.
yes
	Fantastic, I've collected the address.

Unrecognized input

Component exits the flow after the end-user provides unrecognized input three times.

User input	Agent response
	Please tell me your full address to start.
It's fine
	Sorry, I didn't get that. Please tell me your full address to start.
nice
	Hmm, I still wasn't able to get that. Please tell me your full address to start.
great
	Sorry, I'm having difficulty understanding your response.

Unsupported address

Component exits the flow after the end-user provides an address not currently supported by the Address Validation API.

User input	Agent response
	Please tell me your full address to start.
India
	I'm sorry, but I'm currently unable to validate addresses in that region.

Address validation

To understand how the address collection component validates addresses, see Address Validation API Overview.

The address collection component captures end-user input using the @sys.address system entity and sends the captured address to the Address Validation API to extract address elements for further processing.

The following address elements are returned by the Address Validation API and are used by the component to collect and validate a complete address:

administrative_area_level_1
archipelago
country
locality
postal_code
route
street_number

You can try the Google Address Validation Demo with any address from a supported region.

Naming conventions

This prebuilt component uses the following naming conventions:

Feature	Format	Example
Flow	[Component Name]	Address Collection
Component Specific Intent	prebuilt_components_[component_name]_[intent_name]	prebuilt_components_address_collection_locality
Parameter	[param_name]	user_provided_address
Webhook	prebuilt_components_[component_name]:[webhook_action]	prebuilt_components_address_collection:address_validation

Input parameters

Input parameters are parameters that are used to configure certain behaviors of the component. The parameters will be used by one or more conditions within the flow to determine how the component should behave. Flow-scoped parameters must be set on the start page of the component as described below. Session-scoped parameters may be set either by a calling flow, or on the start page of this component.

You can configure which address elements are required by this component by modifying parameter presets in the flow's start page.

This prebuilt component accepts the following input parameters:

Parameter Name	Description	Input Format
$flow.zip_code	If the zip code address element is required then set as `true`, else `false`.	boolean
$flow.city	If the city address element is required then set as `true`, else `false`.	boolean
$flow.admin_area	If the administrative area address element is required then set as `true`, else `false`.	boolean
$flow.street_number	If the street number address element is required then set as `true`, else `false`.	boolean
$flow.route	If the route address element is required then set as `true`, else `false`.	boolean
$flow.country	If the country address element is required then set as `true`, else `false`.	boolean
$flow.island	If the island address element is required then set as `true`, else `false`.	boolean
$flow.retry_num	Sets the maximum retry limit for Maps Address Validation API webhook calls	integer

To configure the input parameters for this component, expand for instructions.

Open the Dialogflow CX Console.
Choose your Google Cloud project.
Select your agent.
Select the Build tab.
Click the imported component in the Flows section.
Click the Start Page in the Pages section.
Click the true Route in the Start Page.
In the Route window, edit the Parameter Presets values as needed.
Click Save.

Output parameters

Output parameters are session parameters that will remain active after exiting the component. These parameters contain important information collected by the component. This prebuilt component provides values for the following output parameters:

Parameter Name	Description	Output Format
address_collection_address	This parameter returns the address object if an address was captured by the component	{ "admin-area": string, "city": string, "country": string, "island": string, "route": string, "zip-code": string, "street-number": string }
address_collection_status	This parameter returns the status of the collected address. The returned value is one of: `VALID_ADDRESS`: address was collected and validated by the Address Validation API. `INVALID_ADDRESS`: address was confirmed by the end-user but one or more elements were not validated or marked as UNCONFIRMED_BUT_PLAUSIBLE by the Address Validation API. `MAPS_API_ERROR`: address was not collected due to Address Validation API error. `COUNTRY_NOT_SUPPORTED`: address was not collected because the Address Validation API doesn't support that region. `NO_USER_CONFIRMATION`: address was not confirmed because the end-user didn't confirm an address.	string

Basic setup

To set up this prebuilt component:

Import the prebuilt component.
Enable the Address Validation API.
Configure the provided flexible webhook with your Maps API key, see Webhook setup below.

Webhook setup

In order to use the Address Validation API to validate addresses, you will need to configure the provided flexible webhook with the correct credentials.

Address Validation webhook

This webhook performs the following actions:

Processes captured Dialogflow parameters, forms request, and verifies the address using the Address Validation API.
Extracts confirmed, unconfirmed, missing, and inferred address elements from the Google Address Validation API response.

To configure the webhook for this component, you'll need to update the webhook settings with your Maps API key.

To retrieve your API Key: go to Google Cloud Platform Console > APIs & Services > Credentials, select your Maps API key, copy the API Key field.

To configure the webhook:

Open the Dialogflow CX Console.
Choose your Google Cloud project.
Select your agent.
Select the Manage tab.
Click Webhooks.
Select the prebuilt_components_address_collection:address_validation webhook.
Replace the URL in the Dialogflow Webhook URL field with the URL including your Maps API Key: https://addressvalidation.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
In the Authentication settings, configure the Username as key and set the Password to your Maps API key.
Click Save.

Complete

Your agent and its webhook should now be set up and ready to test.

Account statement

Alphanumeric collection