arcade-mcp/toolkits/slack/evals/chat/messages/eval_get_dm_messages.py
Renato Byrro ed89af4b4d
Slack Toolkit Refactoring (#453)
# 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`
2025-07-10 13:50:28 -03:00

191 lines
6.9 KiB
Python

from datetime import timedelta
from arcade_evals import (
BinaryCritic,
DatetimeCritic,
EvalRubric,
EvalSuite,
ExpectedToolCall,
tool_eval,
)
from arcade_tdk import ToolCatalog
import arcade_slack
from arcade_slack.critics import RelativeTimeBinaryCritic
from arcade_slack.tools.chat import get_messages
# Evaluation rubric
rubric = EvalRubric(
fail_threshold=0.8,
warn_threshold=0.9,
)
catalog = ToolCatalog()
# Register the Slack tools
catalog.add_module(arcade_slack)
@tool_eval()
def get_messages_in_direct_message_eval_suite() -> EvalSuite:
"""Create an evaluation suite for tools getting messages in direct messages."""
suite = EvalSuite(
name="Slack Chat Tools Evaluation",
system_message="You are an AI assistant that can interact with Slack to send messages and get information from conversations, users, etc.",
catalog=catalog,
rubric=rubric,
)
no_arguments_user_messages_by_username = [
"what are the latest messages I exchanged with janedoe",
"show my messages with janedoe on Slack",
"get the messages I exchanged with janedoe",
"get the message history with janedoe",
]
for i, user_message in enumerate(no_arguments_user_messages_by_username):
suite.add_case(
name=f"{user_message} [{i}]",
user_message=user_message,
expected_tool_calls=[
ExpectedToolCall(
func=get_messages,
args={
"conversation_id": None,
"channel_name": None,
"user_ids": None,
"usernames": ["janedoe"],
"emails": None,
},
),
],
critics=[
BinaryCritic(critic_field="conversation_id", weight=0.1),
BinaryCritic(critic_field="channel_name", weight=0.1),
BinaryCritic(critic_field="user_ids", weight=0.1),
BinaryCritic(critic_field="usernames", weight=0.6),
BinaryCritic(critic_field="emails", weight=0.1),
],
)
no_arguments_user_messages_by_email = [
"what are the latest messages I exchanged with jane.doe@acme.com",
"show my messages with jane.doe@acme.com on Slack",
]
for i, user_message in enumerate(no_arguments_user_messages_by_email):
suite.add_case(
name=f"{user_message} [{i}]",
user_message=user_message,
expected_tool_calls=[
ExpectedToolCall(
func=get_messages,
args={
"conversation_id": None,
"channel_name": None,
"user_ids": None,
"usernames": None,
"emails": ["jane.doe@acme.com"],
},
),
],
critics=[
BinaryCritic(critic_field="conversation_id", weight=0.1),
BinaryCritic(critic_field="channel_name", weight=0.1),
BinaryCritic(critic_field="user_ids", weight=0.1),
BinaryCritic(critic_field="usernames", weight=0.1),
BinaryCritic(critic_field="emails", weight=0.6),
],
)
suite.add_case(
name="get messages in direct conversation by username (on a specific date)",
user_message="get the messages I exchanged with janedoe on 2025-01-31",
expected_tool_calls=[
ExpectedToolCall(
func=get_messages,
args={
"conversation_id": None,
"channel_name": None,
"user_ids": None,
"usernames": ["janedoe"],
"emails": None,
"oldest_datetime": "2025-01-31 00:00:00",
"latest_datetime": "2025-01-31 23:59:59",
},
),
],
critics=[
BinaryCritic(critic_field="conversation_id", weight=0.1),
BinaryCritic(critic_field="channel_name", weight=0.1),
BinaryCritic(critic_field="user_ids", weight=0.1),
BinaryCritic(critic_field="usernames", weight=0.2),
BinaryCritic(critic_field="emails", weight=0.1),
DatetimeCritic(
critic_field="oldest_datetime", weight=0.2, max_difference=timedelta(minutes=2)
),
DatetimeCritic(
critic_field="latest_datetime", weight=0.2, max_difference=timedelta(minutes=2)
),
],
)
suite.add_case(
name="get messages in direct conversation by email (on a specific date)",
user_message="get the messages I exchanged with jane.doe@acme.com on 2025-01-31",
expected_tool_calls=[
ExpectedToolCall(
func=get_messages,
args={
"conversation_id": None,
"channel_name": None,
"user_ids": None,
"usernames": None,
"emails": ["jane.doe@acme.com"],
"oldest_datetime": "2025-01-31 00:00:00",
"latest_datetime": "2025-01-31 23:59:59",
},
),
],
critics=[
BinaryCritic(critic_field="conversation_id", weight=0.1),
BinaryCritic(critic_field="channel_name", weight=0.1),
BinaryCritic(critic_field="user_ids", weight=0.1),
BinaryCritic(critic_field="usernames", weight=0.1),
BinaryCritic(critic_field="emails", weight=0.2),
DatetimeCritic(
critic_field="oldest_datetime", weight=0.2, max_difference=timedelta(minutes=2)
),
DatetimeCritic(
critic_field="latest_datetime", weight=0.2, max_difference=timedelta(minutes=2)
),
],
)
suite.add_case(
name="Get conversation history oldest relative by username (2 days ago)",
user_message="Get the messages I exchanged with janedoe starting 2 days ago",
expected_tool_calls=[
ExpectedToolCall(
func=get_messages,
args={
"conversation_id": None,
"channel_name": None,
"user_ids": None,
"usernames": ["janedoe"],
"emails": None,
"oldest_relative": "02:00:00",
},
),
],
critics=[
BinaryCritic(critic_field="conversation_id", weight=0.1),
BinaryCritic(critic_field="channel_name", weight=0.1),
BinaryCritic(critic_field="user_ids", weight=0.1),
BinaryCritic(critic_field="usernames", weight=0.3),
BinaryCritic(critic_field="emails", weight=0.1),
RelativeTimeBinaryCritic(critic_field="oldest_relative", weight=0.3),
],
)
return suite