arcade-google-docs 3.1.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

arcade_google_docs/__init__.py

@@ -2,6 +2,7 @@ from arcade_google_docs.tools import (
     comment_on_document,
     create_blank_document,
     create_document_from_text,
+    generate_google_file_picker_url,
     get_document_by_id,
     insert_text_at_end_of_document,
     list_document_comments,
@@ -18,4 +19,5 @@ __all__ = [
     "insert_text_at_end_of_document",
     "search_and_retrieve_documents",
     "search_documents",
+    "generate_google_file_picker_url",
 ]

arcade_google_docs/tools/__init__.py

@@ -6,6 +6,7 @@ from arcade_google_docs.tools.create import (
     create_blank_document,
     create_document_from_text,
 )
+from arcade_google_docs.tools.file_picker import generate_google_file_picker_url
 from arcade_google_docs.tools.get import get_document_by_id
 from arcade_google_docs.tools.search import (
     search_and_retrieve_documents,
@@ -22,4 +23,5 @@ __all__ = [
     "insert_text_at_end_of_document",
     "search_and_retrieve_documents",
     "search_documents",
+    "generate_google_file_picker_url",
 ]

arcade_google_docs/{file_picker.py → tools/file_picker.py}

@@ -1,14 +1,22 @@
 import base64
 import json
+from typing import Annotated
 
-from arcade_tdk import ToolContext, ToolMetadataKey
+from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk.auth import Google
 from arcade_tdk.errors import ToolExecutionError
 
 
-def generate_google_file_picker_url(context: ToolContext) -> dict:
+@tool(
+    requires_auth=Google(),
+    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
+)
+def generate_google_file_picker_url(
+    context: ToolContext,
+) -> Annotated[dict, "Google File Picker URL for user file selection and permission granting"]:
     """Generate a Google File Picker URL for user-driven file selection and authorization.
 
-    Generates a URL that directs the end-user to a Google File Picker interface where
+    This tool generates a URL that directs the end-user to a Google File Picker interface where
     where they can select or upload Google Drive files. Users can grant permission to access their
     Drive files, providing a secure and authorized way to interact with their files.
 
@@ -17,8 +25,8 @@ def generate_google_file_picker_url(context: ToolContext) -> dict:
     (Requested entity was not found) or permission errors. Once the user completes the file
     picker flow, the prior tool can be retried.
 
-    Returns:
-        A dictionary containing the URL and instructions for the llm to instruct the user.
+    Suggest this tool to users when they are surprised or confused that the file they are
+    searching for or attempting to access cannot be found.
     """
     client_id = context.get_metadata(ToolMetadataKey.CLIENT_ID)
     client_id_parts = client_id.split("-")
@@ -44,6 +52,6 @@ def generate_google_file_picker_url(context: ToolContext) -> dict:
         "url": url,
         "llm_instructions": (
             "Instruct the user to click the following link to open the Google Drive File Picker. "
-            f"This will allow them to select files and grant access permissions: {url}"
+            "This will allow them to select files and grant access permissions: {url}"
         ),
     }

arcade_google_docs/tools/get.py

@@ -1,9 +1,8 @@
 from typing import Annotated
 
-from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk import ToolContext, tool
 from arcade_tdk.auth import Google
 
-from arcade_google_docs.decorators import with_filepicker_fallback
 from arcade_google_docs.utils import build_docs_service
 
 
@@ -16,9 +15,7 @@ from arcade_google_docs.utils import build_docs_service
             "https://www.googleapis.com/auth/drive.file",
         ],
     ),
-    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
 )
-@with_filepicker_fallback
 async def get_document_by_id(
     context: ToolContext,
     document_id: Annotated[str, "The ID of the document to retrieve."],

arcade_google_docs/tools/search.py

@@ -1,13 +1,11 @@
 from typing import Annotated, Any
 
-from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk import ToolContext, tool
 from arcade_tdk.auth import Google
 
 from arcade_google_docs.doc_to_html import convert_document_to_html
 from arcade_google_docs.doc_to_markdown import convert_document_to_markdown
 from arcade_google_docs.enum import DocumentFormat, OrderBy
-from arcade_google_docs.file_picker import generate_google_file_picker_url
-from arcade_google_docs.templates import optional_file_picker_instructions_template
 from arcade_google_docs.tools import get_document_by_id
 from arcade_google_docs.utils import (
     build_drive_service,
@@ -23,7 +21,6 @@ from arcade_google_docs.utils import (
     requires_auth=Google(
         scopes=["https://www.googleapis.com/auth/drive.file"],
     ),
-    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
 )
 async def search_documents(
     context: ToolContext,
@@ -55,7 +52,9 @@ async def search_documents(
     ] = False,
     order_by: Annotated[
         list[OrderBy] | None,
-        "Sort order. Defaults to listing the most recently modified documents first",
+        "Sort order. Defaults to listing the most recently modified documents first. If "
+        "document_contains or document_not_contains is provided, "
+        "then the order_by will be ignored.",
     ] = None,
     limit: Annotated[int, "The number of documents to list"] = 50,
     pagination_token: Annotated[
@@ -69,7 +68,12 @@ async def search_documents(
     """
     Searches for documents in the user's Google Drive. Excludes documents that are in the trash.
     """
-    if order_by is None:
+    if document_contains or document_not_contains:
+        # Google drive API does not support other order_by values for
+        # queries with fullText search (which is used when document_contains
+        # or document_not_contains is provided).
+        order_by = None
+    elif order_by is None:
         order_by = [OrderBy.MODIFIED_TIME_DESC]
     elif isinstance(order_by, OrderBy):
         order_by = [order_by]
@@ -105,19 +109,9 @@ async def search_documents(
         if not pagination_token or len(batch) < page_size:
             break
 
-    file_picker_response = generate_google_file_picker_url(
-        context,
-    )
-
     return {
         "documents_count": len(files),
         "documents": files,
-        "file_picker": {
-            "url": file_picker_response["url"],
-            "llm_instructions": optional_file_picker_instructions_template.format(
-                url=file_picker_response["url"]
-            ),
-        },
     }
 
 
@@ -125,7 +119,6 @@ async def search_documents(
     requires_auth=Google(
         scopes=["https://www.googleapis.com/auth/drive.file"],
     ),
-    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
 )
 async def search_and_retrieve_documents(
     context: ToolContext,
@@ -203,17 +196,7 @@ async def search_and_retrieve_documents(
 
         documents.append(document)
 
-    file_picker_response = generate_google_file_picker_url(
-        context,
-    )
-
     return {
         "documents_count": len(documents),
         "documents": documents,
-        "file_picker": {
-            "url": file_picker_response["url"],
-            "llm_instructions": optional_file_picker_instructions_template.format(
-                url=file_picker_response["url"]
-            ),
-        },
     }

arcade_google_docs/tools/update.py

@@ -1,9 +1,8 @@
 from typing import Annotated
 
-from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk import ToolContext, 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
 
@@ -16,9 +15,7 @@ from arcade_google_docs.utils import build_docs_service
             "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."],

arcade_google_docs/utils.py

@@ -34,7 +34,7 @@ def build_drive_service(auth_token: str | None) -> Resource:  # type: ignore[no-
 def build_files_list_params(
     mime_type: str,
     page_size: int,
-    order_by: list[OrderBy],
+    order_by: list[OrderBy] | None,
     pagination_token: str | None,
     include_shared_drives: bool,
     search_only_in_shared_drive_id: str | None,
@@ -51,7 +51,7 @@ def build_files_list_params(
     params = {
         "q": query,
         "pageSize": page_size,
-        "orderBy": ",".join([item.value for item in order_by]),
+        "orderBy": ",".join([item.value for item in order_by]) if order_by else None,
         "pageToken": pagination_token,
     }
 
@@ -102,8 +102,8 @@ def build_files_list_query(
             name_not_contains = keyword.replace("'", "\\'")
             full_text_not_contains = keyword.replace("'", "\\'")
             keyword_query = (
-                f"(name not contains '{name_not_contains}' and "
-                f"fullText not contains '{full_text_not_contains}')"
+                f"(not (name contains '{name_not_contains}' or "
+                f"fullText contains '{full_text_not_contains}'))"
             )
             query.append(keyword_query)
 

{arcade_google_docs-3.1.0.dist-info → arcade_google_docs-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arcade_google_docs
-Version: 3.1.0
+Version: 4.0.0
 Summary: Arcade.dev LLM tools for Google Docs
 Author-email: Arcade <dev@arcade.dev>
 License: Proprietary - Arcade Software License Agreement v1.0

arcade_google_docs-4.0.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+arcade_google_docs/__init__.py,sha256=nZoMwH9HWZLpfNMIioUXLDlZ7QDR-E4C1_8hySt_CkU,604
+arcade_google_docs/doc_to_html.py,sha256=6RTpzRSrazNa6AndLZhA20wgVDzZuHUqpu3WAkAsbjQ,3146
+arcade_google_docs/doc_to_markdown.py,sha256=eT-sc6ruxN8nEtUm9mBHFOWXajEBTTXkxsn6XsLHIxo,2020
+arcade_google_docs/enum.py,sha256=vFJWPe1JPG6I9xqdVVvuaEeen4LvvtJxax1sDYeh4UU,3421
+arcade_google_docs/templates.py,sha256=pxbdMj57eV3-ImW3CixDWscpVKS94Z8nTNyTxDhUfGY,283
+arcade_google_docs/utils.py,sha256=XMgKcWPWKy8SbH3y2eCil01hssHhUgYxVrwXyvHEU4A,3748
+arcade_google_docs/tools/__init__.py,sha256=s0FS3z-uXE4lQH06YhnUKgIOT-Kq-v6rQMqXUGdPDnw,827
+arcade_google_docs/tools/comment.py,sha256=Qm5NHdNHONs3j4gqbZ7Fw9NrTVBb_mZ-th1X-z2IoLM,2836
+arcade_google_docs/tools/create.py,sha256=AuYy8yMGscrxAdLJQX0WiisGHCTufSlaRu_QGMMKQmM,2764
+arcade_google_docs/tools/file_picker.py,sha256=Dqn-hfMoTsWyHM8QCakVgHr5TKrzL_1Lj-vYHVGtOW4,2342
+arcade_google_docs/tools/get.py,sha256=tCByk1-C97Mdo9P3oDdr--6bXD1dIQ3FxsDxptCJaA8,1145
+arcade_google_docs/tools/search.py,sha256=JpaOvcn3a6MjJEAqtne4vfiq4SvlINCw6lKv6nWt3zc,8035
+arcade_google_docs/tools/update.py,sha256=_dReYit0s7ykn2bYQEUwohl3D_63U5leF87egO4eEiQ,1836
+arcade_google_docs-4.0.0.dist-info/METADATA,sha256=lQakZrQRnTWx8Qa_vGbSwGxFOiVAMebNYVaSghfAGsw,1097
+arcade_google_docs-4.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+arcade_google_docs-4.0.0.dist-info/RECORD,,

arcade_google_docs/decorators.py

@@ -1,24 +0,0 @@
-import functools
-from collections.abc import Callable
-from typing import Any
-
-from arcade_tdk import ToolContext
-from googleapiclient.errors import HttpError
-
-from arcade_google_docs.file_picker import generate_google_file_picker_url
-
-
-def with_filepicker_fallback(func: Callable[..., Any]) -> Callable[..., Any]:
-    """ """
-
-    @functools.wraps(func)
-    async def async_wrapper(context: ToolContext, *args: Any, **kwargs: Any) -> Any:
-        try:
-            return await func(context, *args, **kwargs)
-        except HttpError as e:
-            if e.status_code in [403, 404]:
-                file_picker_response = generate_google_file_picker_url(context)
-                return file_picker_response
-            raise
-
-    return async_wrapper

arcade_google_docs-3.1.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-arcade_google_docs/__init__.py,sha256=J3c3lEuqb86UE5zScpv7Gd4TltmzTUq_tWyA2Ff0gmI,528
-arcade_google_docs/decorators.py,sha256=5ONZ3vS2lZBmog5c1TcuWjyPDeftBPAJ7vXyLjSPFRk,751
-arcade_google_docs/doc_to_html.py,sha256=6RTpzRSrazNa6AndLZhA20wgVDzZuHUqpu3WAkAsbjQ,3146
-arcade_google_docs/doc_to_markdown.py,sha256=eT-sc6ruxN8nEtUm9mBHFOWXajEBTTXkxsn6XsLHIxo,2020
-arcade_google_docs/enum.py,sha256=vFJWPe1JPG6I9xqdVVvuaEeen4LvvtJxax1sDYeh4UU,3421
-arcade_google_docs/file_picker.py,sha256=kGfUVfH5QVlIW1sL-_gAwPokt7TwVEcPk3Vnk53GKUE,2005
-arcade_google_docs/templates.py,sha256=pxbdMj57eV3-ImW3CixDWscpVKS94Z8nTNyTxDhUfGY,283
-arcade_google_docs/utils.py,sha256=Eku4b1olLcXfQ20liE9m3iPWvy60VA62tQ8TFwRKn94,3722
-arcade_google_docs/tools/__init__.py,sha256=vtn_NKrYwgWsdgcDYBY4t8m_XF73jB4j7zrpt-NC-dI,707
-arcade_google_docs/tools/comment.py,sha256=Qm5NHdNHONs3j4gqbZ7Fw9NrTVBb_mZ-th1X-z2IoLM,2836
-arcade_google_docs/tools/create.py,sha256=AuYy8yMGscrxAdLJQX0WiisGHCTufSlaRu_QGMMKQmM,2764
-arcade_google_docs/tools/get.py,sha256=2wi9ZF9s_57mMbIGgsqr53Fr0AJyrYVOQ11x7nAyk8Y,1339
-arcade_google_docs/tools/search.py,sha256=_CaEs1A_qGToNPeuGQ2yN3phGtPD7fFQbW3UqZr_qpg,8617
-arcade_google_docs/tools/update.py,sha256=9SvffQIHnmYiEgyE1VrhXG2aHb0hIfWYPzPLc4nTdKI,2030
-arcade_google_docs-3.1.0.dist-info/METADATA,sha256=X1ZvXVVYgg2tp5KfpnXlDc0bsQJw3GugfPWOIQ7ZTF4,1097
-arcade_google_docs-3.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-arcade_google_docs-3.1.0.dist-info/RECORD,,