camel-ai 0.2.9__py3-none-any.whl → 0.2.11__py3-none-any.whl

camel/models/gemini_model.py

@@ -1,63 +1,57 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= Copyright 2023-2024 @ 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
+
+from openai import OpenAI, Stream
 
 from camel.configs import Gemini_API_PARAMS, GeminiConfig
 from camel.messages import OpenAIMessage
 from camel.models import BaseModelBackend
 from camel.types import (
     ChatCompletion,
-    ChatCompletionMessage,
-    Choice,
+    ChatCompletionChunk,
     ModelType,
 )
 from camel.utils import (
     BaseTokenCounter,
-    GeminiTokenCounter,
+    OpenAITokenCounter,
     api_keys_required,
-    dependencies_required,
 )
 
-if TYPE_CHECKING:
-    from google.generativeai.types import ContentsType, GenerateContentResponse
-
 
 class GeminiModel(BaseModelBackend):
     r"""Gemini API in a unified BaseModelBackend interface.
 
     Args:
         model_type (Union[ModelType, str]): Model for which a backend is
-            created.
+            created, one of Gemini series.
         model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
-            that will be fed into:obj:`genai.GenerativeModel.generate_content()
-            `. If:obj:`None`, :obj:`GeminiConfig().as_dict()` will be used.
+            that will be fed into:obj:`openai.ChatCompletion.create()`. If
+            :obj:`None`, :obj:`GeminiConfig().as_dict()` will be used.
             (default: :obj:`None`)
         api_key (Optional[str], optional): The API key for authenticating with
-            the gemini service. (default: :obj:`None`)
-        url (Optional[str], optional): The url to the gemini service.
-            (default: :obj:`None`)
+            the Gemini service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the Gemini service.
+            (default: :obj:`https://generativelanguage.googleapis.com/v1beta/
+            openai/`)
         token_counter (Optional[BaseTokenCounter], optional): Token counter to
-            use for the model. If not provided, :obj:`GeminiTokenCounter` will
-            be used. (default: :obj:`None`)
-
-    Notes:
-        Currently :obj:`"stream": True` is not supported with Gemini due to the
-        limitation of the current camel design.
+            use for the model. If not provided, :obj:`OpenAITokenCounter(
+            ModelType.GPT_4O_MINI)` will be used.
+            (default: :obj:`None`)
     """
 
-    @dependencies_required('google')
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -66,29 +60,45 @@ class GeminiModel(BaseModelBackend):
         url: Optional[str] = None,
         token_counter: Optional[BaseTokenCounter] = None,
     ) -> None:
-        import google.generativeai as genai
-        from google.generativeai.types.generation_types import GenerationConfig
-
         if model_config_dict is None:
             model_config_dict = GeminiConfig().as_dict()
-
-        api_key = api_key or os.environ.get("GOOGLE_API_KEY")
+        api_key = api_key or os.environ.get("GEMINI_API_KEY")
+        url = url or os.environ.get(
+            "GEMINI_API_BASE_URL",
+            "https://generativelanguage.googleapis.com/v1beta/openai/",
+        )
         super().__init__(
             model_type, model_config_dict, api_key, url, token_counter
         )
-        genai.configure(api_key=self._api_key)
-        self._client = genai.GenerativeModel(self.model_type)
+        self._client = OpenAI(
+            timeout=60,
+            max_retries=3,
+            api_key=self._api_key,
+            base_url=self._url,
+        )
 
-        keys = list(self.model_config_dict.keys())
-        generation_config_dict = {
-            k: self.model_config_dict.pop(k)
-            for k in keys
-            if hasattr(GenerationConfig, k)
-        }
-        generation_config = genai.types.GenerationConfig(
-            **generation_config_dict
+    @api_keys_required("GEMINI_API_KEY")
+    def run(
+        self,
+        messages: List[OpenAIMessage],
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        r"""Runs inference of Gemini chat completion.
+
+        Args:
+            messages (List[OpenAIMessage]): Message list with the chat history
+                in OpenAI API format.
+
+        Returns:
+            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+                `ChatCompletion` in the non-stream mode, or
+                `Stream[ChatCompletionChunk]` in the stream mode.
+        """
+        response = self._client.chat.completions.create(
+            messages=messages,
+            model=self.model_type,
+            **self.model_config_dict,
         )
-        self.model_config_dict["generation_config"] = generation_config
+        return response
 
     @property
     def token_counter(self) -> BaseTokenCounter:
@@ -99,125 +109,30 @@ class GeminiModel(BaseModelBackend):
                 tokenization style.
         """
         if not self._token_counter:
-            self._token_counter = GeminiTokenCounter(self.model_type)
+            self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
         return self._token_counter
 
-    @api_keys_required("GOOGLE_API_KEY")
-    def run(
-        self,
-        messages: List[OpenAIMessage],
-    ) -> ChatCompletion:
-        r"""Runs inference of Gemini model.
-        This method can handle multimodal input
-
-        Args:
-            messages: Message list or Message with the chat history
-                in OpenAi format.
-
-        Returns:
-            response: A ChatCompletion object formatted for the OpenAI API.
-        """
-        response = self._client.generate_content(
-            contents=self.to_gemini_req(messages),
-            **self.model_config_dict,
-        )
-        response.resolve()
-        return self.to_openai_response(response)
-
     def check_model_config(self):
         r"""Check whether the model configuration contains any
         unexpected arguments to Gemini API.
 
         Raises:
             ValueError: If the model configuration dictionary contains any
-                unexpected arguments to OpenAI API.
+                unexpected arguments to Gemini API.
         """
-        if self.model_config_dict is not None:
-            for param in self.model_config_dict:
-                if param not in Gemini_API_PARAMS:
-                    raise ValueError(
-                        f"Unexpected argument `{param}` is "
-                        "input into Gemini model backend."
-                    )
+        for param in self.model_config_dict:
+            if param not in Gemini_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into Gemini model backend."
+                )
 
     @property
     def stream(self) -> bool:
-        r"""Returns whether the model is in stream mode,
-            which sends partial results each time.
+        r"""Returns whether the model is in stream mode, which sends partial
+        results each time.
 
         Returns:
             bool: Whether the model is in stream mode.
         """
         return self.model_config_dict.get('stream', False)
-
-    def to_gemini_req(self, messages: List[OpenAIMessage]) -> 'ContentsType':
-        r"""Converts the request from the OpenAI API format to the Gemini API
-        request format.
-
-        Args:
-            messages: The request object from the OpenAI API.
-
-        Returns:
-            converted_messages: A list of messages formatted for Gemini API.
-        """
-        # role reference
-        # https://ai.google.dev/api/python/google/generativeai/protos/Content
-        converted_messages = []
-        for message in messages:
-            role = message.get('role')
-            if role == 'assistant':
-                role_to_gemini = 'model'
-            else:
-                role_to_gemini = 'user'
-            converted_message = {
-                "role": role_to_gemini,
-                "parts": message.get("content"),
-            }
-            converted_messages.append(converted_message)
-        return converted_messages
-
-    def to_openai_response(
-        self,
-        response: 'GenerateContentResponse',
-    ) -> ChatCompletion:
-        r"""Converts the response from the Gemini API to the OpenAI API
-        response format.
-
-        Args:
-            response: The response object returned by the Gemini API
-
-        Returns:
-            openai_response: A ChatCompletion object formatted for
-                the OpenAI API.
-        """
-        import time
-        import uuid
-
-        openai_response = ChatCompletion(
-            id=f"chatcmpl-{uuid.uuid4().hex!s}",
-            object="chat.completion",
-            created=int(time.time()),
-            model=self.model_type,
-            choices=[],
-        )
-        for i, candidate in enumerate(response.candidates):
-            content = ""
-            if candidate.content and len(candidate.content.parts) > 0:
-                content = candidate.content.parts[0].text
-            finish_reason = candidate.finish_reason
-            finish_reason_mapping = {
-                "FinishReason.STOP": "stop",
-                "FinishReason.SAFETY": "content_filter",
-                "FinishReason.RECITATION": "content_filter",
-                "FinishReason.MAX_TOKENS": "length",
-            }
-            finish_reason = finish_reason_mapping.get(finish_reason, "stop")
-            choice = Choice(
-                index=i,
-                message=ChatCompletionMessage(
-                    role="assistant", content=content
-                ),
-                finish_reason=finish_reason,
-            )
-        openai_response.choices.append(choice)
-        return openai_response

camel/models/groq_model.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= Copyright 2023-2024 @ 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
 from typing import Any, Dict, List, Optional, Union
 

camel/models/litellm_model.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= Copyright 2023-2024 @ 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from typing import Any, Dict, List, Optional, Union
 
 from camel.configs import LITELLM_API_PARAMS, LiteLLMConfig

camel/models/mistral_model.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= Copyright 2023-2024 @ 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
 

camel/models/model_factory.py

@@ -1,25 +1,28 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= Copyright 2023-2024 @ 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from typing import Dict, Optional, Type, Union
 
 from camel.models.anthropic_model import AnthropicModel
 from camel.models.azure_openai_model import AzureOpenAIModel
 from camel.models.base_model import BaseModelBackend
+from camel.models.cohere_model import CohereModel
+from camel.models.deepseek_model import DeepSeekModel
 from camel.models.gemini_model import GeminiModel
 from camel.models.groq_model import GroqModel
 from camel.models.litellm_model import LiteLLMModel
 from camel.models.mistral_model import MistralModel
+from camel.models.nvidia_model import NvidiaModel
 from camel.models.ollama_model import OllamaModel
 from camel.models.openai_compatible_model import OpenAICompatibleModel
 from camel.models.openai_model import OpenAIModel
@@ -91,6 +94,8 @@ class ModelFactory:
             model_class = TogetherAIModel
         elif model_platform.is_litellm:
             model_class = LiteLLMModel
+        elif model_platform.is_nvidia:
+            model_class = NvidiaModel
 
         elif model_platform.is_openai and model_type.is_openai:
             model_class = OpenAIModel
@@ -108,10 +113,14 @@ class ModelFactory:
             model_class = MistralModel
         elif model_platform.is_reka and model_type.is_reka:
             model_class = RekaModel
+        elif model_platform.is_cohere and model_type.is_cohere:
+            model_class = CohereModel
         elif model_platform.is_yi and model_type.is_yi:
             model_class = YiModel
         elif model_platform.is_qwen and model_type.is_qwen:
             model_class = QwenModel
+        elif model_platform.is_deepseek:
+            model_class = DeepSeekModel
         elif model_type == ModelType.STUB:
             model_class = StubModel
 

camel/models/model_manager.py

@@ -0,0 +1,212 @@
+# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+
+import logging
+from itertools import cycle
+from random import choice
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    List,
+    Union,
+)
+
+from openai import Stream
+
+from camel.messages import OpenAIMessage
+from camel.models.base_model import BaseModelBackend
+from camel.types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    UnifiedModelType,
+)
+from camel.utils import BaseTokenCounter
+
+logger = logging.getLogger(__name__)
+
+
+class ModelProcessingError(Exception):
+    r"""Raised when an error occurs during model processing."""
+
+    pass
+
+
+class ModelManager:
+    r"""ModelManager choosing a model from provided list.
+    Models are picked according to defined strategy.
+
+    Args:
+        models(Union[BaseModelBackend, List[BaseModelBackend]]):
+            model backend or list of model backends
+            (e.g., model instances, APIs)
+        scheduling_strategy (str): name of function that defines how
+            to select the next model. (default: :str:`round_robin`)
+    """
+
+    def __init__(
+        self,
+        models: Union[BaseModelBackend, List[BaseModelBackend]],
+        scheduling_strategy: str = "round_robin",
+    ):
+        if isinstance(models, list):
+            self.models = models
+        else:
+            self.models = [models]
+        self.models_cycle = cycle(self.models)
+        self.current_model = self.models[0]
+
+        # Set the scheduling strategy; default is round-robin
+        try:
+            self.scheduling_strategy = getattr(self, scheduling_strategy)
+        except AttributeError:
+            logger.warning(
+                f"Provided strategy: {scheduling_strategy} is not implemented."
+                f"Using default 'round robin'"
+            )
+            self.scheduling_strategy = self.round_robin
+
+    @property
+    def model_type(self) -> UnifiedModelType:
+        r"""Return type of the current model.
+
+        Returns:
+            Union[ModelType, str]: Current model type.
+        """
+        return self.current_model.model_type
+
+    @property
+    def model_config_dict(self) -> Dict[str, Any]:
+        r"""Return model_config_dict of the current model.
+
+        Returns:
+            Dict[str, Any]: Config dictionary of the current model.
+        """
+        return self.current_model.model_config_dict
+
+    @model_config_dict.setter
+    def model_config_dict(self, model_config_dict: Dict[str, Any]):
+        r"""Set model_config_dict to the current model.
+
+        Args:
+            model_config_dict (Dict[str, Any]): Config dictionary to be set at
+                current model.
+        """
+        self.current_model.model_config_dict = model_config_dict
+
+    @property
+    def current_model_index(self) -> int:
+        r"""Return the index of current model in self.models list.
+
+        Returns:
+            int: index of current model in given list of models.
+        """
+        return self.models.index(self.current_model)
+
+    @property
+    def token_limit(self):
+        r"""Returns the maximum token limit for current model.
+
+        This method retrieves the maximum token limit either from the
+        `model_config_dict` or from the model's default token limit.
+
+        Returns:
+            int: The maximum token limit for the given model.
+        """
+        return self.current_model.token_limit
+
+    @property
+    def token_counter(self) -> BaseTokenCounter:
+        r"""Return token_counter of the current model.
+
+        Returns:
+            BaseTokenCounter: The token counter following the model's
+                tokenization style.
+        """
+        return self.current_model.token_counter
+
+    def add_strategy(self, name: str, strategy_fn: Callable):
+        r"""Add a scheduling strategy method provided by user in case when none
+            of existent strategies fits.
+            When custom strategy is provided, it will be set as
+            "self.scheduling_strategy" attribute.
+
+        Args:
+            name (str): The name of the strategy.
+            strategy_fn (Callable): The scheduling strategy function.
+        """
+        if not callable(strategy_fn):
+            raise ValueError("strategy_fn must be a callable function.")
+        setattr(self, name, strategy_fn.__get__(self))
+        self.scheduling_strategy = getattr(self, name)
+        logger.info(f"Custom strategy '{name}' added.")
+
+    # Strategies
+    def round_robin(self) -> BaseModelBackend:
+        r"""Return models one by one in simple round-robin fashion.
+
+        Returns:
+             BaseModelBackend for processing incoming messages.
+        """
+        return next(self.models_cycle)
+
+    def always_first(self) -> BaseModelBackend:
+        r"""Always return the first model from self.models.
+
+        Returns:
+            BaseModelBackend for processing incoming messages.
+        """
+        return self.models[0]
+
+    def random_model(self) -> BaseModelBackend:
+        r"""Return random model from self.models list.
+
+        Returns:
+             BaseModelBackend for processing incoming messages.
+        """
+        return choice(self.models)
+
+    def run(
+        self, messages: List[OpenAIMessage]
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        r"""Process a list of messages by selecting a model based on
+            the scheduling strategy.
+            Sends the entire list of messages to the selected model,
+            and returns a single response.
+
+        Args:
+            messages (List[OpenAIMessage]): Message list with the chat
+                history in OpenAI API format.
+
+        Returns:
+            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+                `ChatCompletion` in the non-stream mode, or
+                `Stream[ChatCompletionChunk]` in the stream mode.
+        """
+        self.current_model = self.scheduling_strategy()
+
+        # Pass all messages to the selected model and get the response
+        try:
+            response = self.current_model.run(messages)
+        except Exception as exc:
+            logger.error(f"Error processing with model: {self.current_model}")
+            if self.scheduling_strategy == self.always_first:
+                self.scheduling_strategy = self.round_robin
+                logger.warning(
+                    "The scheduling strategy has been changed to 'round_robin'"
+                )
+                # Skip already used one
+                self.current_model = self.scheduling_strategy()
+            raise exc
+        return response

camel/models/nemotron_model.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= Copyright 2023-2024 @ 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
 from typing import List, Optional, Union