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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321 | class SlackReader(BasePydanticReader):
"""
Slack reader.
Reads conversations from channels. If an earliest_date is provided, an
optional latest_date can also be provided. If no latest_date is provided,
we assume the latest date is the current timestamp.
Args:
slack_token (Optional[str]): Slack token. If not provided, we
assume the environment variable `SLACK_BOT_TOKEN` is set.
ssl (Optional[str]): Custom SSL context. If not provided, it is assumed
there is already an SSL context available.
earliest_date (Optional[datetime]): Earliest date from which
to read conversations. If not provided, we read all messages.
latest_date (Optional[datetime]): Latest date from which to
read conversations. If not provided, defaults to current timestamp
in combination with earliest_date.
"""
is_remote: bool = True
slack_token: str
earliest_date_timestamp: Optional[float]
latest_date_timestamp: float
channel_types: str
_client: Any = PrivateAttr()
def __init__(
self,
slack_token: Optional[str] = None,
ssl: Optional[SSLContext] = None,
earliest_date: Optional[datetime] = None,
latest_date: Optional[datetime] = None,
earliest_date_timestamp: Optional[float] = None,
latest_date_timestamp: Optional[float] = None,
channel_types: Optional[str] = None,
) -> None:
"""Initialize with parameters."""
from slack_sdk import WebClient
if slack_token is None:
slack_token = os.environ["SLACK_BOT_TOKEN"]
if slack_token is None:
raise ValueError(
"Must specify `slack_token` or set environment "
"variable `SLACK_BOT_TOKEN`."
)
if ssl is None:
client = WebClient(token=slack_token)
else:
client = WebClient(token=slack_token, ssl=ssl)
if latest_date is not None and earliest_date is None:
raise ValueError(
"Must specify `earliest_date` if `latest_date` is specified."
)
if earliest_date is not None:
earliest_date_timestamp = earliest_date.timestamp()
else:
earliest_date_timestamp = None or earliest_date_timestamp
if latest_date is not None:
latest_date_timestamp = latest_date.timestamp()
else:
latest_date_timestamp = datetime.now().timestamp() or latest_date_timestamp
if channel_types is not None:
channel_types = channel_types
else:
channel_types = "public_channel,private_channel"
res = client.api_test()
if not res["ok"]:
raise ValueError(f"Error initializing Slack API: {res['error']}")
super().__init__(
slack_token=slack_token,
earliest_date_timestamp=earliest_date_timestamp,
latest_date_timestamp=latest_date_timestamp,
channel_types=channel_types,
)
self._client = client
@classmethod
def class_name(cls) -> str:
return "SlackReader"
def _read_message(self, channel_id: str, message_ts: str) -> str:
from slack_sdk.errors import SlackApiError
"""Read a message."""
messages_text: List[str] = []
next_cursor = None
while True:
try:
# https://slack.com/api/conversations.replies
# List all replies to a message, including the message itself.
if self.earliest_date_timestamp is None:
result = self._client.conversations_replies(
channel=channel_id, ts=message_ts, cursor=next_cursor
)
else:
conversations_replies_kwargs = {
"channel": channel_id,
"ts": message_ts,
"cursor": next_cursor,
"latest": str(self.latest_date_timestamp),
}
if self.earliest_date_timestamp is not None:
conversations_replies_kwargs["oldest"] = str(
self.earliest_date_timestamp
)
result = self._client.conversations_replies(
**conversations_replies_kwargs # type: ignore
)
messages = result["messages"]
messages_text.extend(message["text"] for message in messages)
if not result["has_more"]:
break
next_cursor = result["response_metadata"]["next_cursor"]
except SlackApiError as e:
error = e.response["error"]
if error == "ratelimited":
retry_after = int(e.response.headers.get("retry-after", 1))
logger.error(
f"Rate limit error reached, sleeping for: {retry_after} seconds"
)
time.sleep(retry_after)
elif error == "not_in_channel":
logger.error(
f"Error: Bot not in channel: {channel_id}, cannot read messages."
)
break
else:
logger.error(
f"Error parsing conversation replies for channel {channel_id}: {e}"
)
break
return "\n\n".join(messages_text)
def _read_channel(self, channel_id: str, reverse_chronological: bool) -> str:
from slack_sdk.errors import SlackApiError
"""Read a channel."""
result_messages: List[str] = []
next_cursor = None
while True:
try:
# Call the conversations.history method using the WebClient
# conversations.history returns the first 100 messages by default
# These results are paginated,
# see: https://api.slack.com/methods/conversations.history$pagination
conversations_history_kwargs = {
"channel": channel_id,
"cursor": next_cursor,
"latest": str(self.latest_date_timestamp),
}
if self.earliest_date_timestamp is not None:
conversations_history_kwargs["oldest"] = str(
self.earliest_date_timestamp
)
result = self._client.conversations_history(
**conversations_history_kwargs # type: ignore
)
conversation_history = result["messages"]
# Print results
logger.info(
f"{len(conversation_history)} messages found in {channel_id}"
)
result_messages.extend(
self._read_message(channel_id, message["ts"])
for message in conversation_history
)
if not result["has_more"]:
break
next_cursor = result["response_metadata"]["next_cursor"]
except SlackApiError as e:
error = e.response["error"]
if error == "ratelimited":
retry_after = int(e.response.headers.get("retry-after", 1))
logger.error(
f"Rate limit error reached, sleeping for: {retry_after} seconds"
)
time.sleep(retry_after)
elif error == "not_in_channel":
logger.error(
f"Error: Bot not in channel: {channel_id}, cannot read messages."
)
break
else:
logger.error(
f"Error parsing conversation replies for channel {channel_id}: {e}"
)
break
return (
"\n\n".join(result_messages)
if reverse_chronological
else "\n\n".join(result_messages[::-1])
)
def load_data(
self, channel_ids: List[str], reverse_chronological: bool = True
) -> List[Document]:
"""
Load data from the input slack channel ids.
Args:
channel_ids (List[str]): List of channel ids to read.
Returns:
List[Document]: List of documents.
"""
results = []
for channel_id in channel_ids:
channel_content = self._read_channel(
channel_id, reverse_chronological=reverse_chronological
)
results.append(
Document(
id_=channel_id,
text=channel_content,
metadata={"channel": channel_id},
)
)
return results
def _is_regex(self, pattern: str) -> bool:
"""Check if a string is a regex pattern."""
try:
re.compile(pattern)
return True
except re.error:
return False
def _list_channels(self) -> List[Dict[str, Any]]:
"""List channels based on the types."""
from slack_sdk.errors import SlackApiError
try:
result = self._client.conversations_list(types=self.channel_types)
return result["channels"]
except SlackApiError as e:
logger.error(f"Error fetching channels: {e.response['error']}")
raise
def _filter_channels(
self, channels: List[Dict[str, Any]], patterns: List[str]
) -> List[Dict[str, Any]]:
"""Filter channels based on the provided names and regex patterns."""
regex_patterns = [pattern for pattern in patterns if self._is_regex(pattern)]
exact_names = [pattern for pattern in patterns if not self._is_regex(pattern)]
# Match Exact Channel names
filtered_channels = [
channel for channel in channels if channel["name"] in exact_names
]
# Match Regex Patterns
for channel in channels:
for pattern in regex_patterns:
if re.match(pattern, channel["name"]):
filtered_channels.append(channel)
return filtered_channels
def get_channel_ids(self, channel_patterns: List[str]) -> List[str]:
"""
Get list of channel IDs based on names and regex patterns.
Args:
channel_patterns List[str]: List of channel name patterns (names or regex) to read.
Returns:
List[Document]: List of documents.
"""
if not channel_patterns:
raise ValueError("No channel patterns provided.")
channels = self._list_channels()
logger.info(f"Total channels fetched: {len(channels)}")
if not channels:
logger.info("No channels found in Slack.")
return []
filtered_channels = self._filter_channels(
channels=channels, patterns=channel_patterns
)
logger.info(f"Channels matching patterns: {len(filtered_channels)}")
if not filtered_channels:
logger.info(
"None of the channel names or pattern matched with Slack Channels."
)
return []
channel_ids = [channel["id"] for channel in filtered_channels]
return list(set(channel_ids))
|
