camel-ai 0.2.9__py3-none-any.whl → 0.2.11__py3-none-any.whl

camel/loaders/firecrawl_reader.py

@@ -1,24 +1,22 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
 from typing import Any, Dict, Optional
 
 from pydantic import BaseModel
 
-from camel.utils import api_keys_required
-
 
 class Firecrawl:
     r"""Firecrawl allows you to turn entire websites into LLM-ready markdown.
@@ -32,7 +30,6 @@ class Firecrawl:
         https://docs.firecrawl.dev/introduction
     """
 
-    @api_keys_required("FIRECRAWL_API_KEY")
     def __init__(
         self,
         api_key: Optional[str] = None,

camel/loaders/jina_url_reader.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
 from typing import Any, Optional

camel/loaders/unstructured_io.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import uuid
 import warnings
 from typing import (

camel/logger.py

@@ -0,0 +1,112 @@
+# ========= 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 logging
+import os
+import sys
+
+# Create a private logger
+_logger = logging.getLogger('camel')
+
+
+def _configure_library_logging():
+    if os.environ.get('CAMEL_LOGGING_DISABLED', 'False').lower() == 'true':
+        return
+
+    if not logging.root.handlers and not _logger.handlers:
+        logging.basicConfig(
+            level=os.environ.get('LOGLEVEL', 'INFO').upper(),
+            format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+            stream=sys.stdout,
+        )
+        logging.setLoggerClass(logging.Logger)
+        _logger.info("Camel library logging has been configured.")
+    else:
+        _logger.debug("Existing logger configuration found, using that.")
+
+
+def disable_logging():
+    r"""Disable all logging for the Camel library.
+
+    This function sets the log level to a value higher than CRITICAL,
+    effectively disabling all log messages, and adds a NullHandler to
+    suppress any potential warnings about no handlers being found.
+    """
+    os.environ['CAMEL_LOGGING_DISABLED'] = 'true'
+    _logger.setLevel(logging.CRITICAL + 1)
+    # Avoid adding multiple NullHandlers
+    if not any(
+        isinstance(handler, logging.NullHandler)
+        for handler in _logger.handlers
+    ):
+        _logger.addHandler(logging.NullHandler())
+    _logger.debug("Logging has been disabled.")
+
+
+def enable_logging():
+    r"""Enable logging for the Camel library.
+
+    This function re-enables logging if it was previously disabled,
+    and configures the library logging using the default settings.
+    If the logging is already configured,
+        this function does not change its configuration.
+    """
+    os.environ['CAMEL_LOGGING_DISABLED'] = 'false'
+    _configure_library_logging()
+
+
+def set_log_level(level):
+    r"""Set the logging level for the Camel library.
+
+    Args:
+        level (Union[str, int]): The logging level to set. This can be a string
+            (e.g., 'INFO') or a logging level constant (e.g., logging.INFO,
+            logging.DEBUG).
+            See https://docs.python.org/3/library/logging.html#levels
+
+    Raises:
+        ValueError: If the provided level is not a valid logging level.
+    """
+    valid_levels = ['NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
+    if isinstance(level, str):
+        if level.upper() not in valid_levels:
+            raise ValueError(
+                f"Invalid logging level."
+                f" Choose from: {', '.join(valid_levels)}"
+            )
+        level = level.upper()
+    elif not isinstance(level, int):
+        raise ValueError(
+            "Logging level must be an option from the logging module."
+        )
+
+    _logger.setLevel(level)
+    _logger.debug(f"Logging level set to: {logging.getLevelName(level)}")
+
+
+def get_logger(name):
+    r"""Get a logger with the specified name, prefixed with 'camel.'.
+
+    Args:
+        name (str): The name to be appended to 'camel.' to create the logger.
+
+    Returns:
+        logging.Logger: A logger instance with the name 'camel.{name}'.
+    """
+    return logging.getLogger(f'camel.{name}')
+
+
+# Lazy configuration: Only configure logging if explicitly enabled.
+if os.environ.get('CAMEL_LOGGING_DISABLED', 'False').strip().lower() != 'true':
+    _configure_library_logging()

camel/memories/__init__.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from .agent_memories import (
     ChatHistoryMemory,

camel/memories/agent_memories.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from typing import List, Optional
 

camel/memories/base.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from abc import ABC, abstractmethod
 from typing import List, Tuple

camel/memories/blocks/__init__.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from .chat_history_block import ChatHistoryBlock
 from .vectordb_block import VectorDBBlock

camel/memories/blocks/chat_history_block.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import warnings
 from typing import List, Optional
 

camel/memories/blocks/vectordb_block.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from typing import List, Optional
 

camel/memories/context_creators/__init__.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from .score_based import ScoreBasedContextCreator
 

camel/memories/context_creators/score_based.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from typing import List, Tuple
 
 from pydantic import BaseModel

camel/memories/records.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from dataclasses import asdict
 from typing import Any, ClassVar, Dict

camel/messages/__init__.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from camel.types import (
     ChatCompletionAssistantMessageParam,
     ChatCompletionFunctionMessageParam,
@@ -19,12 +19,24 @@ from camel.types import (
     ChatCompletionUserMessageParam,
 )
 
+from .conversion import (
+    HermesFunctionFormatter,
+    ShareGPTMessage,
+)
+from .conversion.conversation_models import (
+    ShareGPTConversation,
+)
+from .conversion.sharegpt.function_call_formatter import (
+    FunctionCallFormatter,
+)
+
 OpenAISystemMessage = ChatCompletionSystemMessageParam
 OpenAIAssistantMessage = ChatCompletionAssistantMessageParam
 OpenAIUserMessage = ChatCompletionUserMessageParam
 OpenAIFunctionMessage = ChatCompletionFunctionMessageParam
 OpenAIMessage = ChatCompletionMessageParam
 
+
 from .base import BaseMessage  # noqa: E402
 from .func_message import FunctionCallingMessage  # noqa: E402
 
@@ -34,6 +46,10 @@ __all__ = [
     'OpenAIUserMessage',
     'OpenAIFunctionMessage',
     'OpenAIMessage',
+    'FunctionCallFormatter',
+    'HermesFunctionFormatter',
+    'ShareGPTConversation',
+    'ShareGPTMessage',
     'BaseMessage',
     'FunctionCallingMessage',
 ]

camel/messages/base.py

@@ -1,30 +1,35 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import base64
 import io
+import re
 from dataclasses import dataclass
-from typing import Any, Dict, List, Literal, Optional, Tuple, Union
+from typing import Any, Dict, List, Literal, Optional, Tuple, Type, Union
 
 import numpy as np
 from PIL import Image
+from pydantic import BaseModel
 
 from camel.messages import (
+    FunctionCallFormatter,
+    HermesFunctionFormatter,
     OpenAIAssistantMessage,
     OpenAIMessage,
     OpenAISystemMessage,
     OpenAIUserMessage,
 )
+from camel.messages.conversion import ShareGPTMessage
 from camel.prompts import CodePrompt, TextPrompt
 from camel.types import (
     OpenAIBackendRole,
@@ -47,24 +52,27 @@ class BaseMessage:
             for the message.
         content (str): The content of the message.
         video_bytes (Optional[bytes]): Optional bytes of a video associated
-            with the message. Default is None.
+            with the message. (default::obj:`None`)
         image_list (Optional[List[Image.Image]]): Optional list of PIL Image
-            objects associated with the message. Default is None.
+            objects associated with the message. (default::obj:`None`)
         image_detail (Literal["auto", "low", "high"]): Detail level of the
-            images associated with the message. Default is "auto".
+            images associated with the message. (default::obj:`auto`)
         video_detail (Literal["auto", "low", "high"]): Detail level of the
-            videos associated with the message. Default is "low".
+            videos associated with the message. (default::obj:`low`)
+        parsed: Optional[Union[Type[BaseModel], dict]]: Optional object which
+            is parsed from the content. (default::obj:`None`)
     """
 
     role_name: str
     role_type: RoleType
-    meta_dict: Optional[Dict[str, str]]
+    meta_dict: Optional[Dict[str, Any]]
     content: str
 
     video_bytes: Optional[bytes] = None
     image_list: Optional[List[Image.Image]] = None
     image_detail: Literal["auto", "low", "high"] = "auto"
     video_detail: Literal["auto", "low", "high"] = "low"
+    parsed: Optional[Union[Type[BaseModel], dict]] = None
 
     @classmethod
     def make_user_message(
@@ -271,6 +279,106 @@ class BaseMessage:
 
         return text_prompts, code_prompts
 
+    @classmethod
+    def from_sharegpt(
+        cls,
+        message: ShareGPTMessage,
+        function_format: Optional[FunctionCallFormatter[Any, Any]] = None,
+        role_mapping=None,
+    ) -> "BaseMessage":
+        r"""Convert ShareGPT message to BaseMessage or FunctionCallingMessage.
+        Note tool calls and responses have an 'assistant' role in CAMEL
+
+        Args:
+            message (ShareGPTMessage): ShareGPT message to convert.
+            function_format (FunctionCallFormatter, optional): Function call
+                formatter to use. (default: :obj:`HermesFunctionFormatter()`.
+            role_mapping (Dict[str, List[str, RoleType]], optional): Role
+                mapping to use. Defaults to a CAMEL specific mapping.
+
+        Returns:
+            BaseMessage: Converted message.
+        """
+        from camel.messages import FunctionCallingMessage
+
+        if role_mapping is None:
+            role_mapping = {
+                "system": ["system", RoleType.USER],
+                "human": ["user", RoleType.USER],
+                "gpt": ["assistant", RoleType.ASSISTANT],
+                "tool": ["assistant", RoleType.ASSISTANT],
+            }
+        role_name, role_type = role_mapping[message.from_]
+
+        if function_format is None:
+            function_format = HermesFunctionFormatter()
+
+        # Check if this is a function-related message
+        if message.from_ == "gpt":
+            func_info = function_format.extract_tool_calls(message.value)
+            if (
+                func_info and len(func_info) == 1
+            ):  # TODO: Handle multiple tool calls
+                # Including cleaned content is useful to
+                # remind consumers of non-considered content
+                clean_content = re.sub(
+                    r"<tool_call>.*?</tool_call>",
+                    "",
+                    message.value,
+                    flags=re.DOTALL,
+                ).strip()
+
+                return FunctionCallingMessage(
+                    role_name=role_name,
+                    role_type=role_type,
+                    meta_dict=None,
+                    content=clean_content,
+                    func_name=func_info[0].__dict__["name"],
+                    args=func_info[0].__dict__["arguments"],
+                )
+        elif message.from_ == "tool":
+            func_r_info = function_format.extract_tool_response(message.value)
+            if func_r_info:
+                return FunctionCallingMessage(
+                    role_name=role_name,
+                    role_type=role_type,
+                    meta_dict=None,
+                    content="",
+                    func_name=func_r_info.__dict__["name"],
+                    result=func_r_info.__dict__["content"],
+                )
+
+        # Regular message
+        return cls(
+            role_name=role_name,
+            role_type=role_type,
+            meta_dict=None,
+            content=message.value,
+        )
+
+    def to_sharegpt(
+        self,
+        function_format: Optional[FunctionCallFormatter] = None,
+    ) -> ShareGPTMessage:
+        r"""Convert BaseMessage to ShareGPT message
+
+        Args:
+            function_format (FunctionCallFormatter): Function call formatter
+                to use. Defaults to Hermes.
+        """
+
+        if function_format is None:
+            function_format = HermesFunctionFormatter()
+
+        # Convert role type to ShareGPT 'from' field
+        if self.role_type == RoleType.USER:
+            from_ = "system" if self.role_name == "system" else "human"
+        else:  # RoleType.ASSISTANT
+            from_ = "gpt"
+
+        # Function conversion code in FunctionCallingMessage
+        return ShareGPTMessage(from_=from_, value=self.content)  # type: ignore[call-arg]
+
     def to_openai_message(
         self,
         role_at_backend: OpenAIBackendRole,
@@ -315,7 +423,6 @@ class BaseMessage:
                 "text": self.content,
             }
         )
-
         if self.image_list and len(self.image_list) > 0:
             for image in self.image_list:
                 if image.format is None: