Skip to content

QueryRefinement

Source code in docs_src/capo_geo_places/types/query_refinement.py
class QueryRefinement(TypedDict, closed=True):
    refined_term: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The term that will be suggested to the user.</p>"""
    original_term: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The sub-string of the original query that is replaced by this query term.</p>"""
    start_index: "int"
    """<p>Start index of the parsed component.</p>"""
    end_index: "int"
    """<p>End index of the parsed query.</p>"""

end_index instance-attribute

end_index: int

End index of the parsed query.

original_term instance-attribute

original_term: SensitiveString

The sub-string of the original query that is replaced by this query term.

refined_term instance-attribute

refined_term: SensitiveString

The term that will be suggested to the user.

start_index instance-attribute

start_index: int

Start index of the parsed component.