Skip to content

SearchResponse

Source code in docs_src/capo_cloudsearch_domain/types/search_response.py 
14
15
16
17
18
19
20
21
22
class SearchResponse(TypedDict, closed=True):
    status: NotRequired["capo_cloudsearch_domain.types.search_status.SearchStatus"]
    """<p>The status information returned for the search request.</p>"""
    hits: NotRequired["capo_cloudsearch_domain.types.hits.Hits"]
    """<p>The documents that match the search criteria.</p>"""
    facets: NotRequired["capo_cloudsearch_domain.types.facets.Facets"]
    """<p>The requested facet information.</p>"""
    stats: NotRequired["capo_cloudsearch_domain.types.stats.Stats"]
    """<p>The requested field statistics information.</p>"""

facets instance-attribute 

facets: NotRequired[Facets]

The requested facet information.

hits instance-attribute 

hits: NotRequired[Hits]

The documents that match the search criteria.

stats instance-attribute 

stats: NotRequired[Stats]

The requested field statistics information.

status instance-attribute 

status: NotRequired[SearchStatus]

The status information returned for the search request.