Skip to content

SuggestionTextWithHighlights

Source code in docs_src/capo_kendra/types/suggestion_text_with_highlights.py
class SuggestionTextWithHighlights(TypedDict, closed=True):
    text: NotRequired["capo_kendra.types.string.String"]
    """<p>The query suggestion text to display to the user.</p>"""
    highlights: NotRequired[
        "capo_kendra.types.suggestion_highlight_list.SuggestionHighlightList"
    ]
    """<p>The beginning and end of the query suggestion text that should be highlighted.</p>"""

highlights instance-attribute

highlights: NotRequired[SuggestionHighlightList]

The beginning and end of the query suggestion text that should be highlighted.

text instance-attribute

text: NotRequired[String]

The query suggestion text to display to the user.