arcade-mcp/toolkits/outlook_mail/evals/eval_write.py
Eric Gustin 07c52100f3
Split and rename multiple toolkits (#438)
# PR Description
## Split toolkits

This PR splits the `Microsoft`, `Google`, and `Search` toolkits into
multiple toolkits each.
 * `Microsoft` --> `OutlookCalendar`, `OutlookMail`.
* `Google` -----> `GoogleCalendar`, `GoogleContacts`, `GoogleDocs`,
`GoogleDrive`, `Gmail`, `GoogleSheets`
* `Search` -----> `GoogleFinance`, `GoogleFlights`, `GoogleHotels`,
`GoogleJobs`, `GoogleMaps`, `GoogleNews`, `GoogleSearch`,
`GoogleShopping`, `Walmart`, `Youtube`

> The original monolithic toolkits (`Microsoft`, `Google`, `Search`) are
not removed in this PR. The plan is to keep those toolkits around while
we
> 1. Stop documenting the toolkits, 
> 2. Stop displaying the toolkits in the dashboard, and 
> 3. Help customers migrate over to the new split toolkits.

## Rename toolkits
This PR renames the following toolkits 
* `Web` ------------> `Firecrawl`
* `CodeSandbox` ---> `E2B`

> The `Web` and `CodeSandbox` toolkits are not removed in this PR. The
plan is to keep them around while we
> 1. Stop documenting the toolkits, 
> 2. Stop displaying the toolkits in the dashboard, and 
> 3. Help customers migrate over to the new renamed toolkits.

## Rename tools
Since toolkit names were changed, this called for some tools to be
renamed as well.
* `GoogleSearch.SearchGoogle` ----------------> `GoogleSearch.Search`
* `GoogleShopping.SearchShoppingProducts` --->
`GoogleShopping.SearchProducts`
* `Walmart.SearchWalmartProducts` ------------> `Walmart.SearchProducts`
* `Walmart.GetWalmartProductDetails` --------->
`Walmart.GetProductDetails`
* `Youtube.SearchYoutubeVideos` -------------->
`Youtube.SearchForVideos`

## Google File Picker
Improvements to the Google File Picker experience were also added in
this PR.

The following tools will ALWAYS provide llm_instructions in their
response to "let the end-user know that they have the option to select
more files via the file picker url if they want to":
* `GoogleDocs.SearchDocuments`
* `GoogleDocs.SearchAndRetrieveDocuments`
* `GoogleDrive.GetFileTreeStructure`

The following tools will only provide the file picker URL if a 404 or
403 from the Google API:
* `GoogleDocs.InsertTextAtEndOfDocument`
* `GoogleDocs.GetDocumentById`
* `GoogleSheets.GetSpreadsheet`
* `GoogleSheets.WriteToCell`

Also, a standalone `GoogleDrive.GenerateGoogleFilePickerUrl` tool
exists.

## Other
* The `SearchDocuments` and `SearchAndRetrieveDocuments` tools used to
be organized within the Drive portion of the Google toolkit, but I moved
these into the new GoogleDocs toolkit because they are specific to Docs.

# Progress

- [x] `OutlookCalendar`
- [x] `OutlookMail`
- [x] `GoogleFinance`
- [x] `GoogleFlights`
- [x] `GoogleHotels`
- [x] `GoogleJobs`
- [x] `GoogleMaps`
- [x] `GoogleNews`
- [x] `GoogleSearch`
- [x] `GoogleShopping`
- [x] `Walmart`
- [x] `Youtube`
- [x] `GoogleCalendar`
- [x] `GoogleContacts`
- [x] `GoogleDocs`
- [x] `GoogleDrive`
- [x] `Gmail`
- [x] `GoogleSheets`
- [x] `Firecrawl`
- [x] `E2B`
- [x] File picker

# Discussion
* Repeated code is a consequence of splitting toolkits that use the same
provider. I am open to any ideas that would allow multiple toolkits to
reference common code. Comment your ideas in this PR.
2025-07-09 16:00:09 -07:00

104 lines
3.9 KiB
Python

from arcade_evals import (
BinaryCritic,
EvalRubric,
EvalSuite,
ExpectedToolCall,
SimilarityCritic,
tool_eval,
)
from arcade_tdk import ToolCatalog
from arcade_outlook_mail import create_draft_email, update_draft_email
from evals.additional_messages import (
update_draft_email_additional_messages,
)
# Evaluation rubric
rubric = EvalRubric(
fail_threshold=0.9,
warn_threshold=0.95,
)
catalog = ToolCatalog()
catalog.add_tool(create_draft_email, "OutlookMail")
catalog.add_tool(update_draft_email, "OutlookMail")
@tool_eval()
def outlook_mail_write_eval_suite() -> EvalSuite:
"""Create an evaluation suite for Outlook Mail tools."""
suite = EvalSuite(
name="Outlook Mail Write Evaluation",
system_message=("You are an AI that has access to tools to send, read, and write emails."),
catalog=catalog,
rubric=rubric,
)
suite.add_case(
name="Create draft email",
user_message=(
"create a new draft email with subject 'Hello friends' and body "
"'I've gathered you all here to celebrate the launch of the new Arcade platform."
"address it to e@arcade.dev and z@arcade.dev. also carbon copy to j@arcade.dev, "
"f@arcade.dev, k@arcade.dev and finally to m@arcade.dev. also bcc to r@arcade.dev"
),
expected_tool_calls=[
ExpectedToolCall(
func=create_draft_email,
args={
"subject": "Hello friends",
"body": "I've gathered you all here to celebrate the launch of the new Arcade platform.",
"to_recipients": ["e@arcade.dev", "z@arcade.dev"],
"cc_recipients": [
"j@arcade.dev",
"f@arcade.dev",
"k@arcade.dev",
"m@arcade.dev",
],
"bcc_recipients": ["r@arcade.dev"],
},
)
],
critics=[
SimilarityCritic(critic_field="subject", weight=0.2),
SimilarityCritic(critic_field="body", weight=0.2),
BinaryCritic(critic_field="to_recipients", weight=0.2),
BinaryCritic(critic_field="cc_recipients", weight=0.2),
BinaryCritic(critic_field="bcc_recipients", weight=0.2),
],
)
suite.add_case(
name="Update draft email",
user_message=(
"oh wait i think i messed up on some emails. I meant 'z', not 'e'. "
"Also, I forgot to bcc y@arcade.dev. Also, replace the period with an "
"exclamation point since I want to convey excitement. Oh I almost forgot, "
"Don't cc anyone."
),
expected_tool_calls=[
ExpectedToolCall(
func=update_draft_email,
args={
"message_id": "AQMkADAwATM0MDAAMi04Y2Y1LTQ3MTEALTAwAi0wMAoARgAAAyXxSd3UxTpCkDpGouEg0JMHAFuxokOLZRtDncM4_x_WeUwAAAIBDwAAAFuxokOLZRtDncM4_x_WeUwAAAAC-dpvAAAA",
"body": "I've gathered you all here to celebrate the launch of the new Arcade platform!",
"to_add": ["z@arcade.dev"],
"to_remove": ["e@arcade.dev"],
"cc_remove": ["j@arcade.dev", "f@arcade.dev", "k@arcade.dev", "m@arcade.dev"],
"bcc_add": ["y@arcade.dev"],
},
)
],
critics=[
BinaryCritic(critic_field="message_id", weight=1 / 6),
BinaryCritic(critic_field="body", weight=1 / 6),
BinaryCritic(critic_field="to_add", weight=1 / 6),
BinaryCritic(critic_field="to_remove", weight=1 / 6),
BinaryCritic(critic_field="cc_remove", weight=1 / 6),
BinaryCritic(critic_field="bcc_add", weight=1 / 6),
],
additional_messages=update_draft_email_additional_messages,
)
return suite