Skip to content

SuggestionMatch

Source code in docs_src/capo_cloudsearch_domain/types/suggestion_match.py
class SuggestionMatch(TypedDict, closed=True):
    suggestion: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>The string that matches the query string specified in the <code>SuggestRequest</code>. </p>"""
    score: "capo_cloudsearch_domain.types.long.Long"
    """<p>The relevance score of a suggested match.</p>"""
    id: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>The document ID of the suggested document.</p>"""

id instance-attribute

id: NotRequired[String]

The document ID of the suggested document.

score instance-attribute

score: Long

The relevance score of a suggested match.

suggestion instance-attribute

suggestion: NotRequired[String]

The string that matches the query string specified in the SuggestRequest.