camel-ai 0.1.5.2__py3-none-any.whl → 0.1.5.4__py3-none-any.whl

camel/agents/chat_agent.py

@@ -32,6 +32,7 @@ from camel.responses import ChatAgentResponse
 from camel.types import (
     ChatCompletion,
     ChatCompletionChunk,
+    ModelPlatformType,
     ModelType,
     OpenAIBackendRole,
     RoleType,
@@ -41,7 +42,6 @@ from camel.utils import get_model_encoding
 if TYPE_CHECKING:
     from openai import Stream
 
-    from camel.configs import BaseConfig
     from camel.functions import OpenAIFunction
     from camel.terminators import ResponseTerminator
 
@@ -80,10 +80,9 @@ class ChatAgent(BaseAgent):
 
     Args:
         system_message (BaseMessage): The system message for the chat agent.
-        model_type (ModelType, optional): The LLM model to use for generating
-            responses. (default :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (BaseConfig, optional): Configuration options for the
-            LLM model. (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         api_key (str, optional): The API key for authenticating with the
             LLM service. Only OpenAI and Anthropic model supported (default:
             :obj:`None`)
@@ -109,8 +108,7 @@ class ChatAgent(BaseAgent):
     def __init__(
         self,
         system_message: BaseMessage,
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[BaseConfig] = None,
+        model: Optional[BaseModelBackend] = None,
         api_key: Optional[str] = None,
         memory: Optional[AgentMemory] = None,
         message_window_size: Optional[int] = None,
@@ -123,24 +121,30 @@ class ChatAgent(BaseAgent):
         self.system_message = system_message
         self.role_name: str = system_message.role_name
         self.role_type: RoleType = system_message.role_type
+        self._api_key = api_key
+        self.model_backend: BaseModelBackend = (
+            model
+            if model is not None
+            else ModelFactory.create(
+                model_platform=ModelPlatformType.OPENAI,
+                model_type=ModelType.GPT_3_5_TURBO,
+                model_config_dict=ChatGPTConfig().__dict__,
+                api_key=self._api_key,
+            )
+        )
         self.output_language: Optional[str] = output_language
         if self.output_language is not None:
             self.set_output_language(self.output_language)
 
-        self.model_type: ModelType = (
-            model_type if model_type is not None else ModelType.GPT_3_5_TURBO
-        )
+        self.model_type: ModelType = self.model_backend.model_type
 
         self.func_dict: Dict[str, Callable] = {}
         if tools is not None:
             for func in tools:
                 self.func_dict[func.get_function_name()] = func.func
 
-        self.model_config = model_config or ChatGPTConfig()
-        self._api_key = api_key
-        self.model_backend: BaseModelBackend = ModelFactory.create(
-            self.model_type, self.model_config.__dict__, self._api_key
-        )
+        self.model_config_dict = self.model_backend.model_config_dict
+
         self.model_token_limit = token_limit or self.model_backend.token_limit
         context_creator = ScoreBasedContextCreator(
             self.model_backend.token_counter,
@@ -643,7 +647,7 @@ class ChatAgent(BaseAgent):
         func = self.func_dict[func_name]
 
         args_str: str = choice.message.tool_calls[0].function.arguments
-        args = json.loads(args_str.replace("'", "\""))
+        args = json.loads(args_str)
 
         # Pass the extracted arguments to the indicated function
         try:
@@ -702,7 +706,7 @@ class ChatAgent(BaseAgent):
         func = self.func_dict[func_name]
 
         args_str: str = choice.message.tool_calls[0].function.arguments
-        args = json.loads(args_str.replace("'", "\""))
+        args = json.loads(args_str)
 
         # Pass the extracted arguments to the indicated function
         try:

camel/agents/critic_agent.py

@@ -20,8 +20,8 @@ from colorama import Fore
 from camel.agents.chat_agent import ChatAgent
 from camel.memories import AgentMemory
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.responses import ChatAgentResponse
-from camel.types import ModelType
 from camel.utils import get_first_int, print_text_animated
 
 
@@ -31,10 +31,9 @@ class CriticAgent(ChatAgent):
     Args:
         system_message (BaseMessage): The system message for the critic
             agent.
-        model_type (ModelType, optional): The LLM model to use for generating
-            responses. (default :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): Configuration options for the LLM model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         message_window_size (int, optional): The maximum number of previous
             messages to include in the context window. If `None`, no windowing
             is performed. (default: :obj:`6`)
@@ -48,8 +47,7 @@ class CriticAgent(ChatAgent):
     def __init__(
         self,
         system_message: BaseMessage,
-        model_type: ModelType = ModelType.GPT_3_5_TURBO,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         memory: Optional[AgentMemory] = None,
         message_window_size: int = 6,
         retry_attempts: int = 2,
@@ -58,8 +56,7 @@ class CriticAgent(ChatAgent):
     ) -> None:
         super().__init__(
             system_message,
-            model_type=model_type,
-            model_config=model_config,
+            model=model,
             memory=memory,
             message_window_size=message_window_size,
         )

camel/agents/deductive_reasoner_agent.py

@@ -15,10 +15,10 @@ import re
 from typing import Dict, List, Optional, Union
 
 from camel.agents.chat_agent import ChatAgent
-from camel.configs import BaseConfig
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import TextPrompt
-from camel.types import ModelType, RoleType
+from camel.types import RoleType
 
 
 class DeductiveReasonerAgent(ChatAgent):
@@ -33,16 +33,14 @@ class DeductiveReasonerAgent(ChatAgent):
         - L represents the path or process from A to B.
 
     Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj: `None`)
-        model_config (BaseConfig, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
     """
 
     def __init__(
         self,
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[BaseConfig] = None,
+        model: Optional[BaseModelBackend] = None,
     ) -> None:
         system_message = BaseMessage(
             role_name="Insight Agent",
@@ -50,7 +48,7 @@ class DeductiveReasonerAgent(ChatAgent):
             meta_dict=None,
             content="You assign roles based on tasks.",
         )
-        super().__init__(system_message, model_type, model_config)
+        super().__init__(system_message, model=model)
 
     def deduce_conditions_and_quality(
         self,

camel/agents/embodied_agent.py

@@ -23,8 +23,8 @@ from camel.interpreters import (
     SubprocessInterpreter,
 )
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.responses import ChatAgentResponse
-from camel.types import ModelType
 from camel.utils import print_text_animated
 
 
@@ -33,10 +33,9 @@ class EmbodiedAgent(ChatAgent):
 
     Args:
         system_message (BaseMessage): The system message for the chat agent.
-        model_type (ModelType, optional): The LLM model to use for generating
-            responses. (default :obj:`ModelType.GPT_4`)
-        model_config (Any, optional): Configuration options for the LLM model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         message_window_size (int, optional): The maximum number of previous
             messages to include in the context window. If `None`, no windowing
             is performed. (default: :obj:`None`)
@@ -55,8 +54,7 @@ class EmbodiedAgent(ChatAgent):
     def __init__(
         self,
         system_message: BaseMessage,
-        model_type: ModelType = ModelType.GPT_4,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         message_window_size: Optional[int] = None,
         tool_agents: Optional[List[BaseToolAgent]] = None,
         code_interpreter: Optional[BaseInterpreter] = None,
@@ -78,8 +76,7 @@ class EmbodiedAgent(ChatAgent):
         self.logger_color = logger_color
         super().__init__(
             system_message=system_message,
-            model_type=model_type,
-            model_config=model_config,
+            model=model,
             message_window_size=message_window_size,
         )
 

camel/agents/knowledge_graph_agent.py

@@ -11,19 +11,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-from typing import Any, Optional, Union
+from typing import Optional, Union
 
-from unstructured.documents.elements import Element
+try:
+    from unstructured.documents.elements import Element
+except ImportError:
+    Element = None
 
 from camel.agents import ChatAgent
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import TextPrompt
 from camel.storages.graph_storages.graph_element import (
     GraphElement,
     Node,
     Relationship,
 )
-from camel.types import ModelType, RoleType
+from camel.types import RoleType
 
 text_prompt = """
 You are tasked with extracting nodes and relationships from given content and 
@@ -105,16 +109,14 @@ class KnowledgeGraphAgent(ChatAgent):
 
     def __init__(
         self,
-        model_type: ModelType = ModelType.GPT_3_5_TURBO,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
     ) -> None:
         r"""Initialize the `KnowledgeGraphAgent`.
 
         Args:
-            model_type (ModelType, optional): The type of model to use for the
-                agent. Defaults to `ModelType.GPT_3_5_TURBO`.
-            model_config (Any, optional): The configuration for the model.
-                Defaults to `None`.
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         """
         system_message = BaseMessage(
             role_name="Graphify",
@@ -126,7 +128,7 @@ class KnowledgeGraphAgent(ChatAgent):
             "illuminate the hidden connections within the chaos of "
             "information.",
         )
-        super().__init__(system_message, model_type, model_config)
+        super().__init__(system_message, model=model)
 
     def run(
         self,

camel/agents/role_assignment_agent.py

@@ -12,32 +12,31 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 import re
-from typing import Any, Dict, Optional, Union
+from typing import Dict, Optional, Union
 
 from camel.agents.chat_agent import ChatAgent
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import TextPrompt
-from camel.types import ModelType, RoleType
+from camel.types import RoleType
 
 
 class RoleAssignmentAgent(ChatAgent):
     r"""An agent that generates role names based on the task prompt.
 
+    Args:
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
+
     Attributes:
         role_assignment_prompt (TextPrompt): A prompt for the agent to generate
         role names.
-
-    Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
     """
 
     def __init__(
         self,
-        model_type: ModelType = ModelType.GPT_3_5_TURBO,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
     ) -> None:
         system_message = BaseMessage(
             role_name="Role Assigner",
@@ -45,7 +44,7 @@ class RoleAssignmentAgent(ChatAgent):
             meta_dict=None,
             content="You assign roles based on tasks.",
         )
-        super().__init__(system_message, model_type, model_config)
+        super().__init__(system_message, model=model)
 
     def run(
         self,

camel/agents/search_agent.py

@@ -11,12 +11,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-from typing import Any, Optional
+from typing import Optional
 
 from camel.agents.chat_agent import ChatAgent
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import TextPrompt
-from camel.types import ModelType, RoleType
+from camel.types import RoleType
 from camel.utils import create_chunks
 
 
@@ -33,8 +34,7 @@ class SearchAgent(ChatAgent):
 
     def __init__(
         self,
-        model_type: ModelType = ModelType.GPT_3_5_TURBO,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
     ) -> None:
         system_message = BaseMessage(
             role_name="Assistant",
@@ -42,7 +42,7 @@ class SearchAgent(ChatAgent):
             meta_dict=None,
             content="You are a helpful assistant.",
         )
-        super().__init__(system_message, model_type, model_config)
+        super().__init__(system_message, model=model)
 
     def summarize_text(self, text: str, query: str) -> str:
         r"""Summarize the information from the text, base on the query.

camel/agents/task_agent.py

@@ -14,10 +14,10 @@
 from typing import Any, Dict, List, Optional, Union
 
 from camel.agents.chat_agent import ChatAgent
-from camel.configs import ChatGPTConfig
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import PromptTemplateGenerator, TextPrompt
-from camel.types import ModelType, RoleType, TaskType
+from camel.types import RoleType, TaskType
 from camel.utils import get_task_list
 
 
@@ -30,27 +30,25 @@ class TaskSpecifyAgent(ChatAgent):
         task_specify_prompt (TextPrompt): The prompt for specifying the task.
 
     Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         task_type (TaskType, optional): The type of task for which to generate
             a prompt. (default: :obj:`TaskType.AI_SOCIETY`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
         task_specify_prompt (Union[str, TextPrompt], optional): The prompt for
             specifying the task. (default: :obj:`None`)
         word_limit (int, optional): The word limit for the task prompt.
             (default: :obj:`50`)
         output_language (str, optional): The language to be output by the
-        agent. (default: :obj:`None`)
+            agent. (default: :obj:`None`)
     """
 
     DEFAULT_WORD_LIMIT = 50
 
     def __init__(
         self,
-        model_type: Optional[ModelType] = None,
+        model: Optional[BaseModelBackend] = None,
         task_type: TaskType = TaskType.AI_SOCIETY,
-        model_config: Optional[Any] = None,
         task_specify_prompt: Optional[Union[str, TextPrompt]] = None,
         word_limit: int = DEFAULT_WORD_LIMIT,
         output_language: Optional[str] = None,
@@ -67,8 +65,6 @@ class TaskSpecifyAgent(ChatAgent):
         else:
             self.task_specify_prompt = TextPrompt(task_specify_prompt)
 
-        model_config = model_config or ChatGPTConfig(temperature=1.0)
-
         system_message = BaseMessage(
             role_name="Task Specifier",
             role_type=RoleType.ASSISTANT,
@@ -78,8 +74,7 @@ class TaskSpecifyAgent(ChatAgent):
 
         super().__init__(
             system_message,
-            model_type=model_type,
-            model_config=model_config,
+            model=model,
             output_language=output_language,
         )
 
@@ -130,18 +125,16 @@ class TaskPlannerAgent(ChatAgent):
             the task into subtasks.
 
     Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         output_language (str, optional): The language to be output by the
-        agent. (default: :obj:`None`)
+            agent. (default: :obj:`None`)
     """
 
     def __init__(
         self,
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         output_language: Optional[str] = None,
     ) -> None:
         self.task_planner_prompt = TextPrompt(
@@ -156,8 +149,7 @@ class TaskPlannerAgent(ChatAgent):
 
         super().__init__(
             system_message,
-            model_type,
-            model_config,
+            model=model,
             output_language=output_language,
         )
 
@@ -208,10 +200,9 @@ class TaskCreationAgent(ChatAgent):
         role_name (str): The role name of the Agent to create the task.
         objective (Union[str, TextPrompt]): The objective of the Agent to
             perform the task.
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The LLM backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         output_language (str, optional): The language to be output by the
             agent. (default: :obj:`None`)
         message_window_size (int, optional): The maximum number of previous
@@ -225,8 +216,7 @@ class TaskCreationAgent(ChatAgent):
         self,
         role_name: str,
         objective: Union[str, TextPrompt],
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         output_language: Optional[str] = None,
         message_window_size: Optional[int] = None,
         max_task_num: Optional[int] = 3,
@@ -266,8 +256,7 @@ Be concrete.
 
         super().__init__(
             system_message,
-            model_type,
-            model_config,
+            model=model,
             output_language=output_language,
             message_window_size=message_window_size,
         )
@@ -282,6 +271,7 @@ Be concrete.
         Args:
             task_list (List[str]): The completed or in-progress
                 tasks which should not overlap with new created tasks.
+
         Returns:
             List[str]: The new task list generated by the Agent.
         """
@@ -321,10 +311,9 @@ class TaskPrioritizationAgent(ChatAgent):
     Args:
         objective (Union[str, TextPrompt]): The objective of the Agent to
             perform the task.
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The LLM backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         output_language (str, optional): The language to be output by the
             agent. (default: :obj:`None`)
         message_window_size (int, optional): The maximum number of previous
@@ -335,8 +324,7 @@ class TaskPrioritizationAgent(ChatAgent):
     def __init__(
         self,
         objective: Union[str, TextPrompt],
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         output_language: Optional[str] = None,
         message_window_size: Optional[int] = None,
     ) -> None:
@@ -372,8 +360,7 @@ with any other output."""
 
         super().__init__(
             system_message,
-            model_type,
-            model_config,
+            model=model,
             output_language=output_language,
             message_window_size=message_window_size,
         )
@@ -386,6 +373,7 @@ with any other output."""
 
         Args:
             task_list (List[str]): The unprioritized tasks of agent.
+
         Returns:
             List[str]: The new prioritized task list generated by the Agent.
         """

camel/configs/openai_config.py

@@ -41,6 +41,19 @@ class ChatGPTConfig(BaseConfig):
             (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`)
@@ -95,6 +108,7 @@ class ChatGPTConfig(BaseConfig):
     stop: str | Sequence[str] | NotGiven = NOT_GIVEN
     max_tokens: int | NotGiven = NOT_GIVEN
     presence_penalty: float = 0.0
+    response_format: dict | NotGiven = NOT_GIVEN
     frequency_penalty: float = 0.0
     logit_bias: dict = field(default_factory=dict)
     user: str = ""

camel/embeddings/base.py

@@ -11,8 +11,10 @@
 # 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 abc import ABC, abstractmethod
-from typing import Any, Generic, List, TypeVar
+from typing import Any, Generic, TypeVar
 
 T = TypeVar('T')
 
@@ -23,19 +25,18 @@ class BaseEmbedding(ABC, Generic[T]):
     @abstractmethod
     def embed_list(
         self,
-        objs: List[T],
+        objs: list[T],
         **kwargs: Any,
-    ) -> List[List[float]]:
+    ) -> list[list[float]]:
         r"""Generates embeddings for the given texts.
 
         Args:
-            objs (List[T]): The objects for which to generate the embeddings.
+            objs (list[T]): The objects for which to generate the embeddings.
             **kwargs (Any): Extra kwargs passed to the embedding API.
 
         Returns:
-            List[List[float]]: A list that represents the
-            generated embedding as a list of floating-point numbers or a
-            numpy matrix with embeddings.
+            list[list[float]]: A list that represents the
+                generated embedding as a list of floating-point numbers.
         """
         pass
 
@@ -43,7 +44,7 @@ class BaseEmbedding(ABC, Generic[T]):
         self,
         obj: T,
         **kwargs: Any,
-    ) -> List[float]:
+    ) -> list[float]:
         r"""Generates an embedding for the given text.
 
         Args:
@@ -51,7 +52,7 @@ class BaseEmbedding(ABC, Generic[T]):
             **kwargs (Any): Extra kwargs passed to the embedding API.
 
         Returns:
-            List[float]: A list of floating-point numbers representing the
+            list[float]: A list of floating-point numbers representing the
                 generated embedding.
         """
         return self.embed_list([obj], **kwargs)[0]