arcade-mcp/toolkits/google_contacts/evals/eval_google_contacts.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

135 lines
3.7 KiB
Python

from arcade_evals import (
BinaryCritic,
EvalRubric,
EvalSuite,
ExpectedToolCall,
tool_eval,
)
from arcade_tdk import ToolCatalog
import arcade_google_contacts
from arcade_google_contacts.tools import (
create_contact,
search_contacts_by_email,
search_contacts_by_name,
)
# Evaluation rubric
rubric = EvalRubric(
fail_threshold=0.9,
warn_threshold=0.95,
)
catalog = ToolCatalog()
catalog.add_module(arcade_google_contacts)
@tool_eval()
def contacts_eval_suite() -> EvalSuite:
"""Create an evaluation suite for Google Contacts tools."""
suite = EvalSuite(
name="Google Contacts Tools Evaluation",
system_message="You are an AI assistant that can manage Google Contacts using the provided tools.",
catalog=catalog,
rubric=rubric,
)
suite.add_case(
name="Search contacts by name",
user_message="Find my contact Bob",
expected_tool_calls=[
ExpectedToolCall(
func=search_contacts_by_name,
args={
"name": "Bob",
},
)
],
)
suite.add_case(
name="Search contacts by email",
user_message="Find my contact alice@example.com",
expected_tool_calls=[
ExpectedToolCall(
func=search_contacts_by_email,
args={
"email": "alice@example.com",
},
)
],
)
suite.add_case(
name="Search contacts with query and limit",
user_message="Find 5 contacts whose names include 'Alice'",
expected_tool_calls=[
ExpectedToolCall(
func=search_contacts_by_name,
args={
"name": "Alice",
"limit": 5,
},
)
],
critics=[
BinaryCritic(critic_field="query", weight=0.5),
BinaryCritic(critic_field="limit", weight=0.5),
],
)
suite.add_case(
name="Create new contact with only given name",
user_message="Create a new contact for Alice",
expected_tool_calls=[
ExpectedToolCall(
func=create_contact,
args={
"given_name": "Alice",
},
)
],
critics=[
BinaryCritic(critic_field="given_name", weight=1.0),
],
)
suite.add_case(
name="Create new contact with only email (infer name from email)",
user_message="Create a new contact for alice@example.com",
expected_tool_calls=[
ExpectedToolCall(
func=create_contact,
args={
"given_name": "Alice",
"email": "alice@example.com",
},
)
],
critics=[
BinaryCritic(critic_field="email", weight=0.5),
BinaryCritic(critic_field="given_name", weight=0.5),
],
)
suite.add_case(
name="Create new contact with full name and email",
user_message="Create a contact for Bob Smith (bob.smith@example.com)",
expected_tool_calls=[
ExpectedToolCall(
func=create_contact,
args={
"given_name": "Bob",
"family_name": "Smith",
"email": "bob.smith@example.com",
},
)
],
critics=[
BinaryCritic(critic_field="given_name", weight=0.33),
BinaryCritic(critic_field="family_name", weight=0.33),
BinaryCritic(critic_field="email", weight=0.34),
],
)
return suite