SearchForTextResult
Contains a search result from a text search query that is run on a place index resource.
Contents
- Place
-
Details about the search result, such as its address and position.
Type: Place object
Required: Yes
- Distance
-
The distance in meters of a great-circle arc between the bias position specified and the result.
Distancewill be returned only if a bias position was specified in the query.Note
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
Type: Double
Valid Range: Minimum value of 0.
Required: No
- PlaceId
-
The unique identifier of the place. You can use this with the
GetPlaceoperation to find the place again later.Note
For
SearchPlaceIndexForTextoperations, thePlaceIdis returned only by place indexes that use HERE or Grab as a data provider.Type: String
Required: No
- Relevance
-
The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.
Returned only when the partner selected is Esri or Grab.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
