Skip to content

SuggestQueryResult

Source code in docs_src/capo_geo_places/types/suggest_query_result.py 
12
13
14
15
16
class SuggestQueryResult(TypedDict, closed=True):
    query_id: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html">SearchText API docs</a>. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>"""
    query_type: NotRequired["capo_geo_places.types.query_type.QueryType"]
    """<p> The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""

query_id instance-attribute 

query_id: NotRequired[SensitiveString]

QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

The fields QueryText, and QueryID are mutually exclusive.

query_type instance-attribute 

query_type: NotRequired[QueryType]

The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.