Message

Message#

1. Concept#

The BaseMessage class is the base class for message objects used in the CAMEL chat system. It is designed to provide a consistent structure for the messages in the system and allow for easy conversion between different message types.

2. Get Started#

2.1 Creating a BaseMessage Instance#

To create a BaseMessage instance, you need to provide the following arguments:

  • role_name: The name of the user or assistant role.

  • role_type: The type of role, either RoleType.ASSISTANT or RoleType.USER.

  • meta_dict: An optional metadata dictionary for the message.

  • content: The content of the message.

Here’s an example of creating a BaseMessage instance:

from camel.messages import BaseMessage
from camel.types import RoleType

message = BaseMessage(
    role_name="test_user",
    role_type=RoleType.USER,
    content="test content"
)

Additionally, the BaseMessage class provides class methods to easily create user and assistant agent messages:

  1. Creating a user agent message:

    from camel.messages import BaseMessage

user_message = BaseMessage.make_user_message(
    role_name="user_name", 
    content="test content for user",
)

  2. Creating an assistant agent message:

    from camel.messages import BaseMessage

assistant_message = BaseMessage.make_assistant_message(
    role_name="assistant_name",
    content="test content for assistant",
)

2.2 Using the Methods of the BaseMessage Class#

The BaseMessage class offers several methods:

  1. Creating a new instance with updated content:

    new_message = message.create_new_instance("new test content")
print(isinstance(new_message, BaseMessage))
>>> True

  2. Converting to an OpenAIMessage object:

    openai_message = message.to_openai_message(role_at_backend=OpenAIBackendRole.USER)
print(openai_message == {"role": "user", "content": "test content"})
>>> True

  3. Converting to an OpenAISystemMessage object:

    openai_system_message = message.to_openai_system_message()
print(openai_system_message == {"role": "system", "content": "test content"})
>>> True

  4. Converting to an OpenAIUserMessage object:

    openai_user_message = message.to_openai_user_message()
print(openai_user_message == {"role": "user", "content": "test content"})
>>> True

  5. Converting to an OpenAIAssistantMessage object:

    openai_assistant_message = message.to_openai_assistant_message()
print(openai_assistant_message == {"role": "assistant", "content": "test content"})
>>> True

  6. Converting to a dictionary:

    message_dict = message.to_dict()
print(message_dict == {
    "role_name": "test_user",
    "role_type": "USER",
    "content": "test content"
})
>>> True

These methods allow you to convert a BaseMessage instance into different message types depending on your needs.

3. Conclusion#

In this session, we introduced the BaseMessage class and its conversion to different types of messages. These components play essential roles in the CAMEL chat system, facilitating the creation, management, and interpretation of messages with clarity.

Contents