Skip to content

SuggestModel

Source code in docs_src/capo_cloudsearch_domain/types/suggest_model.py
class SuggestModel(TypedDict, closed=True):
    query: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>The query string specified in the suggest request.</p>"""
    found: "capo_cloudsearch_domain.types.long.Long"
    """<p>The number of documents that were found to match the query string.</p>"""
    suggestions: NotRequired["capo_cloudsearch_domain.types.suggestions.Suggestions"]
    """<p>The documents that match the query string.</p>"""

found instance-attribute

found: Long

The number of documents that were found to match the query string.

query instance-attribute

query: NotRequired[String]

The query string specified in the suggest request.

suggestions instance-attribute

suggestions: NotRequired[Suggestions]

The documents that match the query string.