# 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.
240 lines
6.9 KiB
Python
240 lines
6.9 KiB
Python
from arcade_evals import (
|
|
EvalRubric,
|
|
EvalSuite,
|
|
ExpectedToolCall,
|
|
NumericCritic,
|
|
SimilarityCritic,
|
|
tool_eval,
|
|
)
|
|
from arcade_tdk import ToolCatalog
|
|
|
|
import arcade_google_search
|
|
from arcade_google_search.tools import search
|
|
|
|
# Evaluation rubric
|
|
rubric = EvalRubric(
|
|
fail_threshold=0.8,
|
|
warn_threshold=0.9,
|
|
)
|
|
|
|
catalog = ToolCatalog()
|
|
# Register the Google Search tool
|
|
catalog.add_module(arcade_google_search)
|
|
|
|
|
|
@tool_eval()
|
|
def google_search_eval_suite() -> EvalSuite:
|
|
"""Create an evaluation suite for the Google Search tool."""
|
|
suite = EvalSuite(
|
|
name="Google Search Tool Evaluation",
|
|
system_message="You are an AI assistant that can perform web searches using the provided tools.",
|
|
catalog=catalog,
|
|
rubric=rubric,
|
|
)
|
|
|
|
# Simple search query with default results
|
|
suite.add_case(
|
|
name="Simple search query with default results",
|
|
user_message="Search for 'Climate change effects on polar bears' on Google.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "Climate change effects on polar bears",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# Search query with specific number of results
|
|
suite.add_case(
|
|
name="Search query with specific number of results",
|
|
user_message="Find the top 3 articles about quantum computing.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "articles about quantum computing",
|
|
"n_results": 3,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=0.7),
|
|
NumericCritic(
|
|
critic_field="n_results",
|
|
weight=0.3,
|
|
value_range=(1, 100),
|
|
),
|
|
],
|
|
)
|
|
|
|
# Search query with 'n' results specified in words
|
|
suite.add_case(
|
|
name="Search query with 'n' results specified in words",
|
|
user_message="Give me five recipes for vegan lasagna.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "recipes for vegan lasagna",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=0.7),
|
|
NumericCritic(
|
|
critic_field="n_results",
|
|
weight=0.3,
|
|
value_range=(1, 100),
|
|
),
|
|
],
|
|
)
|
|
|
|
# Ambiguous number of results
|
|
suite.add_case(
|
|
name="Ambiguous number of results",
|
|
user_message="Find articles about climate change impacts 10.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "articles about climate change impacts 10",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# Search query with multiple instructions
|
|
suite.add_case(
|
|
name="Search query with multiple instructions",
|
|
user_message="Search for the latest news on electric cars, and tell me about Tesla's new model.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "latest news on electric cars",
|
|
"n_results": 5,
|
|
},
|
|
),
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "Tesla's new model",
|
|
"n_results": 5,
|
|
},
|
|
),
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# Search with stop words and filler words
|
|
suite.add_case(
|
|
name="Search with stop words and filler words",
|
|
user_message="Could you please search for the best ways to learn French?",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "best ways to learn French",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# No clear query given
|
|
suite.add_case(
|
|
name="No clear query given",
|
|
user_message="Find it for me.",
|
|
expected_tool_calls=[],
|
|
critics=[],
|
|
)
|
|
|
|
# Search query with special characters
|
|
suite.add_case(
|
|
name="Search query with special characters",
|
|
user_message="Find me '@OpenAI's latest research papers'",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "@OpenAI's latest research papers",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# Search query with complex instructions
|
|
suite.add_case(
|
|
name="Search query with complex instructions",
|
|
user_message="I need information about the impact of deforestation in the Amazon over the past decade.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "impact of deforestation in the Amazon over the past decade",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# Search query in a different language
|
|
suite.add_case(
|
|
name="Search query in a different language",
|
|
user_message="Busca información sobre la economía de España.",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "economía de España",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
# Search query with numeric data
|
|
suite.add_case(
|
|
name="Search query with numeric data",
|
|
user_message="What was the population of Japan in 2020?",
|
|
expected_tool_calls=[
|
|
ExpectedToolCall(
|
|
func=search,
|
|
args={
|
|
"query": "population of Japan in 2020",
|
|
"n_results": 5,
|
|
},
|
|
)
|
|
],
|
|
critics=[
|
|
SimilarityCritic(critic_field="query", weight=1.0),
|
|
],
|
|
)
|
|
|
|
return suite
|