camel-ai 0.1.5.5__py3-none-any.whl → 0.1.5.9__py3-none-any.whl

camel/models/ollama_model.py

@@ -29,6 +29,7 @@ class OllamaModel:
         model_type: str,
         model_config_dict: Dict[str, Any],
         url: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
     ) -> None:
         r"""Constructor for Ollama backend with OpenAI compatibility.
 
@@ -40,6 +41,9 @@ class OllamaModel:
                 be fed into openai.ChatCompletion.create().
             url (Optional[str]): The url to the model 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.
         """
         self.model_type = model_type
         self.model_config_dict = model_config_dict
@@ -50,7 +54,7 @@ class OllamaModel:
             base_url=url,
             api_key="ollama",  # required but ignored
         )
-        self._token_counter: Optional[BaseTokenCounter] = None
+        self._token_counter = token_counter
         self.check_model_config()
 
     @property
@@ -61,7 +65,6 @@ class OllamaModel:
             BaseTokenCounter: The token counter following the model's
                 tokenization style.
         """
-        # NOTE: Use OpenAITokenCounter temporarily
         if not self._token_counter:
             self._token_counter = OpenAITokenCounter(ModelType.GPT_3_5_TURBO)
         return self._token_counter
@@ -104,6 +107,22 @@ class OllamaModel:
         )
         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

camel/models/open_source_model.py

@@ -19,7 +19,10 @@ from camel.configs import OPENAI_API_PARAMS
 from camel.messages import OpenAIMessage
 from camel.models import BaseModelBackend
 from camel.types import ChatCompletion, ChatCompletionChunk, ModelType
-from camel.utils import BaseTokenCounter, OpenSourceTokenCounter
+from camel.utils import (
+    BaseTokenCounter,
+    OpenSourceTokenCounter,
+)
 
 
 class OpenSourceModel(BaseModelBackend):
@@ -33,6 +36,7 @@ class OpenSourceModel(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 model backends of Open-source models.
 
@@ -43,9 +47,13 @@ class OpenSourceModel(BaseModelBackend):
             api_key (Optional[str]): The API key for authenticating with the
                 model service. (ignored for open-source models)
             url (Optional[str]): The url to the model service.
+            token_counter (Optional[BaseTokenCounter]): Token counter to use
+                for the model. If not provided, `OpenSourceTokenCounter` will
+                be used.
         """
-        super().__init__(model_type, model_config_dict, api_key, url)
-        self._token_counter: Optional[BaseTokenCounter] = None
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
 
         # Check whether the input model type is open-source
         if not model_type.is_open_source:

camel/models/openai_model.py

@@ -36,6 +36,7 @@ class OpenAIModel(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 OpenAI backend.
 
@@ -48,8 +49,13 @@ class OpenAIModel(BaseModelBackend):
                 OpenAI service. (default: :obj:`None`)
             url (Optional[str]): The url to the OpenAI service. (default:
                 :obj:`None`)
+            token_counter (Optional[BaseTokenCounter]): Token counter to use
+                for the model. If not provided, `OpenAITokenCounter` will
+                be used.
         """
-        super().__init__(model_type, model_config_dict, api_key, url)
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
         self._url = url or os.environ.get("OPENAI_API_BASE_URL")
         self._api_key = api_key or os.environ.get("OPENAI_API_KEY")
         self._client = OpenAI(
@@ -58,7 +64,6 @@ class OpenAIModel(BaseModelBackend):
             base_url=self._url,
             api_key=self._api_key,
         )
-        self._token_counter: Optional[BaseTokenCounter] = None
 
     @property
     def token_counter(self) -> BaseTokenCounter:

camel/models/stub_model.py

@@ -55,12 +55,12 @@ class StubModel(BaseModelBackend):
         model_config_dict: Dict[str, Any],
         api_key: Optional[str] = None,
         url: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
     ) -> None:
         r"""All arguments are unused for the dummy model."""
-        super().__init__(model_type, model_config_dict, api_key, url)
-        self._token_counter: Optional[BaseTokenCounter] = None
-        self._api_key = api_key
-        self._url = url
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
 
     @property
     def token_counter(self) -> BaseTokenCounter:

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,7 +14,6 @@
 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,
@@ -26,6 +25,7 @@ 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 +42,5 @@ __all__ = [
     'SolutionExtractionPromptTemplateDict',
     'GenerateTextEmbeddingDataPromptTemplateDict',
     'ObjectRecognitionPromptTemplateDict',
-    'DescriptionVideoPromptTemplateDict',
+    'VideoDescriptionPromptTemplateDict',
 ]

camel/prompts/task_prompt_template.py

@@ -18,9 +18,6 @@ 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,
 )
@@ -38,6 +35,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 +64,6 @@ 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.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/retrievers/auto_retriever.py

@@ -283,12 +283,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/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/toolkits/__init__.py

@@ -11,13 +11,49 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ruff: noqa: I001
+from .openai_function import (
+    OpenAIFunction,
+    get_openai_function_schema,
+    get_openai_tool_schema,
+)
+from .open_api_specs.security_config import openapi_security_config
+
+from .google_maps_toolkit import MAP_FUNCS, GoogleMapsToolkit
+from .math_toolkit import MATH_FUNCS, MathToolkit
+from .open_api_toolkit import OPENAPI_FUNCS, OpenAPIToolkit
+from .retrieval_toolkit import RETRIEVAL_FUNCS, RetrievalToolkit
+from .search_toolkit import SEARCH_FUNCS, SearchToolkit
+from .twitter_toolkit import TWITTER_FUNCS, TwitterToolkit
+from .weather_toolkit import WEATHER_FUNCS, WeatherToolkit
+from .slack_toolkit import SLACK_FUNCS, SlackToolkit
 
 from .base import BaseToolkit
 from .code_execution import CodeExecutionToolkit
 from .github_toolkit import GithubToolkit
 
 __all__ = [
+    'OpenAIFunction',
+    'get_openai_function_schema',
+    'get_openai_tool_schema',
+    'openapi_security_config',
+    'MATH_FUNCS',
+    'MAP_FUNCS',
+    'OPENAPI_FUNCS',
+    'RETRIEVAL_FUNCS',
+    'SEARCH_FUNCS',
+    'TWITTER_FUNCS',
+    'WEATHER_FUNCS',
+    'SLACK_FUNCS',
     'BaseToolkit',
     'GithubToolkit',
+    'MathToolkit',
+    'GoogleMapsToolkit',
+    'SearchToolkit',
+    'SlackToolkit',
+    'TwitterToolkit',
+    'WeatherToolkit',
+    'RetrievalToolkit',
+    'OpenAPIToolkit',
     'CodeExecutionToolkit',
 ]

camel/toolkits/base.py

@@ -14,7 +14,7 @@
 
 from typing import List
 
-from camel.functions import OpenAIFunction
+from .openai_function import OpenAIFunction
 
 
 class BaseToolkit:

camel/toolkits/code_execution.py

@@ -13,8 +13,8 @@
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 from typing import List, Literal
 
-from camel.functions import OpenAIFunction
 from camel.interpreters import InternalPythonInterpreter
+from camel.toolkits import OpenAIFunction
 
 from .base import BaseToolkit
 

camel/toolkits/github_toolkit.py

@@ -17,10 +17,11 @@ from dataclasses import dataclass
 from datetime import datetime, timedelta
 from typing import List, Optional
 
-from camel.functions import OpenAIFunction
-from camel.toolkits.base import BaseToolkit
 from camel.utils import dependencies_required
 
+from .base import BaseToolkit
+from .openai_function import OpenAIFunction
+
 
 @dataclass
 class GithubIssue: