camel-ai 0.2.14__py3-none-any.whl → 0.2.16__py3-none-any.whl

camel/models/cohere_model.py

@@ -43,6 +43,11 @@ except (ImportError, AttributeError):
 class CohereModel(BaseModelBackend):
     r"""Cohere API in a unified BaseModelBackend interface."""
 
+    @api_keys_required(
+        [
+            ("api_key", 'COHERE_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -210,7 +215,6 @@ class CohereModel(BaseModelBackend):
             )
         return self._token_counter
 
-    @api_keys_required("COHERE_API_KEY")
     def run(self, messages: List[OpenAIMessage]) -> ChatCompletion:
         r"""Runs inference of Cohere chat completion.
 

camel/models/deepseek_model.py

@@ -50,6 +50,11 @@ class DeepSeekModel(BaseModelBackend):
         https://api-docs.deepseek.com/
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "DEEPSEEK_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -90,7 +95,6 @@ class DeepSeekModel(BaseModelBackend):
             )
         return self._token_counter
 
-    @api_keys_required("DEEPSEEK_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/gemini_model.py

@@ -52,6 +52,11 @@ class GeminiModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'GEMINI_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -77,7 +82,6 @@ class GeminiModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("GEMINI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/groq_model.py

@@ -51,6 +51,11 @@ class GroqModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "GROQ_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -89,7 +94,6 @@ class GroqModel(BaseModelBackend):
             self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
         return self._token_counter
 
-    @api_keys_required("GROQ_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/mistral_model.py

@@ -59,6 +59,11 @@ class MistralModel(BaseModelBackend):
             be used. (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "MISTRAL_API_KEY"),
+        ]
+    )
     @dependencies_required('mistralai')
     def __init__(
         self,
@@ -200,7 +205,6 @@ class MistralModel(BaseModelBackend):
             )
         return self._token_counter
 
-    @api_keys_required("MISTRAL_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/nemotron_model.py

@@ -40,6 +40,11 @@ class NemotronModel(BaseModelBackend):
         Nemotron model doesn't support additional model config like OpenAI.
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "NVIDIA_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -58,7 +63,6 @@ class NemotronModel(BaseModelBackend):
             api_key=self._api_key,
         )
 
-    @api_keys_required("NVIDIA_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/nvidia_model.py

@@ -48,6 +48,11 @@ class NvidiaModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "NVIDIA_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -72,7 +77,6 @@ class NvidiaModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("NVIDIA_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/openai_model.py

@@ -52,6 +52,11 @@ class OpenAIModel(BaseModelBackend):
             be used. (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "OPENAI_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -86,7 +91,6 @@ class OpenAIModel(BaseModelBackend):
             self._token_counter = OpenAITokenCounter(self.model_type)
         return self._token_counter
 
-    @api_keys_required("OPENAI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/qwen_model.py

@@ -52,6 +52,11 @@ class QwenModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "QWEN_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -77,7 +82,6 @@ class QwenModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("QWEN_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/reka_model.py

@@ -56,6 +56,11 @@ class RekaModel(BaseModelBackend):
             be used. (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "REKA_API_KEY"),
+        ]
+    )
     @dependencies_required('reka')
     def __init__(
         self,
@@ -168,7 +173,6 @@ class RekaModel(BaseModelBackend):
             )
         return self._token_counter
 
-    @api_keys_required("REKA_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/reward/nemotron_model.py

@@ -53,7 +53,11 @@ class NemotronRewardModel(BaseRewardModel):
             api_key=self.api_key,
         )
 
-    @api_keys_required("NVIDIA_API_KEY")
+    @api_keys_required(
+        [
+            (None, "NVIDIA_API_KEY"),
+        ]
+    )
     def evaluate(self, messages: List[Dict[str, str]]) -> Dict[str, float]:
         r"""Evaluate the messages using the Nemotron model.
 

camel/models/samba_model.py

@@ -74,6 +74,11 @@ class SambaModel(BaseModelBackend):
             ModelType.GPT_4O_MINI)` will be used.
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'SAMBA_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -143,7 +148,6 @@ class SambaModel(BaseModelBackend):
                 " SambaNova service"
             )
 
-    @api_keys_required("SAMBA_API_KEY")
     def run(  # type: ignore[misc]
         self, messages: List[OpenAIMessage]
     ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:

camel/models/togetherai_model.py

@@ -53,6 +53,11 @@ class TogetherAIModel(BaseModelBackend):
             ModelType.GPT_4O_MINI)` will be used.
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'TOGETHER_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -78,7 +83,6 @@ class TogetherAIModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("TOGETHER_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/yi_model.py

@@ -52,6 +52,11 @@ class YiModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'YI_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -76,7 +81,6 @@ class YiModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("YI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/zhipuai_model.py

@@ -52,6 +52,11 @@ class ZhipuAIModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'ZHIPUAI_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -76,7 +81,6 @@ class ZhipuAIModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("ZHIPUAI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/retrievers/auto_retriever.py

@@ -121,6 +121,14 @@ class AutoRetriever:
 
         collection_name = re.sub(r'[^a-zA-Z0-9]', '', content)[:20]
 
+        # Ensure the first character is either an underscore or a letter for
+        # Milvus
+        if (
+            self.storage_type == StorageType.MILVUS
+            and not collection_name[0].isalpha()
+        ):
+            collection_name = f"_{collection_name}"
+
         return collection_name
 
     def run_vector_retriever(

camel/retrievers/vector_retriever.py

@@ -161,13 +161,16 @@ class VectorRetriever(BaseRetriever):
                 # content path, chunk metadata, and chunk text
                 for vector, chunk in zip(batch_vectors, batch_chunks):
                     if isinstance(content, str):
-                        content_path_info = {"content path": content}
+                        content_path_info = {"content path": content[:100]}
                     elif isinstance(content, IOBase):
                         content_path_info = {"content path": "From file bytes"}
                     elif isinstance(content, Element):
                         content_path_info = {
-                            "content path": content.metadata.file_directory
-                            or ""
+                            "content path": content.metadata.file_directory[
+                                :100
+                            ]
+                            if content.metadata.file_directory
+                            else ""
                         }
 
                     chunk_metadata = {"metadata": chunk.metadata.to_dict()}

camel/schemas/openai_converter.py

@@ -53,6 +53,11 @@ class OpenAISchemaConverter(BaseConverter):
 
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "OPENAI_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: ModelType = ModelType.GPT_4O_MINI,
@@ -69,7 +74,6 @@ class OpenAISchemaConverter(BaseConverter):
         )._client
         super().__init__()
 
-    @api_keys_required("OPENAI_API_KEY")
     def convert(  # type: ignore[override]
         self,
         content: str,

camel/societies/role_playing.py

@@ -509,8 +509,8 @@ class RolePlaying:
         # step and once in role play), and the model generates only one
         # response when multi-response support is enabled.
         if (
-            'n' in self.user_agent.model_config_dict.keys()
-            and self.user_agent.model_config_dict['n'] > 1
+            'n' in self.user_agent.model_backend.model_config_dict.keys()
+            and self.user_agent.model_backend.model_config_dict['n'] > 1
         ):
             self.user_agent.record_message(user_msg)
 
@@ -532,8 +532,8 @@ class RolePlaying:
         # step and once in role play), and the model generates only one
         # response when multi-response support is enabled.
         if (
-            'n' in self.assistant_agent.model_config_dict.keys()
-            and self.assistant_agent.model_config_dict['n'] > 1
+            'n' in self.assistant_agent.model_backend.model_config_dict.keys()
+            and self.assistant_agent.model_backend.model_config_dict['n'] > 1
         ):
             self.assistant_agent.record_message(assistant_msg)
 

camel/societies/workforce/workforce.py

@@ -251,7 +251,7 @@ class Workforce(BaseNode):
                 additional_info = "A Workforce node"
             elif isinstance(child, SingleAgentWorker):
                 additional_info = "tools: " + (
-                    ", ".join(child.worker.func_dict.keys())
+                    ", ".join(child.worker.tool_dict.keys())
                 )
             elif isinstance(child, RolePlayingWorker):
                 additional_info = "A Role playing node"
@@ -369,7 +369,7 @@ class Workforce(BaseNode):
             model_config_dict=model_config_dict,
         )
 
-        return ChatAgent(worker_sys_msg, model=model, tools=function_list)
+        return ChatAgent(worker_sys_msg, model=model, tools=function_list)  # type: ignore[arg-type]
 
     async def _get_returned_task(self) -> Task:
         r"""Get the task that's published by this node and just get returned

camel/storages/graph_storages/nebula_graph.py

@@ -12,8 +12,19 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
+import logging
+import re
 import time
-from typing import TYPE_CHECKING, Any, Dict, List, Tuple
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple
+
+from camel.storages.graph_storages.base import BaseGraphStorage
+from camel.storages.graph_storages.graph_element import (
+    GraphElement,
+)
+from camel.utils.commons import dependencies_required
+
+logger = logging.getLogger(__name__)
+
 
 if TYPE_CHECKING:
     from nebula3.data.ResultSet import (  # type: ignore[import-untyped]
@@ -24,11 +35,6 @@ if TYPE_CHECKING:
         Session,
     )
 
-from camel.storages.graph_storages.base import BaseGraphStorage
-from camel.storages.graph_storages.graph_element import (
-    GraphElement,
-)
-from camel.utils.commons import dependencies_required
 
 MAX_RETRIES = 5
 RETRY_DELAY = 3
@@ -178,55 +184,81 @@ class NebulaGraph(BaseGraphStorage):
         """
         nodes = self._extract_nodes(graph_elements)
         for node in nodes:
-            self.add_node(node['id'], node['type'])
+            try:
+                self.add_node(node['id'], node['type'])
+            except Exception as e:
+                logger.warning(f"Failed to add node {node}. Error: {e}")
+                continue
 
         relationships = self._extract_relationships(graph_elements)
         for rel in relationships:
-            self.add_triplet(rel['subj']['id'], rel['obj']['id'], rel['type'])
+            try:
+                self.add_triplet(
+                    rel['subj']['id'], rel['obj']['id'], rel['type']
+                )
+            except Exception as e:
+                logger.warning(f"Failed to add relationship {rel}. Error: {e}")
+                continue
 
     def ensure_edge_type_exists(
         self,
         edge_type: str,
+        time_label: Optional[str] = None,
     ) -> None:
         r"""Ensures that a specified edge type exists in the NebulaGraph
         database. If the edge type already exists, this method does nothing.
 
         Args:
             edge_type (str): The name of the edge type to be created.
+            time_label (str, optional): A specific timestamp to set as the
+                default value for the time label property. If not
+                provided, no timestamp will be added. (default: :obj:`None`)
 
         Raises:
             Exception: If the edge type creation fails after multiple retry
                 attempts, an exception is raised with the error message.
         """
-        create_edge_stmt = f'CREATE EDGE IF NOT EXISTS {edge_type}()'
+        create_edge_stmt = f"CREATE EDGE IF NOT EXISTS {edge_type} ()"
+        if time_label is not None:
+            time_label = self._validate_time_label(time_label)
+            create_edge_stmt = f"""CREATE EDGE IF NOT EXISTS {edge_type}
+            (time_label DATETIME DEFAULT {time_label})"""
 
         for attempt in range(MAX_RETRIES):
             res = self.query(create_edge_stmt)
             if res.is_succeeded():
-                return  # Tag creation succeeded, exit the method
+                return  # Edge type creation succeeded
 
             if attempt < MAX_RETRIES - 1:
                 time.sleep(RETRY_DELAY)
             else:
                 # Final attempt failed, raise an exception
                 raise Exception(
-                    f"Failed to create tag `{edge_type}` after "
+                    f"Failed to create edge type `{edge_type}` after "
                     f"{MAX_RETRIES} attempts: {res.error_msg()}"
                 )
 
-    def ensure_tag_exists(self, tag_name: str) -> None:
+    def ensure_tag_exists(
+        self, tag_name: str, time_label: Optional[str] = None
+    ) -> None:
         r"""Ensures a tag is created in the NebulaGraph database. If the tag
         already exists, it does nothing.
 
         Args:
             tag_name (str): The name of the tag to be created.
+            time_label (str, optional): A specific timestamp to set as the
+                default value for the time label property. If not provided,
+                no timestamp will be added. (default: :obj:`None`)
 
         Raises:
             Exception: If the tag creation fails after retries, an exception
                 is raised with the error message.
         """
-
-        create_tag_stmt = f'CREATE TAG IF NOT EXISTS {tag_name}()'
+        create_tag_stmt = f"CREATE TAG IF NOT EXISTS {tag_name} ()"
+        if time_label is not None:
+            time_label = self._validate_time_label(time_label)
+            create_tag_stmt = f"""CREATE TAG IF NOT EXISTS {tag_name}
+            (time_label DATETIME DEFAULT {time_label})"""
 
         for attempt in range(MAX_RETRIES):
             res = self.query(create_tag_stmt)
@@ -246,24 +278,39 @@ class NebulaGraph(BaseGraphStorage):
         self,
         node_id: str,
         tag_name: str,
+        time_label: Optional[str] = None,
     ) -> None:
         r"""Add a node with the specified tag and properties.
 
         Args:
             node_id (str): The ID of the node.
             tag_name (str): The tag name of the node.
+            time_label (str, optional): A specific timestamp to set for
+                the node's time label property. If not provided, no timestamp
+                will be added. (default: :obj:`None`)
         """
-        self.ensure_tag_exists(tag_name)
+        node_id = re.sub(r'[^a-zA-Z0-9\u4e00-\u9fa5]', '', node_id)
+        tag_name = re.sub(r'[^a-zA-Z0-9\u4e00-\u9fa5]', '', tag_name)
 
-        # Insert node without properties
-        insert_stmt = (
-            f'INSERT VERTEX IF NOT EXISTS {tag_name}() VALUES "{node_id}":()'
-        )
+        self.ensure_tag_exists(tag_name, time_label)
+
+        # Insert node with or without time_label property
+        if time_label is not None:
+            time_label = self._validate_time_label(time_label)
+            insert_stmt = (
+                f'INSERT VERTEX IF NOT EXISTS {tag_name}(time_label) VALUES '
+                f'"{node_id}":("{time_label}")'
+            )
+        else:
+            insert_stmt = (
+                f'INSERT VERTEX IF NOT EXISTS {tag_name}() VALUES '
+                f'"{node_id}":()'
+            )
 
         for attempt in range(MAX_RETRIES):
             res = self.query(insert_stmt)
             if res.is_succeeded():
-                return  # Tag creation succeeded, exit the method
+                return  # Node creation succeeded, exit the method
 
             if attempt < MAX_RETRIES - 1:
                 time.sleep(RETRY_DELAY)
@@ -329,7 +376,7 @@ class NebulaGraph(BaseGraphStorage):
     @property
     def get_structured_schema(self) -> Dict[str, Any]:
         r"""Generates a structured schema consisting of node and relationship
-        properties, relationships, and metadata.
+        properties, relationships, and metadata, including timestamps.
 
         Returns:
             Dict[str, Any]: A dictionary representing the structured schema.
@@ -400,6 +447,7 @@ class NebulaGraph(BaseGraphStorage):
         subj: str,
         obj: str,
         rel: str,
+        time_label: Optional[str] = None,
     ) -> None:
         r"""Adds a relationship (triplet) between two entities in the Nebula
         Graph database.
@@ -408,24 +456,44 @@ class NebulaGraph(BaseGraphStorage):
             subj (str): The identifier for the subject entity.
             obj (str): The identifier for the object entity.
             rel (str): The relationship between the subject and object.
+            time_label (str, optional): A specific timestamp to set for the
+                time label property of the relationship. If not provided,
+                no timestamp will be added. (default: :obj:`None`)
+
+        Raises:
+            ValueError: If the time_label format is invalid.
+            Exception: If creating the relationship fails.
         """
+        subj = re.sub(r'[^a-zA-Z0-9\u4e00-\u9fa5]', '', subj)
+        obj = re.sub(r'[^a-zA-Z0-9\u4e00-\u9fa5]', '', obj)
+        rel = re.sub(r'[^a-zA-Z0-9\u4e00-\u9fa5]', '', rel)
+
         self.ensure_tag_exists(subj)
         self.ensure_tag_exists(obj)
-        self.ensure_edge_type_exists(rel)
+        self.ensure_edge_type_exists(rel, time_label)
         self.add_node(node_id=subj, tag_name=subj)
         self.add_node(node_id=obj, tag_name=obj)
 
-        # Avoid latenicy
+        # Avoid latency
         time.sleep(1)
 
-        insert_stmt = (
-            f'INSERT EDGE IF NOT EXISTS {rel}() VALUES "{subj}"->"{obj}":();'
-        )
+        # Create edge with or without time_label property
+        if time_label is not None:
+            time_label = self._validate_time_label(time_label)
+            insert_stmt = (
+                f'INSERT EDGE IF NOT EXISTS {rel}(time_label) VALUES '
+                f'"{subj}"->"{obj}":("{time_label}")'
+            )
+        else:
+            insert_stmt = (
+                f'INSERT EDGE IF NOT EXISTS {rel}() VALUES '
+                f'"{subj}"->"{obj}":()'
+            )
 
         res = self.query(insert_stmt)
         if not res.is_succeeded():
             raise Exception(
-                f'create relationship `]{subj}` -> `{obj}`'
+                f'create relationship `{subj}` -> `{obj}`'
                 + f'failed: {res.error_msg()}'
             )
 
@@ -545,3 +613,27 @@ class NebulaGraph(BaseGraphStorage):
             )
 
         return rel_schema_props, rel_structure_props
+
+    def _validate_time_label(self, time_label: str) -> str:
+        r"""Validates the format of a time label string.
+
+        Args:
+            time_label (str): The time label string to validate.
+                Should be in format 'YYYY-MM-DDThh:mm:ss'.
+
+        Returns:
+            str: The validated time label.
+
+        Raises:
+            ValueError: If the time label format is invalid.
+        """
+        try:
+            # Check if the format matches YYYY-MM-DDThh:mm:ss
+            pattern = r'^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$'
+            if not re.match(pattern, time_label):
+                raise ValueError(
+                    "Time label must be in format 'YYYY-MM-DDThh:mm:ss'"
+                )
+            return time_label
+        except Exception as e:
+            raise ValueError(f"Invalid time label format: {e!s}")