Skip to content

SearchResponse

Source code in docs_src/capo_sagemaker/types/search_response.py
class SearchResponse(TypedDict, closed=True):
    results: NotRequired["capo_sagemaker.types.search_results_list.SearchResultsList"]
    """<p>A list of <code>SearchRecord</code> objects.</p>"""
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>If the result of the previous <code>Search</code> request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.</p>"""
    total_hits: NotRequired["capo_sagemaker.types.total_hits.TotalHits"]
    """<p>The total number of matching results.</p>"""

next_token instance-attribute

next_token: NotRequired[NextToken]

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

results instance-attribute

results: NotRequired[SearchResultsList]

A list of SearchRecord objects.

total_hits instance-attribute

total_hits: NotRequired[TotalHits]

The total number of matching results.