Values.PlaceSourceContains details about addresses or points of interest that match the search criteria. Not all details are included with all responses. Some details may only be returned by specific data partners.
type nonrec t = {label : SensitiveString.t option;The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.
*)geometry : PlaceGeometry.t option;addressNumber : SensitiveString.t option;The numerical portion of an address, such as a building number.
*)street : SensitiveString.t option;The name for a street or a road to identify a location. For example, Main Street.
*)neighborhood : SensitiveString.t option;The name of a community district. For example, Downtown.
*)municipality : SensitiveString.t option;A name for a local area, such as a city or town name. For example, Toronto.
*)subRegion : SensitiveString.t option;A county, or an area that's part of a larger region. For example, Metro Vancouver.
*)region : SensitiveString.t option;A name for an area or geographical division, such as a province or state name. For example, British Columbia.
*)country : SensitiveString.t option;A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
*)postalCode : SensitiveString.t option;A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
*)interpolated : SensitiveBoolean.t option;True if the result is interpolated from other known places. False if the Place is a known place. Not returned when the partner does not provide the information. For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
*)timeZone : TimeZone.t option;The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.
*)unitType : SensitiveString.t option;For addresses with a UnitNumber, the type of unit. For example, Apartment. Returned only for a place index that uses Esri as a data provider.
*)unitNumber : SensitiveString.t option;For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123. Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.
*)categories : PlaceCategoryList.t option;The Amazon Location categories that describe this 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.
*)supplementalCategories : PlaceSupplementalCategoryList.t option;Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
*)subMunicipality : SensitiveString.t option;An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York. This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.
*)}val make :
?label:??? ->
?geometry:??? ->
?addressNumber:??? ->
?street:??? ->
?neighborhood:??? ->
?municipality:??? ->
?subRegion:??? ->
?region:??? ->
?country:??? ->
?postalCode:??? ->
?interpolated:??? ->
?timeZone:??? ->
?unitType:??? ->
?unitNumber:??? ->
?categories:??? ->
?supplementalCategories:??? ->
?subMunicipality:??? ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of SensitiveBoolean.t
| `List of [> `String of PlaceCategory.t ] list
| `String of SensitiveString.t
| `Structure of
(string
* [> `Integer of SensitiveInteger.t
| `List of [> `Double of Double.t ] list
| `String of SensitiveString.t ])
list ])
list ]