07c52100f3
# 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.
47 lines
1.9 KiB
Python
47 lines
1.9 KiB
Python
from typing import Annotated, Any
|
|
|
|
from arcade_tdk import ToolContext, tool
|
|
from arcade_tdk.errors import ToolExecutionError
|
|
|
|
from arcade_google_news.constants import DEFAULT_GOOGLE_NEWS_COUNTRY, DEFAULT_GOOGLE_NEWS_LANGUAGE
|
|
from arcade_google_news.exceptions import CountryNotFoundError, LanguageNotFoundError
|
|
from arcade_google_news.google_data import COUNTRY_CODES, LANGUAGE_CODES
|
|
from arcade_google_news.utils import call_serpapi, extract_news_results, prepare_params
|
|
|
|
|
|
@tool(requires_secrets=["SERP_API_KEY"])
|
|
async def search_news_stories(
|
|
context: ToolContext,
|
|
keywords: Annotated[
|
|
str,
|
|
"Keywords to search for news articles. E.g. 'Apple launches new iPhone'.",
|
|
],
|
|
country_code: Annotated[
|
|
str | None,
|
|
"2-character country code to search for news articles. E.g. 'us' (United States). "
|
|
f"Defaults to '{DEFAULT_GOOGLE_NEWS_COUNTRY}'.",
|
|
] = None,
|
|
language_code: Annotated[
|
|
str,
|
|
"2-character language code to search for news articles. E.g. 'en' (English). "
|
|
f"Defaults to '{DEFAULT_GOOGLE_NEWS_LANGUAGE}'.",
|
|
] = DEFAULT_GOOGLE_NEWS_LANGUAGE,
|
|
limit: Annotated[
|
|
int | None,
|
|
"Maximum number of news articles to return. Defaults to None "
|
|
"(returns all results found by the API).",
|
|
] = None,
|
|
) -> Annotated[dict[str, list[dict[str, Any]]], "News results."]:
|
|
"""Search for news articles related to a given query."""
|
|
if not keywords:
|
|
raise ToolExecutionError("Keywords are required to search for news articles.")
|
|
|
|
if country_code and country_code not in COUNTRY_CODES:
|
|
raise CountryNotFoundError(country_code)
|
|
|
|
if language_code not in LANGUAGE_CODES:
|
|
raise LanguageNotFoundError(language_code)
|
|
|
|
params = prepare_params("google_news", q=keywords, gl=country_code, hl=language_code)
|
|
results = call_serpapi(context, params)
|
|
return {"news_results": extract_news_results(results, limit=limit)}
|