SearchItemPaged Class

Constructor

SearchItemPaged(*args, **kwargs)

by_page	Get an iterator of pages of objects, instead of an iterator of objects.
get_answers	Return semantic answers. Only included if the semantic ranker is used and answers are requested in the search query via the query_answer parameter.
get_count	Return the count of results if include_total_count was set for the query.
get_coverage	Return the coverage percentage, if minimum_coverage was specificied for the query.
get_facets	Return any facet results if faceting was requested.
next

Get an iterator of pages of objects, instead of an iterator of objects.

by_page(continuation_token: str | None = None) -> Iterator[Iterator[ReturnType]]

Name	Description
continuation_token	str An opaque continuation token. This value can be retrieved from the continuation_token field of a previous generator object. If specified, this generator will begin returning results from this point. Default value: None

Type	Description
<xref:iterator>[<xref:iterator>[<xref:ReturnType>]]	An iterator of pages (themselves iterator of objects)

Return semantic answers. Only included if the semantic ranker is used and answers are requested in the search query via the query_answer parameter.

get_answers() -> List[QueryAnswerResult] | None

Type	Description
list[QueryAnswerResult], None	answers

Return the count of results if include_total_count was set for the query.

get_count() -> int

Type	Description
int	count of results

Return the coverage percentage, if minimum_coverage was specificied for the query.

get_coverage() -> float

Type	Description
float	coverage percentage

Return any facet results if faceting was requested.

get_facets() -> Dict | None

Type	Description
dict, None	facet results

next() -> ReturnType