camel-ai 0.1.8__tar.gz → 0.2.0__tar.gz

{camel_ai-0.1.8 → camel_ai-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: camel-ai
-Version: 0.1.8
+Version: 0.2.0
 Summary: Communicative Agents for AI Society Study
 Home-page: https://www.camel-ai.org/
 License: Apache-2.0
@@ -56,9 +56,10 @@ Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "graph-storages" or extra == "
 Requires-Dist: newspaper3k (>=0.2.8,<0.3.0) ; extra == "tools" or extra == "all"
 Requires-Dist: nltk (==3.8.1) ; extra == "tools" or extra == "all"
 Requires-Dist: numpy (>=1,<2)
-Requires-Dist: openai (>=1.2.3,<2.0.0)
+Requires-Dist: openai (>=1.45.0,<2.0.0)
 Requires-Dist: openapi-spec-validator (>=0.7.1,<0.8.0) ; extra == "tools" or extra == "all"
 Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
+Requires-Dist: pandoc
 Requires-Dist: pathlib (>=1.0.1,<2.0.0)
 Requires-Dist: pillow (>=10.2.0,<11.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: prance (>=23.6.21.0,<24.0.0.0) ; extra == "tools" or extra == "all"
@@ -213,7 +214,7 @@ conda create --name camel python=3.10
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.8 https://github.com/camel-ai/camel.git
+git clone -b v0.2.0 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel

{camel_ai-0.1.8 → camel_ai-0.2.0}/README.md

@@ -119,7 +119,7 @@ conda create --name camel python=3.10
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.8 https://github.com/camel-ai/camel.git
+git clone -b v0.2.0 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/__init__.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 
-__version__ = '0.1.8'
+__version__ = '0.2.0'
 
 __all__ = [
     '__version__',

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/agents/chat_agent.py

@@ -181,6 +181,16 @@ class ChatAgent(BaseAgent):
             tool.get_function_name(): tool.func for tool in all_tools
         }
 
+        # If the user hasn't configured tools in `BaseModelBackend`,
+        # the tools set from `ChatAgent` will be used.
+        # This design simplifies the interface while retaining tool-running
+        # capabilities for `BaseModelBackend`.
+        if all_tools and not self.model_backend.model_config_dict['tools']:
+            tool_schema_list = [
+                tool.get_openai_tool_schema() for tool in all_tools
+            ]
+            self.model_backend.model_config_dict['tools'] = tool_schema_list
+
         self.model_config_dict = self.model_backend.model_config_dict
 
         self.model_token_limit = token_limit or self.model_backend.token_limit

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/configs/__init__.py

@@ -21,8 +21,10 @@ from .ollama_config import OLLAMA_API_PARAMS, OllamaConfig
 from .openai_config import OPENAI_API_PARAMS, ChatGPTConfig, OpenSourceConfig
 from .reka_config import REKA_API_PARAMS, RekaConfig
 from .samba_config import (
+    SAMBA_CLOUD_API_PARAMS,
     SAMBA_FAST_API_PARAMS,
     SAMBA_VERSE_API_PARAMS,
+    SambaCloudAPIConfig,
     SambaFastAPIConfig,
     SambaVerseAPIConfig,
 )
@@ -57,6 +59,8 @@ __all__ = [
     'SAMBA_FAST_API_PARAMS',
     'SambaVerseAPIConfig',
     'SAMBA_VERSE_API_PARAMS',
+    'SambaCloudAPIConfig',
+    'SAMBA_CLOUD_API_PARAMS',
     'TogetherAIConfig',
     'TOGETHERAI_API_PARAMS',
 ]

camel_ai-0.2.0/camel/configs/samba_config.py

@@ -0,0 +1,207 @@
+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+from __future__ import annotations
+
+from typing import Any, Dict, Optional, Sequence, Union
+
+from openai._types import NOT_GIVEN, NotGiven
+from pydantic import Field
+
+from camel.configs.base_config import BaseConfig
+
+
+class SambaFastAPIConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using the
+    SambaNova Fast API.
+
+    Args:
+        max_tokens (Optional[int], optional): the maximum number of tokens to
+            generate, e.g. 100.
+            (default: :obj:`2048`)
+        stop (Optional[Union[str,list[str]]]): Stop generation if this token
+            is detected. Or if one of these tokens is detected when providing
+            a string list.
+            (default: :obj:`None`)
+        stream (Optional[bool]): If True, partial message deltas will be sent
+            as data-only server-sent events as they become available.
+            Currently SambaNova Fast API only support stream mode.
+            (default: :obj:`True`)
+        stream_options (Optional[Dict]): Additional options for streaming.
+            (default: :obj:`{"include_usage": True}`)
+    """
+
+    max_tokens: Optional[int] = 2048
+    stop: Optional[Union[str, list[str]]] = None
+    stream: Optional[bool] = True
+    stream_options: Optional[Dict] = {"include_usage": True}  # noqa: RUF012
+
+    def as_dict(self) -> dict[str, Any]:
+        config_dict = super().as_dict()
+        if "tools" in config_dict:
+            del config_dict["tools"]  # SambaNova does not support tool calling
+        return config_dict
+
+
+SAMBA_FAST_API_PARAMS = {
+    param for param in SambaFastAPIConfig().model_fields.keys()
+}
+
+
+class SambaVerseAPIConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using the
+    SambaVerse API.
+
+    Args:
+        temperature (float, optional): Sampling temperature to use, between
+            :obj:`0` and :obj:`2`. Higher values make the output more random,
+            while lower values make it more focused and deterministic.
+            (default: :obj:`0.7`)
+        top_p (float, optional): An alternative to sampling with temperature,
+            called nucleus sampling, where the model considers the results of
+            the tokens with top_p probability mass. So :obj:`0.1` means only
+            the tokens comprising the top 10% probability mass are considered.
+            (default: :obj:`0.95`)
+        top_k (int, optional): Only sample from the top K options for each
+            subsequent token. Used to remove "long tail" low probability
+            responses.
+            (default: :obj:`50`)
+        max_tokens (Optional[int], optional): The maximum number of tokens to
+            generate, e.g. 100.
+            (default: :obj:`2048`)
+        repetition_penalty (Optional[float], optional): The parameter for
+            repetition penalty. 1.0 means no penalty.
+            (default: :obj:`1.0`)
+        stop (Optional[Union[str,list[str]]]): Stop generation if this token
+            is detected. Or if one of these tokens is detected when providing
+            a string list.
+            (default: :obj:`""`)
+        stream (Optional[bool]): If True, partial message deltas will be sent
+            as data-only server-sent events as they become available.
+            Currently SambaVerse API doesn't support stream mode.
+            (default: :obj:`False`)
+    """
+
+    temperature: Optional[float] = 0.7
+    top_p: Optional[float] = 0.95
+    top_k: Optional[int] = 50
+    max_tokens: Optional[int] = 2048
+    repetition_penalty: Optional[float] = 1.0
+    stop: Optional[Union[str, list[str]]] = ""
+    stream: Optional[bool] = False
+
+    def as_dict(self) -> dict[str, Any]:
+        config_dict = super().as_dict()
+        if "tools" in config_dict:
+            del config_dict["tools"]  # SambaNova does not support tool calling
+        return config_dict
+
+
+SAMBA_VERSE_API_PARAMS = {
+    param for param in SambaVerseAPIConfig().model_fields.keys()
+}
+
+
+class SambaCloudAPIConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using the
+    OpenAI API.
+
+    Args:
+        temperature (float, optional): Sampling temperature to use, between
+            :obj:`0` and :obj:`2`. Higher values make the output more random,
+            while lower values make it more focused and deterministic.
+            (default: :obj:`0.2`)
+        top_p (float, optional): An alternative to sampling with temperature,
+            called nucleus sampling, where the model considers the results of
+            the tokens with top_p probability mass. So :obj:`0.1` means only
+            the tokens comprising the top 10% probability mass are considered.
+            (default: :obj:`1.0`)
+        n (int, optional): How many chat completion choices to generate for
+            each input message. (default: :obj:`1`)
+        response_format (object, optional): An object specifying the format
+            that the model must output. Compatible with GPT-4 Turbo and all
+            GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106. Setting to
+            {"type": "json_object"} enables JSON mode, which guarantees the
+            message the model generates is valid JSON. Important: when using
+            JSON mode, you must also instruct the model to produce JSON
+            yourself via a system or user message. Without this, the model
+            may generate an unending stream of whitespace until the generation
+            reaches the token limit, resulting in a long-running and seemingly
+            "stuck" request. Also note that the message content may be
+            partially cut off if finish_reason="length", which indicates the
+            generation exceeded max_tokens or the conversation exceeded the
+            max context length.
+        stream (bool, optional): If True, partial message deltas will be sent
+            as data-only server-sent events as they become available.
+            (default: :obj:`False`)
+        stop (str or list, optional): Up to :obj:`4` sequences where the API
+            will stop generating further tokens. (default: :obj:`None`)
+        max_tokens (int, optional): The maximum number of tokens to generate
+            in the chat completion. The total length of input tokens and
+            generated tokens is limited by the model's context length.
+            (default: :obj:`None`)
+        presence_penalty (float, optional): Number between :obj:`-2.0` and
+            :obj:`2.0`. Positive values penalize new tokens based on whether
+            they appear in the text so far, increasing the model's likelihood
+            to talk about new topics. See more information about frequency and
+            presence penalties. (default: :obj:`0.0`)
+        frequency_penalty (float, optional): Number between :obj:`-2.0` and
+            :obj:`2.0`. Positive values penalize new tokens based on their
+            existing frequency in the text so far, decreasing the model's
+            likelihood to repeat the same line verbatim. See more information
+            about frequency and presence penalties. (default: :obj:`0.0`)
+        logit_bias (dict, optional): Modify the likelihood of specified tokens
+            appearing in the completion. Accepts a json object that maps tokens
+            (specified by their token ID in the tokenizer) to an associated
+            bias value from :obj:`-100` to :obj:`100`. Mathematically, the bias
+            is added to the logits generated by the model prior to sampling.
+            The exact effect will vary per model, but values between:obj:` -1`
+            and :obj:`1` should decrease or increase likelihood of selection;
+            values like :obj:`-100` or :obj:`100` should result in a ban or
+            exclusive selection of the relevant token. (default: :obj:`{}`)
+        user (str, optional): A unique identifier representing your end-user,
+            which can help OpenAI to monitor and detect abuse.
+            (default: :obj:`""`)
+        tools (list[OpenAIFunction], optional): A list of tools the model may
+            call. Currently, only functions are supported as a tool. Use this
+            to provide a list of functions the model may generate JSON inputs
+            for. A max of 128 functions are supported.
+        tool_choice (Union[dict[str, str], str], optional): Controls which (if
+            any) tool is called by the model. :obj:`"none"` means the model
+            will not call any tool and instead generates a message.
+            :obj:`"auto"` means the model can pick between generating a
+            message or calling one or more tools.  :obj:`"required"` means the
+            model must call one or more tools. Specifying a particular tool
+            via {"type": "function", "function": {"name": "my_function"}}
+            forces the model to call that tool. :obj:`"none"` is the default
+            when no tools are present. :obj:`"auto"` is the default if tools
+            are present.
+    """
+
+    temperature: float = 0.2  # openai default: 1.0
+    top_p: float = 1.0
+    n: int = 1
+    stream: bool = False
+    stop: Union[str, Sequence[str], NotGiven] = NOT_GIVEN
+    max_tokens: Union[int, NotGiven] = NOT_GIVEN
+    presence_penalty: float = 0.0
+    response_format: Union[dict, NotGiven] = NOT_GIVEN
+    frequency_penalty: float = 0.0
+    logit_bias: dict = Field(default_factory=dict)
+    user: str = ""
+    tool_choice: Optional[Union[dict[str, str], str]] = None
+
+
+SAMBA_CLOUD_API_PARAMS = {
+    param for param in SambaCloudAPIConfig().model_fields.keys()
+}

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/models/ollama_model.py

@@ -76,10 +76,10 @@ class OllamaModel:
             )
             print(
                 f"Ollama server started on http://localhost:11434/v1 "
-                f"for {self.model_type} model"
+                f"for {self.model_type} model."
             )
         except Exception as e:
-            print(f"Failed to start Ollama server: {e}")
+            print(f"Failed to start Ollama server: {e}.")
 
     @property
     def token_counter(self) -> BaseTokenCounter:

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/models/openai_model.py

@@ -93,6 +93,22 @@ class OpenAIModel(BaseModelBackend):
                 `ChatCompletion` in the non-stream mode, or
                 `Stream[ChatCompletionChunk]` in the stream mode.
         """
+        # 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]:
+            # Remove system message that is not supported in o1 model.
+            messages = [msg for msg in messages if msg.get("role") != "system"]
+
+            # Remove unsupported parameters and reset the fixed parameters
+            del self.model_config_dict["stream"]
+            del self.model_config_dict["tools"]
+            del self.model_config_dict["tool_choice"]
+            self.model_config_dict["temperature"] = 1.0
+            self.model_config_dict["top_p"] = 1.0
+            self.model_config_dict["n"] = 1.0
+            self.model_config_dict["presence_penalty"] = 0.0
+            self.model_config_dict["frequency_penalty"] = 0.0
+
         response = self._client.chat.completions.create(
             messages=messages,
             model=self.model_type.value,

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/models/samba_model.py

@@ -20,7 +20,11 @@ from typing import Any, Dict, List, Optional, Union
 import httpx
 from openai import OpenAI, Stream
 
-from camel.configs import SAMBA_FAST_API_PARAMS, SAMBA_VERSE_API_PARAMS
+from camel.configs import (
+    SAMBA_CLOUD_API_PARAMS,
+    SAMBA_FAST_API_PARAMS,
+    SAMBA_VERSE_API_PARAMS,
+)
 from camel.messages import OpenAIMessage
 from camel.types import (
     ChatCompletion,
@@ -59,9 +63,10 @@ class SambaModel:
                 SambaNova service. (default: :obj:`None`)
             url (Optional[str]): The url to the SambaNova service. Current
                 support SambaNova Fast API: :obj:`"https://fast-api.snova.ai/
-                v1/chat/ completions"` and SambaVerse API: :obj:`"https://
-                sambaverse.sambanova.ai/api/predict"`. (default::obj:`"https://
-                fast-api.snova.ai/v1/chat/completions"`)
+                v1/chat/ completions"`, SambaVerse API: :obj:`"https://
+                sambaverse.sambanova.ai/api/predict"` and SambaNova Cloud:
+                :obj:`"https://api.sambanova.ai/v1"`
+                (default::obj:`"https://fast-api.snova.ai/v1/chat/completions"`)
             token_counter (Optional[BaseTokenCounter]): Token counter to use
                 for the model. If not provided, `OpenAITokenCounter(ModelType.
                 GPT_4O_MINI)` will be used.
@@ -76,6 +81,14 @@ class SambaModel:
         self.model_config_dict = model_config_dict
         self.check_model_config()
 
+        if self._url == "https://api.sambanova.ai/v1":
+            self._client = OpenAI(
+                timeout=60,
+                max_retries=3,
+                base_url=self._url,
+                api_key=self._api_key,
+            )
+
     @property
     def token_counter(self) -> BaseTokenCounter:
         r"""Initialize the token counter for the model backend.
@@ -111,6 +124,14 @@ class SambaModel:
                         "input into SambaVerse API."
                     )
 
+        elif self._url == "https://api.sambanova.ai/v1":
+            for param in self.model_config_dict:
+                if param not in SAMBA_CLOUD_API_PARAMS:
+                    raise ValueError(
+                        f"Unexpected argument `{param}` is "
+                        "input into SambaCloud API."
+                    )
+
         else:
             raise ValueError(
                 f"{self._url} is not supported, please check the url to the"
@@ -141,7 +162,7 @@ class SambaModel:
     def _run_streaming(  # type: ignore[misc]
         self, messages: List[OpenAIMessage]
     ) -> Stream[ChatCompletionChunk]:
-        r"""Handles streaming inference with SambaNova FastAPI.
+        r"""Handles streaming inference with SambaNova's API.
 
         Args:
             messages (List[OpenAIMessage]): A list of messages representing the
@@ -189,6 +210,15 @@ class SambaModel:
             except httpx.HTTPError as e:
                 raise RuntimeError(f"HTTP request failed: {e!s}")
 
+        # Handle SambaNova's Cloud API
+        elif self._url == "https://api.sambanova.ai/v1":
+            response = self._client.chat.completions.create(
+                messages=messages,
+                model=self.model_type,
+                **self.model_config_dict,
+            )
+            return response
+
         elif self._url == "https://sambaverse.sambanova.ai/api/predict":
             raise ValueError(
                 "https://sambaverse.sambanova.ai/api/predict doesn't support"
@@ -198,7 +228,7 @@ class SambaModel:
     def _run_non_streaming(
         self, messages: List[OpenAIMessage]
     ) -> ChatCompletion:
-        r"""Handles non-streaming inference with SambaNova FastAPI.
+        r"""Handles non-streaming inference with SambaNova's API.
 
         Args:
             messages (List[OpenAIMessage]): A list of messages representing the
@@ -251,6 +281,15 @@ class SambaModel:
             except json.JSONDecodeError as e:
                 raise ValueError(f"Failed to decode JSON response: {e!s}")
 
+        # Handle SambaNova's Cloud API
+        elif self._url == "https://api.sambanova.ai/v1":
+            response = self._client.chat.completions.create(
+                messages=messages,
+                model=self.model_type,
+                **self.model_config_dict,
+            )
+            return response
+
         # Handle SambaNova's Sambaverse API
         else:
             headers = {

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/models/vllm_model.py

@@ -80,10 +80,10 @@ class VLLMModel:
             )
             print(
                 f"vllm server started on http://localhost:8000/v1 "
-                f"for {self.model_type} model"
+                f"for {self.model_type} model."
             )
         except Exception as e:
-            print(f"Failed to start vllm server: {e}")
+            print(f"Failed to start vllm server: {e}.")
 
     @property
     def token_counter(self) -> BaseTokenCounter:

{camel_ai-0.1.8 → camel_ai-0.2.0}/camel/toolkits/__init__.py

@@ -19,19 +19,18 @@ from .openai_function import (
 )
 from .open_api_specs.security_config import openapi_security_config
 
-from .google_maps_toolkit import MAP_FUNCS, GoogleMapsToolkit
-from .math_toolkit import MATH_FUNCS, MathToolkit
-from .open_api_toolkit import OPENAPI_FUNCS, OpenAPIToolkit
-from .retrieval_toolkit import RETRIEVAL_FUNCS, RetrievalToolkit
-from .search_toolkit import SEARCH_FUNCS, SearchToolkit
-from .twitter_toolkit import TWITTER_FUNCS, TwitterToolkit
-from .weather_toolkit import WEATHER_FUNCS, WeatherToolkit
-from .slack_toolkit import SLACK_FUNCS, SlackToolkit
-from .dalle_toolkit import DALLE_FUNCS, DalleToolkit
-from .linkedin_toolkit import LINKEDIN_FUNCS, LinkedInToolkit
-from .reddit_toolkit import REDDIT_FUNCS, RedditToolkit
+from .google_maps_toolkit import GoogleMapsToolkit
+from .math_toolkit import MathToolkit, MATH_FUNCS
+from .open_api_toolkit import OpenAPIToolkit
+from .retrieval_toolkit import RetrievalToolkit
+from .search_toolkit import SearchToolkit, SEARCH_FUNCS
+from .twitter_toolkit import TwitterToolkit
+from .weather_toolkit import WeatherToolkit, WEATHER_FUNCS
+from .slack_toolkit import SlackToolkit
+from .dalle_toolkit import DalleToolkit, DALLE_FUNCS
+from .linkedin_toolkit import LinkedInToolkit
+from .reddit_toolkit import RedditToolkit
 
-from .base import BaseToolkit
 from .code_execution import CodeExecutionToolkit
 from .github_toolkit import GithubToolkit
 
@@ -40,18 +39,6 @@ __all__ = [
     'get_openai_function_schema',
     'get_openai_tool_schema',
     'openapi_security_config',
-    'MATH_FUNCS',
-    'MAP_FUNCS',
-    'OPENAPI_FUNCS',
-    'RETRIEVAL_FUNCS',
-    'SEARCH_FUNCS',
-    'TWITTER_FUNCS',
-    'WEATHER_FUNCS',
-    'SLACK_FUNCS',
-    'DALLE_FUNCS',
-    'LINKEDIN_FUNCS',
-    'REDDIT_FUNCS',
-    'BaseToolkit',
     'GithubToolkit',
     'MathToolkit',
     'GoogleMapsToolkit',
@@ -65,4 +52,8 @@ __all__ = [
     'LinkedInToolkit',
     'RedditToolkit',
     'CodeExecutionToolkit',
+    'MATH_FUNCS',
+    'SEARCH_FUNCS',
+    'WEATHER_FUNCS',
+    'DALLE_FUNCS',
 ]