🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
Auto-update documentation after merge [skip ci]
camel-docs-botd265e786cce0
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.jsonindex b83dd267b..5f1812f64 100644--- a/docs/mintlify/docs.json+++ b/docs/mintlify/docs.json@@ -429,6 +429,7 @@"pages": ["reference/camel.retrievers.auto_retriever","reference/camel.retrievers.base",+ "reference/camel.retrievers.base_rerank","reference/camel.retrievers.bm25_retriever","reference/camel.retrievers.cohere_rerank_retriever","reference/camel.retrievers.hybrid_retrival",diff --git a/docs/mintlify/reference/camel.retrievers.base_rerank.mdx b/docs/mintlify/reference/camel.retrievers.base_rerank.mdxnew file mode 100644index 000000000..e203001a8--- /dev/null+++ b/docs/mintlify/reference/camel.retrievers.base_rerank.mdx@@ -0,0 +1,46 @@+<a id="camel.retrievers.base_rerank"></a>++<a id="camel.retrievers.base_rerank.BaseRerankRetriever"></a>++## BaseRerankRetriever++```python+class BaseRerankRetriever(BaseRetriever):+```++Abstract base class for re-ranking retrievers.++A re-ranking retriever takes a query together with a list of already+retrieved results (for example, the output of a :class:`VectorRetriever`,+a :class:`BM25Retriever`, or a :class:`HybridRetriever`) and re-orders+those results by their semantic relevance to the query, typically using a+cross-encoder or a dedicated re-ranking API.++Unlike first-stage retrievers, re-rankers do not ingest content, so the+:meth:`process` method is not required and is left unimplemented.++<a id="camel.retrievers.base_rerank.BaseRerankRetriever.query"></a>++### query++```python+def query(+ self,+ query: str,+ retrieved_result: List[Dict[str, Any]],+ top_k: int = DEFAULT_TOP_K_RESULTS+):+```++Re-ranks the given retrieved results against the query.++**Parameters:**++- **query** (str): The query string used for re-ranking.+- **retrieved_result** (List[Dict[str, Any]]): The content to be re-ranked, typically the output of a first-stage retriever. Each item should contain a `__INLINE_CODE_0__` entry.+- **top_k** (int, optional): The number of top results to return after re-ranking. Must be a positive integer. (default: :obj:`DEFAULT_TOP_K_RESULTS`)++**Returns:**++ List[Dict[str, Any]]: The re-ranked results, each containing the+original data plus an updated `__INLINE_CODE_0__`.diff --git a/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx b/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdxindex 692844e38..20d6826f6 100644--- a/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx+++ b/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx@@ -5,7 +5,7 @@## CohereRerankRetriever```python-class CohereRerankRetriever(BaseRetriever):+class CohereRerankRetriever(BaseRerankRetriever):```An implementation of the `BaseRetriever` using the `Cohere Re-ranking`diff --git a/docs/mintlify/reference/camel.retrievers.hybrid_retrival.mdx b/docs/mintlify/reference/camel.retrievers.hybrid_retrival.mdxindex 2312175a8..225591b2d 100644--- a/docs/mintlify/reference/camel.retrievers.hybrid_retrival.mdx+++ b/docs/mintlify/reference/camel.retrievers.hybrid_retrival.mdx@@ -92,7 +92,9 @@ def query(vector_retriever_top_k: int = 50,vector_retriever_similarity_threshold: float = 0.5,bm25_retriever_top_k: int = 50,- return_detailed_info: bool = False+ return_detailed_info: bool = False,+ reranker: Optional[BaseRerankRetriever] = None,+ rerank_input_top_k: int = 50):```@@ -110,6 +112,8 @@ retrievers.- **vector_retriever_similarity_threshold** (float): Similarity threshold for vector retriever.- **bm25_retriever_top_k** (int): Top results from BM25 retriever.- **return_detailed_info** (bool): Return detailed info if True.+- **reranker** (Optional[BaseRerankRetriever]): An optional re-ranking retriever (e.g. :class:`CohereRerankRetriever` or :class:`JinaRerankRetriever`). When provided, the fused results are re-ordered by the reranker before being truncated to `__INLINE_CODE_2____INLINE_CODE_3__None`)+- **rerank_input_top_k** (int): The number of top fused candidates fed into the reranker. Only used when `__INLINE_CODE_0____INLINE_CODE_1__50`)**Returns:**diff --git a/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdx b/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdxindex fde437bec..779ac60a2 100644--- a/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdx+++ b/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdx@@ -5,7 +5,7 @@## JinaRerankRetriever```python-class JinaRerankRetriever(BaseRetriever):+class JinaRerankRetriever(BaseRerankRetriever):```An implementation of the `BaseRetriever` using the `Jina AI Reranker`