# 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.
96 lines
3.9 KiB
Python
96 lines
3.9 KiB
Python
import asyncio
|
|
from typing import Annotated
|
|
|
|
from arcade_tdk import ToolContext, tool
|
|
from arcade_tdk.auth import Google
|
|
|
|
from arcade_google_contacts.constants import DEFAULT_SEARCH_CONTACTS_LIMIT
|
|
from arcade_google_contacts.utils import build_people_service, search_contacts
|
|
|
|
|
|
async def _warmup_cache(service) -> None: # type: ignore[no-untyped-def]
|
|
"""
|
|
Warm-up the search cache for contacts by sending a request with an empty query.
|
|
This ensures that the lazy cache is updated for both primary contacts and other contacts.
|
|
This is unfortunately a real thing: https://developers.google.com/people/v1/contacts#search_the_users_contacts
|
|
"""
|
|
service.people().searchContacts(query="", pageSize=1, readMask="names,emailAddresses").execute()
|
|
await asyncio.sleep(3) # TODO experiment with this value
|
|
|
|
|
|
@tool(requires_auth=Google(scopes=["https://www.googleapis.com/auth/contacts.readonly"]))
|
|
async def search_contacts_by_email(
|
|
context: ToolContext,
|
|
email: Annotated[str, "The email address to search for"],
|
|
limit: Annotated[
|
|
int | None,
|
|
"The maximum number of contacts to return (30 is the max allowed by Google API)",
|
|
] = DEFAULT_SEARCH_CONTACTS_LIMIT,
|
|
) -> Annotated[dict, "A dictionary containing the list of matching contacts"]:
|
|
"""
|
|
Search the user's contacts in Google Contacts by email address.
|
|
"""
|
|
service = build_people_service(context.get_auth_token_or_empty())
|
|
# Warm-up the cache before performing search.
|
|
# TODO: Ideally we should warmup only if this user (or google domain?) hasn't warmed up recently
|
|
await _warmup_cache(service)
|
|
|
|
return {"contacts": search_contacts(service, email, limit)}
|
|
|
|
|
|
@tool(requires_auth=Google(scopes=["https://www.googleapis.com/auth/contacts.readonly"]))
|
|
async def search_contacts_by_name(
|
|
context: ToolContext,
|
|
name: Annotated[str, "The full name to search for"],
|
|
limit: Annotated[
|
|
int | None,
|
|
"The maximum number of contacts to return (30 is the max allowed by Google API)",
|
|
] = DEFAULT_SEARCH_CONTACTS_LIMIT,
|
|
) -> Annotated[dict, "A dictionary containing the list of matching contacts"]:
|
|
"""
|
|
Search the user's contacts in Google Contacts by name.
|
|
"""
|
|
service = build_people_service(context.get_auth_token_or_empty())
|
|
# Warm-up the cache before performing search.
|
|
# TODO: Ideally we should warmup only if this user (or google domain?) hasn't warmed up recently
|
|
await _warmup_cache(service)
|
|
return {"contacts": search_contacts(service, name, limit)}
|
|
|
|
|
|
@tool(requires_auth=Google(scopes=["https://www.googleapis.com/auth/contacts"]))
|
|
async def create_contact(
|
|
context: ToolContext,
|
|
given_name: Annotated[str, "The given name of the contact"],
|
|
family_name: Annotated[str | None, "The optional family name of the contact"],
|
|
email: Annotated[str | None, "The optional email address of the contact"],
|
|
) -> Annotated[dict, "A dictionary containing the details of the created contact"]:
|
|
"""
|
|
Create a new contact record in Google Contacts.
|
|
|
|
Examples:
|
|
```
|
|
create_contact(given_name="Alice")
|
|
create_contact(given_name="Alice", family_name="Smith")
|
|
create_contact(given_name="Alice", email="alice@example.com")
|
|
```
|
|
"""
|
|
# Build the People API service
|
|
service = build_people_service(context.get_auth_token_or_empty())
|
|
|
|
# Construct the person payload with the specified names
|
|
name_body = {"givenName": given_name}
|
|
if family_name:
|
|
name_body["familyName"] = family_name
|
|
contact_body = {"names": [name_body]}
|
|
if email:
|
|
contact_body["emailAddresses"] = [{"value": email, "type": "work"}]
|
|
|
|
# Create the contact. The personFields parameter specifies what information
|
|
# should be returned. Here, we return names and emailAddresses.
|
|
created_contact = (
|
|
service.people()
|
|
.createContact(body=contact_body, personFields="names,emailAddresses")
|
|
.execute()
|
|
)
|
|
|
|
return {"contact": created_contact}
|