Autocompletar

Autocompleteretorna endereços completos e componentes de endereço com base na entrada parcial. Os principais casos de uso incluem o preenchimento automático do formulário de endereço e o preenchimento antecipado do endereço (preenchendo o endereço de forma interativa enquanto o usuário final o digita).

nota

Por padrão, somente o ID do local, o tipo de local e os atributos do rótulo são retornados para cada resultado. Detalhes adicionais ricos, incluindo o detalhamento completo do endereço e os intervalos de destaques de entrada para casos de uso interativos, podem ser obtidos definindo o atributo de AdditionalFeatures entrada, mas observe que a solicitação de recursos adicionais pode afetar Preços de locais

nota

Endereços em japonês não são aceitos.

Os resultados são sempre endereços ou componentes do endereço, como ruas, códigos postais e países. Os pontos de interesse nunca são devolvidos. Os resultados não incluem códigos geográficos, pois Autocomplete se concentra no preenchimento do endereço, não na geocodificação. Para obter coordenadas de geocodificação do endereço, use a operação Geocodificar. Os resultados podem ser filtrados por área geográfica. Eles também podem ser filtrados por tipo de local, por exemplo, para incluir somente localidades ou somente códigos postais.

Para obter detalhes completos sobre todos os atributos de solicitação e resposta do Autocomplete, consulte Autocomplete na Amazon Location Service API Reference.

Por exemplo, solicitações, respostas, comandos cURL e CLI para essa API, consulte Como usar o preenchimento automático.

Casos de uso

• Melhore a experiência de checkout: forneça preenchimento de endereços em tempo real à medida que os clientes inserem seus endereços em experiências de checkout de comércio eletrônico e outras experiências de entrada de endereços em sites ou aplicativos. Garanta que os locais de entrega ou coleta correspondam aos endereços conhecidos, reduzindo erros dispendiosos e aumentando a satisfação do cliente.

• Support ao atendimento ao cliente: forneça sugestões de endereço em tempo real aos representantes de atendimento ao cliente em áreas como contact centers e atendimento de emergência, simplificando o processo de coleta de informações de endereço precisas e melhorando a satisfação do usuário, reduzindo o tempo necessário para obter as informações corretas de endereço.

Sobre a solicitação

A Autocomplete operação oferece suporte a vários atributos de solicitação opcionais para refinar os resultados da pesquisa. Para obter a lista completa dos atributos da solicitação, consulte Autocomplete na Amazon Location Service API Reference.

A solicitação aceita os seguintes parâmetros principais:

Autenticação

A operação da API de preenchimento automático oferece suporte a dois modos alternativos de autenticação. Você pode se autenticar assinando a solicitação com uma assinatura SigV4 ou fornecendo uma chave de API.

• Se você estiver fazendo solicitações usando um SDK da AWS específico de uma linguagem ou usando o AWS CLI, sua solicitação normalmente será assinada com o SigV4 por padrão.

• Em alguns casos de uso, por exemplo, fazendo solicitações de um navegador da web ou usando algum outro cliente de SDK que não seja da AWS, as chaves de API são uma forma mais apropriada de autenticação. Use o atributo opcional Key request para fornecer uma chave de API para Autocomplete autenticação.

Para obter mais informações, consulte Autenticação com o Amazon Location Service a Amazon Location Service API Reference.

Especificando o endereço a ser consultado

• Use o atributo de QueryText solicitação obrigatória para fornecer o texto de formato livre para consulta.

• BiasPosition: use o atributo opcional de BiasPosition solicitação para fornecer uma posição do pino, como um par de [longitude, latitude] coordenadas, para melhorar a relevância dos resultados retornados.

Para obter mais informações, consulte Consulta e desvios a Amazon Location Service API Reference.

Incluindo todos os atributos de resposta

Defina o campo opcional AdditionalFeatures com o valor ["Core"] para incluir todos os atributos de resultados disponíveis na resposta, incluindo o detalhamento completo do endereço e os locais de destaque interativos. Observe que solicitar esses atributos extras pode afetar os preços

Refinar os resultados

Use o atributo Filtro para filtrar os resultados retornados com base em países, tipos de lugares ou áreas geográficas específicos. Para obter mais detalhes, consulte Filtrar o Amazon Location Service Developer Guide.

Sobre a resposta

O objeto de resposta contém um atributo de matriz chamado ResultItems que contém a lista de resultados classificados em ordem crescente de relevância. Para ver a lista completa dos atributos do item resultante, consulte Autocomplete na Amazon Location Service API Reference.

A seguir está uma pequena lista de alguns dos atributos mais importantes do item de resultado.

Endereço e detalhes relacionados

• PlaceTypecontém o tipo de local do resultado, que nos diz se o endereço representa um endereço de ponto, uma rua etc. Os resultados retornados por sempre Autocomplete terão um tipo de local que represente um endereço completo ou um componente de um endereço, como uma rua ou código postal. Os resultados nunca incluirão pontos de interesse.

• Addresscontém o rótulo de resultado e, se ["Core"] for especificadoAdditionalFeatures, também contém a divisão completa do endereço em campos estruturados, incluindo número da casa, nome da rua, código postal, país e similares.

Análise de resultados

Fornece dados de análise para cada resultado em relação à consulta de entrada.

• Distance: Se um BiasPosition foi fornecido na solicitação, cada item resultante contém um Distance atributo que fornece a distância, em metros, desse resultado doBiasPosition. Requer que AdditionalFeatures seja definida como ["Core"].

• Highlightsmostra onde as palavras, frases e substrings da entrada QueryText aparecem exatamente em um atributo de resultado, permitindo que os aplicativos forneçam experiências de usuário úteis que destacam as correspondências para seus usuários. Requer que AdditionalFeatures seja definida como ["Core"].