camel-ai 0.1.5.6__py3-none-any.whl → 0.1.6.1__py3-none-any.whl

camel/models/vllm_model.py

@@ -0,0 +1,138 @@
+# =========== 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 typing import Any, Dict, List, Optional, Union
+
+from openai import OpenAI, Stream
+
+from camel.configs import VLLM_API_PARAMS
+from camel.messages import OpenAIMessage
+from camel.types import ChatCompletion, ChatCompletionChunk, ModelType
+from camel.utils import BaseTokenCounter, OpenAITokenCounter
+
+
+# flake8: noqa: E501
+class VLLMModel:
+    r"""vLLM service interface."""
+
+    def __init__(
+        self,
+        model_type: str,
+        model_config_dict: Dict[str, Any],
+        url: Optional[str] = None,
+        api_key: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
+    ) -> None:
+        r"""Constructor for vLLM backend with OpenAI compatibility.
+
+        # Reference: https://docs.vllm.ai/en/latest/serving/openai_compatible_server.html
+
+        Args:
+            model_type (str): Model for which a backend is created.
+            model_config_dict (Dict[str, Any]): A dictionary that will
+                be fed into openai.ChatCompletion.create().
+            url (Optional[str]): The url to the model service. (default:
+                :obj:`None`)
+            api_key (Optional[str]): The API key for authenticating with the
+                model service.
+            token_counter (Optional[BaseTokenCounter]): Token counter to use
+                for the model. If not provided, `OpenAITokenCounter(ModelType.
+                GPT_3_5_TURBO)` will be used.
+        """
+        self.model_type = model_type
+        self.model_config_dict = model_config_dict
+        # Use OpenAI cilent as interface call vLLM
+        self._client = OpenAI(
+            timeout=60,
+            max_retries=3,
+            base_url=url,
+            api_key=api_key,
+        )
+        self._token_counter = token_counter
+        self.check_model_config()
+
+    @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_3_5_TURBO)
+        return self._token_counter
+
+    def check_model_config(self):
+        r"""Check whether the model configuration contains any
+        unexpected arguments to vLLM API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to OpenAI API.
+        """
+        for param in self.model_config_dict:
+            if param not in VLLM_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into vLLM model backend."
+                )
+
+    def run(
+        self,
+        messages: List[OpenAIMessage],
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        r"""Runs inference of OpenAI 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.
+        """
+
+        response = self._client.chat.completions.create(
+            messages=messages,
+            model=self.model_type,
+            **self.model_config_dict,
+        )
+        return response
+
+    @property
+    def token_limit(self) -> int:
+        """Returns the maximum token limit for the given model.
+
+        Returns:
+            int: The maximum token limit for the given model.
+        """
+        max_tokens = self.model_config_dict.get("max_tokens")
+        if isinstance(max_tokens, int):
+            return max_tokens
+        print(
+            "Must set `max_tokens` as an integer in `model_config_dict` when"
+            " setting up the model. Using 4096 as default value."
+        )
+        return 4096
+
+    @property
+    def stream(self) -> bool:
+        r"""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)

camel/models/zhipuai_model.py

@@ -37,6 +37,7 @@ class ZhipuAIModel(BaseModelBackend):
         model_config_dict: Dict[str, Any],
         api_key: Optional[str] = None,
         url: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
     ) -> None:
         r"""Constructor for ZhipuAI backend.
 
@@ -49,8 +50,13 @@ class ZhipuAIModel(BaseModelBackend):
                 ZhipuAI service. (default: :obj:`None`)
             url (Optional[str]): The url to the ZhipuAI service. (default:
                 :obj:`None`)
+            token_counter (Optional[BaseTokenCounter]): Token counter to use
+                for the model. If not provided, `OpenAITokenCounter(ModelType.
+                GPT_3_5_TURBO)` will be used.
         """
-        super().__init__(model_type, model_config_dict)
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
         self._url = url or os.environ.get("ZHIPUAI_API_BASE_URL")
         self._api_key = api_key or os.environ.get("ZHIPUAI_API_KEY")
         if not self._url or not self._api_key:
@@ -63,7 +69,6 @@ class ZhipuAIModel(BaseModelBackend):
             api_key=self._api_key,
             base_url=self._url,
         )
-        self._token_counter: Optional[BaseTokenCounter] = None
 
     @api_keys_required("ZHIPUAI_API_KEY")
     def run(
@@ -100,7 +105,6 @@ class ZhipuAIModel(BaseModelBackend):
         """
 
         if not self._token_counter:
-            # It's a temporary setting for token counter.
             self._token_counter = OpenAITokenCounter(ModelType.GPT_3_5_TURBO)
         return self._token_counter
 
@@ -118,7 +122,6 @@ class ZhipuAIModel(BaseModelBackend):
                     f"Unexpected argument `{param}` is "
                     "input into ZhipuAI model backend."
                 )
-        pass
 
     @property
     def stream(self) -> bool:

camel/prompts/__init__.py

@@ -14,18 +14,22 @@
 from .ai_society import AISocietyPromptTemplateDict
 from .base import CodePrompt, TextPrompt, TextPromptDict
 from .code import CodePromptTemplateDict
-from .descripte_video_prompt import DescriptionVideoPromptTemplateDict
 from .evaluation import EvaluationPromptTemplateDict
 from .generate_text_embedding_data import (
     GenerateTextEmbeddingDataPromptTemplateDict,
 )
+from .image_craft import ImageCraftPromptTemplateDict
 from .misalignment import MisalignmentPromptTemplateDict
+from .multi_condition_image_craft import (
+    MultiConditionImageCraftPromptTemplateDict,
+)
 from .object_recognition import ObjectRecognitionPromptTemplateDict
 from .prompt_templates import PromptTemplateGenerator
 from .role_description_prompt_template import RoleDescriptionPromptTemplateDict
 from .solution_extraction import SolutionExtractionPromptTemplateDict
 from .task_prompt_template import TaskPromptTemplateDict
 from .translation import TranslationPromptTemplateDict
+from .video_description_prompt import VideoDescriptionPromptTemplateDict
 
 __all__ = [
     'TextPrompt',
@@ -42,5 +46,8 @@ __all__ = [
     'SolutionExtractionPromptTemplateDict',
     'GenerateTextEmbeddingDataPromptTemplateDict',
     'ObjectRecognitionPromptTemplateDict',
+    'ImageCraftPromptTemplateDict',
+    'MultiConditionImageCraftPromptTemplateDict',
     'DescriptionVideoPromptTemplateDict',
+    'VideoDescriptionPromptTemplateDict',
 ]

camel/prompts/image_craft.py

@@ -0,0 +1,34 @@
+# =========== 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 typing import Any
+
+from camel.prompts import TextPrompt, TextPromptDict
+from camel.types import RoleType
+
+
+class ImageCraftPromptTemplateDict(TextPromptDict):
+    ASSISTANT_PROMPT = TextPrompt(
+        """You are tasked with creating an original image based on
+        the provided descriptive captions. Use your imagination
+        and artistic skills to visualize and draw the images and
+        explain your thought process."""
+    )
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.update(
+            {
+                RoleType.ASSISTANT: self.ASSISTANT_PROMPT,
+            }
+        )

camel/prompts/multi_condition_image_craft.py

@@ -0,0 +1,34 @@
+# =========== 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 typing import Any
+
+from camel.prompts import TextPrompt, TextPromptDict
+from camel.types import RoleType
+
+
+class MultiConditionImageCraftPromptTemplateDict(TextPromptDict):
+    ASSISTANT_PROMPT = TextPrompt(
+        """You are tasked with creating an image based on
+        the provided text and images conditions. Please use your
+        imagination and artistic capabilities to visualize and
+        draw the images and explain what you are thinking about."""
+    )
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.update(
+            {
+                RoleType.ASSISTANT: self.ASSISTANT_PROMPT,
+            }
+        )

camel/prompts/task_prompt_template.py

@@ -18,16 +18,17 @@ from camel.prompts.ai_society import (
     TextPromptDict,
 )
 from camel.prompts.code import CodePromptTemplateDict
-from camel.prompts.descripte_video_prompt import (
-    DescriptionVideoPromptTemplateDict,
-)
 from camel.prompts.evaluation import (
     EvaluationPromptTemplateDict,
 )
 from camel.prompts.generate_text_embedding_data import (
     GenerateTextEmbeddingDataPromptTemplateDict,
 )
+from camel.prompts.image_craft import ImageCraftPromptTemplateDict
 from camel.prompts.misalignment import MisalignmentPromptTemplateDict
+from camel.prompts.multi_condition_image_craft import (
+    MultiConditionImageCraftPromptTemplateDict,
+)
 from camel.prompts.object_recognition import (
     ObjectRecognitionPromptTemplateDict,
 )
@@ -38,6 +39,9 @@ from camel.prompts.solution_extraction import (
     SolutionExtractionPromptTemplateDict,
 )
 from camel.prompts.translation import TranslationPromptTemplateDict
+from camel.prompts.video_description_prompt import (
+    VideoDescriptionPromptTemplateDict,
+)
 from camel.types import TaskType
 
 
@@ -64,6 +68,8 @@ class TaskPromptTemplateDict(Dict[Any, TextPromptDict]):
                 TaskType.ROLE_DESCRIPTION: RoleDescriptionPromptTemplateDict(),
                 TaskType.OBJECT_RECOGNITION: ObjectRecognitionPromptTemplateDict(),  # noqa: E501
                 TaskType.GENERATE_TEXT_EMBEDDING_DATA: GenerateTextEmbeddingDataPromptTemplateDict(),  # noqa: E501
-                TaskType.VIDEO_DESCRIPTION: DescriptionVideoPromptTemplateDict(),  # noqa: E501
+                TaskType.IMAGE_CRAFT: ImageCraftPromptTemplateDict(),
+                TaskType.MULTI_CONDITION_IMAGE_CRAFT: MultiConditionImageCraftPromptTemplateDict(),  # noqa: E501
+                TaskType.VIDEO_DESCRIPTION: VideoDescriptionPromptTemplateDict(),  # noqa: E501
             }
         )

camel/prompts/{descripte_video_prompt.py → video_description_prompt.py}

@@ -18,7 +18,7 @@ from camel.types import RoleType
 
 
 # flake8: noqa :E501
-class DescriptionVideoPromptTemplateDict(TextPromptDict):
+class VideoDescriptionPromptTemplateDict(TextPromptDict):
     ASSISTANT_PROMPT = TextPrompt(
         """You are a master of video analysis. 
         Please provide a shot description of the content of the current video."""

camel/responses/agent_responses.py

@@ -11,14 +11,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-from dataclasses import dataclass
 from typing import Any, Dict, List
 
+from pydantic import BaseModel, ConfigDict
+
 from camel.messages import BaseMessage
 
 
-@dataclass(frozen=True)
-class ChatAgentResponse:
+class ChatAgentResponse(BaseModel):
     r"""Response of a ChatAgent.
 
     Attributes:
@@ -31,6 +31,7 @@ class ChatAgentResponse:
         info (Dict[str, Any]): Extra information about the chat message.
     """
 
+    model_config = ConfigDict(arbitrary_types_allowed=True)
     msgs: List[BaseMessage]
     terminated: bool
     info: Dict[str, Any]

camel/retrievers/auto_retriever.py

@@ -235,8 +235,6 @@ class AutoRetriever:
             else content_input_paths
         )
 
-        vr = VectorRetriever()
-
         all_retrieved_info = []
         for content_input_path in content_input_paths:
             # Generate a valid collection name
@@ -283,12 +281,14 @@ class AutoRetriever:
                     vr = VectorRetriever(
                         storage=vector_storage_instance,
                         similarity_threshold=similarity_threshold,
+                        embedding_model=self.embedding_model,
                     )
                     vr.process(content_input_path)
                 else:
                     vr = VectorRetriever(
                         storage=vector_storage_instance,
                         similarity_threshold=similarity_threshold,
+                        embedding_model=self.embedding_model,
                     )
                 # Retrieve info by given query from the vector storage
                 retrieved_info = vr.query(query, top_k)

camel/societies/babyagi_playing.py

@@ -270,10 +270,12 @@ class BabyAGI:
                 "All tasks are solved"
             )
             return ChatAgentResponse(
-                [assistant_msg], terminated, assistant_response.info
+                msgs=[assistant_msg],
+                terminated=terminated,
+                info=assistant_response.info,
             )
         return ChatAgentResponse(
-            [assistant_msg],
-            assistant_response.terminated,
-            assistant_response.info,
+            msgs=[assistant_msg],
+            terminated=assistant_response.terminated,
+            info=assistant_response.info,
         )

camel/societies/role_playing.py

@@ -478,9 +478,11 @@ class RolePlaying:
         user_response = self.user_agent.step(assistant_msg)
         if user_response.terminated or user_response.msgs is None:
             return (
-                ChatAgentResponse([], False, {}),
+                ChatAgentResponse(msgs=[], terminated=False, info={}),
                 ChatAgentResponse(
-                    [], user_response.terminated, user_response.info
+                    msgs=[],
+                    terminated=user_response.terminated,
+                    info=user_response.info,
                 ),
             )
         user_msg = self._reduce_message_options(user_response.msgs)
@@ -490,20 +492,26 @@ class RolePlaying:
         if assistant_response.terminated or assistant_response.msgs is None:
             return (
                 ChatAgentResponse(
-                    [], assistant_response.terminated, assistant_response.info
+                    msgs=[],
+                    terminated=assistant_response.terminated,
+                    info=assistant_response.info,
+                ),
+                ChatAgentResponse(
+                    msgs=[user_msg], terminated=False, info=user_response.info
                 ),
-                ChatAgentResponse([user_msg], False, user_response.info),
             )
         assistant_msg = self._reduce_message_options(assistant_response.msgs)
         self.assistant_agent.record_message(assistant_msg)
 
         return (
             ChatAgentResponse(
-                [assistant_msg],
-                assistant_response.terminated,
-                assistant_response.info,
+                msgs=[assistant_msg],
+                terminated=assistant_response.terminated,
+                info=assistant_response.info,
             ),
             ChatAgentResponse(
-                [user_msg], user_response.terminated, user_response.info
+                msgs=[user_msg],
+                terminated=user_response.terminated,
+                info=user_response.info,
             ),
         )

camel/storages/graph_storages/graph_element.py

@@ -13,17 +13,17 @@
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 from __future__ import annotations
 
-from dataclasses import dataclass, field
 from typing import List, Union
 
+from pydantic import BaseModel, ConfigDict, Field
+
 try:
     from unstructured.documents.elements import Element
 except ImportError:
     Element = None
 
 
-@dataclass
-class Node:
+class Node(BaseModel):
     r"""Represents a node in a graph with associated properties.
 
     Attributes:
@@ -35,11 +35,10 @@ class Node:
 
     id: Union[str, int]
     type: str = "Node"
-    properties: dict = field(default_factory=dict)
+    properties: dict = Field(default_factory=dict)
 
 
-@dataclass
-class Relationship:
+class Relationship(BaseModel):
     r"""Represents a directed relationship between two nodes in a graph.
 
     Attributes:
@@ -53,24 +52,21 @@ class Relationship:
     subj: Node
     obj: Node
     type: str = "Relationship"
-    properties: dict = field(default_factory=dict)
+    properties: dict = Field(default_factory=dict)
 
 
-@dataclass
-class GraphElement:
+class GraphElement(BaseModel):
     r"""A graph element with lists of nodes and relationships.
 
     Attributes:
         nodes (List[Node]): A list of nodes in the graph.
         relationships (List[Relationship]): A list of relationships in the
-        graph.
+            graph.
         source (Element): The element from which the graph information is
-        derived.
+            derived.
     """
 
-    # Allow arbitrary types for Element
-    class Config:
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
     nodes: List[Node]
     relationships: List[Relationship]

camel/storages/graph_storages/neo4j_graph.py

@@ -12,6 +12,7 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 import logging
+import os
 from hashlib import md5
 from typing import Any, Dict, List, Optional
 
@@ -95,6 +96,10 @@ class Neo4jGraph(BaseGraphStorage):
         r"""Create a new Neo4j graph instance."""
         import neo4j
 
+        url = os.environ.get("NEO4J_URI") or url
+        username = os.environ.get("NEO4J_USERNAME") or username
+        password = os.environ.get("NEO4J_PASSWORD") or password
+
         self.driver = neo4j.GraphDatabase.driver(
             url, auth=(username, password)
         )

camel/storages/vectordb_storages/base.py

@@ -13,13 +13,13 @@
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 
 from abc import ABC, abstractmethod
-from dataclasses import dataclass, field
 from typing import Any, Dict, List, Optional
 from uuid import uuid4
 
+from pydantic import BaseModel, Field
 
-@dataclass
-class VectorRecord:
+
+class VectorRecord(BaseModel):
     r"""Encapsulates information about a vector's unique identifier and its
     payload, which is primarily used as a data transfer object when saving
     to vector storage.
@@ -33,12 +33,11 @@ class VectorRecord:
     """
 
     vector: List[float]
-    id: str = field(default_factory=lambda: str(uuid4()))
+    id: str = Field(default_factory=lambda: str(uuid4()))
     payload: Optional[Dict[str, Any]] = None
 
 
-@dataclass
-class VectorDBQuery:
+class VectorDBQuery(BaseModel):
     r"""Represents a query to a vector database.
 
     Attributes:
@@ -49,11 +48,24 @@ class VectorDBQuery:
     """
 
     query_vector: List[float]
+    """The numerical representation of the query vector."""
     top_k: int = 1
+    """The number of top similar vectors to retrieve from the database."""
+
+    def __init__(
+        self, query_vector: List[float], top_k: int, **kwargs: Any
+    ) -> None:
+        """Pass in query_vector and tok_k as positional arg.
+        Args:
+            query_vector (List[float]): The numerical representation of the
+                query vector.
+            top_k (int, optional): The number of top similar vectors to
+                retrieve from the database. (default: :obj:`1`)
+        """
+        super().__init__(query_vector=query_vector, top_k=top_k, **kwargs)
 
 
-@dataclass
-class VectorDBQueryResult:
+class VectorDBQueryResult(BaseModel):
     r"""Encapsulates the result of a query against a vector database.
 
     Attributes:
@@ -66,7 +78,7 @@ class VectorDBQueryResult:
     similarity: float
 
     @classmethod
-    def construct(
+    def create(
         cls,
         similarity: float,
         vector: List[float],
@@ -75,13 +87,12 @@ class VectorDBQueryResult:
     ) -> "VectorDBQueryResult":
         r"""A class method to construct a `VectorDBQueryResult` instance."""
         return cls(
-            record=VectorRecord(vector, id, payload),
+            record=VectorRecord(vector=vector, id=id, payload=payload),
             similarity=similarity,
         )
 
 
-@dataclass
-class VectorDBStatus:
+class VectorDBStatus(BaseModel):
     r"""Vector database status.
 
     Attributes:
@@ -195,7 +206,7 @@ class BaseVectorStorage(ABC):
             List[List[Dict[str, Any]]]: A list of vector payloads retrieved
                 from the storage based on similarity to the query vector.
         """
-        results = self.query(VectorDBQuery(vector, top_k))
+        results = self.query(VectorDBQuery(query_vector=vector, top_k=top_k))
         return [
             result.record.payload
             for result in results

camel/storages/vectordb_storages/milvus.py

@@ -361,7 +361,7 @@ class MilvusStorage(BaseVectorStorage):
         query_results = []
         for point in search_result:
             query_results.append(
-                VectorDBQueryResult.construct(
+                VectorDBQueryResult.create(
                     similarity=(point[0]['distance']),
                     id=str(point[0]['id']),
                     payload=(point[0]['entity'].get('payload')),

camel/storages/vectordb_storages/qdrant.py

@@ -11,7 +11,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-from dataclasses import asdict
 from datetime import datetime
 from typing import Any, Dict, List, Optional, Tuple, Union, cast
 
@@ -261,7 +260,7 @@ class QdrantStorage(BaseVectorStorage):
         """
         from qdrant_client.http.models import PointStruct, UpdateStatus
 
-        qdrant_points = [PointStruct(**asdict(p)) for p in records]
+        qdrant_points = [PointStruct(**p.model_dump()) for p in records]
         op_info = self._client.upsert(
             collection_name=self.collection_name,
             points=qdrant_points,
@@ -340,7 +339,7 @@ class QdrantStorage(BaseVectorStorage):
         query_results = []
         for point in search_result:
             query_results.append(
-                VectorDBQueryResult.construct(
+                VectorDBQueryResult.create(
                     similarity=point.score,
                     id=str(point.id),
                     payload=point.payload,