Esta página foi traduzida pela API Cloud Translation.

Componente pré-criado da 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:

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

Outros recursos

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

Exemplos de diálogos

As caixas de diálogo de exemplo 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 fornece um endereço completo, e o componente de coleta de endereços o verifica.

Entrada do usuário	Resposta do agente
	Diga seu endereço completo para começar.
1600 Amphitheatre Parkway, Mountain View, CA 94043-1351, EUA
	Colete 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 e o país é EUA. É isso mesmo? Diga sim ou não.
sim
	Ótimo, coletei o endereço.

Endereço parcialmente 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 final.

Entrada do usuário	Resposta do agente
	Diga seu endereço completo para começar.
1600 Amphitheatre Parkway
	Achei que parte do endereço é 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 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 parcialmente válido com elementos fornecidos pelo usuário

O usuário final informa um endereço parcial. O agente supõe a parte que está faltando, mas o usuário final insere o próprio comando depois de dizer "não" e o agente aceita o endereço.

Entrada do usuário	Resposta do agente
	Diga seu endereço completo para começar.
1600 Amphitheatre Parkway
	Achei que parte do endereço é 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 político-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. Mais alguma coisa a ser alterada? Diga sim ou não.
custos
	Após a validação, substituí o código postal como 94043. O endereço final é 94043. O número da rua é 1600, o trajeto é Amphitheatre Parkway, a cidade é Mountain View, a área político-administrativa é CA, o CEP é 94043 e 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
	Diga seu endereço completo para começar.
Tudo bem
	Sinto muito. Não entendi. Diga seu endereço completo para começar.
Bem-estar
	Humm, ainda não consegui entender. Diga seu endereço completo para começar.
ótimo
	Estou com dificuldades para entender sua resposta.

Endereço não aceito

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

Entrada do usuário	Resposta do agente
	Diga seu endereço completo para começar.
Í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 usados pelo componente para coletar e validar um endereço completo:

administrative_area_level_1
arquipélago
país
região administrativa
postal_code
trajeto
street_number

É possível testar a demonstração de validação de endereço 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]	Coleção de endereços
Intent específica do componente	prebuilt_components_[component_name]_[intent_name]	prebuilt_components_address_collection_locality
Parâmetro	[nome_do_parâmetro]	user_provided_address
Webhook	prebuilt_components_[component_name]:[webhook_action]	prebuilt_components_address_collection:address_validation

Parâmetros de entrada

Os parâmetros de entrada são usados para configurar determinados comportamentos do componente. Os parâmetros são usados por uma ou mais condições no fluxo para determinar como o componente vai se comportar. Os parâmetros com escopo de 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âmetros 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 obrigatório, defina como `true`. Caso contrário, defina como `false`.	boolean
$flow.city	Se o elemento de endereço da cidade for obrigatório, defina como `true`. Caso contrário, defina como `false`.	boolean
$flow.admin_area	Se o elemento de endereço da área político-administrativa for necessário, defina como `true`. Caso contrário, será `false`.	boolean
$flow.street_number	Se o elemento do endereço do número da rua for obrigatório, defina como `true`. Caso contrário, use `false`.	boolean
$flow.route	Se o elemento de endereço de rota for necessário, defina como `true`. Caso contrário, defina como `false`.	boolean
$flow.country	Se o elemento de endereço do país for obrigatório, defina como `true`. Caso contrário, defina como `false`.	boolean
$flow.island	Se o elemento de endereço da ilha for obrigatório, defina como `true`. Caso contrário, `false`.	boolean
$flow.retry_num	Define o limite máximo de tentativas para chamadas de webhook da API Maps Address Validation	integer

Para configurar os parâmetros de entrada desse componente, abra 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 na página inicial na seção Páginas.
Clique na rota true na página inicial.
Na janela "Rota", edite os valores de Predefinições de parâmetros 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 permanecerão 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
address_collection_address	Este parâmetro retorna o objeto de endereço se um endereço tiver sido capturado pelo componente.	{ "admin-area": string, "city": string, "country": string, "island": string, "route": string, "zip-code": string, "street-number": string }
address_collection_status	Esse parâmetro retorna o status do endereço coletado. O valor retornado é um dos seguintes: `VALID_ADDRESS`: o endereço nã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 endereço de suporte 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 a chave da API Maps. Consulte a 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:

Os processos capturaram parâmetros do Dialogflow, solicitam formulários e verificam 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 quiser configurar o webhook desse componente, você precisará atualizar as configurações do webhook com sua chave de API Maps.

Para recuperar sua chave de API: acesse Console do Google Cloud Platform > APIs e serviços > Credenciais, selecione a chave da 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_validation.
Substitua o URL no campo Webhook URL do Dialogflow pelo URL, incluindo sua chave de API Maps: https://addressvalidation.googleapis.com/v1:validateAddress?key=MAPS_API_KEY
Nas configurações Autenticação, defina o nome de usuário como key e a senha como a chave da API Maps.
Clique em Save.

Concluído

Seu agente e o webhook dele agora estão configurados e prontos para testes.

Extrato da conta

Coleção alfanumérica