Skip to content

AutocompleteResultItem

Source code in docs_src/capo_geo_places/types/autocomplete_result_item.py
class AutocompleteResultItem(TypedDict, closed=True):
    place_id: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.</p>"""
    place_type: "capo_geo_places.types.place_type.PlaceType"
    """<p>PlaceType describes the type of result entry returned.</p>"""
    title: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>A formatted string for display when presenting this result to an end user.</p>"""
    address: NotRequired["capo_geo_places.types.address.Address"]
    """<p>The address associated with this result.</p>"""
    distance: "capo_geo_places.types.distance_meters.DistanceMeters"
    """<p>The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.</p>"""
    language: NotRequired["capo_geo_places.types.language_tag.LanguageTag"]
    """<p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.</p>"""
    political_view: NotRequired["capo_geo_places.types.country_code3.CountryCode3"]
    """<p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.</p>"""
    highlights: NotRequired[
        "capo_geo_places.types.autocomplete_highlights.AutocompleteHighlights"
    ]
    """<p>Indicates the starting and ending index of the place in the text query that match the found title. </p>"""
    estimated_point_address: NotRequired[
        "capo_geo_places.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>If <code>true</code>, indicates that the coordinates of the position and access points of the point address are estimated.</p>"""

address instance-attribute

address: NotRequired[Address]

The address associated with this result.

distance instance-attribute

distance: DistanceMeters

The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.

estimated_point_address instance-attribute

estimated_point_address: NotRequired[SensitiveBoolean]

If true, indicates that the coordinates of the position and access points of the point address are estimated.

highlights instance-attribute

highlights: NotRequired[AutocompleteHighlights]

Indicates the starting and ending index of the place in the text query that match the found title.

language instance-attribute

language: NotRequired[LanguageTag]

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

place_id instance-attribute

place_id: SensitiveString

The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.

place_type instance-attribute

place_type: PlaceType

PlaceType describes the type of result entry returned.

political_view instance-attribute

political_view: NotRequired[CountryCode3]

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

title instance-attribute

A formatted string for display when presenting this result to an end user.