Search Place Index for Text

locationservice_search_place_index_for_text

R Documentation

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest

Description

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

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

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

Search results are returned in order of highest to lowest relevance.

Usage

locationservice_search_place_index_for_text(IndexName, Text,
  BiasPosition, FilterBBox, FilterCountries, MaxResults, Language,
  FilterCategories, Key)

Arguments

IndexName

[required] The name of the place index resource you want to use for the search.

Text

[required] The address, name, city, or region to be used in the search in free-form text format. For example, ⁠123 Any Street⁠.

BiasPosition

An optional parameter that indicates a preference for places 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.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

FilterBBox

An optional parameter that limits the search results by returning only places that are within the provided 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.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

FilterCountries

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

MaxResults

An optional parameter. The maximum number of results returned per request.

The default: 50

Language

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, but not the results themselves. 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, Greece⁠, with the language parameter set to en. The result found will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as A\Theta\eta\nu\alpha.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

FilterCategories

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.

Key

The optional API key to authorize the request.

Value

A list with the following syntax:

list(
  Summary = list(
    Text = "string",
    BiasPosition = list(
      123.0
    ),
    FilterBBox = list(
      123.0
    ),
    FilterCountries = list(
      "string"
    ),
    MaxResults = 123,
    ResultBBox = list(
      123.0
    ),
    DataSource = "string",
    Language = "string",
    FilterCategories = list(
      "string"
    )
  ),
  Results = list(
    list(
      Place = list(
        Label = "string",
        Geometry = list(
          Point = list(
            123.0
          )
        ),
        AddressNumber = "string",
        Street = "string",
        Neighborhood = "string",
        Municipality = "string",
        SubRegion = "string",
        Region = "string",
        Country = "string",
        PostalCode = "string",
        Interpolated = TRUE|FALSE,
        TimeZone = list(
          Name = "string",
          Offset = 123
        ),
        UnitType = "string",
        UnitNumber = "string",
        Categories = list(
          "string"
        ),
        SupplementalCategories = list(
          "string"
        ),
        SubMunicipality = "string"
      ),
      Distance = 123.0,
      Relevance = 123.0,
      PlaceId = "string"
    )
  )
)

Request syntax

svc$search_place_index_for_text(
  IndexName = "string",
  Text = "string",
  BiasPosition = list(
    123.0
  ),
  FilterBBox = list(
    123.0
  ),
  FilterCountries = list(
    "string"
  ),
  MaxResults = 123,
  Language = "string",
  FilterCategories = list(
    "string"
  ),
  Key = "string"
)