住所収集の事前構築済みコンポーネントは、顧客から住所を収集し、Google Address Validation API を使用して住所を検証します。
制限事項
一般的な事前構築済みコンポーネントの制限に加えて、この事前構築済みコンポーネントには次の制限があります。
- Address Validation API の適用範囲の詳細に記載されている国の住所のみがサポートされます。
追加機能
この事前構築されたコンポーネントには、以下の追加機能が用意されています。
サンプル ダイアログ
次のサンプル ダイアログは、この事前構築されたコンポーネントによって処理される一般的なシナリオを示しています。これらは、コンポーネントがテレフォニーを使用して呼び出されたときの動作を示しています。呼び出しにより、Default Welcome Intent と会話開始時の最初のエージェント レスポンスがトリガーされます。
完全な住所の検証
ユーザーが完全な住所を提示し、住所収集コンポーネントが住所を検証します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| まず、完全な住所を教えてください。 | |
| 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 です。間違いありませんか? 「はい」または「いいえ」でお答えください。 |
|
| はい | |
| 素晴らしい。住所を収集しました。 |
認識されない入力
ユーザーが認識できない入力を 3 回提供すると、コンポーネントはフローを終了します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| まず、完全な住所を教えてください。 | |
| 大丈夫です | |
| すみません、聞き取れませんでした。まず、完全な住所を教えてください。 | |
| 素晴らしい | |
| うーん、やはりわかりませんでした。まず、完全な住所を教えてください。 | |
| すばらしい | |
| 申し訳ありませんが、応答を理解するのが難しいです。 |
住所がサポート対象外
ユーザーが Address Validation API でサポートされていない住所を提供すると、コンポーネントはフローを終了します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| まず、完全な住所を教えてください。 | |
| インド | |
| すみません、そのリージョンの住所を確認できません。 |
住所確認
住所収集コンポーネントが住所を検証する方法については、Address Validation API の概要をご覧ください。
住所収集コンポーネントは、@sys.address システム エンティティを使用してユーザー入力をキャプチャし、取得した住所を Address Validation API に送信して、さらなる処理のために住所要素を抽出します。
Address Validation API は、次の住所要素を返します。これらを使用して、完全な住所を収集して検証できます。
administrative_area_level_1archipelagocountrylocalitypostal_coderoutestreet_number
サポートされているリージョンの住所であれば、Google Address Validation Demo を試すことができます。
命名規則
この事前構築済みコンポーネントでは、次の命名規則が使用されています。
| 機能 | 形式 | 例 |
|---|---|---|
| フロー | [コンポーネント名] | 住所の収集 |
| コンポーネントに固有のインテント | 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 |
入力パラメータ
入力パラメータは、コンポーネントの特定の動作を構成します。フロー内の 1 つ以上の条件は、パラメータを使用してコンポーネントの動作を決定します。ユーザーは、次の表に示すように、コンポーネントのスタートページでフロースコープのパラメータを設定する必要があります。ユーザーは、呼び出しフローまたはこのコンポーネントのスタートページでセッション スコープのパラメータを設定できます。
ユーザーは、フローのスタートページでパラメータ プリセットを変更することで、このコンポーネントに必要な住所要素を構成できます。
この事前構築済みコンポーネントは、次の入力パラメータを受け入れます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $flow.zip_code | 郵便番号の住所要素が必要な場合は true、それ以外の場合は false に設定します。 |
ブール値 |
| $flow.city | 都市の住所要素が必要な場合は true に設定し、そうでない場合は false に設定します。 |
ブール値 |
| $flow.admin_area | 行政区域の住所要素が必須の場合は true、そうでない場合は false に設定します。 |
ブール値 |
| $flow.street_number | 番地の住所要素が必須の場合は true、そうでない場合は false に設定します。 |
ブール値 |
| $flow.route | 地名の住所要素が必須の場合は true、そうでない場合は false に設定します。 |
ブール値 |
| $flow.country | 国の住所要素が必要な場合は true、そうでない場合は false に設定します。 |
ブール値 |
| $flow.island | 島名の住所要素が必要な場合は true、そうでない場合は false に設定します。 |
ブール値 |
| $flow.retry_num | Maps Address Validation API の Webhook 呼び出しの最大再試行回数を設定します。 | integer |
このコンポーネントの入力パラメータを構成するには、開いて手順を確認します。
- Dialogflow CX コンソールを開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Build] タブを選択します。
- [Flows] セクションでインポートされたコンポーネントをクリックします。
- [Pages] セクションで [Start Page] をクリックします。
- スタートページで true ルートをクリックします。
- [Route] ウィンドウで、必要に応じて [Parameter Presets] 値を編集します。
- [Save] をクリックします。
出力パラメータ
出力パラメータは、ユーザーがコンポーネントを終了した後もアクティブな状態を継続するセッション パラメータです。これらのパラメータには、コンポーネントが収集する重要な情報が含まれます。
事前構築済みコンポーネントは、次の出力パラメータを提供します。
| パラメータ名 | 説明 | 出力形式 |
|---|---|---|
| address_collection_address | このパラメータは、コンポーネントが住所を取得した場合の住所オブジェクトを返します | { |
| address_collection_status | このパラメータは、収集された住所のステータスを返します。返される値は次のいずれかです。VALID_ADDRESS: 住所が収集され、Address Validation API によって検証されました。INVALID_ADDRESS: 住所はユーザーによって確認されましたが、1 つ以上の要素が検証されなかったか、Address Validation API によって UNCONFIRMED_BUT_PLAUSIBLE としてマークされました。MAPS_API_ERROR: Address Validation API のエラーにより、住所が収集されませんでした。COUNTRY_NOT_SUPPORTED: Address Validation API がそのリージョンをサポートしていないため、住所が収集されませんでした。NO_USER_CONFIRMATION: ユーザーが住所を確認しなかったため、住所が確認されませんでした。 |
string |
基本設定
この事前構築済みコンポーネントを設定するには:
- 事前構築済みコンポーネントをインポートします。
- Address Validation API を有効にします。
- 付属の柔軟な Webhook を Maps API キーを使用して構成します。詳細については、Webhook の設定をご覧ください。
Webhook の設定
Address Validation API で住所を検証するには、提供されたフレキシブルな Webhook に正しい認証情報を構成します。
Address Validation Webhook
この Webhook は次のアクションを実行します。
- キャプチャされた Dialogflow CX パラメータを処理してリクエストを形成し、Address Validation API を使用して住所を検証します。
- Address Validation API のレスポンスから、確認済み、未確認、欠落、推定の各住所要素を抽出します。
このコンポーネントの Webhook を構成するには、正しい Maps API キーを使用して Webhook 設定を更新します。
API キーを取得するには、Google Cloud コンソール > [API とサービス] > [認証情報] に移動して Maps API キーを選択し、[API キー] フィールドをコピーします。
Webhook を構成するには:
- Dialogflow CX コンソールに移動する。
- Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
prebuilt_components_address_collection:address_validationWebhook を選択します。- Dialogflow CX Webhook URL フィールドの URL を Maps API キーを含む URL に置き換えます。
https://addressvalidation.googleapis.com/v1:validateAddress?key=<var>MAPS_API_KEY</var> - [認証] 設定で、ユーザー名を
keyに構成し、Maps API キーのパスワードを設定します。 - [保存] をクリックします。
完了
これで、ビルド済みコンポーネントとその Webhook が設定され、テストの準備が整いました。