Returns an ordered list of documents based on their relevance to the query.
rerank(
self,
documents: Sequence[Union[str, Document, dict]],
query: str,
top_n: Optional[int] = None,
additional_model_request_fields: Optional[Dict[str, Any]] = None
) -> List[Dict[str, Any]]| 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 | Optional[int] | Default: NoneThe number of top-ranked results to return. Defaults to self.top_n. |
additional_model_request_fields | Optional[Dict[str, Any]] | Default: NoneAdditional fields to pass to the model. |