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.
65 lines
2.1 KiB
Python
65 lines
2.1 KiB
Python
from typing import Annotated
|
|
|
|
from arcade_tdk import ToolContext, tool
|
|
|
|
from arcade_google_jobs.constants import DEFAULT_GOOGLE_JOBS_LANGUAGE
|
|
from arcade_google_jobs.exceptions import LanguageNotFoundError
|
|
from arcade_google_jobs.google_data import LANGUAGE_CODES
|
|
from arcade_google_jobs.utils import call_serpapi, prepare_params
|
|
|
|
|
|
@tool(requires_secrets=["SERP_API_KEY"])
|
|
async def search_jobs(
|
|
context: ToolContext,
|
|
query: Annotated[
|
|
str,
|
|
"Search query. Provide a job title, company name, and/or any keywords in general "
|
|
"representing what kind of jobs the user is looking for. E.g. 'software engineer' "
|
|
"or 'data analyst at Apple'.",
|
|
],
|
|
location: Annotated[
|
|
str | None,
|
|
"Location to search for jobs. E.g. 'United States' or 'New York, NY'. Defaults to None.",
|
|
] = None,
|
|
language: Annotated[
|
|
str,
|
|
"2-character language code to use in the Google Jobs search. "
|
|
f"E.g. 'en' for English. Defaults to '{DEFAULT_GOOGLE_JOBS_LANGUAGE}'.",
|
|
] = DEFAULT_GOOGLE_JOBS_LANGUAGE,
|
|
limit: Annotated[
|
|
int,
|
|
"Maximum number of results to retrieve. Defaults to 10 (max supported by the API).",
|
|
] = 10,
|
|
next_page_token: Annotated[
|
|
str | None,
|
|
"Next page token to paginate results. Defaults to None (start from the first page).",
|
|
] = None,
|
|
) -> Annotated[dict, "Google Jobs results"]:
|
|
"""Search Google Jobs using SerpAPI."""
|
|
if language not in LANGUAGE_CODES:
|
|
raise LanguageNotFoundError(language)
|
|
|
|
params = prepare_params(
|
|
engine="google_jobs",
|
|
q=query,
|
|
hl=language,
|
|
)
|
|
|
|
if location:
|
|
params["location"] = location
|
|
|
|
if next_page_token:
|
|
params["next_page_token"] = next_page_token
|
|
|
|
results = call_serpapi(context, params)
|
|
jobs_results = results.get("jobs_results", [])
|
|
|
|
try:
|
|
next_page_token = results["serpapi_pagination"]["next_page_token"]
|
|
except KeyError:
|
|
next_page_token = None
|
|
|
|
return {
|
|
"jobs": jobs_results[:limit],
|
|
"next_page_token": next_page_token,
|
|
}
|