AsyncSearchItemPaged Class

Constructor

AsyncSearchItemPaged(*args, **kwargs)

by_page	Get an async iterator of pages of objects, instead of an async 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.

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

by_page(continuation_token: str | None = None) -> AsyncIterator[AsyncIterator[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
AsyncIterator[AsyncIterator[<xref:ReturnType>]]	An async iterator of pages (themselves async 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.

async get_answers() -> List[QueryAnswerResult] | None

Type	Description
list[<xref:azure.search.documents.QueryAnswerResult>]	Answers.

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

async get_count() -> int

Type	Description
int	Count of results.

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

async get_coverage() -> float

Type	Description
float	Coverage percentage.

Return any facet results if faceting was requested.

async get_facets() -> Dict | None

Type	Description
dict	Facet results.

Was this page helpful?