Componente pré-criado de coleta de endereços

O componente pré-criado de coleta de endereços coleta um endereço do usuário final e usa a API Google Address Validation para validar endereços.

Limitações

Além das limitações comuns de componentes pré-criados, esse componente pré-criado tem as seguintes limitações:

Aceita apenas endereços de países listados em Detalhes da cobertura da API Address Validation.

Funcionalidades adicionais

As seguintes funcionalidades adicionais são fornecidas por esse componente pré-criado:

Exemplos de diálogos

Os exemplos de caixas de diálogo abaixo demonstram cenários comuns processados por esse componente pré-criado. As caixas de diálogo de exemplo demonstram o comportamento quando o componente é chamado por telefonia, o que aciona a intent de boas-vindas padrão e a primeira resposta do agente no início da conversa.

Endereço completo válido

O usuário final informa um endereço completo, e o componente de coleta de endereços o verifica.

Entrada do usuário	Resposta do agente
	Para começar, diga seu endereço completo.
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, EUA
	Coletei o endereço final. O número da rua é 1600, o trajeto é Amphitheatre Parkway, a cidade é Mountain View, a área político-administrativa é CA, o código postal é 94043, o país é EUA. É isso mesmo? Diga sim ou não.
sim
	Ótimo, coletei o endereço.

Endereço parcial válido com elementos inferidos

O usuário final informa um endereço parcial. O agente supõe a parte que está faltando e a verifica após a confirmação do usuário.

Entrada do usuário	Resposta do agente
	Para começar, diga seu endereço completo.
1600 Amphitheatre Parkway
	Acho que parte do endereço: a cidade é Mountain View, o CEP é 94043, a área político-administrativa é CA, o país é EUA. Eu coletei o endereço final: o número da rua é 1600, o trajeto é Amphitheatre Parkway, a cidade é Mountain View, a área administrativa é CA, o código postal é 94043, o país é EUA. É isso mesmo? Diga sim ou não.
Sim
	Ótimo, coletei o endereço.

Endereço parcial válido com elementos fornecidos pelo usuário

O usuário final informa um endereço parcial. O agente identifica a parte que está faltando, mas o usuário final fornece a própria entrada depois de dizer "não", e o agente aceita o endereço.

Entrada do usuário	Resposta do agente
	Para começar, diga seu endereço completo.
1600 Amphitheatre Parkway
	Acho que parte do endereço: a cidade é Mountain View, o CEP é 94043, a área político-administrativa é CA, o país é EUA. Eu coletei o endereço final: o número da rua é 1600, o trajeto é Amphitheatre Parkway, a cidade é Mountain View, a área administrativa é CA, o código postal é 94043, o país é EUA. É isso mesmo? Diga sim ou não.
Não
	OK. Diga que parte do endereço precisa ser alterada.
Código postal
	Poderia informar o CEP?
94044
	Terminei essa atualização. Gostaria de mudar mais alguma coisa? Diga sim ou não.
custos
	Após a validação, substituímos o código postal por 94043. Coletamos o endereço final. O número da rua é 1600, o trajeto é Amphitheatre Parkway, a cidade é Mountain View, a área político-administrativa é CA, o código postal é 94043, o país é EUA. É isso mesmo? Diga sim ou não.
sim
	Ótimo, coletei o endereço.

Entrada não reconhecida

O componente sai do fluxo depois que o usuário final fornece uma entrada não reconhecida três vezes.

Entrada do usuário	Resposta do agente
	Para começar, diga seu endereço completo.
Razoável
	Sinto muito. Não entendi. Para começar, diga seu endereço completo.
Bem-estar
	Humm, ainda não consegui entender. Para começar, diga seu endereço completo.
ótimo
	Não estou conseguindo entender sua resposta.

Endereço incompatível

O componente sai do fluxo depois que o usuário final fornece um endereço que não é compatível com a API Address Validation.

Entrada do usuário	Resposta do agente
	Para começar, diga seu endereço completo.
Índia
	No momento, não é possível validar endereços nessa região.

Validação de endereço

Para entender como o componente de coleta de endereços valida endereços, consulte a Visão geral da API Address Validation.

O componente de coleta de endereços captura a entrada do usuário final usando a entidade do sistema@sys.address e envia o endereço capturado para a API Address Validation para extrair elementos de endereço para processamento adicional.

Os elementos de endereço a seguir são retornados pela API Address Validation e são usados pelo componente para coletar e validar um endereço completo:

admin_area_level_1
arquipélago
país
região administrativa
postal_code [código_postal]
rota
street_number (link em inglês)

É possível testar a demonstração de validação de endereços do Google com qualquer endereço de uma região com suporte.

Convenções de nomeação

Esse componente pré-criado usa as seguintes convenções de nomenclatura:

Recurso	Formato	Exemplo
Fluxo	[Nome do componente]	Coleta de endereços
Intent específico do componente	pré-build_components_[component_name]_[intent_name]	pré-build_components_address_collection_região
Parâmetro	[nome_do_parâmetro]	endereço_fornecido pelo usuário
Webhook	prebuilt_components_[component_name]:[webhook_action]	pré-build_components_address_collection:address_validação

Parâmetros de entrada

Os parâmetros de entrada são usados para configurar determinados comportamentos do componente. Os parâmetros serão usados por uma ou mais condições no fluxo para determinar como o componente vai se comportar. Os parâmetros no escopo do fluxo precisam ser definidos na página inicial do componente, conforme descrito abaixo. Os parâmetros no escopo da sessão podem ser definidos por um fluxo de chamada ou na página inicial desse componente.

Você pode configurar quais elementos de endereço são exigidos por esse componente modificando as predefinições de parâmetro na página inicial do fluxo.

Esse componente pré-criado aceita os seguintes parâmetros de entrada:

Nome do parâmetro	Descrição	Formato da entrada
$flow.zip_code	Se o elemento de endereço de CEP for necessário, defina como `true`. Caso contrário, defina `false`.	booleano
$flow.city	Se o elemento de endereço da cidade for obrigatório, defina como `true`. Caso contrário, defina `false`.	booleano
$flow.admin_area	Se o elemento de endereço da área político-administrativa for obrigatório, defina-o como `true`. Caso contrário, defina `false`.	booleano
número_de_fluxos.street_number	Se o elemento de endereço do número for obrigatório, defina como `true`. Caso contrário, defina `false`.	booleano
$flow.route	Se o elemento de endereço da rota for necessário, defina como `true`. Caso contrário, defina `false`.	booleano
$flow.country	Se o elemento de endereço do país for obrigatório, defina como `true`. Caso contrário, defina `false`.	booleano
$flow.island	Se o elemento de endereço da ilha for obrigatório, defina como `true`. Caso contrário, defina `false`.	booleano
$flow.retry_num	Define o limite máximo de tentativas para chamadas do webhook da API Maps Address Validation	integer

Para configurar os parâmetros de entrada desse componente, expanda para conferir as instruções.

Abra o Console do Dialogflow CX.
Escolha seu projeto do Google Cloud.
Selecione seu agente.
Selecione a guia Build.
Clique no componente importado na seção Fluxos.
Clique em "Página inicial" na seção Páginas.
Clique na rota true na página inicial.
Na janela "Rota", edite os valores em Parameter Presets conforme necessário.
Clique em Save.

Parâmetros de saída

Os parâmetros de saída são parâmetros de sessão que permanecem ativos após a saída do componente. Esses parâmetros contêm informações importantes coletadas pelo componente. Esse componente pré-criado fornece valores para os seguintes parâmetros de saída:

Nome do parâmetro	Descrição	Formato da saída
endereço_coleção_endereço	Se um endereço tiver sido capturado pelo componente, esse parâmetro retornará o objeto de endereço.	{ "admin-area": string, "city": string, "country": string, "island": string, "route": string, "zip-code": string, "street-number": string }
status_da_coleção_de_endereços	Esse parâmetro retorna o status do endereço coletado. O valor retornado é um destes: `VALID_ADDRESS`: o endereço foi coletado e validado pela API Address Validation. `INVALID_ADDRESS`: o endereço foi confirmado pelo usuário final, mas um ou mais elementos não foram validados ou marcados como UNCONFIRMED_BUT_PLAUSIBLE pela API Address Validation. `MAPS_API_ERROR`: o endereço não foi coletado devido a um erro da API Address Validation. `COUNTRY_NOT_SUPPORTED`: o endereço não foi coletado porque o usuário final não confirmou o endereço da região de validação `COUNTRY_NOT_SUPPORTED`: o endereço do usuário final não foi confirmado. `NO_USER_CONFIRMATION`	string

Configuração básica

Para configurar esse componente pré-criado:

Importe o componente pré-criado.
Ative a API Address Validation.
Configure o webhook flexível fornecido com sua chave da API Maps. Consulte "Configuração do webhook" abaixo.

Configuração do webhook

Para usar a API Address Validation para validar endereços, você precisará configurar o webhook flexível fornecido com as credenciais corretas.

Webhook de validação de endereço

Esse webhook executa as seguintes ações:

Processa os parâmetros capturados do Dialogflow, faz a solicitação de formulários e verifica o endereço usando a API Address Validation.
Extrai elementos de endereço confirmados, não confirmados, ausentes e inferidos da resposta da API Google Address Validation.

Se você quiser definir o webhook para esse componente, será preciso atualizar as configurações do webhook com a chave da API Maps.

Para recuperar sua chave de API: acesse Console do Google Cloud Platform > APIs e serviços > Credenciais, selecione sua chave de API Maps e copie o campo "Chave de API".

Para configurar o webhook:

Abra o Console do Dialogflow CX.
Escolha seu projeto do Google Cloud.
Selecione seu agente.
Selecione a guia Gerenciar.
Clique em Webhooks.
Selecione o webhook prebuilt_components_address_collection:address_validação.
Substitua o URL no campo URL do webhook pelo URL que inclui a chave da API Maps: https://addressexpiration.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
Nas configurações de Autenticação, defina o nome de usuário como key e a senha da sua chave da API Maps.
Clique em Save.

Concluído

Seu agente e o webhook dele já estão configurados e prontos para serem testados.

Extrato da conta

Coleção alfanumérica