camel-ai 0.1.5.3__tar.gz → 0.1.5.4__tar.gz

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: camel-ai
-Version: 0.1.5.3
+Version: 0.1.5.4
 Summary: Communicative Agents for AI Society Study
 Home-page: https://www.camel-ai.org/
 License: Apache-2.0
 Keywords: communicative-ai,ai-societies,artificial-intelligence,deep-learning,multi-agent-systems,cooperative-ai,natural-language-processing,large-language-models
 Author: CAMEL-AI.org
-Requires-Python: >=3.8.1,<3.12
+Requires-Python: >=3.9.0,<3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -23,7 +23,7 @@ Provides-Extra: tools
 Provides-Extra: vector-databases
 Requires-Dist: PyMuPDF (>=1.22.5,<2.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: accelerate (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
-Requires-Dist: anthropic (>=0.28.0,<0.29.0)
+Requires-Dist: anthropic (>=0.29.0,<0.30.0)
 Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "tools" or extra == "all"
 Requires-Dist: cohere (>=4.56,<5.0) ; extra == "retrievers" or extra == "all"
 Requires-Dist: colorama (>=0,<1)
@@ -35,7 +35,7 @@ Requires-Dist: docstring-parser (>=0.15,<0.16)
 Requires-Dist: docx2txt (>=0.8,<0.9) ; extra == "tools" or extra == "all"
 Requires-Dist: duckduckgo-search (>=6.1.0,<7.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: googlemaps (>=4.10.0,<5.0.0) ; extra == "tools" or extra == "all"
-Requires-Dist: imageio (>=2.34.1,<3.0.0) ; extra == "tools" or extra == "all"
+Requires-Dist: imageio[pyav] (>=2.34.2,<3.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: jsonschema (>=4,<5)
 Requires-Dist: litellm (>=1.38.1,<2.0.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: mock (>=5,<6) ; extra == "test"
@@ -60,7 +60,7 @@ Requires-Dist: pytest-asyncio (>=0.23.0,<0.24.0) ; extra == "test"
 Requires-Dist: qdrant-client (>=1.9.0,<2.0.0) ; extra == "vector-databases" or extra == "all"
 Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0) ; extra == "retrievers" or extra == "all"
 Requires-Dist: requests_oauthlib (>=1.3.1,<2.0.0) ; extra == "tools" or extra == "all"
-Requires-Dist: sentence-transformers (>=2.2.2,<3.0.0) ; extra == "encoders" or extra == "all"
+Requires-Dist: sentence-transformers (>=3.0.1,<4.0.0) ; extra == "encoders" or extra == "all"
 Requires-Dist: sentencepiece (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: slack-sdk (>=3.27.2,<4.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: soundfile (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
@@ -180,13 +180,13 @@ exit
 Install `CAMEL` from source with conda and pip:
 ```sh
 # Create a conda virtual environment
-conda create --name camel python=3.10
+conda create --name camel python=3.9
 
 # Activate CAMEL conda environment
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.5.3 https://github.com/camel-ai/camel.git
+git clone -b v0.1.5.4 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/README.md

@@ -104,13 +104,13 @@ exit
 Install `CAMEL` from source with conda and pip:
 ```sh
 # Create a conda virtual environment
-conda create --name camel python=3.10
+conda create --name camel python=3.9
 
 # Activate CAMEL conda environment
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.5.3 https://github.com/camel-ai/camel.git
+git clone -b v0.1.5.4 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/camel/agents/knowledge_graph_agent.py

@@ -13,7 +13,10 @@
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 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

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/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]

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/camel/embeddings/openai_embedding.py

@@ -11,10 +11,12 @@
 # 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
+
 import os
-from typing import Any, List, Optional
+from typing import Any
 
-from openai import OpenAI
+from openai import NOT_GIVEN, NotGiven, OpenAI
 
 from camel.embeddings.base import BaseEmbedding
 from camel.types import EmbeddingModelType
@@ -25,10 +27,13 @@ class OpenAIEmbedding(BaseEmbedding[str]):
     r"""Provides text embedding functionalities using OpenAI's models.
 
     Args:
-        model (OpenAiEmbeddingModel, optional): The model type to be used for
-            generating embeddings. (default: :obj:`ModelType.ADA_2`)
-        api_key (Optional[str]): The API key for authenticating with the
+        model_type (EmbeddingModelType, optional): The model type to be
+            used for text embeddings.
+            (default: :obj:`TEXT_EMBEDDING_3_SMALL`)
+        api_key (str, optional): The API key for authenticating with the
             OpenAI service. (default: :obj:`None`)
+        dimensions (int, optional): The text embedding output dimensions.
+            (default: :obj:`NOT_GIVEN`)
 
     Raises:
         RuntimeError: If an unsupported model type is specified.
@@ -36,36 +41,44 @@ class OpenAIEmbedding(BaseEmbedding[str]):
 
     def __init__(
         self,
-        model_type: EmbeddingModelType = EmbeddingModelType.ADA_2,
-        api_key: Optional[str] = None,
+        model_type: EmbeddingModelType = (
+            EmbeddingModelType.TEXT_EMBEDDING_3_SMALL
+        ),
+        api_key: str | None = None,
+        dimensions: int | NotGiven = NOT_GIVEN,
     ) -> None:
         if not model_type.is_openai:
             raise ValueError("Invalid OpenAI embedding model type.")
         self.model_type = model_type
-        self.output_dim = model_type.output_dim
+        if dimensions == NOT_GIVEN:
+            self.output_dim = model_type.output_dim
+        else:
+            assert isinstance(dimensions, int)
+            self.output_dim = dimensions
         self._api_key = api_key or os.environ.get("OPENAI_API_KEY")
         self.client = OpenAI(timeout=60, max_retries=3, api_key=self._api_key)
 
     @model_api_key_required
     def embed_list(
         self,
-        objs: List[str],
+        objs: list[str],
         **kwargs: Any,
-    ) -> List[List[float]]:
+    ) -> list[list[float]]:
         r"""Generates embeddings for the given texts.
 
         Args:
-            objs (List[str]): The texts for which to generate the embeddings.
+            objs (list[str]): The texts 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
+            list[list[float]]: A list that represents the generated embedding
                 as a list of floating-point numbers.
         """
         # TODO: count tokens
         response = self.client.embeddings.create(
             input=objs,
             model=self.model_type.value,
+            dimensions=self.output_dim,
             **kwargs,
         )
         return [data.embedding for data in response.data]

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/camel/embeddings/sentence_transformers_embeddings.py

@@ -11,51 +11,63 @@
 # 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, List
+from __future__ import annotations
+
+from typing import Any
+
+from numpy import ndarray
 
 from camel.embeddings.base import BaseEmbedding
 
 
 class SentenceTransformerEncoder(BaseEmbedding[str]):
-    r"""This class provides functionalities to generate embeddings
-    using a specified model from `Sentence Transformers`.
+    r"""This class provides functionalities to generate text
+    embeddings using `Sentence Transformers`.
 
     References:
         https://www.sbert.net/
     """
 
-    def __init__(self, model_name: str = 'intfloat/e5-large-v2'):
+    def __init__(
+        self,
+        model_name: str = "intfloat/e5-large-v2",
+        **kwargs,
+    ):
         r"""Initializes the: obj: `SentenceTransformerEmbedding` class
         with the specified transformer model.
 
         Args:
             model_name (str, optional): The name of the model to use.
-                                        Defaults to `intfloat/e5-large-v2`.
+                (default: :obj:`intfloat/e5-large-v2`)
+            **kwargs (optional): Additional arguments of
+                :class:`SentenceTransformer`, such as :obj:`prompts` etc.
         """
         from sentence_transformers import SentenceTransformer
 
-        self.model = SentenceTransformer(model_name)
+        self.model = SentenceTransformer(model_name, **kwargs)
 
     def embed_list(
         self,
-        objs: List[str],
+        objs: list[str],
         **kwargs: Any,
-    ) -> List[List[float]]:
+    ) -> list[list[float]]:
         r"""Generates embeddings for the given texts using the model.
 
         Args:
-            objs (List[str]): The texts for which to generate the
-            embeddings.
+            objs (list[str]): The texts for which to generate the
+                embeddings.
 
         Returns:
-            List[List[float]]: A list that represents the generated embedding
+            list[list[float]]: A list that represents the generated embedding
                 as a list of floating-point numbers.
         """
         if not objs:
             raise ValueError("Input text list is empty")
-        return self.model.encode(
+        embeddings = self.model.encode(
             objs, normalize_embeddings=True, **kwargs
-        ).tolist()
+        )
+        assert isinstance(embeddings, ndarray)
+        return embeddings.tolist()
 
     def get_output_dim(self) -> int:
         r"""Returns the output dimension of the embeddings.
@@ -63,4 +75,6 @@ class SentenceTransformerEncoder(BaseEmbedding[str]):
         Returns:
             int: The dimensionality of the embeddings.
         """
-        return self.model.get_sentence_embedding_dimension()
+        output_dim = self.model.get_sentence_embedding_dimension()
+        assert isinstance(output_dim, int)
+        return output_dim

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/camel/retrievers/auto_retriever.py

@@ -159,11 +159,11 @@ class AutoRetriever:
     ) -> str:
         r"""Retrieves the last modified date and time of a given file. This
         function takes vector storage instance as input and returns the last
-        modified date from the meta data.
+        modified date from the metadata.
 
         Args:
             vector_storage_instance (BaseVectorStorage): The vector storage
-                where modified date is to be retrieved from meta data.
+                where modified date is to be retrieved from metadata.
 
         Returns:
             str: The last modified date from vector storage.

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/camel/storages/graph_storages/graph_element.py

@@ -16,7 +16,10 @@ from __future__ import annotations
 from dataclasses import dataclass, field
 from typing import List, Union
 
-from unstructured.documents.elements import Element
+try:
+    from unstructured.documents.elements import Element
+except ImportError:
+    Element = None
 
 
 @dataclass
@@ -72,3 +75,8 @@ class GraphElement:
     nodes: List[Node]
     relationships: List[Relationship]
     source: Element
+
+    def __post_init__(self):
+        if Element is None:
+            raise ImportError("""The 'unstructured' package is required to use
+                              the 'source' attribute.""")

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/camel/types/enums.py

@@ -49,6 +49,7 @@ class ModelType(Enum):
     CLAUDE_3_OPUS = "claude-3-opus-20240229"
     CLAUDE_3_SONNET = "claude-3-sonnet-20240229"
     CLAUDE_3_HAIKU = "claude-3-haiku-20240307"
+    CLAUDE_3_5_SONNET = "claude-3-5-sonnet-20240620"
 
     # Nvidia models
     NEMOTRON_4_REWARD = "nvidia/nemotron-4-340b-reward"
@@ -104,6 +105,7 @@ class ModelType(Enum):
             ModelType.CLAUDE_3_OPUS,
             ModelType.CLAUDE_3_SONNET,
             ModelType.CLAUDE_3_HAIKU,
+            ModelType.CLAUDE_3_5_SONNET,
         }
 
     @property
@@ -155,6 +157,7 @@ class ModelType(Enum):
             ModelType.CLAUDE_3_OPUS,
             ModelType.CLAUDE_3_SONNET,
             ModelType.CLAUDE_3_HAIKU,
+            ModelType.CLAUDE_3_5_SONNET,
         }:
             return 200_000
         elif self is ModelType.NEMOTRON_4_REWARD:
@@ -186,35 +189,27 @@ class ModelType(Enum):
 
 
 class EmbeddingModelType(Enum):
-    ADA_2 = "text-embedding-ada-002"
-    ADA_1 = "text-embedding-ada-001"
-    BABBAGE_1 = "text-embedding-babbage-001"
-    CURIE_1 = "text-embedding-curie-001"
-    DAVINCI_1 = "text-embedding-davinci-001"
+    TEXT_EMBEDDING_ADA_2 = "text-embedding-ada-002"
+    TEXT_EMBEDDING_3_SMALL = "text-embedding-3-small"
+    TEXT_EMBEDDING_3_LARGE = "text-embedding-3-large"
 
     @property
     def is_openai(self) -> bool:
         r"""Returns whether this type of models is an OpenAI-released model."""
         return self in {
-            EmbeddingModelType.ADA_2,
-            EmbeddingModelType.ADA_1,
-            EmbeddingModelType.BABBAGE_1,
-            EmbeddingModelType.CURIE_1,
-            EmbeddingModelType.DAVINCI_1,
+            EmbeddingModelType.TEXT_EMBEDDING_ADA_2,
+            EmbeddingModelType.TEXT_EMBEDDING_3_SMALL,
+            EmbeddingModelType.TEXT_EMBEDDING_3_LARGE,
         }
 
     @property
     def output_dim(self) -> int:
-        if self is EmbeddingModelType.ADA_2:
+        if self is EmbeddingModelType.TEXT_EMBEDDING_ADA_2:
             return 1536
-        elif self is EmbeddingModelType.ADA_1:
-            return 1024
-        elif self is EmbeddingModelType.BABBAGE_1:
-            return 2048
-        elif self is EmbeddingModelType.CURIE_1:
-            return 4096
-        elif self is EmbeddingModelType.DAVINCI_1:
-            return 12288
+        elif self is EmbeddingModelType.TEXT_EMBEDDING_3_SMALL:
+            return 1536
+        elif self is EmbeddingModelType.TEXT_EMBEDDING_3_LARGE:
+            return 3072
         else:
             raise ValueError(f"Unknown model type {self}.")
 

{camel_ai-0.1.5.3 → camel_ai-0.1.5.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "camel-ai"
-version = "0.1.5.3"
+version = "0.1.5.4"
 authors = ["CAMEL-AI.org"]
 description = "Communicative Agents for AI Society Study"
 readme = "README.md"
@@ -27,7 +27,7 @@ repository = "https://github.com/camel-ai/camel"
 documentation = "https://docs.camel-ai.org"
 
 [tool.poetry.dependencies]
-python = ">=3.8.1,<3.12"
+python = ">=3.9.0,<3.12"
 numpy = "^1"
 openai = "^1.2.3"
 tiktoken = "^0.7.0"
@@ -35,10 +35,11 @@ colorama = "^0"
 jsonschema = "^4"
 protobuf = "^4"
 pathlib = "^1.0.1"   
-anthropic = "^0.28.0"
+anthropic = "^0.29.0"
 docstring-parser = "^0.15"
 pydantic = ">=1.9,<3"
 curl_cffi = "0.6.2"
+pillow ="^10.2.0"
 
 # model-platforms
 litellm = { version = "^1.38.1", optional = true }
@@ -67,16 +68,15 @@ requests_oauthlib = { version = "^1.3.1", optional = true }
 prance = { version = "^23.6.21.0", optional = true }
 openapi-spec-validator = { version = "^0.7.1", optional = true }
 unstructured = { extras = ["all-docs"], version = "^0.10.30", optional = true }
-pillow = { version = "^10.2.0", optional = true }
 slack-sdk = { version = "^3.27.2", optional = true }
 pydub = { version = "^0.25.1", optional = true }
 pygithub = { version = "^2.3.0", optional = true }
-imageio = { version = "^2.34.1", optional = true }
+imageio = {extras = ["pyav"], version = "^2.34.2"}
 pyTelegramBotAPI = { version = "^4.18.0", optional = true }
 "discord.py" = { version = "^2.3.2", optional = true }
 
 # encoders
-sentence-transformers = { version = "^2.2.2", optional = true }
+sentence-transformers = { version = "^3.0.1", optional = true }
 
 # vector-databases
 qdrant-client = { version = "^1.9.0", optional = true }

camel_ai-0.1.5.3/camel/bots/__init__.py

@@ -1,20 +0,0 @@
-# =========== 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 .discord_bot import DiscordBot
-from .telegram_bot import TelegramBot
-
-__all__ = [
-    'DiscordBot',
-    'TelegramBot',
-]

camel_ai-0.1.5.3/camel/bots/discord_bot.py

@@ -1,103 +0,0 @@
-# =========== 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. ===========
-import os
-from typing import TYPE_CHECKING, List, Optional
-
-from camel.agents import ChatAgent
-from camel.messages import BaseMessage
-
-if TYPE_CHECKING:
-    from discord import Message
-
-
-class DiscordBot:
-    r"""Represents a Discord bot that is powered by an agent.
-
-    Attributes:
-        chat_agent (ChatAgent): Chat agent that will power the bot.
-        channel_ids (List[int], optional): The channel IDs that the bot will
-            listen to.
-        discord_token (str, optional): The bot token.
-    """
-
-    def __init__(
-        self,
-        chat_agent: ChatAgent,
-        channel_ids: Optional[List[int]] = None,
-        discord_token: Optional[str] = None,
-    ) -> None:
-        self.chat_agent = chat_agent
-        self.token = discord_token or os.getenv('DISCORD_TOKEN')
-        self.channel_ids = channel_ids
-
-        if not self.token:
-            raise ValueError(
-                "`DISCORD_TOKEN` not found in environment variables. Get it"
-                " here: `https://discord.com/developers/applications`."
-            )
-
-        try:
-            import discord
-        except ImportError:
-            raise ImportError(
-                "Please install `discord` first. You can install it by running"
-                " `python3 -m pip install -U discord.py`."
-            )
-        intents = discord.Intents.default()
-        intents.message_content = True
-        self.client = discord.Client(intents=intents)
-
-        # Register event handlers
-        self.client.event(self.on_ready)
-        self.client.event(self.on_message)
-
-    def run(self) -> None:
-        r"""Start the Discord bot using its token.
-
-        This method starts the Discord bot by running the client with the
-        provided token.
-        """
-        self.client.run(self.token)  # type: ignore[arg-type]
-
-    async def on_ready(self) -> None:
-        r"""This method is called when the bot has successfully connected to
-        the Discord server.
-
-        It prints a message indicating that the bot has logged in and displays
-        the username of the bot.
-        """
-        print(f'We have logged in as {self.client.user}')
-
-    async def on_message(self, message: 'Message') -> None:
-        r"""Event handler for when a message is received.
-
-        Args:
-            message (discord.Message): The message object received.
-        """
-        if message.author == self.client.user:
-            return
-
-        if self.channel_ids and message.channel.id not in self.channel_ids:
-            return
-
-        if not self.client.user or not self.client.user.mentioned_in(message):
-            return
-
-        self.chat_agent.reset()
-
-        user_msg = BaseMessage.make_user_message(
-            role_name="User", content=message.content
-        )
-        assistant_response = self.chat_agent.step(user_msg)
-        await message.channel.send(assistant_response.msg.content)