地址集合预构建组件会从最终用户那里收集地址,并使用 Google Address Validation API 来验证地址。
限制
除了常见的预构建组件限制之外,此预构建组件还具有以下限制:
- 仅支持 Address Validation API 覆盖范围详情中列出的国家/地区的地址。
其他功能
此预构建组件提供了以下其他功能:
示例对话框
以下示例对话框展示了此预构建组件处理的常见场景。这些示例对话框演示了通过电话调用组件时的行为,这会在对话开始时触发“默认欢迎意图”和第一个代理响应。
完整的有效地址
最终用户提供完整地址,并且地址收集组件成功对其进行验证。
用户输入 | 代理响应 |
---|---|
请先告诉我您的完整地址。 | |
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, USA | |
我收集了最终地址;街道编号是 1600,路线是 Amphitheatre Parkway,城市是 Mountain View,行政区是 CA,邮政编码是 94043,国家/地区是 USA。对吗?请说“是”或“不是”。 | |
是 | |
太好了,我已经收集了地址。 |
包含推断元素的部分有效地址
最终用户提供部分地址;客服人员猜测缺失的部分,并在最终用户确认后成功进行验证。
用户输入 | 代理响应 |
---|---|
请先告诉我您的完整地址。 | |
1600 Amphitheatre Parkway | |
我猜对了地址的某些部分,城市是 Mountain View,邮政编码是 94043,行政区是 CA,国家/地区是 USA。 我已收集最终地址;街道编号为 1600,路线是 Amphitheatre Parkway,城市是 Mountain View,行政区是 CA,邮政编码是 94043,国家/地区是 USA。对吗?请说“是”或“不是”。 |
|
是 | |
太好了,我已经收集了地址。 |
包含用户提供的元素的部分有效地址
最终用户提供部分地址;代理猜测缺少的部分,但最终用户在说“否”后提供了自己的输入,代理成功接受了地址。
用户输入 | 代理响应 |
---|---|
请先告诉我您的完整地址。 | |
1600 Amphitheatre Parkway | |
我猜对了地址的某些部分,城市是 Mountain View,邮政编码是 94043,行政区是 CA,国家/地区是 USA。 我已收集最终地址;街道编号为 1600,路线是 Amphitheatre Parkway,城市是 Mountain View,行政区是 CA,邮政编码是 94043,国家/地区是 USA。对吗?请说“是”或“不是”。 |
|
否 | |
好的。请告诉我地址的哪一部分需要更改。 | |
邮政编码 | |
您可以告诉我邮政编码吗? | |
94044 | |
我已完成此次更新。还有其他地方可以更改吗?请说“是”或“不是”。 | |
无 | |
验证后,我已将邮政编码替换为 94043。 我已收集到最终地址:门牌号为 1600,路线为 Amphitheatre Parkway,城市为 Mountain View,行政区为 CA,邮政编码为 94043,国家/地区为 USA。对吗?请说“是”或“不是”。 |
|
是 | |
太好了,我已经收集了地址。 |
无法识别的输入内容
在最终用户提供无法识别的输入内容三次后,组件会退出流程。
用户输入 | 代理响应 |
---|---|
请先告诉我您的完整地址。 | |
没关系 | |
抱歉,我没听明白。请先告诉我您的完整地址。 | |
nice | |
抱歉,我还是没听明白。请先告诉我您的完整地址。 | |
非常好 | |
抱歉,我没听懂你的回复。 |
地址不受支持
在最终用户提供 Address Validation API 当前不支持的地址后,组件会退出该流程。
用户输入 | 代理响应 |
---|---|
请先告诉我您的完整地址。 | |
印度 | |
抱歉,我目前无法验证该区域的地址。 |
地址验证
如需了解地址收集组件如何验证地址,请参阅 Address Validation API 概览。
地址收集组件使用 @sys.address 系统实体捕获最终用户输入,并将捕获的地址发送到 Address Validation API 以提取地址元素以供进一步处理。
以下地址元素由 Address Validation API 返回,并由该组件用于收集和验证完整地址:
- administrative_area_level_1
- 群岛
- country [国家/地区]
- 市行政区
- postal_code
- 路线
- street_number
您可以尝试使用受支持区域中的任何地址进行 Google 地址验证演示。
命名惯例
此预构建组件使用以下命名惯例:
特征 | 形式 | 示例 |
---|---|---|
流 | [组件名称] | 地址收集 |
组件专用 intent | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_address_collection_locality |
参数 | [param_name] | user_provided_address |
Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_address_collection:address_validation |
输入参数
输入参数是用于配置组件某些行为的参数。流中的一个或多个条件将使用这些参数来确定组件的行为方式。流范围的参数必须在组件的初始页上设置,如下所述。会话级范围的参数可以通过调用流设置,也可以在此组件的初始页上设置。
您可以通过修改流程的初始页中的参数预设来配置此组件需要哪些地址元素。
此预构建组件接受以下输入参数:
参数名称 | 说明 | 输入格式 |
---|---|---|
$flow.zip_code | 如果需要邮政编码地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.city | 如果需要城市地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.admin_area | 如果需要行政区的地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.street_number | 如果需要门牌号地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.route | 如果需要路线地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.country | 如果需要国家/地区地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.island | 如果需要岛地址元素,则设置为 true ,否则设置为 false 。 |
boolean |
$flow.retry_num | 设置 Maps Address Validation API 网络钩子调用的重试次数上限 | 整数 |
如需为此组件配置输入参数,请展开查看相关说明。
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择 Build 标签页。
- 在流部分中点击导入的组件。
- 点击网页部分中的初始页。
- 点击初始页中的 true 路由。
- 在“路由”窗口中,根据需要修改参数预设值。
- 点击保存。
输出参数
输出参数是在退出组件后将保持活跃状态的会话参数。这些参数包含该组件收集的重要信息。此预构建组件提供了以下输出参数的值:
参数名称 | 说明 | 输出格式 |
---|---|---|
address_collection_address | 如果组件捕获了地址,该参数会返回地址对象 | { |
address_collection_status | 此参数返回所收集地址的状态。返回的值为以下值之一:VALID_ADDRESS :地址已通过 Address Validation API 收集并验证。INVALID_ADDRESS :地址已由最终用户确认,但有一个或多个元素未通过 Address Validation API 验证或标记为 UNCONFIRMED_BUT_PLAUSIBLE。MAPS_API_ERROR :由于 Address Validation API 发生错误,导致未收集地址。COUNTRY_NOT_SUPPORTED :地址验证 API 未确认,原因是地址验证 API 未确认。NO_USER_CONFIRMATION |
string |
基本设置
如需设置此预构建组件,请执行以下操作:
网络钩子设置
为了使用 Address Validation API 验证地址,您需要使用正确的凭据配置提供的灵活 webhook。
地址验证 webhook
此 webhook 会执行以下操作:
- 使用 Address Validation API 处理捕获的 Dialogflow 参数、表单请求,并验证地址。
- 从 Google Address Validation API 响应中提取已确认、未确认、缺失和推断的地址元素。
如需为此组件配置网络钩子,您需要使用自己的 Maps API 密钥更新网络钩子设置。
- 如要检索您的 API 密钥,请前往 Google Cloud Platform 控制台 > API 和服务 > 凭据,选择您的 Maps API 密钥,然后复制“API 密钥”字段。
如需配置 webhook,请执行以下操作:
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择管理标签页。
- 点击网络钩子。
- 选择 build_components_address_collection:address_validation 网络钩子。
- 将 Dialogflow Webhook 网址字段中的网址替换为包含您的 Maps API 密钥的网址:https://addressvalidation.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
- 在 Authentication 设置中,将用户名配置为
key
,并将密码设置为您的 Maps API 密钥。 - 点击保存。
完成
现在,您的代理及其 webhook 应该已设置完毕,可以进行测试了。