Skip to content

TotalHits

Source code in docs_src/capo_sagemaker/types/total_hits.py 
12
13
14
15
16
class TotalHits(TypedDict, closed=True):
    value: NotRequired["capo_sagemaker.types.long.Long"]
    """<p>The total number of matching results. This value may be exact or an estimate, depending on the <code>Relation</code> field.</p>"""
    relation: NotRequired["capo_sagemaker.types.relation.Relation"]
    """<p>Indicates the relationship between the returned <code>Value</code> and the actual total number of matching results. Possible values are:</p> <ul> <li> <p> <code>EqualTo</code>: The <code>Value</code> is the exact count of matching results.</p> </li> <li> <p> <code>GreaterThanOrEqualTo</code>: The <code>Value</code> is a lower bound of the actual count of matching results.</p> </li> </ul>"""

relation instance-attribute 

relation: NotRequired[Relation]

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

  • EqualTo: The Value is the exact count of matching results.

  • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

value instance-attribute 

value: NotRequired[Long]

The total number of matching results. This value may be exact or an estimate, depending on the Relation field.