Skip to content

SearchForTextResult

Source code in docs_src/capo_location/types/search_for_text_result.py 
15
16
17
18
19
20
21
22
23
class SearchForTextResult(TypedDict, closed=True):
    place: "capo_location.types.place.Place"
    """<p>Details about the search result, such as its address and position.</p>"""
    distance: NotRequired["capo_location.types.sensitive_double.SensitiveDouble"]
    """<p>The distance in meters of a great-circle arc between the bias position specified and the result. <code>Distance</code> will be returned only if a bias position was specified in the query.</p> <note> <p>A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.</p> </note>"""
    relevance: NotRequired["capo_location.types.sensitive_double.SensitiveDouble"]
    """<p>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.</p> <p>Returned only when the partner selected is Esri or Grab.</p>"""
    place_id: NotRequired["capo_location.types.place_id.PlaceId"]
    """<p>The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the place again later.</p> <note> <p>For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place indexes that use HERE or Grab as a data provider.</p> </note>"""

distance instance-attribute 

distance: NotRequired[SensitiveDouble]

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

place instance-attribute 

place: Place

Details about the search result, such as its address and position.

place_id instance-attribute 

place_id: NotRequired[PlaceId]

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

relevance instance-attribute 

relevance: NotRequired[SensitiveDouble]

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.