camel-ai 0.2.10__py3-none-any.whl → 0.2.12__py3-none-any.whl

camel/toolkits/stripe_toolkit.py

@@ -0,0 +1,273 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+
+import json
+import logging
+import os
+from typing import List
+
+from camel.toolkits import FunctionTool
+from camel.toolkits.base import BaseToolkit
+from camel.utils import api_keys_required
+
+
+class StripeToolkit(BaseToolkit):
+    r"""A class representing a toolkit for Stripe operations.
+
+    This toolkit provides methods to interact with the Stripe API,
+    allowing users to operate stripe core resources, including Customer,
+    Balance, BalanceTransaction, Payment, Refund
+
+    Use the Developers Dashboard https://dashboard.stripe.com/test/apikeys to
+    create an API keys as STRIPE_API_KEY.
+
+    Attributes:
+        logger (Logger): a logger to write logs.
+    """
+
+    @api_keys_required("STRIPE_API_KEY")
+    def __init__(self, retries: int = 3):
+        r"""Initializes the StripeToolkit with the specified number of
+        retries.
+
+        Args:
+            retries (int,optional): Number of times to retry the request in
+                case of failure. (default: :obj:`3`)
+        """
+        import stripe
+
+        stripe.max_network_retries = retries
+        stripe.log = 'info'
+        self.logger = logging.getLogger(__name__)
+        self.logger.setLevel(logging.INFO)
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter(
+            '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+        )
+        handler.setFormatter(formatter)
+        if not self.logger.handlers:
+            self.logger.addHandler(handler)
+        stripe.api_key = os.environ.get("STRIPE_API_KEY")
+
+    def customer_get(self, customer_id: str) -> str:
+        r"""Retrieve a customer by ID.
+
+        Args:
+            customer_id (str): The ID of the customer to retrieve.
+
+        Returns:
+            str: The customer data as a str.
+        """
+        import stripe
+
+        try:
+            self.logger.info(f"Retrieving customer with ID: {customer_id}")
+            customer = stripe.Customer.retrieve(customer_id)
+            self.logger.info(f"Retrieved customer: {customer.id}")
+            json_string = json.dumps(customer)
+            return json_string
+        except Exception as e:
+            return self.handle_exception("customer_get", e)
+
+    def customer_list(self, limit: int = 100) -> str:
+        r"""List customers.
+
+        Args:
+            limit (int, optional): Number of customers to retrieve. (default:
+                :obj:`100`)
+
+        Returns:
+            str: An output str if successful, or an error message string if
+                failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info(f"Listing customers with limit={limit}")
+            customers = stripe.Customer.list(limit=limit).data
+            self.logger.info(
+                f"Successfully retrieved {len(customers)} customers."
+            )
+            return json.dumps([customer for customer in customers])
+        except Exception as e:
+            return self.handle_exception("customer_list", e)
+
+    def balance_get(self) -> str:
+        r"""Retrieve your account balance.
+
+        Returns:
+            str: A str containing the account balance if successful, or an
+                error message string if failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info("Retrieving account balance.")
+            balance = stripe.Balance.retrieve()
+            self.logger.info(
+                f"Successfully retrieved account balance: {balance}."
+            )
+            return json.dumps(balance)
+        except Exception as e:
+            return self.handle_exception("balance_get", e)
+
+    def balance_transaction_list(self, limit: int = 100) -> str:
+        r"""List your balance transactions.
+
+        Args:
+            limit (int, optional): Number of balance transactions to retrieve.
+                (default::obj:`100`)
+
+        Returns:
+            str: A list of balance transaction data if successful, or an error
+                message string if failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info(
+                f"Listing balance transactions with limit={limit}"
+            )
+            transactions = stripe.BalanceTransaction.list(limit=limit).data
+            self.logger.info(
+                f"Successfully retrieved {len(transactions)} "
+                "balance transactions."
+            )
+            return json.dumps([transaction for transaction in transactions])
+        except Exception as e:
+            return self.handle_exception("balance_transaction_list", e)
+
+    def payment_get(self, payment_id: str) -> str:
+        r"""Retrieve a payment by ID.
+
+        Args:
+            payment_id (str): The ID of the payment to retrieve.
+
+        Returns:
+            str:The payment data as a str if successful, or an error message
+                string if failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info(f"Retrieving payment with ID: {payment_id}")
+            payment = stripe.PaymentIntent.retrieve(payment_id)
+            self.logger.info(f"Retrieved payment: {payment.id}")
+            return json.dumps(payment)
+        except Exception as e:
+            return self.handle_exception("payment_get", e)
+
+    def payment_list(self, limit: int = 100) -> str:
+        r"""List payments.
+
+        Args:
+            limit (int, optional): Number of payments to retrieve.
+                (default::obj:`100`)
+
+        Returns:
+            str: A list of payment data if successful, or an error message
+                string if failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info(f"Listing payments with limit={limit}")
+            payments = stripe.PaymentIntent.list(limit=limit).data
+            self.logger.info(
+                f"Successfully retrieved {len(payments)} payments."
+            )
+            return json.dumps([payment for payment in payments])
+        except Exception as e:
+            return self.handle_exception("payment_list", e)
+
+    def refund_get(self, refund_id: str) -> str:
+        r"""Retrieve a refund by ID.
+
+        Args:
+            refund_id (str): The ID of the refund to retrieve.
+
+        Returns:
+            str: The refund data as a str if successful, or an error message
+                string if failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info(f"Retrieving refund with ID: {refund_id}")
+            refund = stripe.Refund.retrieve(refund_id)
+            self.logger.info(f"Retrieved refund: {refund.id}")
+            return json.dumps(refund)
+        except Exception as e:
+            return self.handle_exception("refund_get", e)
+
+    def refund_list(self, limit: int = 100) -> str:
+        r"""List refunds.
+
+        Args:
+            limit (int, optional): Number of refunds to retrieve.
+                (default::obj:`100`)
+
+        Returns:
+            str: A list of refund data as a str if successful, or an error
+                message string if failed.
+        """
+        import stripe
+
+        try:
+            self.logger.info(f"Listing refunds with limit={limit}")
+            refunds = stripe.Refund.list(limit=limit).data
+            self.logger.info(f"Successfully retrieved {len(refunds)} refunds.")
+            return json.dumps([refund for refund in refunds])
+        except Exception as e:
+            return self.handle_exception("refund_list", e)
+
+    def handle_exception(self, func_name: str, error: Exception) -> str:
+        r"""Handle exceptions by logging and returning an error message.
+
+        Args:
+            func_name (str): The name of the function where the exception
+                occurred.
+            error (Exception): The exception instance.
+
+        Returns:
+            str: An error message string.
+        """
+        from stripe import StripeError
+
+        if isinstance(error, StripeError):
+            message = error.user_message or str(error)
+            self.logger.error(f"Stripe error in {func_name}: {message}")
+            return f"Stripe error in {func_name}: {message}"
+        else:
+            self.logger.error(f"Unexpected error in {func_name}: {error!s}")
+            return f"Unexpected error in {func_name}: {error!s}"
+
+    def get_tools(self) -> List[FunctionTool]:
+        r"""Returns a list of FunctionTool objects representing the
+        functions in the toolkit.
+
+        Returns:
+            List[FunctionTool]: A list of FunctionTool objects for the
+                toolkit methods.
+        """
+        return [
+            FunctionTool(self.customer_get),
+            FunctionTool(self.customer_list),
+            FunctionTool(self.balance_get),
+            FunctionTool(self.balance_transaction_list),
+            FunctionTool(self.payment_get),
+            FunctionTool(self.payment_list),
+            FunctionTool(self.refund_get),
+            FunctionTool(self.refund_list),
+        ]

camel/toolkits/twitter_toolkit.py

@@ -20,12 +20,15 @@ from typing import Any, Dict, List, Optional, Union
 import requests
 from requests_oauthlib import OAuth1
 
+from camel.logger import get_logger
 from camel.toolkits import FunctionTool
 from camel.toolkits.base import BaseToolkit
 from camel.utils import api_keys_required
 
 TWEET_TEXT_LIMIT = 280
 
+logger = get_logger(__name__)
+
 
 @api_keys_required(
     "TWITTER_CONSUMER_KEY",

camel/types/__init__.py

@@ -14,6 +14,7 @@
 from .enums import (
     AudioModelType,
     EmbeddingModelType,
+    HuggingFaceRepoType,
     ModelPlatformType,
     ModelType,
     OpenAIBackendRole,
@@ -73,4 +74,5 @@ __all__ = [
     'NOT_GIVEN',
     'NotGiven',
     'ParsedChatCompletion',
+    'HuggingFaceRepoType',
 ]

camel/types/enums.py

@@ -41,9 +41,12 @@ class ModelType(UnifiedModelType, Enum):
     GLM_4V = 'glm-4v'
     GLM_3_TURBO = "glm-3-turbo"
 
+    # Groq platform models
     GROQ_LLAMA_3_1_8B = "llama-3.1-8b-instant"
     GROQ_LLAMA_3_1_70B = "llama-3.1-70b-versatile"
     GROQ_LLAMA_3_1_405B = "llama-3.1-405b-reasoning"
+    GROQ_LLAMA_3_3_70B = "llama-3.3-70b-versatile"
+    GROQ_LLAMA_3_3_70B_PREVIEW = "llama-3.3-70b-specdec"
     GROQ_LLAMA_3_8B = "llama3-8b-8192"
     GROQ_LLAMA_3_70B = "llama3-70b-8192"
     GROQ_MIXTRAL_8_7B = "mixtral-8x7b-32768"
@@ -59,13 +62,25 @@ class ModelType(UnifiedModelType, Enum):
     CLAUDE_INSTANT_1_2 = "claude-instant-1.2"
 
     # Claude3 models
-    CLAUDE_3_OPUS = "claude-3-opus-20240229"
+    CLAUDE_3_OPUS = "claude-3-opus-latest"
     CLAUDE_3_SONNET = "claude-3-sonnet-20240229"
     CLAUDE_3_HAIKU = "claude-3-haiku-20240307"
-    CLAUDE_3_5_SONNET = "claude-3-5-sonnet-20240620"
+    CLAUDE_3_5_SONNET = "claude-3-5-sonnet-latest"
+    CLAUDE_3_5_HAIKU = "claude-3-5-haiku-latest"
 
     # Nvidia models
-    NEMOTRON_4_REWARD = "nvidia/nemotron-4-340b-reward"
+    NVIDIA_NEMOTRON_340B_INSTRUCT = "nvidia/nemotron-4-340b-instruct"
+    NVIDIA_NEMOTRON_340B_REWARD = "nvidia/nemotron-4-340b-reward"
+    NVIDIA_YI_LARGE = "01-ai/yi-large"
+    NVIDIA_MISTRAL_LARGE = "mistralai/mistral-large"
+    NVIDIA_MIXTRAL_8X7B = "mistralai/mixtral-8x7b-instruct"
+    NVIDIA_LLAMA3_70B = "meta/llama3-70b"
+    NVIDIA_LLAMA3_1_8B_INSTRUCT = "meta/llama-3.1-8b-instruct"
+    NVIDIA_LLAMA3_1_70B_INSTRUCT = "meta/llama-3.1-70b-instruct"
+    NVIDIA_LLAMA3_1_405B_INSTRUCT = "meta/llama-3.1-405b-instruct"
+    NVIDIA_LLAMA3_2_1B_INSTRUCT = "meta/llama-3.2-1b-instruct"
+    NVIDIA_LLAMA3_2_3B_INSTRUCT = "meta/llama-3.2-3b-instruct"
+    NVIDIA_LLAMA3_3_70B_INSTRUCT = "meta/llama-3.3-70b-instruct"
 
     # Gemini models
     GEMINI_1_5_FLASH = "gemini-1.5-flash"
@@ -165,6 +180,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GPT_4,
             ModelType.GPT_4_TURBO,
             ModelType.GPT_4O,
+            ModelType.GPT_4O_MINI,
         }
 
     @property
@@ -191,6 +207,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.CLAUDE_3_SONNET,
             ModelType.CLAUDE_3_HAIKU,
             ModelType.CLAUDE_3_5_SONNET,
+            ModelType.CLAUDE_3_5_HAIKU,
         }
 
     @property
@@ -200,6 +217,8 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GROQ_LLAMA_3_1_8B,
             ModelType.GROQ_LLAMA_3_1_70B,
             ModelType.GROQ_LLAMA_3_1_405B,
+            ModelType.GROQ_LLAMA_3_3_70B,
+            ModelType.GROQ_LLAMA_3_3_70B_PREVIEW,
             ModelType.GROQ_LLAMA_3_8B,
             ModelType.GROQ_LLAMA_3_70B,
             ModelType.GROQ_MIXTRAL_8_7B,
@@ -225,13 +244,20 @@ class ModelType(UnifiedModelType, Enum):
 
     @property
     def is_nvidia(self) -> bool:
-        r"""Returns whether this type of models is Nvidia-released model.
-
-        Returns:
-            bool: Whether this type of models is nvidia.
-        """
+        r"""Returns whether this type of models is a NVIDIA model."""
         return self in {
-            ModelType.NEMOTRON_4_REWARD,
+            ModelType.NVIDIA_NEMOTRON_340B_INSTRUCT,
+            ModelType.NVIDIA_NEMOTRON_340B_REWARD,
+            ModelType.NVIDIA_YI_LARGE,
+            ModelType.NVIDIA_MISTRAL_LARGE,
+            ModelType.NVIDIA_LLAMA3_70B,
+            ModelType.NVIDIA_MIXTRAL_8X7B,
+            ModelType.NVIDIA_LLAMA3_1_8B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_1_70B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_1_405B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_2_1B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_2_3B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_3_70B_INSTRUCT,
         }
 
     @property
@@ -329,7 +355,6 @@ class ModelType(UnifiedModelType, Enum):
         if self is ModelType.GLM_4V:
             return 1024
         elif self in {
-            ModelType.NEMOTRON_4_REWARD,
             ModelType.STUB,
             ModelType.REKA_CORE,
             ModelType.REKA_EDGE,
@@ -338,17 +363,21 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.QWEN_MATH_TURBO,
             ModelType.COHERE_COMMAND,
             ModelType.COHERE_COMMAND_LIGHT,
+            ModelType.NVIDIA_NEMOTRON_340B_INSTRUCT,
+            ModelType.NVIDIA_NEMOTRON_340B_REWARD,
         }:
             return 4_096
         elif self in {
             ModelType.GPT_4,
             ModelType.GROQ_LLAMA_3_8B,
             ModelType.GROQ_LLAMA_3_70B,
+            ModelType.GROQ_LLAMA_3_3_70B_PREVIEW,
             ModelType.GROQ_GEMMA_7B_IT,
             ModelType.GROQ_GEMMA_2_9B_IT,
             ModelType.GLM_3_TURBO,
             ModelType.GLM_4,
             ModelType.QWEN_VL_PLUS,
+            ModelType.NVIDIA_LLAMA3_70B,
         }:
             return 8_192
         elif self in {
@@ -370,6 +399,9 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.YI_LARGE_FC,
             ModelType.QWEN_MAX,
             ModelType.QWEN_VL_MAX,
+            ModelType.NVIDIA_YI_LARGE,
+            ModelType.NVIDIA_MISTRAL_LARGE,
+            ModelType.NVIDIA_MIXTRAL_8X7B,
             ModelType.QWEN_QWQ_32B,
         }:
             return 32_768
@@ -401,6 +433,13 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.COHERE_COMMAND_R,
             ModelType.COHERE_COMMAND_R_PLUS,
             ModelType.COHERE_COMMAND_NIGHTLY,
+            ModelType.NVIDIA_LLAMA3_1_8B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_1_70B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_1_405B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_2_1B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_2_3B_INSTRUCT,
+            ModelType.NVIDIA_LLAMA3_3_70B_INSTRUCT,
+            ModelType.GROQ_LLAMA_3_3_70B,
         }:
             return 128_000
         elif self in {
@@ -418,6 +457,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.CLAUDE_3_SONNET,
             ModelType.CLAUDE_3_HAIKU,
             ModelType.CLAUDE_3_5_SONNET,
+            ModelType.CLAUDE_3_5_HAIKU,
             ModelType.YI_MEDIUM_200K,
         }:
             return 200_000
@@ -582,7 +622,9 @@ class ModelPlatformType(Enum):
     COHERE = "cohere"
     YI = "lingyiwanwu"
     QWEN = "tongyi-qianwen"
+    NVIDIA = "nvidia"
     DEEPSEEK = "deepseek"
+    SGLANG = "sglang"
 
     @property
     def is_openai(self) -> bool:
@@ -614,6 +656,11 @@ class ModelPlatformType(Enum):
         r"""Returns whether this platform is vllm."""
         return self is ModelPlatformType.VLLM
 
+    @property
+    def is_sglang(self) -> bool:
+        r"""Returns whether this platform is sglang."""
+        return self is ModelPlatformType.SGLANG
+
     @property
     def is_together(self) -> bool:
         r"""Returns whether this platform is together."""
@@ -670,6 +717,11 @@ class ModelPlatformType(Enum):
         r"""Returns whether this platform is Qwen."""
         return self is ModelPlatformType.QWEN
 
+    @property
+    def is_nvidia(self) -> bool:
+        r"""Returns whether this platform is Nvidia."""
+        return self is ModelPlatformType.NVIDIA
+
     @property
     def is_deepseek(self) -> bool:
         r"""Returns whether this platform is DeepSeek."""
@@ -716,3 +768,9 @@ class JinaReturnFormat(Enum):
     MARKDOWN = "markdown"
     HTML = "html"
     TEXT = "text"
+
+
+class HuggingFaceRepoType(str, Enum):
+    DATASET = "dataset"
+    MODEL = "model"
+    SPACE = "space"

camel/utils/commons.py

@@ -12,6 +12,7 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import importlib
+import logging
 import os
 import platform
 import re
@@ -39,14 +40,19 @@ import pydantic
 import requests
 from pydantic import BaseModel
 
+from camel.logger import get_logger
 from camel.types import TaskType
 
 from .constants import Constants
 
 F = TypeVar('F', bound=Callable[..., Any])
 
+logger = get_logger(__name__)
 
-def print_text_animated(text, delay: float = 0.02, end: str = ""):
+
+def print_text_animated(
+    text, delay: float = 0.02, end: str = "", log_level: int = logging.INFO
+):
     r"""Prints the given text with an animated effect.
 
     Args:
@@ -55,11 +61,22 @@ def print_text_animated(text, delay: float = 0.02, end: str = ""):
             (default: :obj:`0.02`)
         end (str, optional): The end character to print after each
             character of text. (default: :obj:`""`)
+        log_level (int, optional): The log level to use.
+            See https://docs.python.org/3/library/logging.html#levels
+            (default: :obj:`logging.INFO`)
     """
-    for char in text:
-        print(char, end=end, flush=True)
-        time.sleep(delay)
-    print('\n')
+    if logger.isEnabledFor(log_level):
+        # timestamp and other prefixes
+        logger.log(log_level, '')
+
+        for char in text:
+            print(char, end=end, flush=True)
+            time.sleep(delay)
+        # Close the log entry
+        logger.log(log_level, '')
+    else:
+        # This may be relevant for logging frameworks
+        logger.log(log_level, text)
 
 
 def get_prompt_template_key_words(template: str) -> Set[str]:

camel/utils/token_counting.py

@@ -22,6 +22,7 @@ from typing import TYPE_CHECKING, List, Optional
 
 from PIL import Image
 
+from camel.logger import get_logger
 from camel.types import (
     ModelType,
     OpenAIImageType,
@@ -44,6 +45,8 @@ SQUARE_PIXELS = 512
 SQUARE_TOKENS = 170
 EXTRA_TOKENS = 85
 
+logger = get_logger(__name__)
+
 
 def get_model_encoding(value_for_tiktoken: str):
     r"""Get model encoding from tiktoken.
@@ -65,7 +68,7 @@ def get_model_encoding(value_for_tiktoken: str):
         ]:
             encoding = tiktoken.get_encoding("o200k_base")
         else:
-            print("Model not found. Using cl100k_base encoding.")
+            logger.info("Model not found. Using cl100k_base encoding.")
             encoding = tiktoken.get_encoding("cl100k_base")
     return encoding
 
@@ -219,13 +222,18 @@ class OpenAITokenCounter(BaseTokenCounter):
 
 class AnthropicTokenCounter(BaseTokenCounter):
     @dependencies_required('anthropic')
-    def __init__(self):
-        r"""Constructor for the token counter for Anthropic models."""
+    def __init__(self, model: str):
+        r"""Constructor for the token counter for Anthropic models.
+
+        Args:
+            model (str): The name of the Anthropic model being used.
+        """
         from anthropic import Anthropic
 
         self.client = Anthropic()
-        self.tokenizer = self.client.get_tokenizer()
+        self.model = model
 
+    @dependencies_required('anthropic')
     def count_tokens_from_messages(self, messages: List[OpenAIMessage]) -> int:
         r"""Count number of tokens in the provided message list using
         loaded tokenizer specific for this type of model.
@@ -237,11 +245,18 @@ class AnthropicTokenCounter(BaseTokenCounter):
         Returns:
             int: Number of tokens in the messages.
         """
-        num_tokens = 0
-        for message in messages:
-            content = str(message["content"])
-            num_tokens += self.client.count_tokens(content)
-        return num_tokens
+        from anthropic.types.beta import BetaMessageParam
+
+        return self.client.beta.messages.count_tokens(
+            messages=[
+                BetaMessageParam(
+                    content=str(msg["content"]),
+                    role="user" if msg["role"] == "user" else "assistant",
+                )
+                for msg in messages
+            ],
+            model=self.model,
+        ).input_tokens
 
 
 class GeminiTokenCounter(BaseTokenCounter):
@@ -357,7 +372,7 @@ class MistralTokenCounter(BaseTokenCounter):
                 ModelType.MISTRAL_CODESTRAL,
                 ModelType.MISTRAL_CODESTRAL_MAMBA,
             }
-            else self.model_type.value
+            else self.model_type
         )
 
         self.tokenizer = MistralTokenizer.from_model(model_name)
@@ -400,7 +415,7 @@ class MistralTokenCounter(BaseTokenCounter):
         )
 
         mistral_request = ChatCompletionRequest(  # type: ignore[type-var]
-            model=self.model_type.value,
+            model=self.model_type,
             messages=[openai_msg],
         )