Method●Since v0.3

rerank

Returns an ordered list of documents ordered by their relevance to the provided query.

rerank(
  self,
  documents: Sequence[Union[str, Document, dict]],
  query: str,
  *,
  top_n: Optional[int] = 1
) -> List[Dict[str, Any]]

Parameters

Name	Type	Description
`query`*	`str`	The query to use for reranking.
`documents`*	`Sequence[Union[str, Document, dict]]`	A sequence of documents to rerank.
`top_n` *	`unknown`	The number of results to return. If None returns all results. Defaults to self.top_n.