camel-ai 0.2.46__py3-none-any.whl → 0.2.47__py3-none-any.whl

camel/toolkits/browser_toolkit.py

@@ -301,9 +301,9 @@ def _add_set_of_mark(
 
     Returns:
         Tuple[Image.Image, List[str], List[str], List[str]]: A tuple
-        containing the screenshot with marked ROIs, ROIs fully within the
-        images, ROIs located above the visible area, and ROIs located below
-        the visible area.
+            containing the screenshot with marked ROIs, ROIs fully within the
+            images, ROIs located above the visible area, and ROIs located below
+            the visible area.
     """
     visible_rects: List[str] = list()
     rects_above: List[str] = list()  # Scroll up to see
@@ -1013,8 +1013,6 @@ class BrowserToolkit(BaseToolkit):
         self.browser = BaseBrowser(
             headless=headless, cache_dir=cache_dir, channel=channel
         )
-        # This needs to be called explicitly
-        self.browser.init()
 
         self.history_window = history_window
         self.web_agent_model = web_agent_model
@@ -1037,7 +1035,7 @@ class BrowserToolkit(BaseToolkit):
         if self.web_agent_model is None:
             web_agent_model = ModelFactory.create(
                 model_platform=ModelPlatformType.OPENAI,
-                model_type=ModelType.GPT_4O,
+                model_type=ModelType.GPT_4_1,
                 model_config_dict={"temperature": 0, "top_p": 1},
             )
         else:
@@ -1499,7 +1497,6 @@ Your output should be in json format, including the following fields:
         else:
             simulation_result = self._get_final_answer(task_prompt)
 
-        self.browser.close()
         return simulation_result
 
     def get_tools(self) -> List[FunctionTool]:

camel/toolkits/jina_reranker_toolkit.py

@@ -0,0 +1,231 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+from typing import List, Optional, Tuple
+
+from camel.toolkits import FunctionTool
+from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
+
+
+@MCPServer()
+class JinaRerankerToolkit(BaseToolkit):
+    r"""A class representing a toolkit for reranking documents
+    using Jina Reranker.
+
+    This class provides methods for reranking documents (text or images)
+    based on their relevance to a given query using the Jina Reranker model.
+    """
+
+    def __init__(
+        self,
+        timeout: Optional[float] = None,
+        device: Optional[str] = None,
+    ) -> None:
+        r"""Initializes a new instance of the JinaRerankerToolkit class.
+
+        Args:
+            timeout (Optional[float]): The timeout value for API requests
+                in seconds. If None, no timeout is applied.
+                (default: :obj:`None`)
+            device (Optional[str]): Device to load the model on. If None,
+                will use CUDA if available, otherwise CPU.
+                (default: :obj:`None`)
+        """
+        import torch
+        from transformers import AutoModel
+
+        super().__init__(timeout=timeout)
+
+        self.model = AutoModel.from_pretrained(
+            'jinaai/jina-reranker-m0',
+            torch_dtype="auto",
+            trust_remote_code=True,
+        )
+        DEVICE = (
+            device
+            if device is not None
+            else ("cuda" if torch.cuda.is_available() else "cpu")
+        )
+        self.model.to(DEVICE)
+        self.model.eval()
+
+    def _sort_documents(
+        self, documents: List[str], scores: List[float]
+    ) -> List[Tuple[str, float]]:
+        r"""Sort documents by their scores in descending order.
+
+        Args:
+            documents (List[str]): List of documents to sort.
+            scores (List[float]): Corresponding scores for each document.
+
+        Returns:
+            List[Tuple[str, float]]: Sorted list of (document, score) pairs.
+
+        Raises:
+            ValueError: If documents and scores have different lengths.
+        """
+        if len(documents) != len(scores):
+            raise ValueError("Number of documents must match number of scores")
+        doc_score_pairs = list(zip(documents, scores))
+        doc_score_pairs.sort(key=lambda x: x[1], reverse=True)
+
+        return doc_score_pairs
+
+    def rerank_text_documents(
+        self,
+        query: str,
+        documents: List[str],
+        max_length: int = 1024,
+    ) -> List[Tuple[str, float]]:
+        r"""Reranks text documents based on their relevance to a text query.
+
+        Args:
+            query (str): The text query for reranking.
+            documents (List[str]): List of text documents to be reranked.
+            max_length (int): Maximum token length for processing.
+                (default: :obj:`1024`)
+
+        Returns:
+            List[Tuple[str, float]]: A list of tuples containing
+                the reranked documents and their relevance scores.
+        """
+        import torch
+
+        if self.model is None:
+            raise ValueError(
+                "Model has not been initialized or failed to initialize."
+            )
+
+        with torch.inference_mode():
+            text_pairs = [[query, doc] for doc in documents]
+            scores = self.model.compute_score(
+                text_pairs, max_length=max_length, doc_type="text"
+            )
+
+        return self._sort_documents(documents, scores)
+
+    def rerank_image_documents(
+        self,
+        query: str,
+        documents: List[str],
+        max_length: int = 2048,
+    ) -> List[Tuple[str, float]]:
+        r"""Reranks image documents based on their relevance to a text query.
+
+        Args:
+            query (str): The text query for reranking.
+            documents (List[str]): List of image URLs or paths to be reranked.
+            max_length (int): Maximum token length for processing.
+                (default: :obj:`2048`)
+
+        Returns:
+            List[Tuple[str, float]]: A list of tuples containing
+                the reranked image URLs/paths and their relevance scores.
+        """
+        import torch
+
+        if self.model is None:
+            raise ValueError(
+                "Model has not been initialized or failed to initialize."
+            )
+
+        with torch.inference_mode():
+            image_pairs = [[query, doc] for doc in documents]
+            scores = self.model.compute_score(
+                image_pairs, max_length=max_length, doc_type="image"
+            )
+
+        return self._sort_documents(documents, scores)
+
+    def image_query_text_documents(
+        self,
+        image_query: str,
+        documents: List[str],
+        max_length: int = 2048,
+    ) -> List[Tuple[str, float]]:
+        r"""Reranks text documents based on their relevance to an image query.
+
+        Args:
+            image_query (str): The image URL or path used as query.
+            documents (List[str]): List of text documents to be reranked.
+            max_length (int): Maximum token length for processing.
+                (default: :obj:`2048`)
+
+        Returns:
+            List[Tuple[str, float]]: A list of tuples containing
+                the reranked documents and their relevance scores.
+        """
+        import torch
+
+        if self.model is None:
+            raise ValueError("Model has not been initialized.")
+        with torch.inference_mode():
+            image_pairs = [[image_query, doc] for doc in documents]
+            scores = self.model.compute_score(
+                image_pairs,
+                max_length=max_length,
+                query_type="image",
+                doc_type="text",
+            )
+
+        return self._sort_documents(documents, scores)
+
+    def image_query_image_documents(
+        self,
+        image_query: str,
+        documents: List[str],
+        max_length: int = 2048,
+    ) -> List[Tuple[str, float]]:
+        r"""Reranks image documents based on their relevance to an image query.
+
+        Args:
+            image_query (str): The image URL or path used as query.
+            documents (List[str]): List of image URLs or paths to be reranked.
+            max_length (int): Maximum token length for processing.
+                (default: :obj:`2048`)
+
+        Returns:
+            List[Tuple[str, float]]: A list of tuples containing
+                the reranked image URLs/paths and their relevance scores.
+        """
+        import torch
+
+        if self.model is None:
+            raise ValueError("Model has not been initialized.")
+
+        with torch.inference_mode():
+            image_pairs = [[image_query, doc] for doc in documents]
+            scores = self.model.compute_score(
+                image_pairs,
+                max_length=max_length,
+                query_type="image",
+                doc_type="image",
+            )
+
+        return self._sort_documents(documents, scores)
+
+    def get_tools(self) -> List[FunctionTool]:
+        r"""Returns a list of FunctionTool objects representing the
+        functions in the toolkit.
+
+        Returns:
+            List[FunctionTool]: A list of FunctionTool objects
+                representing the functions in the toolkit.
+        """
+        return [
+            FunctionTool(self.rerank_text_documents),
+            FunctionTool(self.rerank_image_documents),
+            FunctionTool(self.image_query_text_documents),
+            FunctionTool(self.image_query_image_documents),
+        ]

camel/toolkits/search_toolkit.py

@@ -1064,6 +1064,172 @@ class SearchToolkit(BaseToolkit):
         except Exception as e:
             return {"error": f"Exa search failed: {e!s}"}
 
+    @api_keys_required([(None, 'TONGXIAO_API_KEY')])
+    def search_alibaba_tongxiao(
+        self,
+        query: str,
+        time_range: Literal[
+            "OneDay", "OneWeek", "OneMonth", "OneYear", "NoLimit"
+        ] = "NoLimit",
+        industry: Optional[
+            Literal[
+                "finance",
+                "law",
+                "medical",
+                "internet",
+                "tax",
+                "news_province",
+                "news_center",
+            ]
+        ] = None,
+        page: int = 1,
+        return_main_text: bool = False,
+        return_markdown_text: bool = True,
+        enable_rerank: bool = True,
+    ) -> Dict[str, Any]:
+        r"""Query the Alibaba Tongxiao search API and return search results.
+
+        A powerful search API optimized for Chinese language queries with
+        features:
+        - Enhanced Chinese language understanding
+        - Industry-specific filtering (finance, law, medical, etc.)
+        - Structured data with markdown formatting
+        - Result reranking for relevance
+        - Time-based filtering
+
+        Args:
+            query (str): The search query string (length >= 1 and <= 100).
+            time_range (Literal["OneDay", "OneWeek", "OneMonth", "OneYear",
+                "NoLimit"]): Time frame filter for search results.
+                (default: :obj:`"NoLimit"`)
+            industry (Optional[Literal["finance", "law", "medical",
+                "internet", "tax", "news_province", "news_center"]]):
+                Industry-specific search filter. When specified, only returns
+                results from sites in the specified industries. Multiple
+                industries can be comma-separated.
+                (default: :obj:`None`)
+            page (int): Page number for results pagination.
+                (default: :obj:`1`)
+            return_main_text (bool): Whether to include the main text of the
+                webpage in results. (default: :obj:`True`)
+            return_markdown_text (bool): Whether to include markdown formatted
+                content in results. (default: :obj:`True`)
+            enable_rerank (bool): Whether to enable result reranking. If
+                response time is critical, setting this to False can reduce
+                response time by approximately 140ms. (default: :obj:`True`)
+
+        Returns:
+            Dict[str, Any]: A dictionary containing either search results with
+                'requestId' and 'results' keys, or an 'error' key with error
+                message. Each result contains title, snippet, url and other
+                metadata.
+        """
+        TONGXIAO_API_KEY = os.getenv("TONGXIAO_API_KEY")
+
+        # Validate query length
+        if not query or len(query) > 100:
+            return {
+                "error": "Query length must be between 1 and 100 characters"
+            }
+
+        # API endpoint and parameters
+        base_url = "https://cloud-iqs.aliyuncs.com/search/genericSearch"
+        headers = {
+            "X-API-Key": TONGXIAO_API_KEY,
+        }
+
+        # Convert boolean parameters to string for compatibility with requests
+        params: Dict[str, Union[str, int]] = {
+            "query": query,
+            "timeRange": time_range,
+            "page": page,
+            "returnMainText": str(return_main_text).lower(),
+            "returnMarkdownText": str(return_markdown_text).lower(),
+            "enableRerank": str(enable_rerank).lower(),
+        }
+
+        # Only add industry parameter if specified
+        if industry is not None:
+            params["industry"] = industry
+
+        try:
+            # Send GET request with proper typing for params
+            response = requests.get(
+                base_url, headers=headers, params=params, timeout=10
+            )
+
+            # Check response status
+            if response.status_code != 200:
+                return {
+                    "error": (
+                        f"Alibaba Tongxiao API request failed with status "
+                        f"code {response.status_code}: {response.text}"
+                    )
+                }
+
+            # Parse JSON response
+            data = response.json()
+
+            # Extract and format pageItems
+            page_items = data.get("pageItems", [])
+            results = []
+            for idx, item in enumerate(page_items):
+                # Create a simplified result structure
+                result = {
+                    "result_id": idx + 1,
+                    "title": item.get("title", ""),
+                    "snippet": item.get("snippet", ""),
+                    "url": item.get("link", ""),
+                    "hostname": item.get("hostname", ""),
+                }
+
+                # Only include additional fields if they exist and are
+                # requested
+                if "summary" in item and item.get("summary"):
+                    result["summary"] = item["summary"]
+                elif (
+                    return_main_text
+                    and "mainText" in item
+                    and item.get("mainText")
+                ):
+                    result["summary"] = item["mainText"]
+
+                if (
+                    return_main_text
+                    and "mainText" in item
+                    and item.get("mainText")
+                ):
+                    result["main_text"] = item["mainText"]
+
+                if (
+                    return_markdown_text
+                    and "markdownText" in item
+                    and item.get("markdownText")
+                ):
+                    result["markdown_text"] = item["markdownText"]
+
+                if "score" in item:
+                    result["score"] = item["score"]
+
+                if "publishTime" in item:
+                    result["publish_time"] = item["publishTime"]
+
+                results.append(result)
+
+            # Return a simplified structure
+            return {
+                "request_id": data.get("requestId", ""),
+                "results": results,
+            }
+
+        except requests.exceptions.RequestException as e:
+            return {"error": f"Alibaba Tongxiao search request failed: {e!s}"}
+        except Exception as e:
+            return {
+                "error": f"Unexpected error during Alibaba Tongxiao "
+                f"search: {e!s}"
+            }
+
     def get_tools(self) -> List[FunctionTool]:
         r"""Returns a list of FunctionTool objects representing the
         functions in the toolkit.
@@ -1084,4 +1250,5 @@ class SearchToolkit(BaseToolkit):
             FunctionTool(self.search_baidu),
             FunctionTool(self.search_bing),
             FunctionTool(self.search_exa),
+            FunctionTool(self.search_alibaba_tongxiao),
         ]

camel/types/enums.py

@@ -42,6 +42,8 @@ class ModelType(UnifiedModelType, Enum):
     GPT_4_1 = "gpt-4.1-2025-04-14"
     GPT_4_1_MINI = "gpt-4.1-mini-2025-04-14"
     GPT_4_1_NANO = "gpt-4.1-nano-2025-04-14"
+    O4_MINI = "o4-mini"
+    O3 = "o3"
 
     AWS_CLAUDE_3_7_SONNET = "anthropic.claude-3-7-sonnet-20250219-v1:0"
     AWS_CLAUDE_3_5_SONNET = "anthropic.claude-3-5-sonnet-20241022-v2:0"
@@ -351,6 +353,8 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GPT_4_1,
             ModelType.GPT_4_1_MINI,
             ModelType.GPT_4_1_NANO,
+            ModelType.O4_MINI,
+            ModelType.O3,
         }
 
     @property
@@ -893,6 +897,8 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.AWS_CLAUDE_3_HAIKU,
             ModelType.AWS_CLAUDE_3_SONNET,
             ModelType.AWS_CLAUDE_3_7_SONNET,
+            ModelType.O4_MINI,
+            ModelType.O3,
         }:
             return 200_000
         elif self in {

camel/utils/token_counting.py

@@ -136,7 +136,11 @@ class OpenAITokenCounter(BaseTokenCounter):
         elif ("gpt-3.5-turbo" in self.model) or ("gpt-4" in self.model):
             self.tokens_per_message = 3
             self.tokens_per_name = 1
-        elif ("o1" in self.model) or ("o3" in self.model):
+        elif (
+            ("o1" in self.model)
+            or ("o3" in self.model)
+            or ("o4" in self.model)
+        ):
             self.tokens_per_message = 2
             self.tokens_per_name = 1
         else:
@@ -144,8 +148,8 @@ class OpenAITokenCounter(BaseTokenCounter):
             raise NotImplementedError(
                 "Token counting for OpenAI Models is not presently "
                 f"implemented for model {model}. "
-                "See https://github.com/openai/openai-python/blob/main/chatml.md "
-                "for information on how messages are converted to tokens. "
+                "See https://github.com/openai/openai-python/blob/main/chatml"
+                ".md for information on how messages are converted to tokens. "
                 "See https://platform.openai.com/docs/models/gpt-4"
                 "or https://platform.openai.com/docs/models/gpt-3-5"
                 "for information about openai chat models."

{camel_ai-0.2.46.dist-info → camel_ai-0.2.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: camel-ai
-Version: 0.2.46
+Version: 0.2.47
 Summary: Communicative Agents for AI Society Study
 Project-URL: Homepage, https://www.camel-ai.org/
 Project-URL: Repository, https://github.com/camel-ai/camel
@@ -89,6 +89,7 @@ Requires-Dist: pydub<0.26,>=0.25.1; extra == 'all'
 Requires-Dist: pygithub<3,>=2.6.0; extra == 'all'
 Requires-Dist: pymilvus<3,>=2.4.0; extra == 'all'
 Requires-Dist: pymupdf<2,>=1.22.5; extra == 'all'
+Requires-Dist: pyobvector>=0.1.18; extra == 'all'
 Requires-Dist: pyowm<4,>=3.3.0; extra == 'all'
 Requires-Dist: pytelegrambotapi<5,>=4.18.0; extra == 'all'
 Requires-Dist: pytest-asyncio<0.24,>=0.23.0; extra == 'all'
@@ -103,6 +104,7 @@ Requires-Dist: requests-oauthlib<2,>=1.3.1; extra == 'all'
 Requires-Dist: rouge<2,>=1.0.1; extra == 'all'
 Requires-Dist: scenedetect>=0.6.5.2; extra == 'all'
 Requires-Dist: scholarly[tor]==1.7.11; extra == 'all'
+Requires-Dist: scrapegraph-py<2,>=1.12.0; extra == 'all'
 Requires-Dist: sentence-transformers<4,>=3.0.1; extra == 'all'
 Requires-Dist: sentencepiece<0.3,>=0.2; extra == 'all'
 Requires-Dist: slack-bolt<2,>=1.20.1; extra == 'all'
@@ -253,6 +255,7 @@ Requires-Dist: python-dotenv<2,>=1.0.0; extra == 'owl'
 Requires-Dist: requests-oauthlib<2,>=1.3.1; extra == 'owl'
 Requires-Dist: rouge<2,>=1.0.1; extra == 'owl'
 Requires-Dist: scenedetect>=0.6.5.2; extra == 'owl'
+Requires-Dist: scrapegraph-py<2,>=1.12.0; extra == 'owl'
 Requires-Dist: sentencepiece<0.3,>=0.2; extra == 'owl'
 Requires-Dist: soundfile<0.14,>=0.13; extra == 'owl'
 Requires-Dist: tabulate>=0.9.0; extra == 'owl'
@@ -272,6 +275,7 @@ Requires-Dist: neo4j<6,>=5.18.0; extra == 'rag'
 Requires-Dist: numpy~=1.26; extra == 'rag'
 Requires-Dist: pandasai<3,>=2.3.0; extra == 'rag'
 Requires-Dist: pymilvus<3,>=2.4.0; extra == 'rag'
+Requires-Dist: pyobvector>=0.1.18; extra == 'rag'
 Requires-Dist: pytidb-experimental==0.0.1.dev4; extra == 'rag'
 Requires-Dist: qdrant-client<2,>=1.9.0; extra == 'rag'
 Requires-Dist: rank-bm25<0.3,>=0.2.2; extra == 'rag'
@@ -289,6 +293,7 @@ Requires-Dist: mem0ai>=0.1.73; extra == 'storage'
 Requires-Dist: nebula3-python==3.8.2; extra == 'storage'
 Requires-Dist: neo4j<6,>=5.18.0; extra == 'storage'
 Requires-Dist: pymilvus<3,>=2.4.0; extra == 'storage'
+Requires-Dist: pyobvector>=0.1.18; extra == 'storage'
 Requires-Dist: pytidb-experimental==0.0.1.dev4; extra == 'storage'
 Requires-Dist: qdrant-client<2,>=1.9.0; extra == 'storage'
 Requires-Dist: redis<6,>=5.0.6; extra == 'storage'
@@ -314,6 +319,7 @@ Requires-Dist: newspaper3k<0.3,>=0.2.8; extra == 'web-tools'
 Requires-Dist: playwright>=1.50.0; extra == 'web-tools'
 Requires-Dist: pyowm<4,>=3.3.0; extra == 'web-tools'
 Requires-Dist: requests-oauthlib<2,>=1.3.1; extra == 'web-tools'
+Requires-Dist: scrapegraph-py<2,>=1.12.0; extra == 'web-tools'
 Requires-Dist: sympy<2,>=1.13.3; extra == 'web-tools'
 Requires-Dist: tavily-python<0.6,>=0.5.0; extra == 'web-tools'
 Requires-Dist: wikipedia<2,>=1; extra == 'web-tools'
@@ -338,6 +344,9 @@ Description-Content-Type: text/markdown
 [![Hugging Face][huggingface-image]][huggingface-url]
 [![Star][star-image]][star-url]
 [![Package License][package-license-image]][package-license-url]
+[![PyPI Download][package-download-image]][package-download-url]
+
+<a href="https://trendshift.io/repositories/649" target="_blank"><img src="https://trendshift.io/api/badge/repositories/649" alt="camel-ai/camel | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
 
 </div>
 
@@ -782,6 +791,7 @@ The source code is licensed under Apache 2.0.
 [star-url]: https://github.com/camel-ai/camel/stargazers
 [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
 [package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE
+[package-download-image]: https://img.shields.io/pypi/dm/camel-ai
 
 [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
 [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
@@ -797,3 +807,4 @@ The source code is licensed under Apache 2.0.
 [reddit-url]: https://www.reddit.com/r/CamelAI/
 [reddit-image]: https://img.shields.io/reddit/subreddit-subscribers/CamelAI?style=plastic&logo=reddit&label=r%2FCAMEL&labelColor=white
 [ambassador-url]: https://www.camel-ai.org/community
+[package-download-url]: https://pypi.org/project/camel-ai