camel-ai 0.2.13__py3-none-any.whl → 0.2.15__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

@@ -21,6 +21,7 @@ from camel.configs import OPENAI_API_PARAMS, ChatGPTConfig
 from camel.messages import OpenAIMessage
 from camel.models import BaseModelBackend
 from camel.types import (
+    NOT_GIVEN,
     ChatCompletion,
     ChatCompletionChunk,
     ModelType,
@@ -51,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],
@@ -85,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],
@@ -103,7 +108,11 @@ class OpenAIModel(BaseModelBackend):
         """
         # o1-preview and o1-mini have Beta limitations
         # reference: https://platform.openai.com/docs/guides/reasoning
-        if self.model_type in [ModelType.O1_MINI, ModelType.O1_PREVIEW]:
+        if self.model_type in [
+            ModelType.O1,
+            ModelType.O1_MINI,
+            ModelType.O1_PREVIEW,
+        ]:
             warnings.warn(
                 "Warning: You are using an O1 model (O1_MINI or O1_PREVIEW), "
                 "which has certain limitations, reference: "
@@ -111,22 +120,21 @@ class OpenAIModel(BaseModelBackend):
                 UserWarning,
             )
 
-            # Remove system message that is not supported in o1 model.
-            messages = [msg for msg in messages if msg.get("role") != "system"]
-
             # Check and remove unsupported parameters and reset the fixed
             # parameters
-            unsupported_keys = ["stream", "tools", "tool_choice"]
+            unsupported_keys = [
+                "temperature",
+                "top_p",
+                "presence_penalty",
+                "frequency_penalty",
+                "logprobs",
+                "top_logprobs",
+                "logit_bias",
+            ]
             for key in unsupported_keys:
                 if key in self.model_config_dict:
                     del self.model_config_dict[key]
 
-            self.model_config_dict["temperature"] = 1.0
-            self.model_config_dict["top_p"] = 1.0
-            self.model_config_dict["n"] = 1
-            self.model_config_dict["presence_penalty"] = 0.0
-            self.model_config_dict["frequency_penalty"] = 0.0
-
         if self.model_config_dict.get("response_format"):
             # stream is not supported in beta.chat.completions.parse
             if "stream" in self.model_config_dict:
@@ -140,6 +148,14 @@ class OpenAIModel(BaseModelBackend):
 
             return self._to_chat_completion(response)
 
+        # Removing 'strict': True from the dictionary for
+        # client.chat.completions.create
+        if self.model_config_dict.get('tools') is not NOT_GIVEN:
+            for tool in self.model_config_dict.get('tools', []):
+                function_dict = tool.get('function', {})
+                if 'strict' in function_dict:
+                    del function_dict['strict']
+
         response = self._client.chat.completions.create(
             messages=messages,
             model=self.model_type,

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/__init__.py

@@ -13,5 +13,6 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from .openai_converter import OpenAISchemaConverter
+from .outlines_converter import OutlinesConverter
 
-__all__ = ["OpenAISchemaConverter"]
+__all__ = ["OpenAISchemaConverter", "OutlinesConverter"]

camel/schemas/base.py

@@ -15,8 +15,6 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict
 
-from pydantic import BaseModel
-
 
 class BaseConverter(ABC):
     r"""A base class for schema outputs that includes functionality
@@ -30,7 +28,7 @@ class BaseConverter(ABC):
     @abstractmethod
     def convert(
         self, content: str, *args: Any, **kwargs: Dict[str, Any]
-    ) -> BaseModel:
+    ) -> Any:
         r"""Structures the input text into the expected response format.
 
         Args:
@@ -40,6 +38,6 @@ class BaseConverter(ABC):
             prompt (Optional[str], optional): The prompt to be used.
 
         Returns:
-            Optional[BaseModel]: The structured response.
+           Any: The converted response.
         """
         pass

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,