Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

refactor(models): centralize Langfuse trace code in BaseModelBackend (#3642)

Vahant Sharmaa6c12402deab
diff --git a/camel/models/azure_openai_model.py b/camel/models/azure_openai_model.py
index 36541df4b..8baf3e436 100644
--- a/camel/models/azure_openai_model.py
+++ b/camel/models/azure_openai_model.py
@@ -34,9 +34,7 @@ from camel.types import (
from camel.utils import (
BaseTokenCounter,
OpenAITokenCounter,
- get_current_agent_session_id,
is_langfuse_available,
- update_langfuse_trace,
)
AzureADTokenProvider = Callable[[], str]
@@ -275,18 +273,7 @@ class AzureOpenAIModel(BaseModelBackend):
`ChatCompletionStreamManager[BaseModel]` for
structured output streaming.
"""
-
- # 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()
response_format = response_format or self.model_config_dict.get(
"response_format", None
@@ -333,18 +320,7 @@ class AzureOpenAIModel(BaseModelBackend):
`AsyncChatCompletionStreamManager[BaseModel]` for
structured output streaming.
"""
-
- # 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()
response_format = response_format or self.model_config_dict.get(
"response_format", None
diff --git a/camel/models/base_model.py b/camel/models/base_model.py
index 8f672b53e..605baaffc 100644
--- a/camel/models/base_model.py
+++ b/camel/models/base_model.py
@@ -33,7 +33,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:
@@ -440,6 +445,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,
diff --git a/camel/models/cohere_model.py b/camel/models/cohere_model.py
index b5b928bc4..b638ad63b 100644
--- a/camel/models/cohere_model.py
+++ b/camel/models/cohere_model.py
@@ -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
diff --git a/camel/models/deepseek_model.py b/camel/models/deepseek_model.py
index f4526bf1a..b937e0b0b 100644
--- a/camel/models/deepseek_model.py
+++ b/camel/models/deepseek_model.py
@@ -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
diff --git a/camel/models/function_gemma_model.py b/camel/models/function_gemma_model.py
index eaf987176..fc83479d6 100644
--- a/camel/models/function_gemma_model.py
+++ b/camel/models/function_gemma_model.py
@@ -29,9 +29,7 @@ from camel.types import ChatCompletion, CompletionUsage, ModelType
from camel.utils import (
BaseTokenCounter,
OpenAITokenCounter,
- get_current_agent_session_id,
update_current_observation,
- update_langfuse_trace,
)
# conditional observe import based on environment variables
@@ -822,18 +820,7 @@ class FunctionGemmaModel(BaseModelBackend):
model_parameters=self.model_config_dict,
)
- 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()
prompt = self._format_messages(messages, tools)
logger.debug(f"FunctionGemma prompt:\n{prompt}")
@@ -876,18 +863,7 @@ class FunctionGemmaModel(BaseModelBackend):
model_parameters=self.model_config_dict,
)
- 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()
prompt = self._format_messages(messages, tools)
logger.debug(f"FunctionGemma prompt:\n{prompt}")
diff --git a/camel/models/gemini_model.py b/camel/models/gemini_model.py
index 8a5cf614d..e4a2d60e1 100644
--- a/camel/models/gemini_model.py
+++ b/camel/models/gemini_model.py
@@ -37,8 +37,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":
@@ -475,18 +473,7 @@ class GeminiModel(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()
response_format = response_format or self.model_config_dict.get(
"response_format", None
@@ -528,18 +515,7 @@ class GeminiModel(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()
response_format = response_format or self.model_config_dict.get(
"response_format", None
diff --git a/camel/models/litellm_model.py b/camel/models/litellm_model.py
index 6281c4740..9bb7681bd 100644
--- a/camel/models/litellm_model.py
+++ b/camel/models/litellm_model.py
@@ -25,9 +25,7 @@ from camel.utils import (
BaseTokenCounter,
LiteLLMTokenCounter,
dependencies_required,
- get_current_agent_session_id,
update_current_observation,
- update_langfuse_trace,
)
if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":
@@ -188,19 +186,7 @@ class LiteLLMModel(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()
response = self.client(
timeout=self._timeout,
diff --git a/camel/models/mistral_model.py b/camel/models/mistral_model.py
index 7f0a2f615..066133d20 100644
--- a/camel/models/mistral_model.py
+++ b/camel/models/mistral_model.py
@@ -35,9 +35,7 @@ from camel.utils import (
OpenAITokenCounter,
api_keys_required,
dependencies_required,
- get_current_agent_session_id,
update_current_observation,
- update_langfuse_trace,
)
logger = get_logger(__name__)
@@ -277,19 +275,7 @@ class MistralModel(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()
request_config = self._prepare_request(
messages, response_format, tools
@@ -352,19 +338,7 @@ class MistralModel(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()
request_config = self._prepare_request(
messages, response_format, tools
diff --git a/camel/models/moonshot_model.py b/camel/models/moonshot_model.py
index 969eb33d3..09d053722 100644
--- a/camel/models/moonshot_model.py
+++ b/camel/models/moonshot_model.py
@@ -32,8 +32,6 @@ from camel.types import (
from camel.utils import (
BaseTokenCounter,
api_keys_required,
- get_current_agent_session_id,
- update_langfuse_trace,
)
logger = get_logger(__name__)
@@ -258,17 +256,7 @@ class MoonshotModel(OpenAICompatibleModel):
`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
diff --git a/camel/models/openai_compatible_model.py b/camel/models/openai_compatible_model.py
index b128d9a71..552d9897b 100644
--- a/camel/models/openai_compatible_model.py
+++ b/camel/models/openai_compatible_model.py
@@ -35,9 +35,7 @@ from camel.types import (
from camel.utils import (
BaseTokenCounter,
OpenAITokenCounter,
- get_current_agent_session_id,
is_langfuse_available,
- update_langfuse_trace,
)
if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":
@@ -199,18 +197,7 @@ class OpenAICompatibleModel(BaseModelBackend):
`ChatCompletionStreamManager[BaseModel]` for
structured output streaming.
"""
-
- # 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()
response_format = response_format or self.model_config_dict.get(
"response_format", None
@@ -262,18 +249,7 @@ class OpenAICompatibleModel(BaseModelBackend):
or `AsyncChatCompletionStreamManager[BaseModel]` for
structured output streaming.
"""
-
- # 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()
response_format = response_format or self.model_config_dict.get(
"response_format", None
diff --git a/camel/models/openai_model.py b/camel/models/openai_model.py
index e26647bb0..063e55bd0 100644
--- a/camel/models/openai_model.py
+++ b/camel/models/openai_model.py
@@ -35,9 +35,7 @@ from camel.utils import (
BaseTokenCounter,
OpenAITokenCounter,
api_keys_required,
- get_current_agent_session_id,
is_langfuse_available,
- update_langfuse_trace,
)
logger = get_logger(__name__)
@@ -270,24 +268,6 @@ class OpenAIModel(BaseModelBackend):
self._token_counter = OpenAITokenCounter(self.model_type)
return self._token_counter
- def _log_and_trace(self) -> None:
- r"""Update Langfuse trace with session metadata and log it."""
- agent_session_id = get_current_agent_session_id() or "no-session-id"
- model_type_str = str(self.model_type)
- metadata = {
- "source": "camel",
- "agent_id": agent_session_id,
- "agent_type": "camel_chat_agent",
- "model_type": model_type_str,
- }
- metadata = {k: str(v) for k, v in metadata.items()}
- update_langfuse_trace(
- session_id=agent_session_id,
- metadata=metadata,
- tags=["CAMEL-AI", model_type_str],
- )
- logger.info(f"metadata: {metadata}")
-
@observe()
def _run(
self,
diff --git a/camel/models/reka_model.py b/camel/models/reka_model.py
index 413b2dc10..a6d7af82c 100644
--- a/camel/models/reka_model.py
+++ b/camel/models/reka_model.py
@@ -25,9 +25,7 @@ from camel.utils import (
OpenAITokenCounter,
api_keys_required,
dependencies_required,
- get_current_agent_session_id,
update_current_observation,
- update_langfuse_trace,
)
if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":
@@ -240,19 +238,7 @@ class RekaModel(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()
reka_messages = self._convert_openai_to_reka_messages(messages)
@@ -310,19 +296,7 @@ class RekaModel(BaseModelBackend):
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()
reka_messages = self._convert_openai_to_reka_messages(messages)
diff --git a/camel/models/samba_model.py b/camel/models/samba_model.py
index 8cfdb18e1..93d7003c0 100644
--- a/camel/models/samba_model.py
+++ b/camel/models/samba_model.py
@@ -36,9 +36,7 @@ from camel.utils import (
BaseTokenCounter,
OpenAITokenCounter,
api_keys_required,
- get_current_agent_session_id,
update_current_observation,
- update_langfuse_trace,
)
try:
@@ -201,19 +199,7 @@ class SambaModel(BaseModelBackend):
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()
if "tools" in self.model_config_dict:
del self.model_config_dict["tools"]
@@ -252,19 +238,7 @@ class SambaModel(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()
if "tools" in self.model_config_dict:
del self.model_config_dict["tools"]
diff --git a/camel/models/sglang_model.py b/camel/models/sglang_model.py
index fc6aef045..f8bea6757 100644
--- a/camel/models/sglang_model.py
+++ b/camel/models/sglang_model.py
@@ -32,9 +32,7 @@ from camel.types import (
from camel.utils import (
BaseTokenCounter,
OpenAITokenCounter,
- get_current_agent_session_id,
update_current_observation,
- update_langfuse_trace,
)
if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":
@@ -266,19 +264,7 @@ class SGLangModel(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()
# Ensure server is running
self._ensure_server_running()
@@ -341,19 +327,7 @@ class SGLangModel(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()
# Ensure server is running
self._ensure_server_running()
diff --git a/camel/models/watsonx_model.py b/camel/models/watsonx_model.py
index f5a2add57..24f262d28 100644
--- a/camel/models/watsonx_model.py
+++ b/camel/models/watsonx_model.py
@@ -26,9 +26,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":
@@ -193,19 +191,7 @@ class WatsonXModel(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()
try:
request_config = self._prepare_request(
messages, response_format, tools
@@ -256,19 +242,7 @@ class WatsonXModel(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()
try:
request_config = self._prepare_request(