LocationService / Client / search_place_index_for_suggestions

search_place_index_for_suggestions#

LocationService.Client.search_place_index_for_suggestions(**kwargs)#

Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

Note

You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.

Request Syntax

response = client.search_place_index_for_suggestions(
    BiasPosition=[
        123.0,
    ],
    FilterBBox=[
        123.0,
    ],
    FilterCategories=[
        'string',
    ],
    FilterCountries=[
        'string',
    ],
    IndexName='string',
    Key='string',
    Language='string',
    MaxResults=123,
    Text='string'
)

Parameters:

BiasPosition (list) –
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

Note
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
- (float) –
FilterBBox (list) –
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

Note
FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
- (float) –
FilterCategories (list) –
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
- (string) –
FilterCountries (list) –
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
- Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.
- (string) –
IndexName (string) –
[REQUIRED]

The name of the place index resource you want to use for the search.
Key (string) – The optional API key to authorize the request.
Language (string) –
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we’ll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
MaxResults (integer) –
An optional parameter. The maximum number of results returned per request.

The default: 5
Text (string) –
[REQUIRED]

The free-form partial text to use to generate place suggestions. For example, eiffel tow.

Return type:

dict

Returns:

Response Syntax

{
    'Results': [
        {
            'Categories': [
                'string',
            ],
            'PlaceId': 'string',
            'SupplementalCategories': [
                'string',
            ],
            'Text': 'string'
        },
    ],
    'Summary': {
        'BiasPosition': [
            123.0,
        ],
        'DataSource': 'string',
        'FilterBBox': [
            123.0,
        ],
        'FilterCategories': [
            'string',
        ],
        'FilterCountries': [
            'string',
        ],
        'Language': 'string',
        'MaxResults': 123,
        'Text': 'string'
    }
}

Response Structure

(dict) –
- Results (list) –
  
  A list of place suggestions that best match the search text.
  - (dict) –
    
    Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.
    - Categories (list) –
      
      The Amazon Location categories that describe the Place.
      
      For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
      - (string) –
    - PlaceId (string) –
      
      The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.
      
      The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.
      
      Note
      For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
      
      While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:
      - Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
      - HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.
      - Grab: Place IDs can expire or become invalid in the following situations.
        
        Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
        
        Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the place.result_type field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.
    - SupplementalCategories (list) –
      
      Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
      - (string) –
    - Text (string) –
      
      The text of the place suggestion, typically formatted as an address string.
- Summary (dict) –
  
  Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index.
  - BiasPosition (list) –
    
    Contains the coordinates for the optional bias position specified in the request.
    
    This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    - (float) –
  - DataSource (string) –
    
    The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
    - Esri
    - Grab
    - Here
    For more information about data providers, see Amazon Location Service data providers.
  - FilterBBox (list) –
    
    Contains the coordinates for the optional bounding box specified in the request.
    - (float) –
  - FilterCategories (list) –
    
    The optional category filter specified in the request.
    - (string) –
  - FilterCountries (list) –
    
    Contains the optional country filter specified in the request.
    - (string) –
  - Language (string) –
    
    The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
  - MaxResults (integer) –
    
    Contains the optional result count limit specified in the request.
  - Text (string) –
    
    The free-form partial text input specified in the request.

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException