# 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.
60 lines
2 KiB
Python
60 lines
2 KiB
Python
from typing import Annotated
|
|
|
|
from arcade_tdk import ToolContext, ToolMetadataKey, tool
|
|
from arcade_tdk.auth import Google
|
|
|
|
from arcade_google_docs.decorators import with_filepicker_fallback
|
|
from arcade_google_docs.tools.get import get_document_by_id
|
|
from arcade_google_docs.utils import build_docs_service
|
|
|
|
|
|
# Uses https://developers.google.com/docs/api/reference/rest/v1/documents/batchUpdate
|
|
# Example `arcade chat` query: `insert "The END" at the end of document with ID 1234567890`
|
|
@tool(
|
|
requires_auth=Google(
|
|
scopes=[
|
|
"https://www.googleapis.com/auth/drive.file",
|
|
],
|
|
),
|
|
requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
|
|
)
|
|
@with_filepicker_fallback
|
|
async def insert_text_at_end_of_document(
|
|
context: ToolContext,
|
|
document_id: Annotated[str, "The ID of the document to update."],
|
|
text_content: Annotated[str, "The text content to insert into the document"],
|
|
) -> Annotated[dict, "The response from the batchUpdate API as a dict."]:
|
|
"""
|
|
Updates an existing Google Docs document using the batchUpdate API endpoint.
|
|
"""
|
|
document_or_file_picker_response = await get_document_by_id(context, document_id)
|
|
|
|
# If the document was not found, return the file picker response
|
|
if "body" not in document_or_file_picker_response:
|
|
return document_or_file_picker_response # type: ignore[no-any-return]
|
|
|
|
document = document_or_file_picker_response
|
|
|
|
end_index = document["body"]["content"][-1]["endIndex"]
|
|
|
|
service = build_docs_service(context.get_auth_token_or_empty())
|
|
|
|
requests = [
|
|
{
|
|
"insertText": {
|
|
"location": {
|
|
"index": int(end_index) - 1,
|
|
},
|
|
"text": text_content,
|
|
}
|
|
}
|
|
]
|
|
|
|
# Execute the documents().batchUpdate() method
|
|
response = (
|
|
service.documents()
|
|
.batchUpdate(documentId=document_id, body={"requests": requests})
|
|
.execute()
|
|
)
|
|
|
|
return dict(response)
|