ed89af4b4d
# Backwards-compatible refactoring of the Slack toolkit Several performance improvements, streamlined tool set, and easier to understand tool interfaces. All "old" tools were kept for backwards compatibility, with the same interfaces and response structure (but using the new and more performant tools under the hood). Full revision of unit-tests and evals. ## Streamlined tool set Multiple groups of tools were streamlined into a single one: * "get conversation metadata" from 5 tools to one; * "send message" from 2 tools to one; * "get users in conversation" from 3 tools to one; * "get messages" from 4 tools to one ## New capabilities * Messages retrieved are now populated with the users' names, apart from ID: makes it easier for LLMs to reference who sent a message, were mentioned, or reacted to a message * Retrieve users by username, email, and/or ID (before we only supported ID) * Retrieve multiple users in a single tool call ## Concurrency controls All operations issuing multiple requests concurrently now have a `Semaphore` to limit the concurrency level. The limit can be controlled through the `SLACK_MAX_CONCURRENT_REQUESTS` env var (defaults to 3). ## Networking performance improvement Various operations that used to make multiple API calls are now executed more efficiently: ### Find users by username * Before: a full scan of `users_list` was required (potentially multiple pages for large workspaces); * Now it stops as soon as we have all users needed (yes, it was dumb before) ### Get multiple users by their IDs * Before: for each user ID, we made one API call to the `users_info` endpoint * Now: we call `list_users` and scan the results to match the user IDs (an estimate of 99.5% of Slack workspaces have < 200 users; for large workspaces, we may need to paginate `list_users`) ### Get a conversation by its users * Before: * Call to `list_conversations` (potentially paginating) * For each conversation, one call to `conversations_members` (potentially paginating) * Then loop and find which conversation matches the users' IDs * Now: * A single call to `conversations_open`
74 lines
2.3 KiB
Python
74 lines
2.3 KiB
Python
import json
|
|
from typing import cast
|
|
|
|
from arcade_tdk.errors import RetryableToolError, ToolExecutionError
|
|
from slack_sdk.errors import SlackApiError
|
|
from slack_sdk.web.async_client import AsyncWebClient
|
|
|
|
from arcade_slack.models import (
|
|
ConversationType,
|
|
FindChannelByNameSentinel,
|
|
)
|
|
from arcade_slack.utils import (
|
|
async_paginate,
|
|
extract_conversation_metadata,
|
|
)
|
|
|
|
|
|
async def get_conversation_by_id(
|
|
auth_token: str,
|
|
conversation_id: str,
|
|
) -> dict:
|
|
"""Get metadata of a conversation in Slack by the conversation_id."""
|
|
try:
|
|
slack_client = AsyncWebClient(token=auth_token)
|
|
response = await slack_client.conversations_info(
|
|
channel=conversation_id,
|
|
include_locale=True,
|
|
include_num_members=True,
|
|
)
|
|
return dict(**extract_conversation_metadata(response["channel"]))
|
|
|
|
except SlackApiError as e:
|
|
slack_error = cast(str, e.response.get("error", ""))
|
|
if "not_found" in slack_error.lower():
|
|
message = f"Conversation with ID '{conversation_id}' not found."
|
|
raise ToolExecutionError(message=message, developer_message=message)
|
|
raise
|
|
|
|
|
|
async def get_channel_by_name(
|
|
auth_token: str,
|
|
channel_name: str,
|
|
) -> dict:
|
|
channel_name_casefolded = channel_name.lstrip("#").casefold()
|
|
|
|
slack_client = AsyncWebClient(token=auth_token)
|
|
|
|
results, _ = await async_paginate(
|
|
func=slack_client.conversations_list,
|
|
response_key="channels",
|
|
types=",".join([
|
|
ConversationType.PUBLIC_CHANNEL.value,
|
|
ConversationType.PRIVATE_CHANNEL.value,
|
|
]),
|
|
exclude_archived=True,
|
|
sentinel=FindChannelByNameSentinel(channel_name_casefolded),
|
|
)
|
|
|
|
available_channels = []
|
|
|
|
for channel in results:
|
|
if channel["name"].casefold() == channel_name_casefolded:
|
|
return dict(**extract_conversation_metadata(channel))
|
|
else:
|
|
available_channels.append({"id": channel["id"], "name": channel["name"]})
|
|
|
|
error_message = f"Channel with name '{channel_name}' not found."
|
|
|
|
raise RetryableToolError(
|
|
message=error_message,
|
|
developer_message=error_message,
|
|
additional_prompt_content=f"Available channels: {json.dumps(available_channels)}",
|
|
retry_after_ms=500,
|
|
)
|