Skip to content

Hits

Source code in docs_src/capo_cloudsearch_domain/types/hits.py 
13
14
15
16
17
18
19
20
21
class Hits(TypedDict, closed=True):
    found: "capo_cloudsearch_domain.types.long.Long"
    """<p>The total number of documents that match the search request.</p>"""
    start: "capo_cloudsearch_domain.types.long.Long"
    """<p>The index of the first matching document.</p>"""
    cursor: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.</p>"""
    hit: NotRequired["capo_cloudsearch_domain.types.hit_list.HitList"]
    """<p>A document that matches the search request.</p>"""

cursor instance-attribute 

cursor: NotRequired[String]

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

found instance-attribute 

found: Long

The total number of documents that match the search request.

hit instance-attribute 

hit: NotRequired[HitList]

A document that matches the search request.

start instance-attribute 

start: Long

The index of the first matching document.