Feat(Group chat channels) (#120)

Author: echo-yiyiyi

README.md

@@ -249,13 +249,13 @@ To discover how to create profiles for large-scale users, as well as how to visu
 
 ### Latest Updates
 
-📢 Support Interview Action for asking agents specific questions and getting answers. - 📆 June 2, 2025
+📢 Add features for creating group chats, sending messages in group chats, and leaving group chats. - 📆 June 6, 2025
 
+- Support Interview Action for asking agents specific questions and getting answers. - 📆 June 2, 2025
 - Support customization of each agent's models, tools, and prompts; refactor the interface to follow the PettingZoo style. - 📆 May 22, 2025
 - Refactor into the OASIS environment, publish camel-oasis on PyPI, and release the documentation. - 📆 April 24, 2025
 - Support OPENAI Embedding model for Twhin-Bert Recommendation System. - 📆 March 25, 2025
-- Updated social media links and QR codes in the README! Join OASIS & CAMEL on WeChat, X, Reddit, and Discord. - 📆 March 24, 2025
-- Add multi-threading support to speed up LLM inference by 13x - 📆 March 4, 2025
+  ...
 - Slightly refactoring the database to add Quote Action and modify Repost Action - 📆 January 13, 2025
 - Added the demo video and oasis's star history in the README - 📆 January 5, 2025
 - Introduced an Electronic Mall on the Reddit platform - 📆 December 5, 2024

docs/key_modules/actions.mdx

@@ -108,6 +108,11 @@ OASIS provides a comprehensive set of actions that simulate real social media be
 | `DO_NOTHING` | Perform no action (pass the turn) |
 | `PURCHASE_PRODUCT` | Purchase a product (for e-commerce simulations) |
 | `INTERVIEW` | Interview a user and record the interview result in the database |
+| `CREATE_GROUP`  | Create a new group with a given name                             |
+| `JOIN_GROUP`  | Join a group by group ID                                         |
+| `LEAVE_GROUP`  | Leave a group by group ID                                        |
+| `SEND_TO_GROUP`  | Send a message to a group                                        |
+| `LISTEN_FROM_GROUP`  | Listen for messages from groups                                  |
 
 ### Platform-Specific Actions
 
@@ -302,7 +307,7 @@ action = ManualAction(
 )
 ```
 
-### REFRESH
+#### REFRESH
 ```python
 action = ManualAction(
     action=ActionType.REFRESH,
@@ -333,3 +338,43 @@ action = ManualAction(
     args={"prompt": "What is your name?"}
 )
 ```
+
+#### CREATE_GROUP
+```python
+action = ManualAction(
+    action=ActionType.CREATE_GROUP,
+    args={"group_name": "OASIS Fans"}
+)
+```
+
+#### JOIN_GROUP
+```python
+action = ManualAction(
+    action=ActionType.JOIN_GROUP,
+    args={"group_id": 1}
+)
+```
+
+#### LEAVE_GROUP
+```python
+action = ManualAction(
+    action=ActionType.LEAVE_GROUP,
+    args={"group_id": 1}
+)
+```
+
+#### SEND_TO_GROUP
+```python
+action = ManualAction(
+    action=ActionType.SEND_TO_GROUP,
+    args={"group_id": 1, "message": "Hello, OASIS fans!"}
+)
+```
+
+#### LISTEN_FROM_GROUP
+```python
+action = ManualAction(
+    action=ActionType.LISTEN_FROM_GROUP,
+    args={}
+)
+```

examples/group_chat_simulation.py

@@ -0,0 +1,108 @@
+# =========== 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. ===========
+import asyncio
+import os
+
+from camel.models import ModelFactory
+from camel.types import ModelPlatformType
+
+import oasis
+from oasis import (ActionType, LLMAction, ManualAction,
+                   generate_twitter_agent_graph)
+
+
+async def main():
+    openai_model = ModelFactory.create(
+        model_platform=ModelPlatformType.DEEPSEEK,
+        model_type="deepseek-chat",
+        url="https://api.deepseek.com/v1",
+    )
+
+    # Define the available actions for the agents
+    available_actions = [
+        ActionType.JOIN_GROUP,
+        ActionType.LEAVE_GROUP,
+        ActionType.LISTEN_FROM_GROUP,
+        ActionType.SEND_TO_GROUP,
+        ActionType.LIKE_POST,
+        ActionType.UNLIKE_POST,
+        ActionType.REPOST,
+        ActionType.QUOTE_POST,
+    ]
+
+    agent_graph = await generate_twitter_agent_graph(
+        profile_path=(
+            "data/twitter_dataset/anonymous_topic_200_1h/False_Business_0.csv"
+        ),
+        model=openai_model,
+        available_actions=available_actions,
+    )
+
+    # Define the path to the database
+    db_path = "./data/twitter_simulation.db"
+
+    # Delete the old database
+    if os.path.exists(db_path):
+        os.remove(db_path)
+
+    # Make the environment
+    env = oasis.make(
+        agent_graph=agent_graph,
+        platform=oasis.DefaultPlatformType.TWITTER,
+        database_path=db_path,
+    )
+
+    # Run the environment
+    await env.reset()
+
+    group_result = await env.platform.create_group(1, "AI Group")
+    group_id = group_result["group_id"]
+
+    actions_1 = {}
+
+    actions_1[env.agent_graph.get_agent(0)] = ManualAction(
+        action_type=ActionType.JOIN_GROUP, action_args={"group_id": group_id})
+    await env.step(actions_1)
+
+    actions_2 = {
+        agent: LLMAction()
+        # Activate 5 agents with id 1, 3, 5, 7, 9
+        for _, agent in env.agent_graph.get_agents([1, 3, 5, 7, 9])
+    }
+
+    await env.step(actions_2)
+
+    actions_3 = {}
+
+    actions_3[env.agent_graph.get_agent(1)] = ManualAction(
+        action_type=ActionType.SEND_TO_GROUP,
+        action_args={
+            "group_id": group_id,
+            "message": "DeepSeek is amazing!"
+        },
+    )
+    await env.step(actions_3)
+
+    actions_4 = {
+        agent: LLMAction()
+        for _, agent in env.agent_graph.get_agents()
+    }
+    await env.step(actions_4)
+
+    # Close the environment
+    await env.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

oasis/social_agent/agent_action.py

@@ -51,6 +51,10 @@ def get_openai_function_list(self) -> list[FunctionTool]:
                 self.unmute,
                 self.purchase_product,
                 self.interview,
+                self.join_group,
+                self.leave_group,
+                self.send_to_group,
+                self.create_group,
             ]
         ]
 
@@ -665,3 +669,60 @@ async def interview(self, prompt: str):
             }
         """
         return await self.perform_action(prompt, ActionType.INTERVIEW.value)
+
+    async def create_group(self, group_name: str):
+        r"""Creates a new group on the platform.
+
+        Args:
+            group_name (str): The name of the group to be created.
+
+        Returns:
+            dict: Platform response indicating success or failure,
+            e.g.{"success": True, "group_id": 1}
+        """
+        return await self.perform_action(group_name,
+                                         ActionType.CREATE_GROUP.value)
+
+    async def join_group(self, group_id: int):
+        r"""Joins a group with the specified ID.
+
+        Args:
+            group_id (int): The ID of the group to join.
+
+        Returns:
+            dict: Platform response indicating success or failure,
+            e.g. {"success": True}
+        """
+        return await self.perform_action(group_id, ActionType.JOIN_GROUP.value)
+
+    async def leave_group(self, group_id: int):
+        r"""Leaves a group with the specified ID.
+
+        Args:
+            group_id (int): The ID of the group to leave.
+
+        Returns:
+            dict: Platform response indicating success or failure, e.g.
+            {"success": True}
+        """
+        return await self.perform_action(group_id,
+                                         ActionType.LEAVE_GROUP.value)
+
+    async def send_to_group(self, group_id: int, message: str):
+        r"""Sends a message to a specific group.
+
+        Args:
+            group_id (int): The ID of the target group.
+            message (str): The content of the message to send.
+
+        Returns:
+            dict: Platform response indicating success or failure, e.g.
+             {"success": True, "message_id": 123}
+        """
+        return await self.perform_action((group_id, message),
+                                         ActionType.SEND_TO_GROUP.value)
+
+    async def listen_from_group(self):
+        r"""Listen messages from groups"""
+        return await self.perform_action(self.agent_id,
+                                         ActionType.LISTEN_FROM_GROUP.value)

oasis/social_agent/agent_environment.py

@@ -34,7 +34,18 @@ class SocialEnvironment(Environment):
 
     posts_env_template = Template(
         "After refreshing, you see some posts $posts")
+
+    groups_env_template = Template(
+        "And there are many group chat channels $all_groups\n"
+        "And You are already in some groups $joined_groups\n"
+        "You receive some messages from them $messages\n"
+        "You can join the groups you are interested, "
+        "leave the groups you already in, send messages to the group "
+        "you already in.\n"
+        "You must make sure you can only send messages to the group you "
+        "are already in")
     env_template = Template(
+        "$groups_env\n"
         "$posts_env\npick one you want to perform action that best "
         "reflects your current inclination based on your profile and "
         "posts content. Do not limit your action in just `like` to like posts")
@@ -60,6 +71,21 @@ async def get_follows_env(self) -> str:
         # TODO: Implement follows env
         return self.follows_env_template.substitute(num_follows=0)
 
+    async def get_group_env(self) -> str:
+        groups = await self.action.listen_from_group()
+        if groups["success"]:
+            all_groups = json.dumps(groups["all_groups"])
+            joined_groups = json.dumps(groups["joined_groups"])
+            messages = json.dumps(groups["messages"])
+            groups_env = self.groups_env_template.substitute(
+                all_groups=all_groups,
+                joined_groups=joined_groups,
+                messages=messages,
+            )
+        else:
+            groups_env = "No groups."
+        return groups_env
+
     async def to_text_prompt(
         self,
         include_posts: bool = True,
@@ -76,4 +102,5 @@ async def to_text_prompt(
             followers_env=followers_env,
             follows_env=follows_env,
             posts_env=posts_env,
+            groups_env=await self.get_group_env(),
         )

oasis/social_platform/database.py

@@ -34,6 +34,9 @@
 COMMENT_LIKE_SCHEMA_SQL = "comment_like.sql"
 COMMENT_DISLIKE_SCHEMA_SQL = "comment_dislike.sql"
 PRODUCT_SCHEMA_SQL = "product.sql"
+GROUP_SCHEMA_SQL = "chat_group.sql"
+GROUP_MEMBER_SCHEMA_SQL = "group_member.sql"
+GROUP_MESSAGE_SCHEMA_SQL = "group_message.sql"
 
 TABLE_NAMES = {
     "user",
@@ -48,6 +51,9 @@
     "comment_like.sql",
     "comment_dislike.sql",
     "product.sql",
+    "group",
+    "group_member",
+    "group_message",
 }
 
 
@@ -154,6 +160,24 @@ def create_db(db_path: str | None = None):
             product_sql_script = sql_file.read()
         cursor.executescript(product_sql_script)
 
+        # Read and execute the group table SQL script:
+        group_sql_path = osp.join(schema_dir, GROUP_SCHEMA_SQL)
+        with open(group_sql_path, "r") as sql_file:
+            group_sql_script = sql_file.read()
+        cursor.executescript(group_sql_script)
+
+        # Read and execute the group_member table SQL script:
+        group_member_sql_path = osp.join(schema_dir, GROUP_MEMBER_SCHEMA_SQL)
+        with open(group_member_sql_path, "r") as sql_file:
+            group_member_sql_script = sql_file.read()
+        cursor.executescript(group_member_sql_script)
+
+        # Read and execute the group_message table SQL script:
+        group_message_sql_path = osp.join(schema_dir, GROUP_MESSAGE_SCHEMA_SQL)
+        with open(group_message_sql_path, "r") as sql_file:
+            group_message_sql_script = sql_file.read()
+        cursor.executescript(group_message_sql_script)
+
         # Commit the changes:
         conn.commit()