Skip to content

SuggestResultItem

Source code in docs_src/capo_geo_places/types/suggest_result_item.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class SuggestResultItem(TypedDict, closed=True):
    title: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The display title that should be used when presenting this option to the end user.</p>"""
    suggest_result_item_type: (
        "capo_geo_places.types.suggest_result_item_type.SuggestResultItemType"
    )
    """<p>The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.</p>"""
    place: NotRequired["capo_geo_places.types.suggest_place_result.SuggestPlaceResult"]
    """<p>The suggested place by its unique ID.</p>"""
    query: NotRequired["capo_geo_places.types.suggest_query_result.SuggestQueryResult"]
    highlights: NotRequired[
        "capo_geo_places.types.suggest_highlights.SuggestHighlights"
    ]
    """<p>Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms. </p>"""

highlights instance-attribute 

highlights: NotRequired[SuggestHighlights]

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

place instance-attribute 

place: NotRequired[SuggestPlaceResult]

The suggested place by its unique ID.

query instance-attribute 

query: NotRequired[SuggestQueryResult]

suggest_result_item_type instance-attribute 

suggest_result_item_type: SuggestResultItemType

The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

title instance-attribute 

title: SensitiveString

The display title that should be used when presenting this option to the end user.