camel-ai 0.2.49__py3-none-any.whl → 0.2.51__py3-none-any.whl

camel/models/azure_openai_model.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
-from typing import Any, Dict, List, Optional, Type, Union
+from typing import Any, Callable, Dict, List, Optional, Type, Union
 
 from openai import AsyncAzureOpenAI, AsyncStream, AzureOpenAI, Stream
 from pydantic import BaseModel
@@ -27,6 +27,8 @@ from camel.types import (
 )
 from camel.utils import BaseTokenCounter, OpenAITokenCounter
 
+AzureADTokenProvider = Callable[[], str]
+
 
 class AzureOpenAIModel(BaseModelBackend):
     r"""Azure OpenAI API in a unified BaseModelBackend interface.
@@ -46,6 +48,12 @@ class AzureOpenAIModel(BaseModelBackend):
             (default: :obj:`None`)
         azure_deployment_name (Optional[str], optional): The deployment name
             you chose when you deployed an azure model. (default: :obj:`None`)
+        azure_ad_token (Optional[str], optional): Your Azure Active Directory
+            token, https://www.microsoft.com/en-us/security/business/
+            identity-access/microsoft-entra-id. (default: :obj:`None`)
+        azure_ad_token_provider (Optional[AzureADTokenProvider], optional): A
+            function that returns an Azure Active Directory token, will be
+            invoked on every request. (default: :obj:`None`)
         token_counter (Optional[BaseTokenCounter], optional): Token counter to
             use for the model. If not provided, :obj:`OpenAITokenCounter`
             will be used. (default: :obj:`None`)
@@ -68,6 +76,8 @@ class AzureOpenAIModel(BaseModelBackend):
         token_counter: Optional[BaseTokenCounter] = None,
         api_version: Optional[str] = None,
         azure_deployment_name: Optional[str] = None,
+        azure_ad_token_provider: Optional["AzureADTokenProvider"] = None,
+        azure_ad_token: Optional[str] = None,
     ) -> None:
         if model_config_dict is None:
             model_config_dict = ChatGPTConfig().as_dict()
@@ -79,15 +89,19 @@ class AzureOpenAIModel(BaseModelBackend):
         )
 
         self.api_version = api_version or os.environ.get("AZURE_API_VERSION")
-        self.azure_deployment_name = azure_deployment_name or os.environ.get(
+        self._azure_deployment_name = azure_deployment_name or os.environ.get(
             "AZURE_DEPLOYMENT_NAME"
         )
+        self._azure_ad_token = azure_ad_token or os.environ.get(
+            "AZURE_AD_TOKEN"
+        )
+        self.azure_ad_token_provider = azure_ad_token_provider
         if self.api_version is None:
             raise ValueError(
                 "Must provide either the `api_version` argument "
                 "or `AZURE_API_VERSION` environment variable."
             )
-        if self.azure_deployment_name is None:
+        if self._azure_deployment_name is None:
             raise ValueError(
                 "Must provide either the `azure_deployment_name` argument "
                 "or `AZURE_DEPLOYMENT_NAME` environment variable."
@@ -95,18 +109,22 @@ class AzureOpenAIModel(BaseModelBackend):
 
         self._client = AzureOpenAI(
             azure_endpoint=str(self._url),
-            azure_deployment=self.azure_deployment_name,
+            azure_deployment=self._azure_deployment_name,
             api_version=self.api_version,
             api_key=self._api_key,
+            azure_ad_token=self._azure_ad_token,
+            azure_ad_token_provider=self.azure_ad_token_provider,
             timeout=self._timeout,
             max_retries=3,
         )
 
         self._async_client = AsyncAzureOpenAI(
             azure_endpoint=str(self._url),
-            azure_deployment=self.azure_deployment_name,
+            azure_deployment=self._azure_deployment_name,
             api_version=self.api_version,
             api_key=self._api_key,
+            azure_ad_token=self._azure_ad_token,
+            azure_ad_token_provider=self.azure_ad_token_provider,
             timeout=self._timeout,
             max_retries=3,
         )
@@ -193,7 +211,7 @@ class AzureOpenAIModel(BaseModelBackend):
 
         return self._client.chat.completions.create(
             messages=messages,
-            model=self.azure_deployment_name,  # type:ignore[arg-type]
+            model=self._azure_deployment_name,  # type:ignore[arg-type]
             **request_config,
         )
 
@@ -209,7 +227,7 @@ class AzureOpenAIModel(BaseModelBackend):
 
         return await self._async_client.chat.completions.create(
             messages=messages,
-            model=self.azure_deployment_name,  # type:ignore[arg-type]
+            model=self._azure_deployment_name,  # type:ignore[arg-type]
             **request_config,
         )
 
@@ -232,7 +250,7 @@ class AzureOpenAIModel(BaseModelBackend):
 
         return self._client.beta.chat.completions.parse(
             messages=messages,
-            model=self.azure_deployment_name,  # type:ignore[arg-type]
+            model=self._azure_deployment_name,  # type:ignore[arg-type]
             **request_config,
         )
 
@@ -255,7 +273,7 @@ class AzureOpenAIModel(BaseModelBackend):
 
         return await self._async_client.beta.chat.completions.parse(
             messages=messages,
-            model=self.azure_deployment_name,  # type:ignore[arg-type]
+            model=self._azure_deployment_name,  # type:ignore[arg-type]
             **request_config,
         )
 

camel/models/model_factory.py

@@ -32,6 +32,7 @@ from camel.models.mistral_model import MistralModel
 from camel.models.modelscope_model import ModelScopeModel
 from camel.models.moonshot_model import MoonshotModel
 from camel.models.netmind_model import NetmindModel
+from camel.models.novita_model import NovitaModel
 from camel.models.nvidia_model import NvidiaModel
 from camel.models.ollama_model import OllamaModel
 from camel.models.openai_compatible_model import OpenAICompatibleModel
@@ -47,6 +48,7 @@ from camel.models.stub_model import StubModel
 from camel.models.togetherai_model import TogetherAIModel
 from camel.models.vllm_model import VLLMModel
 from camel.models.volcano_model import VolcanoModel
+from camel.models.watsonx_model import WatsonXModel
 from camel.models.yi_model import YiModel
 from camel.models.zhipuai_model import ZhipuAIModel
 from camel.types import ModelPlatformType, ModelType, UnifiedModelType
@@ -62,8 +64,8 @@ class ModelFactory:
 
     @staticmethod
     def create(
-        model_platform: ModelPlatformType,
-        model_type: Union[ModelType, str],
+        model_platform: Union[ModelPlatformType, str],
+        model_type: Union[ModelType, str, UnifiedModelType],
         model_config_dict: Optional[Dict] = None,
         token_counter: Optional[BaseTokenCounter] = None,
         api_key: Optional[str] = None,
@@ -73,10 +75,12 @@ class ModelFactory:
         r"""Creates an instance of `BaseModelBackend` of the specified type.
 
         Args:
-            model_platform (ModelPlatformType): Platform from which the model
-                originates.
-            model_type (Union[ModelType, str]): Model for which a
-                backend is created. Can be a `str` for open source platforms.
+            model_platform (Union[ModelPlatformType, str]): Platform from
+                which the model originates. Can be a string or
+                ModelPlatformType enum.
+            model_type (Union[ModelType, str, UnifiedModelType]): Model for
+                which a backend is created. Can be a string, ModelType enum, or
+                UnifiedModelType.
             model_config_dict (Optional[Dict]): A dictionary that will be fed
                 into the backend constructor. (default: :obj:`None`)
             token_counter (Optional[BaseTokenCounter], optional): Token
@@ -97,6 +101,21 @@ class ModelFactory:
         Raises:
             ValueError: If there is no backend for the model.
         """
+        # Convert string to ModelPlatformType enum if needed
+        if isinstance(model_platform, str):
+            try:
+                model_platform = ModelPlatformType(model_platform)
+            except ValueError:
+                raise ValueError(f"Unknown model platform: {model_platform}")
+
+        # Convert string to ModelType enum or UnifiedModelType if needed
+        if isinstance(model_type, str):
+            try:
+                model_type = ModelType(model_type)
+            except ValueError:
+                # If not in ModelType, create a UnifiedModelType
+                model_type = UnifiedModelType(model_type)
+
         model_class: Optional[Type[BaseModelBackend]] = None
         model_type = UnifiedModelType(model_type)
 
@@ -163,8 +182,12 @@ class ModelFactory:
             model_class = MoonshotModel
         elif model_platform.is_modelscope:
             model_class = ModelScopeModel
+        elif model_platform.is_novita:
+            model_class = NovitaModel
         elif model_type == ModelType.STUB:
             model_class = StubModel
+        elif model_type.is_watsonx:
+            model_class = WatsonXModel
 
         if model_class is None:
             raise ValueError(

camel/models/modelscope_model.py

@@ -13,11 +13,19 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
-from typing import Any, Dict, Optional, Union
+import time
+from typing import Any, Dict, List, Optional, Union
+
+from openai import AsyncStream, Stream
 
 from camel.configs import MODELSCOPE_API_PARAMS, ModelScopeConfig
+from camel.messages import OpenAIMessage
 from camel.models.openai_compatible_model import OpenAICompatibleModel
-from camel.types import ModelType
+from camel.types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    ModelType,
+)
 from camel.utils import (
     BaseTokenCounter,
     api_keys_required,
@@ -81,6 +89,171 @@ class ModelScopeModel(OpenAICompatibleModel):
             timeout=timeout,
         )
 
+    def _post_handle_response(
+        self, response: Union[ChatCompletion, Stream[ChatCompletionChunk]]
+    ) -> ChatCompletion:
+        r"""Handle reasoning content with <think> tags at the beginning."""
+        if not isinstance(response, Stream):
+            # Handle non-streaming response (existing logic)
+            if self.model_config_dict.get("extra_body", {}).get(
+                "enable_thinking", False
+            ):
+                reasoning_content = response.choices[
+                    0
+                ].message.reasoning_content  # type: ignore[attr-defined]
+                combined_content = (
+                    f"<think>\n{reasoning_content}\n</think>\n"
+                    if reasoning_content
+                    else ""
+                )
+                response_content = response.choices[0].message.content or ""
+                combined_content += response_content
+
+                # Construct a new ChatCompletion with combined content
+                return ChatCompletion.construct(
+                    id=response.id,
+                    choices=[
+                        dict(
+                            finish_reason=response.choices[0].finish_reason,
+                            index=response.choices[0].index,
+                            logprobs=response.choices[0].logprobs,
+                            message=dict(
+                                role=response.choices[0].message.role,
+                                content=combined_content,
+                            ),
+                        )
+                    ],
+                    created=response.created,
+                    model=response.model,
+                    object="chat.completion",
+                    system_fingerprint=response.system_fingerprint,
+                    usage=response.usage,
+                )
+            else:
+                return response  # Return original if no thinking enabled
+
+        # Handle streaming response
+        accumulated_reasoning = ""
+        accumulated_content = ""
+        final_chunk = None
+        usage_data = None  # Initialize usage data
+        role = "assistant"  # Default role
+
+        for chunk in response:
+            final_chunk = chunk  # Keep track of the last chunk for metadata
+            if chunk.choices:
+                delta = chunk.choices[0].delta
+                if delta.role:
+                    role = delta.role  # Update role if provided
+                if (
+                    hasattr(delta, 'reasoning_content')
+                    and delta.reasoning_content
+                ):
+                    accumulated_reasoning += delta.reasoning_content
+                if delta.content:
+                    accumulated_content += delta.content
+
+            if hasattr(chunk, 'usage') and chunk.usage:
+                usage_data = chunk.usage
+
+        combined_content = (
+            f"<think>\n{accumulated_reasoning}\n</think>\n"
+            if accumulated_reasoning
+            else ""
+        ) + accumulated_content
+
+        # Construct the final ChatCompletion object from accumulated
+        # stream data
+        if final_chunk:
+            finish_reason = "stop"  # Default finish reason
+            logprobs = None
+            if final_chunk.choices:
+                finish_reason = (
+                    final_chunk.choices[0].finish_reason or finish_reason
+                )
+                if hasattr(final_chunk.choices[0], 'logprobs'):
+                    logprobs = final_chunk.choices[0].logprobs
+
+            return ChatCompletion.construct(
+                # Use data from the final chunk or defaults
+                id=final_chunk.id
+                if hasattr(final_chunk, 'id')
+                else "streamed-completion",
+                choices=[
+                    dict(
+                        finish_reason=finish_reason,
+                        index=0,
+                        logprobs=logprobs,
+                        message=dict(
+                            role=role,
+                            content=combined_content,
+                        ),
+                    )
+                ],
+                created=final_chunk.created
+                if hasattr(final_chunk, 'created')
+                else int(time.time()),
+                model=final_chunk.model
+                if hasattr(final_chunk, 'model')
+                else self.model_type,
+                object="chat.completion",
+                system_fingerprint=final_chunk.system_fingerprint
+                if hasattr(final_chunk, 'system_fingerprint')
+                else None,
+                usage=usage_data,
+            )
+        else:
+            # Handle cases where the stream was empty or invalid
+            return ChatCompletion.construct(
+                id="empty-stream",
+                choices=[
+                    dict(
+                        finish_reason="error",
+                        index=0,
+                        message=dict(role="assistant", content=""),
+                    )
+                ],
+                created=int(time.time()),
+                model=self.model_type,
+                object="chat.completion",
+                usage=usage_data,
+            )
+
+    def _request_chat_completion(
+        self,
+        messages: List[OpenAIMessage],
+        tools: Optional[List[Dict[str, Any]]] = None,
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        request_config = self.model_config_dict.copy()
+
+        if tools:
+            request_config["tools"] = tools
+
+        return self._post_handle_response(
+            self._client.chat.completions.create(
+                messages=messages,
+                model=self.model_type,
+                **request_config,
+            )
+        )
+
+    async def _arequest_chat_completion(
+        self,
+        messages: List[OpenAIMessage],
+        tools: Optional[List[Dict[str, Any]]] = None,
+    ) -> Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
+        request_config = self.model_config_dict.copy()
+
+        if tools:
+            request_config["tools"] = tools
+
+        response = await self._async_client.chat.completions.create(
+            messages=messages,
+            model=self.model_type,
+            **request_config,
+        )
+        return self._post_handle_response(response)
+
     def check_model_config(self):
         r"""Check whether the model configuration contains any
         unexpected arguments to ModelScope API.

camel/models/novita_model.py

@@ -0,0 +1,95 @@
+# ========= 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 os
+from typing import Any, Dict, Optional, Union
+
+from camel.configs import NOVITA_API_PARAMS, NovitaConfig
+from camel.models.openai_compatible_model import OpenAICompatibleModel
+from camel.types import ModelType
+from camel.utils import (
+    BaseTokenCounter,
+    api_keys_required,
+)
+
+
+class NovitaModel(OpenAICompatibleModel):
+    r"""Constructor for Novita backend with OpenAI compatibility.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created, supported model can be found here:
+            https://novita.ai/models?utm_source=github_owl&utm_campaign=github_link
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into:obj:`openai.ChatCompletion.create()`. If
+            :obj:`None`, :obj:`NovitaConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the Novita service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the Novita service.
+            If not provided, "https://api.novita.ai/v3/openai" will be used.
+            (default: :obj:`None`)
+        token_counter (Optional[BaseTokenCounter], optional): Token counter to
+            use for the model. If not provided, :obj:`OpenAITokenCounter(
+            ModelType.GPT_4O_MINI)` will be used.
+        timeout (Optional[float], optional): The timeout value in seconds for
+            API calls. If not provided, will fall back to the MODEL_TIMEOUT
+            environment variable or default to 180 seconds.
+            (default: :obj:`None`)
+    """
+
+    @api_keys_required(
+        [
+            ("api_key", 'NOVITA_API_KEY'),
+        ]
+    )
+    def __init__(
+        self,
+        model_type: Union[ModelType, str],
+        model_config_dict: Optional[Dict[str, Any]] = None,
+        api_key: Optional[str] = None,
+        url: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
+        timeout: Optional[float] = None,
+    ) -> None:
+        if model_config_dict is None:
+            model_config_dict = NovitaConfig().as_dict()
+        api_key = api_key or os.environ.get("NOVITA_API_KEY")
+        url = url or os.environ.get(
+            "NOVITA_API_BASE_URL", "https://api.novita.ai/v3/openai"
+        )
+        timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
+        super().__init__(
+            model_type=model_type,
+            model_config_dict=model_config_dict,
+            api_key=api_key,
+            url=url,
+            token_counter=token_counter,
+            timeout=timeout,
+        )
+
+    def check_model_config(self):
+        r"""Check whether the model configuration contains any
+        unexpected arguments to Novita API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to Novita API.
+        """
+        for param in self.model_config_dict:
+            if param not in NOVITA_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into Novita model backend."
+                )

camel/models/ollama_model.py

@@ -16,10 +16,13 @@ import subprocess
 from typing import Any, Dict, Optional, Union
 
 from camel.configs import OLLAMA_API_PARAMS, OllamaConfig
+from camel.logger import get_logger
 from camel.models.openai_compatible_model import OpenAICompatibleModel
 from camel.types import ModelType
 from camel.utils import BaseTokenCounter
 
+logger = get_logger(__name__)
+
 
 class OllamaModel(OpenAICompatibleModel):
     r"""Ollama service interface.
@@ -60,20 +63,22 @@ class OllamaModel(OpenAICompatibleModel):
     ) -> None:
         if model_config_dict is None:
             model_config_dict = OllamaConfig().as_dict()
-        url = url or os.environ.get("OLLAMA_BASE_URL")
+        self._url = url or os.environ.get("OLLAMA_BASE_URL")
         timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
+        self._model_type = model_type
+
+        if not self._url:
+            self._start_server()
+
         super().__init__(
-            model_type=model_type,
+            model_type=self._model_type,
             model_config_dict=model_config_dict,
-            api_key=api_key,
-            url=url,
+            api_key="Not_Used",
+            url=self._url,
             token_counter=token_counter,
             timeout=timeout,
         )
 
-        if not self._url:
-            self._start_server()
-
     def _start_server(self) -> None:
         r"""Starts the Ollama server in a subprocess."""
         try:
@@ -83,12 +88,12 @@ class OllamaModel(OpenAICompatibleModel):
                 stderr=subprocess.PIPE,
             )
             self._url = "http://localhost:11434/v1"
-            print(
+            logger.info(
                 f"Ollama server started on {self._url} "
-                f"for {self.model_type} model."
+                f"for {self._model_type} model."
             )
         except Exception as e:
-            print(f"Failed to start Ollama server: {e}.")
+            logger.error(f"Failed to start Ollama server: {e}.")
 
     def check_model_config(self):
         r"""Check whether the model configuration contains any