camel-ai 0.2.59__py3-none-any.whl → 0.2.82__py3-none-any.whl

camel/utils/message_summarizer.py

@@ -0,0 +1,148 @@
+# ========= Copyright 2023-2025 @ 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-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+from camel.agents import ChatAgent
+from camel.messages import BaseMessage
+from camel.models import BaseModelBackend, ModelFactory
+from camel.types import ModelPlatformType, ModelType
+
+
+class MessageSummary(BaseModel):
+    r"""Schema for structured message summaries.
+
+    Attributes:
+        summary (str): A brief, one-sentence summary of the conversation.
+        participants (List[str]): The roles of participants involved.
+        key_topics_and_entities (List[str]): Important topics, concepts, and
+            entities discussed.
+        decisions_and_outcomes (List[str]): Key decisions, conclusions, or
+            outcomes reached.
+        action_items (List[str]): A list of specific tasks or actions to be
+            taken, with assignees if mentioned.
+        progress_on_main_task (str): A summary of progress made on the
+            primary task.
+    """
+
+    summary: str = Field(
+        description="A brief, one-sentence summary of the conversation."
+    )
+    participants: List[str] = Field(
+        description="The roles of participants involved."
+    )
+    key_topics_and_entities: List[str] = Field(
+        description="Important topics, concepts, and entities discussed."
+    )
+    decisions_and_outcomes: List[str] = Field(
+        description="Key decisions, conclusions, or outcomes reached."
+    )
+    action_items: List[str] = Field(
+        description=(
+            "A list of specific tasks or actions to be taken, with assignees "
+            "if mentioned."
+        )
+    )
+    progress_on_main_task: str = Field(
+        description="A summary of progress made on the primary task."
+    )
+
+
+class MessageSummarizer:
+    r"""Utility class for generating structured summaries of chat messages.
+
+    Args:
+        model_backend (Optional[BaseModelBackend], optional):
+            The model backend to use for summarization.
+            If not provided, a default model backend will be created.
+    """
+
+    def __init__(
+        self,
+        model_backend: Optional[BaseModelBackend] = None,
+    ):
+        if model_backend is None:
+            self.model_backend = ModelFactory.create(
+                model_platform=ModelPlatformType.DEFAULT,
+                model_type=ModelType.GPT_4O_MINI,
+            )
+        else:
+            self.model_backend = model_backend
+        self.agent = ChatAgent(
+            BaseMessage.make_assistant_message(
+                role_name="Message Summarizer",
+                content=(
+                    "You are an expert conversation summarizer. Your task is "
+                    "to analyze chat messages and create a structured summary "
+                    "in JSON format. The summary should capture:\n"
+                    "- summary: A brief, one-sentence summary of the "
+                    "conversation.\n"
+                    "- participants: The roles of participants involved.\n"
+                    "- key_topics_and_entities: Important topics, concepts, "
+                    "and entities discussed.\n"
+                    "- decisions_and_outcomes: Key decisions, conclusions, or "
+                    "outcomes reached.\n"
+                    "- action_items: A list of specific tasks or actions to "
+                    "be taken, with assignees if mentioned.\n"
+                    "- progress_on_main_task: A summary of progress made on "
+                    "the primary task.\n\n"
+                    "Your response must be a JSON object that strictly "
+                    "adheres to this structure. Be concise and accurate."
+                ),
+            ),
+            model=self.model_backend,
+        )
+
+    def summarize(self, messages: List[BaseMessage]) -> MessageSummary:
+        r"""Generate a structured summary of the provided messages.
+
+        Args:
+            messages (List[BaseMessage]): List of messages to summarize.
+
+        Returns:
+            MessageSummary: Structured summary of the conversation.
+
+        Raises:
+            ValueError: If the messages list is empty or if the model's
+            response cannot be parsed as valid JSON.
+        """
+        if not messages:
+            raise ValueError("Cannot summarize an empty list of messages.")
+
+        # Construct prompt from messages
+        message_text = "\n".join(
+            f"{msg.role_name}: {msg.content}" for msg in messages
+        )
+        prompt = (
+            "Please analyze the following chat messages and generate a "
+            "structured summary.\n\n"
+            f"MESSAGES:\n\"\"\"\n{message_text}\n\"\"\"\n\n"
+            "Your response must be a JSON object that strictly adheres to the "
+            "required format."
+        )
+
+        # Get structured summary from model with forced JSON response
+        response = self.agent.step(prompt, response_format=MessageSummary)
+
+        if response.msg is None or response.msg.parsed is None:
+            raise ValueError(
+                "Failed to get a structured summary from the model."
+            )
+
+        summary = response.msg.parsed
+        if not isinstance(summary, MessageSummary):
+            raise ValueError("The parsed response is not a MessageSummary.")
+
+        return summary

camel/utils/response_format.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from __future__ import annotations
 

camel/utils/token_counting.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from __future__ import annotations
 
@@ -133,7 +133,11 @@ class OpenAITokenCounter(BaseTokenCounter):
             self.tokens_per_message = 4
             # If there's a name, the role is omitted
             self.tokens_per_name = -1
-        elif ("gpt-3.5-turbo" in self.model) or ("gpt-4" in self.model):
+        elif (
+            ("gpt-3.5-turbo" in self.model)
+            or ("gpt-4" in self.model)
+            or ("gpt-5" in self.model)
+        ):
             self.tokens_per_message = 3
             self.tokens_per_name = 1
         elif (
@@ -191,24 +195,32 @@ class OpenAITokenCounter(BaseTokenCounter):
                             image_str: str = item["image_url"]["url"]
                             detail = item["image_url"]["detail"]
 
-                            image_prefix_format = "data:image/{};base64,"
-                            image_prefix: Optional[str] = None
-                            for image_type in list(OpenAIImageType):
-                                # Find the correct image format
-                                image_prefix = image_prefix_format.format(
-                                    image_type.value
+                            # Only count tokens for base64 encoded images
+                            # For URLs, we cannot reliably determine token count without fetching the image
+                            if image_str.startswith("data:image"):
+                                # Base64 encoded image
+                                image_prefix_format = "data:image/{};base64,"
+                                image_prefix: Optional[str] = None
+                                for image_type in list(OpenAIImageType):
+                                    # Find the correct image format
+                                    image_prefix = image_prefix_format.format(
+                                        image_type.value
+                                    )
+                                    if image_prefix in image_str:
+                                        break
+                                assert isinstance(image_prefix, str)
+                                encoded_image = image_str.split(image_prefix)[
+                                    1
+                                ]
+                                image_bytes = BytesIO(
+                                    base64.b64decode(encoded_image)
                                 )
-                                if image_prefix in image_str:
-                                    break
-                            assert isinstance(image_prefix, str)
-                            encoded_image = image_str.split(image_prefix)[1]
-                            image_bytes = BytesIO(
-                                base64.b64decode(encoded_image)
-                            )
-                            image = Image.open(image_bytes)
-                            num_tokens += self._count_tokens_from_image(
-                                image, OpenAIVisionDetailType(detail)
-                            )
+                                image = Image.open(image_bytes)
+                                num_tokens += self._count_tokens_from_image(
+                                    image, OpenAIVisionDetailType(detail)
+                                )
+                            # Note: For regular URLs, token count cannot be determined without fetching the image
+                            # The actual token usage will be reported by the API response
                 if key == "name":
                     num_tokens += self.tokens_per_name
 
@@ -280,15 +292,26 @@ class OpenAITokenCounter(BaseTokenCounter):
 
 class AnthropicTokenCounter(BaseTokenCounter):
     @dependencies_required('anthropic')
-    def __init__(self, model: str):
+    def __init__(
+        self,
+        model: str,
+        api_key: Optional[str] = None,
+        base_url: Optional[str] = None,
+    ):
         r"""Constructor for the token counter for Anthropic models.
 
         Args:
             model (str): The name of the Anthropic model being used.
+            api_key (Optional[str], optional): The API key for authenticating
+                with the Anthropic service. If not provided, it will use the
+                ANTHROPIC_API_KEY environment variable. (default: :obj:`None`)
+            base_url (Optional[str], optional): The URL of the Anthropic
+                service. If not provided, it will use the default Anthropic
+                URL. (default: :obj:`None`)
         """
         from anthropic import Anthropic
 
-        self.client = Anthropic()
+        self.client = Anthropic(api_key=api_key, base_url=base_url)
         self.model = model
 
     @dependencies_required('anthropic')

camel/utils/tool_result.py

@@ -0,0 +1,44 @@
+# ========= Copyright 2023-2025 @ 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-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+
+from typing import List, Optional
+
+
+class ToolResult:
+    r"""Special result type for tools that can return images along with text.
+
+    This class is used by ChatAgent to detect when a tool returns visual
+    content that should be included in the conversation context.
+    """
+
+    def __init__(self, text: str, images: Optional[List[str]] = None):
+        r"""Initialize a tool result.
+
+        Args:
+            text (str): The text description or result of the tool operation.
+            images (Optional[List[str]]): List of base64-encoded images to
+                include in the conversation context. Images should be encoded
+                as "data:image/{format};base64,{data}" format.
+        """
+        self.text = text
+        self.images = images or []
+
+    def __str__(self) -> str:
+        r"""Return the text representation of the result."""
+        return self.text
+
+    def __repr__(self) -> str:
+        r"""Return a detailed representation of the result."""
+        img_count = len(self.images) if self.images else 0
+        return f"ToolResult(text='{self.text}', images={img_count})"

camel/verifiers/__init__.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 from .base import BaseVerifier
 from .math_verifier import MathVerifier
 from .models import VerificationOutcome

camel/verifiers/base.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 import asyncio
 import time
 from abc import ABC, abstractmethod

camel/verifiers/math_verifier.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from typing import Optional
 

camel/verifiers/models.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 from datetime import datetime
 from enum import Enum
 from typing import Any, Dict, Optional

camel/verifiers/physics_verifier.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import asyncio
 import math

camel/verifiers/python_verifier.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2025 @ 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
@@ -10,7 +10,7 @@
 # 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. =========
+# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import ast
 import asyncio