camel-ai 0.2.82__py3-none-any.whl → 0.2.83a6__py3-none-any.whl

camel/models/base_model.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2026 @ 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,12 +10,22 @@
 # 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. =========
+# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
 import abc
+import inspect
 import os
 import re
 from abc import ABC, abstractmethod
-from typing import Any, Dict, List, Optional, Type, Union
+from typing import (
+    Any,
+    AsyncGenerator,
+    Dict,
+    Generator,
+    List,
+    Optional,
+    Type,
+    Union,
+)
 
 from openai import AsyncStream, Stream
 from openai.lib.streaming.chat import (
@@ -33,7 +43,12 @@ from camel.types import (
     ParsedChatCompletion,
     UnifiedModelType,
 )
-from camel.utils import BaseTokenCounter, Constants
+from camel.utils import (
+    BaseTokenCounter,
+    Constants,
+    get_current_agent_session_id,
+    update_langfuse_trace,
+)
 
 if os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":
     try:
@@ -51,6 +66,132 @@ else:
     logger = camel_get_logger('base_model')
 
 
+class _StreamLogger:
+    r"""Base for stream logging wrappers."""
+
+    def __init__(self, log_path: Optional[str], log_enabled: bool):
+        self._log_path = log_path
+        self._log_enabled = log_enabled
+        self._id = self._model = self._content = ""
+        self._finish_reason: Optional[str] = None
+        self._usage: Optional[Dict[str, Any]] = None
+        self._logged = False
+
+    def _collect(self, chunk: ChatCompletionChunk) -> None:
+        self._id = self._id or getattr(chunk, 'id', '')
+        self._model = self._model or getattr(chunk, 'model', '')
+        if chunk.usage:
+            u = chunk.usage
+            self._usage = (
+                u.model_dump() if hasattr(u, 'model_dump') else u.dict()
+            )
+        if chunk.choices:
+            choice = chunk.choices[0]
+            if choice.delta and choice.delta.content:
+                self._content += choice.delta.content
+            if choice.finish_reason:
+                self._finish_reason = choice.finish_reason
+
+    def _log(self) -> None:
+        if self._logged or not self._log_enabled or not self._log_path:
+            return
+        self._logged = True
+        import json
+        from datetime import datetime
+
+        try:
+            with open(self._log_path, "r+") as f:
+                data = json.load(f)
+                data["response_timestamp"] = datetime.now().isoformat()
+                data["response"] = {
+                    "id": self._id,
+                    "model": self._model,
+                    "content": self._content,
+                    "finish_reason": self._finish_reason,
+                    "usage": self._usage,
+                    "streaming": True,
+                }
+                f.seek(0)
+                json.dump(data, f, indent=4)
+                f.truncate()
+        except Exception:
+            pass
+
+
+class _SyncStreamWrapper(_StreamLogger):
+    r"""Sync stream wrapper with logging."""
+
+    def __init__(
+        self,
+        stream: Union[
+            Stream[ChatCompletionChunk],
+            Generator[ChatCompletionChunk, None, None],
+        ],
+        log_path: Optional[str],
+        log_enabled: bool,
+    ):
+        super().__init__(log_path, log_enabled)
+        self._stream = stream
+
+    def __iter__(self):
+        return self
+
+    def __next__(self) -> ChatCompletionChunk:
+        try:
+            chunk = next(self._stream)
+            self._collect(chunk)
+            return chunk
+        except StopIteration:
+            self._log()
+            raise
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *_):
+        return False
+
+    def __del__(self):
+        self._log()
+
+
+class _AsyncStreamWrapper(_StreamLogger):
+    r"""Async stream wrapper with logging."""
+
+    def __init__(
+        self,
+        stream: Union[
+            AsyncStream[ChatCompletionChunk],
+            AsyncGenerator[ChatCompletionChunk, None],
+        ],
+        log_path: Optional[str],
+        log_enabled: bool,
+    ):
+        super().__init__(log_path, log_enabled)
+        self._stream = stream
+
+    def __aiter__(self):
+        return self
+
+    async def __anext__(self) -> ChatCompletionChunk:
+        try:
+            chunk = await self._stream.__anext__()
+            self._collect(chunk)
+            return chunk
+        except StopAsyncIteration:
+            self._log()
+            raise
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, *_):
+        return False
+
+    def __del__(self):
+        self._log()
+
+
 class ModelBackendMeta(abc.ABCMeta):
     r"""Metaclass that automatically preprocesses messages in run method.
 
@@ -274,14 +415,29 @@ class BaseModelBackend(ABC, metaclass=ModelBackendMeta):
         import json
         from datetime import datetime
 
-        os.makedirs(self._log_dir, exist_ok=True)
+        from camel.utils.agent_context import get_current_agent_id
+
+        agent_id = get_current_agent_id()
+
+        # Remove _context_summarizer suffix to keep all logs in one directory
+        log_agent_id = agent_id
+        if agent_id and agent_id.endswith("_context_summarizer"):
+            log_agent_id = agent_id[: -len("_context_summarizer")]
+
+        log_subdir = (
+            os.path.join(self._log_dir, log_agent_id)
+            if log_agent_id
+            else self._log_dir
+        )
+        os.makedirs(log_subdir, exist_ok=True)
 
         timestamp = datetime.now().strftime('%Y%m%d_%H%M%S_%f')
-        log_file_path = os.path.join(self._log_dir, f"conv_{timestamp}.json")
+        log_file_path = os.path.join(log_subdir, f"conv_{timestamp}.json")
 
         log_entry = {
             "request_timestamp": datetime.now().isoformat(),
             "model": str(self.model_type),
+            "agent_id": agent_id,
             "request": {"messages": messages},
         }
 
@@ -320,6 +476,25 @@ class BaseModelBackend(ABC, metaclass=ModelBackendMeta):
             json.dump(log_data, f, indent=4)
             f.truncate()
 
+    def _log_and_trace(self) -> None:
+        r"""Update Langfuse trace with session metadata.
+
+        This method updates the current Langfuse trace with agent session
+        information and model metadata. Called at the start of _run() and
+        _arun() methods before API execution.
+        """
+        agent_session_id = get_current_agent_session_id()
+        update_langfuse_trace(
+            session_id=agent_session_id,
+            metadata={
+                "source": "camel",
+                "agent_id": agent_session_id,
+                "agent_type": "camel_chat_agent",
+                "model_type": str(self.model_type),
+            },
+            tags=["CAMEL-AI", str(self.model_type)],
+        )
+
     @abstractmethod
     def _run(
         self,
@@ -428,10 +603,13 @@ class BaseModelBackend(ABC, metaclass=ModelBackendMeta):
         result = self._run(messages, response_format, tools)
         logger.info("Result: %s", result)
 
-        # Log the response if logging is enabled
+        # For streaming responses, wrap with logging; otherwise log immediately
+        if isinstance(result, Stream) or inspect.isgenerator(result):
+            return _SyncStreamWrapper(  # type: ignore[return-value]
+                result, log_path, self._log_enabled
+            )
         if log_path:
             self._log_response(log_path, result)
-
         return result
 
     @observe()
@@ -480,10 +658,13 @@ class BaseModelBackend(ABC, metaclass=ModelBackendMeta):
         result = await self._arun(messages, response_format, tools)
         logger.info("Result: %s", result)
 
-        # Log the response if logging is enabled
+        # For streaming responses, wrap with logging; otherwise log immediately
+        if isinstance(result, AsyncStream) or inspect.isasyncgen(result):
+            return _AsyncStreamWrapper(  # type: ignore[return-value]
+                result, log_path, self._log_enabled
+            )
         if log_path:
             self._log_response(log_path, result)
-
         return result
 
     def count_tokens_from_messages(self, messages: List[OpenAIMessage]) -> int:
@@ -536,10 +717,7 @@ class BaseModelBackend(ABC, metaclass=ModelBackendMeta):
         Returns:
             int: The maximum token limit for the given model.
         """
-        return (
-            self.model_config_dict.get("max_tokens")
-            or self.model_type.token_limit
-        )
+        return self.model_type.token_limit
 
     @property
     def stream(self) -> bool:

camel/models/cerebras_model.py

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

camel/models/cohere_model.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2026 @ 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-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
 import ast
 import json
 import logging
@@ -35,9 +35,7 @@ from camel.utils import (
     BaseTokenCounter,
     OpenAITokenCounter,
     api_keys_required,
-    get_current_agent_session_id,
     update_current_observation,
-    update_langfuse_trace,
 )
 
 if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":
@@ -315,19 +313,7 @@ class CohereModel(BaseModelBackend):
             model=str(self.model_type),
             model_parameters=self.model_config_dict,
         )
-        # Update Langfuse trace with current agent session and metadata
-        agent_session_id = get_current_agent_session_id()
-        if agent_session_id:
-            update_langfuse_trace(
-                session_id=agent_session_id,
-                metadata={
-                    "source": "camel",
-                    "agent_id": agent_session_id,
-                    "agent_type": "camel_chat_agent",
-                    "model_type": str(self.model_type),
-                },
-                tags=["CAMEL-AI", str(self.model_type)],
-            )
+        self._log_and_trace()
 
         from cohere.core.api_error import ApiError
 
@@ -396,19 +382,7 @@ class CohereModel(BaseModelBackend):
             model=str(self.model_type),
             model_parameters=self.model_config_dict,
         )
-        # Update Langfuse trace with current agent session and metadata
-        agent_session_id = get_current_agent_session_id()
-        if agent_session_id:
-            update_langfuse_trace(
-                session_id=agent_session_id,
-                metadata={
-                    "source": "camel",
-                    "agent_id": agent_session_id,
-                    "agent_type": "camel_chat_agent",
-                    "model_type": str(self.model_type),
-                },
-                tags=["CAMEL-AI", str(self.model_type)],
-            )
+        self._log_and_trace()
 
         from cohere.core.api_error import ApiError
 

camel/models/cometapi_model.py

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

camel/models/crynux_model.py

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

camel/models/deepseek_model.py

@@ -1,4 +1,4 @@
-# ========= Copyright 2023-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2026 @ 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-2025 @ CAMEL-AI.org. All Rights Reserved. =========
+# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
 from typing import Any, Dict, List, Optional, Type, Union
@@ -31,8 +31,6 @@ from camel.types import (
 from camel.utils import (
     BaseTokenCounter,
     api_keys_required,
-    get_current_agent_session_id,
-    update_langfuse_trace,
 )
 
 if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":
@@ -183,18 +181,7 @@ class DeepSeekModel(OpenAICompatibleModel):
                 `ChatCompletion` in the non-stream mode, or
                 `Stream[ChatCompletionChunk]` in the stream mode.
         """
-
-        # Update Langfuse trace with current agent session and metadata
-        agent_session_id = get_current_agent_session_id()
-        if agent_session_id:
-            update_langfuse_trace(
-                session_id=agent_session_id,
-                metadata={
-                    "agent_id": agent_session_id,
-                    "model_type": str(self.model_type),
-                },
-                tags=["CAMEL-AI", str(self.model_type)],
-            )
+        self._log_and_trace()
 
         request_config = self._prepare_request(
             messages, response_format, tools
@@ -226,18 +213,7 @@ class DeepSeekModel(OpenAICompatibleModel):
                 `ChatCompletion` in the non-stream mode, or
                 `AsyncStream[ChatCompletionChunk]` in the stream mode.
         """
-
-        # Update Langfuse trace with current agent session and metadata
-        agent_session_id = get_current_agent_session_id()
-        if agent_session_id:
-            update_langfuse_trace(
-                session_id=agent_session_id,
-                metadata={
-                    "agent_id": agent_session_id,
-                    "model_type": str(self.model_type),
-                },
-                tags=["CAMEL-AI", str(self.model_type)],
-            )
+        self._log_and_trace()
 
         request_config = self._prepare_request(
             messages, response_format, tools

camel/models/fish_audio_model.py

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