camel-ai 0.2.73a4__py3-none-any.whl → 0.2.80a2__py3-none-any.whl

camel/toolkits/slack_toolkit.py

@@ -128,8 +128,9 @@ class SlackToolkit(BaseToolkit):
             return f"Error creating conversation: {e.response['error']}"
 
     def join_slack_channel(self, channel_id: str) -> str:
-        r"""Joins an existing Slack channel. To get the `channel_id` of a
-        channel, you can use the `get_slack_channel_information` function.
+        r"""Joins an existing Slack channel. When use this function you must
+        call `get_slack_channel_information` function first to get the
+        `channel id`.
 
         Args:
             channel_id (str): The ID of the Slack channel to join.
@@ -147,8 +148,9 @@ class SlackToolkit(BaseToolkit):
             return f"Error joining channel: {e.response['error']}"
 
     def leave_slack_channel(self, channel_id: str) -> str:
-        r"""Leaves an existing Slack channel. To get the `channel_id` of a
-        channel, you can use the `get_slack_channel_information` function.
+        r"""Leaves an existing Slack channel. When use this function you must
+        call `get_slack_channel_information` function first to get the
+        `channel id`.
 
         Args:
             channel_id (str): The ID of the Slack channel to leave.
@@ -199,9 +201,9 @@ class SlackToolkit(BaseToolkit):
             return f"Error retrieving channel list: {e.response['error']}"
 
     def get_slack_channel_message(self, channel_id: str) -> str:
-        r"""Retrieve messages from a Slack channel. To get the `channel_id`
-        of a channel, you can use the `get_slack_channel_information`
-        function.
+        r"""Retrieve messages from a Slack channel. When use this function you
+        must call `get_slack_channel_information` function first to get the
+        `channel id`.
 
         Args:
             channel_id (str): The ID of the Slack channel to retrieve messages
@@ -233,8 +235,10 @@ class SlackToolkit(BaseToolkit):
         file_path: Optional[str] = None,
         user: Optional[str] = None,
     ) -> str:
-        r"""Send a message to a Slack channel. To get the `channel_id` of a
-        channel, you can use the `get_slack_channel_information` function.
+        r"""Send a message to a Slack channel. When use this function you must
+        call `get_slack_channel_information` function first to get the
+        `channel id`. If use user, you must use `get_slack_user_list`
+        function first to get the user id.
 
         Args:
             message (str): The message to send.
@@ -279,7 +283,9 @@ class SlackToolkit(BaseToolkit):
         time_stamp: str,
         channel_id: str,
     ) -> str:
-        r"""Delete a message from a Slack channel.
+        r"""Delete a message from a Slack channel. When use this function you
+        must call `get_slack_channel_information` function first to get the
+        `channel id`.
 
         Args:
             time_stamp (str): The 'ts' value of the message to be deleted.
@@ -301,6 +307,52 @@ class SlackToolkit(BaseToolkit):
         except SlackApiError as e:
             return f"Error deleting message: {e.response['error']}"
 
+    def get_slack_user_list(self) -> str:
+        r"""Retrieve a list of all users in the Slack workspace.
+
+        Returns:
+            str: A JSON string representing a list of users. Each user
+                object contains 'id', 'name'.
+        """
+        from slack_sdk.errors import SlackApiError
+
+        try:
+            slack_client = self._login_slack()
+            response = slack_client.users_list()
+            users = response["members"]
+            filtered_users = [
+                {
+                    "id": user["id"],
+                    "name": user["name"],
+                }
+                for user in users
+            ]
+
+            return json.dumps(filtered_users, ensure_ascii=False)
+        except SlackApiError as e:
+            return f"Error retrieving user list: {e.response['error']}"
+
+    def get_slack_user_info(self, user_id: str) -> str:
+        r"""Retrieve information about a specific user in the Slack workspace.
+        normally, you don't need to use this method, when you need to get a
+        user's detailed information, use this method. Use `get_slack_user_list`
+        function first to get the user id.
+
+        Args:
+            user_id (str): The ID of the user to retrieve information about.
+
+        Returns:
+            str: A JSON string representing the user's information.
+        """
+        from slack_sdk.errors import SlackApiError
+
+        try:
+            slack_client = self._login_slack()
+            response = slack_client.users_info(user=user_id)
+            return json.dumps(response, ensure_ascii=False)
+        except SlackApiError as e:
+            return f"Error retrieving user info: {e.response['error']}"
+
     def get_tools(self) -> List[FunctionTool]:
         r"""Returns a list of FunctionTool objects representing the
         functions in the toolkit.
@@ -317,4 +369,6 @@ class SlackToolkit(BaseToolkit):
             FunctionTool(self.get_slack_channel_message),
             FunctionTool(self.send_slack_message),
             FunctionTool(self.delete_slack_message),
+            FunctionTool(self.get_slack_user_list),
+            FunctionTool(self.get_slack_user_info),
         ]

camel/toolkits/terminal_toolkit/__init__.py

@@ -0,0 +1,18 @@
+# ========= 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. =========
+from .terminal_toolkit import TerminalToolkit
+
+__all__ = [
+    "TerminalToolkit",
+]