camel-ai 0.2.45__py3-none-any.whl → 0.2.47__py3-none-any.whl

camel/__init__.py

@@ -14,7 +14,7 @@
 
 from camel.logger import disable_logging, enable_logging, set_log_level
 
-__version__ = '0.2.45'
+__version__ = '0.2.47'
 
 __all__ = [
     '__version__',

camel/configs/__init__.py

@@ -14,12 +14,14 @@
 from .aiml_config import AIML_API_PARAMS, AIMLConfig
 from .anthropic_config import ANTHROPIC_API_PARAMS, AnthropicConfig
 from .base_config import BaseConfig
+from .bedrock_config import BEDROCK_API_PARAMS, BedrockConfig
 from .cohere_config import COHERE_API_PARAMS, CohereConfig
 from .deepseek_config import DEEPSEEK_API_PARAMS, DeepSeekConfig
 from .gemini_config import Gemini_API_PARAMS, GeminiConfig
 from .groq_config import GROQ_API_PARAMS, GroqConfig
 from .internlm_config import INTERNLM_API_PARAMS, InternLMConfig
 from .litellm_config import LITELLM_API_PARAMS, LiteLLMConfig
+from .lmstudio_config import LMSTUDIO_API_PARAMS, LMStudioConfig
 from .mistral_config import MISTRAL_API_PARAMS, MistralConfig
 from .modelscope_config import MODELSCOPE_API_PARAMS, ModelScopeConfig
 from .moonshot_config import MOONSHOT_API_PARAMS, MoonshotConfig
@@ -81,6 +83,8 @@ __all__ = [
     'YI_API_PARAMS',
     'QwenConfig',
     'QWEN_API_PARAMS',
+    'BedrockConfig',
+    'BEDROCK_API_PARAMS',
     'DeepSeekConfig',
     'DEEPSEEK_API_PARAMS',
     'PPIOConfig',
@@ -97,4 +101,6 @@ __all__ = [
     'AIML_API_PARAMS',
     'OpenRouterConfig',
     'OPENROUTER_API_PARAMS',
+    'LMSTUDIO_API_PARAMS',
+    'LMStudioConfig',
 ]

camel/configs/bedrock_config.py

@@ -0,0 +1,73 @@
+# ========= 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. =========
+from typing import Dict, Optional, Union
+
+from camel.configs.base_config import BaseConfig
+
+
+class BedrockConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using OpenAI
+    compatibility.
+
+    Args:
+        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`)
+        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:`None`)
+        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:`None`)
+        top_k (int, optional): The number of top tokens to consider.
+        stream (bool, optional): If True, partial message deltas will be sent
+            as data-only server-sent events as they become available.
+            (default: :obj:`None`)
+        tools (list[FunctionTool], 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.
+        reasoning_effort(str, optional): A parameter specifying the level of
+            reasoning used by certain model types. Valid values are :obj:
+            `"low"`, :obj:`"medium"`, or :obj:`"high"`. If set, it is only
+            applied to the model types that support it (e.g., :obj:`o1`,
+            :obj:`o1mini`, :obj:`o1preview`, :obj:`o3mini`). If not provided
+            or if the model type does not support it, this parameter is
+            ignored. (default: :obj:`None`)
+    """
+
+    max_tokens: Optional[int] = None
+    temperature: Optional[float] = None
+    top_p: Optional[float] = None
+    top_k: Optional[int] = None
+    stream: Optional[bool] = None
+    tool_choice: Optional[Union[Dict[str, str], str]] = None
+    reasoning_effort: Optional[str] = None
+
+
+BEDROCK_API_PARAMS = {param for param in BedrockConfig.model_fields.keys()}

camel/configs/lmstudio_config.py

@@ -0,0 +1,94 @@
+# ========= 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. =========
+from __future__ import annotations
+
+from typing import Optional, Sequence, Union
+
+from camel.configs.base_config import BaseConfig
+
+
+class LMStudioConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using OpenAI
+    compatibility.
+
+    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:`None`)
+        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:`None`)
+        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:`None`)
+        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:`None`)
+        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:`None`)
+        tools (list[FunctionTool], 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: Optional[float] = None
+    top_p: Optional[float] = None
+    stream: Optional[bool] = None
+    stop: Optional[Union[str, Sequence[str]]] = None
+    max_tokens: Optional[int] = None
+    presence_penalty: Optional[float] = None
+    response_format: Optional[dict] = None
+    frequency_penalty: Optional[float] = None
+    tool_choice: Optional[Union[dict[str, str], str]] = None
+
+
+LMSTUDIO_API_PARAMS = {param for param in LMStudioConfig.model_fields.keys()}

camel/configs/qwen_config.py

@@ -13,7 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from __future__ import annotations
 
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from camel.configs.base_config import BaseConfig
 
@@ -61,7 +61,7 @@ class QwenConfig(BaseConfig):
             call. It can contain one or more tool objects. During a function
             call process, the model will select one tool from the array.
             (default: :obj:`None`)
-        extra_body (Optional[Dict[str, str]], optional): Additional parameters
+        extra_body (Optional[Dict[str, Any]], optional): Additional parameters
             to be sent to the Qwen API. If you want to enable internet search,
             you can set this parameter to `{"enable_search": True}`.
             (default: :obj:`None`)
@@ -78,7 +78,7 @@ class QwenConfig(BaseConfig):
     max_tokens: Optional[int] = None
     seed: Optional[int] = None
     stop: Optional[Union[str, List]] = None
-    extra_body: Optional[Dict[str, str]] = None
+    extra_body: Optional[Dict[str, Any]] = None
 
     def __init__(self, include_usage: bool = True, **kwargs):
         super().__init__(**kwargs)

camel/datasets/few_shot_generator.py

@@ -16,7 +16,7 @@ import asyncio
 from datetime import datetime
 from typing import List
 
-from pydantic import ValidationError
+from pydantic import BaseModel, Field, ValidationError
 
 from camel.agents import ChatAgent
 from camel.logger import get_logger
@@ -176,14 +176,30 @@ class FewShotGenerator(BaseGenerator):
                 ]
                 prompt = self._construct_prompt(examples)
 
+                # Create a simplified version of DataPoint that omits metadata
+                # because agent.step's response_format parameter doesn't
+                # support type Dict[str, Any]
+                class DataPointSimplified(BaseModel):
+                    question: str = Field(
+                        description="The primary question or issue to "
+                        "be addressed."
+                    )
+                    final_answer: str = Field(description="The final answer.")
+                    rationale: str = Field(
+                        description="Logical reasoning or explanation "
+                        "behind the answer."
+                    )
+
                 try:
                     agent_output = (
-                        self.agent.step(prompt, response_format=DataPoint)
+                        self.agent.step(
+                            prompt, response_format=DataPointSimplified
+                        )
                         .msgs[0]
                         .parsed
                     )
 
-                    assert isinstance(agent_output, DataPoint)
+                    assert isinstance(agent_output, DataPointSimplified)
 
                     self.agent.reset()
 

camel/datasets/models.py

@@ -24,7 +24,7 @@ class DataPoint(BaseModel):
         final_answer (str): The final answer.
         rationale (Optional[str]): Logical reasoning or explanation behind the
             answer. (default: :obj:`None`)
-        metadata Optional[Dict[str, Any]]: Additional metadata about the data
+        metadata (Optional[Dict[str, Any]]): Additional metadata about the data
             point. (default: :obj:`None`)
     """
 

camel/loaders/__init__.py

@@ -20,6 +20,7 @@ from .firecrawl_reader import Firecrawl
 from .jina_url_reader import JinaURLReader
 from .mineru_extractor import MinerU
 from .pandas_reader import PandasReader
+from .scrapegraph_reader import ScrapeGraphAI
 from .unstructured_io import UnstructuredIO
 
 __all__ = [
@@ -34,4 +35,5 @@ __all__ = [
     'PandasReader',
     'MinerU',
     'Crawl4AI',
+    'ScrapeGraphAI',
 ]

camel/loaders/scrapegraph_reader.py

@@ -0,0 +1,96 @@
+# ========= 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
+
+
+class ScrapeGraphAI:
+    r"""ScrapeGraphAI allows you to perform AI-powered web scraping and
+    searching.
+
+    Args:
+        api_key (Optional[str]): API key for authenticating with the
+            ScrapeGraphAI API.
+
+    References:
+        https://scrapegraph.ai/
+    """
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+    ) -> None:
+        from scrapegraph_py import Client
+        from scrapegraph_py.logger import sgai_logger
+
+        self._api_key = api_key or os.environ.get("SCRAPEGRAPH_API_KEY")
+        sgai_logger.set_logging(level="INFO")
+        self.client = Client(api_key=self._api_key)
+
+    def search(
+        self,
+        user_prompt: str,
+    ) -> Dict[str, Any]:
+        r"""Perform an AI-powered web search using ScrapeGraphAI.
+
+        Args:
+            user_prompt (str): The search query or instructions.
+
+        Returns:
+            Dict[str, Any]: The search results including answer and reference
+                URLs.
+
+        Raises:
+            RuntimeError: If the search process fails.
+        """
+        try:
+            response = self.client.searchscraper(user_prompt=user_prompt)
+            return response
+        except Exception as e:
+            raise RuntimeError(f"Failed to perform search: {e}")
+
+    def scrape(
+        self,
+        website_url: str,
+        user_prompt: str,
+        website_html: Optional[str] = None,
+    ) -> Dict[str, Any]:
+        r"""Perform AI-powered web scraping using ScrapeGraphAI.
+
+        Args:
+            website_url (str): The URL to scrape.
+            user_prompt (str): Instructions for what data to extract.
+            website_html (Optional[str]): Optional HTML content to use instead
+                of fetching from the URL.
+
+        Returns:
+            Dict[str, Any]: The scraped data including request ID and result.
+
+        Raises:
+            RuntimeError: If the scrape process fails.
+        """
+        try:
+            response = self.client.smartscraper(
+                website_url=website_url,
+                user_prompt=user_prompt,
+                website_html=website_html,
+            )
+            return response
+        except Exception as e:
+            raise RuntimeError(f"Failed to perform scrape: {e}")
+
+    def close(self) -> None:
+        r"""Close the ScrapeGraphAI client connection."""
+        self.client.close()

camel/models/__init__.py

@@ -13,6 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from .aiml_model import AIMLModel
 from .anthropic_model import AnthropicModel
+from .aws_bedrock_model import AWSBedrockModel
 from .azure_openai_model import AzureOpenAIModel
 from .base_audio_model import BaseAudioModel
 from .base_model import BaseModelBackend
@@ -23,6 +24,7 @@ from .gemini_model import GeminiModel
 from .groq_model import GroqModel
 from .internlm_model import InternLMModel
 from .litellm_model import LiteLLMModel
+from .lmstudio_model import LMStudioModel
 from .mistral_model import MistralModel
 from .model_factory import ModelFactory
 from .model_manager import ModelManager, ModelProcessingError
@@ -76,6 +78,7 @@ __all__ = [
     'PPIOModel',
     'YiModel',
     'QwenModel',
+    'AWSBedrockModel',
     'ModelProcessingError',
     'DeepSeekModel',
     'FishAudioModel',
@@ -86,4 +89,5 @@ __all__ = [
     'BaseAudioModel',
     'SiliconFlowModel',
     'VolcanoModel',
+    'LMStudioModel',
 ]

camel/models/aiml_model.py

@@ -12,29 +12,19 @@
 # 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 openai import AsyncOpenAI, AsyncStream, OpenAI, Stream
-from pydantic import BaseModel
+from typing import Any, Dict, Optional, Union
 
 from camel.configs import AIML_API_PARAMS, AIMLConfig
-from camel.messages import OpenAIMessage
-from camel.models._utils import try_modify_message_with_format
-from camel.models.base_model import BaseModelBackend
-from camel.types import (
-    ChatCompletion,
-    ChatCompletionChunk,
-    ModelType,
-)
+from camel.models.openai_compatible_model import OpenAICompatibleModel
+from camel.types import ModelType
 from camel.utils import (
     BaseTokenCounter,
-    OpenAITokenCounter,
     api_keys_required,
 )
 
 
-class AIMLModel(BaseModelBackend):
-    r"""AIML API in a unified BaseModelBackend interface.
+class AIMLModel(OpenAICompatibleModel):
+    r"""AIML API in a unified OpenAICompatibleModel interface.
 
     Args:
         model_type (Union[ModelType, str]): Model for which a backend is
@@ -77,87 +67,14 @@ class AIMLModel(BaseModelBackend):
         )
         timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
         super().__init__(
-            model_type, model_config_dict, api_key, url, token_counter, timeout
-        )
-        self._client = OpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            api_key=self._api_key,
-            base_url=self._url,
-        )
-        self._async_client = AsyncOpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            api_key=self._api_key,
-            base_url=self._url,
-        )
-
-    def _prepare_request(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Dict[str, Any]:
-        request_config = self.model_config_dict.copy()
-        if tools:
-            request_config["tools"] = tools
-        if response_format:
-            # AIML API does not natively support response format
-            try_modify_message_with_format(messages[-1], response_format)
-        return request_config
-
-    def _run(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-        r"""Runs inference of AIML 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.
-        """
-        request_config = self._prepare_request(
-            messages, response_format, tools
+            model_type=model_type,
+            model_config_dict=model_config_dict,
+            api_key=api_key,
+            url=url,
+            token_counter=token_counter,
+            timeout=timeout,
         )
 
-        response = self._client.chat.completions.create(
-            messages=messages, model=self.model_type, **request_config
-        )
-        return response
-
-    async def _arun(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
-        request_config = self._prepare_request(
-            messages, response_format, tools
-        )
-        response = await self._async_client.chat.completions.create(
-            messages=messages, model=self.model_type, **request_config
-        )
-        return response
-
-    @property
-    def token_counter(self) -> BaseTokenCounter:
-        r"""Initialize the token counter for the model backend.
-
-        Returns:
-            BaseTokenCounter: The token counter following the model's
-                tokenization style.
-        """
-        if not self._token_counter:
-            self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
-        return self._token_counter
-
     def check_model_config(self):
         r"""Check whether the model configuration contains any
         unexpected arguments to AIML API.
@@ -172,13 +89,3 @@ class AIMLModel(BaseModelBackend):
                     f"Unexpected argument `{param}` is "
                     "input into AIML model backend."
                 )
-
-    @property
-    def stream(self) -> bool:
-        """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)