🐫 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-bot40466fc7ac19
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.jsonindex 062dc5fdb..f4dcbb2c0 100644--- a/docs/mintlify/docs.json+++ b/docs/mintlify/docs.json@@ -426,6 +426,7 @@"reference/camel.retrievers.bm25_retriever","reference/camel.retrievers.cohere_rerank_retriever","reference/camel.retrievers.hybrid_retrival",+ "reference/camel.retrievers.jina_rerank_retriever","reference/camel.retrievers.vector_retriever"]},diff --git a/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdx b/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdxnew file mode 100644index 000000000..fde437bec--- /dev/null+++ b/docs/mintlify/reference/camel.retrievers.jina_rerank_retriever.mdx@@ -0,0 +1,70 @@+<a id="camel.retrievers.jina_rerank_retriever"></a>++<a id="camel.retrievers.jina_rerank_retriever.JinaRerankRetriever"></a>++## JinaRerankRetriever++```python+class JinaRerankRetriever(BaseRetriever):+```++An implementation of the `BaseRetriever` using the `Jina AI Reranker`+model.++This retriever uses Jina AI's reranking API to re-order retrieved documents+based on their relevance to the query. It supports multilingual retrieval+across 100+ languages.++**Parameters:**++- **model_name** (Union[JinaRerankerModelType, str]): The model name to use for re-ranking.+- **api_key** (str, optional): The API key for authenticating with the Jina AI service.+- **References**:+- **https**: //jina.ai/reranker/++<a id="camel.retrievers.jina_rerank_retriever.JinaRerankRetriever.__init__"></a>++### __init__++```python+def __init__(+ self,+ model_name: Union[JinaRerankerModelType, str] = JinaRerankerModelType.JINA_RERANKER_V2_BASE_MULTILINGUAL,+ api_key: str | None = None+):+```++Initializes an instance of the JinaRerankRetriever. This+constructor sets up the API key for interacting with the Jina AI+Reranker API.++**Parameters:**++- **model_name** (Union[JinaRerankerModelType, str]): The name of the model to be used for re-ranking. Can be a JinaRerankerModelType enum value or a string. Defaults to `JinaRerankerModelType.JINA_RERANKER_V2_BASE_MULTILINGUAL`.+- **api_key** (Optional[str]): The API key for authenticating requests to the Jina AI API. If not provided, the method will attempt to retrieve the key from the environment variable 'JINA_API_KEY'.++<a id="camel.retrievers.jina_rerank_retriever.JinaRerankRetriever.query"></a>++### query++```python+def query(+ self,+ query: str,+ retrieved_result: list[dict[str, Any]],+ top_k: int = DEFAULT_TOP_K_RESULTS+):+```++Queries and compiles results using the Jina AI re-ranking model.++**Parameters:**++- **query** (str): Query string for information retriever.+- **retrieved_result** (List[Dict[str, Any]]): The content to be re-ranked, should be the output from `BaseRetriever` like `VectorRetriever`. Each dict should have a 'text' key containing the document text.+- **top_k** (int, optional): The number of top results to return during retrieval. Must be a positive integer. Defaults to `DEFAULT_TOP_K_RESULTS`.++**Returns:**++ List[Dict[str, Any]]: Concatenated list of the query results,+each containing the original data plus a 'similarity score'.diff --git a/docs/mintlify/reference/camel.types.enums.mdx b/docs/mintlify/reference/camel.types.enums.mdxindex 46363931f..e23966c39 100644--- a/docs/mintlify/reference/camel.types.enums.mdx+++ b/docs/mintlify/reference/camel.types.enums.mdx@@ -937,3 +937,19 @@ def is_openai(self):```Returns whether this type of voice is an OpenAI-released voice.++<a id="camel.types.enums.JinaRerankerModelType"></a>++## JinaRerankerModelType++```python+class JinaRerankerModelType(str, Enum):+```++Model types for Jina AI Reranker.++These models are available through the Jina AI Reranker API for+re-ranking documents based on their relevance to a query.++For more information, please refer to:+https://jina.ai/reranker/