File size: 10,744 Bytes
62da328 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# ========= 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 __future__ import annotations
import json
import logging
import os
from typing import TYPE_CHECKING, List, Optional
from camel.toolkits.base import BaseToolkit
if TYPE_CHECKING:
from ssl import SSLContext
from slack_sdk import WebClient
from camel.toolkits import FunctionTool
logger = logging.getLogger(__name__)
class SlackToolkit(BaseToolkit):
r"""A class representing a toolkit for Slack operations.
This class provides methods for Slack operations such as creating a new
channel, joining an existing channel, leaving a channel.
"""
def _login_slack(
self,
slack_token: Optional[str] = None,
ssl: Optional[SSLContext] = None,
) -> WebClient:
r"""Authenticate using the Slack API.
Args:
slack_token (str, optional): The Slack API token.
If not provided, it attempts to retrieve the token from
the environment variable SLACK_BOT_TOKEN or SLACK_USER_TOKEN.
ssl (SSLContext, optional): SSL context for secure connections.
Defaults to `None`.
Returns:
WebClient: A WebClient object for interacting with Slack API.
Raises:
ImportError: If slack_sdk package is not installed.
KeyError: If SLACK_BOT_TOKEN or SLACK_USER_TOKEN
environment variables are not set.
"""
try:
from slack_sdk import WebClient
except ImportError as e:
raise ImportError(
"Cannot import slack_sdk. Please install the package with \
`pip install slack_sdk`."
) from e
if not slack_token:
slack_token = os.environ.get("SLACK_BOT_TOKEN") or os.environ.get(
"SLACK_USER_TOKEN"
)
if not slack_token:
raise KeyError(
"SLACK_BOT_TOKEN or SLACK_USER_TOKEN environment "
"variable not set."
)
client = WebClient(token=slack_token, ssl=ssl)
logger.info("Slack login successful.")
return client
def create_slack_channel(
self, name: str, is_private: Optional[bool] = True
) -> str:
r"""Creates a new slack channel, either public or private.
Args:
name (str): Name of the public or private channel to create.
is_private (bool, optional): Whether to create a private channel
instead of a public one. Defaults to `True`.
Returns:
str: JSON string containing information about Slack
channel created.
Raises:
SlackApiError: If there is an error during get slack channel
information.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
response = slack_client.conversations_create(
name=name, is_private=is_private
)
channel_id = response["channel"]["id"]
response = slack_client.conversations_archive(channel=channel_id)
return str(response)
except SlackApiError as e:
return f"Error creating conversation: {e.response['error']}"
def join_slack_channel(self, channel_id: str) -> str:
r"""Joins an existing Slack channel.
Args:
channel_id (str): The ID of the Slack channel to join.
Returns:
str: A confirmation message indicating whether join successfully
or an error message.
Raises:
SlackApiError: If there is an error during get slack channel
information.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
response = slack_client.conversations_join(channel=channel_id)
return str(response)
except SlackApiError as e:
return f"Error creating conversation: {e.response['error']}"
def leave_slack_channel(self, channel_id: str) -> str:
r"""Leaves an existing Slack channel.
Args:
channel_id (str): The ID of the Slack channel to leave.
Returns:
str: A confirmation message indicating whether leave successfully
or an error message.
Raises:
SlackApiError: If there is an error during get slack channel
information.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
response = slack_client.conversations_leave(channel=channel_id)
return str(response)
except SlackApiError as e:
return f"Error creating conversation: {e.response['error']}"
def get_slack_channel_information(self) -> str:
r"""Retrieve Slack channels and return relevant information in JSON
format.
Returns:
str: JSON string containing information about Slack channels.
Raises:
SlackApiError: If there is an error during get slack channel
information.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
response = slack_client.conversations_list()
conversations = response["channels"]
# Filtering conversations and extracting required information
filtered_result = [
{
key: conversation[key]
for key in ("id", "name", "created", "num_members")
}
for conversation in conversations
if all(
key in conversation
for key in ("id", "name", "created", "num_members")
)
]
return json.dumps(filtered_result, ensure_ascii=False)
except SlackApiError as e:
return f"Error creating conversation: {e.response['error']}"
def get_slack_channel_message(self, channel_id: str) -> str:
r"""Retrieve messages from a Slack channel.
Args:
channel_id (str): The ID of the Slack channel to retrieve messages
from.
Returns:
str: JSON string containing filtered message data.
Raises:
SlackApiError: If there is an error during get
slack channel message.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
result = slack_client.conversations_history(channel=channel_id)
messages = result["messages"]
filtered_messages = [
{key: message[key] for key in ("user", "text", "ts")}
for message in messages
if all(key in message for key in ("user", "text", "ts"))
]
return json.dumps(filtered_messages, ensure_ascii=False)
except SlackApiError as e:
return f"Error retrieving messages: {e.response['error']}"
def send_slack_message(
self,
message: str,
channel_id: str,
user: Optional[str] = None,
) -> str:
r"""Send a message to a Slack channel.
Args:
message (str): The message to send.
channel_id (str): The ID of the Slack channel to send message.
user (Optional[str]): The user ID of the recipient.
Defaults to `None`.
Returns:
str: A confirmation message indicating whether the message was sent
successfully or an error message.
Raises:
SlackApiError: If an error occurs while sending the message.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
if user:
response = slack_client.chat_postEphemeral(
channel=channel_id, text=message, user=user
)
else:
response = slack_client.chat_postMessage(
channel=channel_id, text=message
)
return str(response)
except SlackApiError as e:
return f"Error creating conversation: {e.response['error']}"
def delete_slack_message(
self,
time_stamp: str,
channel_id: str,
) -> str:
r"""Delete a message to a Slack channel.
Args:
time_stamp (str): Timestamp of the message to be deleted.
channel_id (str): The ID of the Slack channel to delete message.
Returns:
str: A confirmation message indicating whether the message
was delete successfully or an error message.
Raises:
SlackApiError: If an error occurs while sending the message.
"""
from slack_sdk.errors import SlackApiError
try:
slack_client = self._login_slack()
response = slack_client.chat_delete(
channel=channel_id, ts=time_stamp
)
return str(response)
except SlackApiError as e:
return f"Error creating conversation: {e.response['error']}"
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
representing the functions in the toolkit.
"""
return [
FunctionTool(self.create_slack_channel),
FunctionTool(self.join_slack_channel),
FunctionTool(self.leave_slack_channel),
FunctionTool(self.get_slack_channel_information),
FunctionTool(self.get_slack_channel_message),
FunctionTool(self.send_slack_message),
FunctionTool(self.delete_slack_message),
]
|