# 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.
101 lines
3.4 KiB
Python
101 lines
3.4 KiB
Python
from typing import Annotated, Any, cast
|
|
|
|
from arcade_tdk import ToolContext, tool
|
|
from arcade_tdk.errors import ToolExecutionError
|
|
|
|
from arcade_youtube.constants import DEFAULT_YOUTUBE_SEARCH_COUNTRY, DEFAULT_YOUTUBE_SEARCH_LANGUAGE
|
|
from arcade_youtube.utils import (
|
|
call_serpapi,
|
|
default_country_code,
|
|
default_language_code,
|
|
extract_video_details,
|
|
extract_video_results,
|
|
prepare_params,
|
|
resolve_country_code,
|
|
resolve_language_code,
|
|
)
|
|
|
|
|
|
@tool(requires_secrets=["SERP_API_KEY"])
|
|
async def search_for_videos(
|
|
context: ToolContext,
|
|
keywords: Annotated[
|
|
str,
|
|
"The keywords to search for. E.g. 'Python tutorial'.",
|
|
],
|
|
language_code: Annotated[
|
|
str | None,
|
|
"2-character language code to search for. E.g. 'en' for English. "
|
|
f"Defaults to '{default_language_code(DEFAULT_YOUTUBE_SEARCH_LANGUAGE)}'.",
|
|
] = None,
|
|
country_code: Annotated[
|
|
str | None,
|
|
"2-character country code to search for. E.g. 'us' for United States. "
|
|
f"Defaults to '{default_country_code(DEFAULT_YOUTUBE_SEARCH_COUNTRY)}'.",
|
|
] = None,
|
|
next_page_token: Annotated[
|
|
str | None,
|
|
"The next page token to use for pagination. "
|
|
"Defaults to `None` (start from the first page).",
|
|
] = None,
|
|
) -> Annotated[dict[str, Any], "List of YouTube videos related to the query."]:
|
|
"""Search for YouTube videos related to the query."""
|
|
language_code = resolve_language_code(language_code, DEFAULT_YOUTUBE_SEARCH_LANGUAGE)
|
|
country_code = resolve_country_code(country_code, DEFAULT_YOUTUBE_SEARCH_COUNTRY)
|
|
|
|
params = prepare_params(
|
|
"youtube",
|
|
search_query=keywords,
|
|
hl=language_code,
|
|
gl=country_code,
|
|
sp=next_page_token,
|
|
)
|
|
results = call_serpapi(context, params)
|
|
|
|
if results.get("error"):
|
|
error_msg = cast(str, results.get("error"))
|
|
raise ToolExecutionError(error_msg)
|
|
|
|
return {
|
|
"videos": extract_video_results(results),
|
|
"next_page_token": results.get("serpapi_pagination", {}).get("next_page_token"),
|
|
}
|
|
|
|
|
|
@tool(requires_secrets=["SERP_API_KEY"])
|
|
async def get_youtube_video_details(
|
|
context: ToolContext,
|
|
video_id: Annotated[
|
|
str,
|
|
"The ID of the YouTube video to get details about. E.g. 'dQw4w9WgXcQ'.",
|
|
],
|
|
language_code: Annotated[
|
|
str | None,
|
|
"2-character language code to search for. E.g. 'en' for English. "
|
|
f"Defaults to '{default_language_code(DEFAULT_YOUTUBE_SEARCH_LANGUAGE)}'.",
|
|
] = None,
|
|
country_code: Annotated[
|
|
str | None,
|
|
"2-character country code to search for. E.g. 'us' for United States. "
|
|
f"Defaults to '{default_country_code(DEFAULT_YOUTUBE_SEARCH_COUNTRY)}'.",
|
|
] = None,
|
|
) -> Annotated[dict[str, Any], "Details about a YouTube video."]:
|
|
"""Get details about a YouTube video."""
|
|
language_code = resolve_language_code(language_code, DEFAULT_YOUTUBE_SEARCH_LANGUAGE)
|
|
country_code = resolve_country_code(country_code, DEFAULT_YOUTUBE_SEARCH_COUNTRY)
|
|
|
|
params = prepare_params(
|
|
"youtube_video",
|
|
v=video_id,
|
|
hl=language_code,
|
|
gl=country_code,
|
|
)
|
|
results = call_serpapi(context, params)
|
|
|
|
if results.get("error"):
|
|
error_msg = cast(str, results.get("error"))
|
|
raise ToolExecutionError(error_msg)
|
|
|
|
return {
|
|
"video": extract_video_details(results),
|
|
}
|