google-adk 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

google/adk/tools/bigquery/bigquery_credentials.py

@@ -0,0 +1,217 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+import json
+from typing import List
+from typing import Optional
+
+from fastapi.openapi.models import OAuth2
+from fastapi.openapi.models import OAuthFlowAuthorizationCode
+from fastapi.openapi.models import OAuthFlows
+from google.auth.exceptions import RefreshError
+from google.auth.transport.requests import Request
+from google.oauth2.credentials import Credentials
+from pydantic import BaseModel
+from pydantic import model_validator
+
+from ...auth import AuthConfig
+from ...auth import AuthCredential
+from ...auth import AuthCredentialTypes
+from ...auth import OAuth2Auth
+from ..tool_context import ToolContext
+
+BIGQUERY_TOKEN_CACHE_KEY = "bigquery_token_cache"
+
+
+class BigQueryCredentialsConfig(BaseModel):
+  """Configuration for Google API tools. (Experimental)"""
+
+  # Configure the model to allow arbitrary types like Credentials
+  model_config = {"arbitrary_types_allowed": True}
+
+  credentials: Optional[Credentials] = None
+  """the existing oauth credentials to use. If set,this credential will be used
+  for every end user, end users don't need to be involved in the oauthflow. This
+  field is mutually exclusive with client_id, client_secret and scopes.
+  Don't set this field unless you are sure this credential has the permission to
+  access every end user's data.
+
+  Example usage: when the agent is deployed in Google Cloud environment and
+  the service account (used as application default credentials) has access to
+  all the required BigQuery resource. Setting this credential to allow user to
+  access the BigQuery resource without end users going through oauth flow.
+
+  To get application default credential: `google.auth.default(...)`. See more
+  details in https://cloud.google.com/docs/authentication/application-default-credentials.
+
+  When the deployed environment cannot provide a pre-existing credential,
+  consider setting below client_id, client_secret and scope for end users to go
+  through oauth flow, so that agent can access the user data.
+  """
+  client_id: Optional[str] = None
+  """the oauth client ID to use."""
+  client_secret: Optional[str] = None
+  """the oauth client secret to use."""
+  scopes: Optional[List[str]] = None
+  """the scopes to use.
+  """
+
+  @model_validator(mode="after")
+  def __post_init__(self) -> BigQueryCredentialsConfig:
+    """Validate that either credentials or client ID/secret are provided."""
+    if not self.credentials and (not self.client_id or not self.client_secret):
+      raise ValueError(
+          "Must provide either credentials or client_id abd client_secret pair."
+      )
+    if self.credentials and (
+        self.client_id or self.client_secret or self.scopes
+    ):
+      raise ValueError(
+          "Cannot provide both existing credentials and"
+          " client_id/client_secret/scopes."
+      )
+
+    if self.credentials:
+      self.client_id = self.credentials.client_id
+      self.client_secret = self.credentials.client_secret
+      self.scopes = self.credentials.scopes
+    return self
+
+
+class BigQueryCredentialsManager:
+  """Manages Google API credentials with automatic refresh and OAuth flow handling.
+
+  This class centralizes credential management so multiple tools can share
+  the same authenticated session without duplicating OAuth logic.
+  """
+
+  def __init__(self, credentials_config: BigQueryCredentialsConfig):
+    """Initialize the credential manager.
+
+    Args:
+        credentials_config: Credentials containing client id and client secrete
+        or default credentials
+    """
+    self.credentials_config = credentials_config
+
+  async def get_valid_credentials(
+      self, tool_context: ToolContext
+  ) -> Optional[Credentials]:
+    """Get valid credentials, handling refresh and OAuth flow as needed.
+
+    Args:
+        tool_context: The tool context for OAuth flow and state management
+
+    Returns:
+        Valid Credentials object, or None if OAuth flow is needed
+    """
+    # First, try to get credentials from the tool context
+    creds_json = tool_context.state.get(BIGQUERY_TOKEN_CACHE_KEY, None)
+    creds = (
+        Credentials.from_authorized_user_info(
+            json.loads(creds_json), self.credentials_config.scopes
+        )
+        if creds_json
+        else None
+    )
+
+    # If credentails are empty use the default credential
+    if not creds:
+      creds = self.credentials_config.credentials
+
+    # Check if we have valid credentials
+    if creds and creds.valid:
+      return creds
+
+    # Try to refresh expired credentials
+    if creds and creds.expired and creds.refresh_token:
+      try:
+        creds.refresh(Request())
+        if creds.valid:
+          # Cache the refreshed credentials
+          tool_context.state[BIGQUERY_TOKEN_CACHE_KEY] = creds.to_json()
+          return creds
+      except RefreshError:
+        # Refresh failed, need to re-authenticate
+        pass
+
+    # Need to perform OAuth flow
+    return await self._perform_oauth_flow(tool_context)
+
+  async def _perform_oauth_flow(
+      self, tool_context: ToolContext
+  ) -> Optional[Credentials]:
+    """Perform OAuth flow to get new credentials.
+
+    Args:
+        tool_context: The tool context for OAuth flow
+        required_scopes: Set of required OAuth scopes
+
+    Returns:
+        New Credentials object, or None if flow is in progress
+    """
+
+    # Create OAuth configuration
+    auth_scheme = OAuth2(
+        flows=OAuthFlows(
+            authorizationCode=OAuthFlowAuthorizationCode(
+                authorizationUrl="https://accounts.google.com/o/oauth2/auth",
+                tokenUrl="https://oauth2.googleapis.com/token",
+                scopes={
+                    scope: f"Access to {scope}"
+                    for scope in self.credentials_config.scopes
+                },
+            )
+        )
+    )
+
+    auth_credential = AuthCredential(
+        auth_type=AuthCredentialTypes.OAUTH2,
+        oauth2=OAuth2Auth(
+            client_id=self.credentials_config.client_id,
+            client_secret=self.credentials_config.client_secret,
+        ),
+    )
+
+    # Check if OAuth response is available
+    auth_response = tool_context.get_auth_response(
+        AuthConfig(auth_scheme=auth_scheme, raw_auth_credential=auth_credential)
+    )
+
+    if auth_response:
+      # OAuth flow completed, create credentials
+      creds = Credentials(
+          token=auth_response.oauth2.access_token,
+          refresh_token=auth_response.oauth2.refresh_token,
+          token_uri=auth_scheme.flows.authorizationCode.tokenUrl,
+          client_id=self.credentials_config.client_id,
+          client_secret=self.credentials_config.client_secret,
+          scopes=list(self.credentials_config.scopes),
+      )
+
+      # Cache the new credentials
+      tool_context.state[BIGQUERY_TOKEN_CACHE_KEY] = creds.to_json()
+
+      return creds
+    else:
+      # Request OAuth flow
+      tool_context.request_credential(
+          AuthConfig(
+              auth_scheme=auth_scheme,
+              raw_auth_credential=auth_credential,
+          )
+      )
+      return None

google/adk/tools/bigquery/bigquery_tool.py

@@ -0,0 +1,116 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import inspect
+from typing import Any
+from typing import Callable
+from typing import Optional
+
+from google.oauth2.credentials import Credentials
+from typing_extensions import override
+
+from ..function_tool import FunctionTool
+from ..tool_context import ToolContext
+from .bigquery_credentials import BigQueryCredentialsConfig
+from .bigquery_credentials import BigQueryCredentialsManager
+
+
+class BigQueryTool(FunctionTool):
+  """GoogleApiTool class for tools that call Google APIs.
+
+  This class is for developers to handcraft customized Google API tools rather
+  than auto generate Google API tools based on API specs.
+
+  This class handles all the OAuth complexity, credential management,
+  and common Google API patterns so subclasses can focus on their
+  specific functionality.
+  """
+
+  def __init__(
+      self,
+      func: Callable[..., Any],
+      credentials: Optional[BigQueryCredentialsConfig] = None,
+  ):
+    """Initialize the Google API tool.
+
+    Args:
+        func: callable that impelments the tool's logic, can accept one
+          'credential" parameter
+        credentials: credentials used to call Google API. If None, then we don't
+          hanlde the auth logic
+    """
+    super().__init__(func=func)
+    self._ignore_params.append("credentials")
+    self.credentials_manager = (
+        BigQueryCredentialsManager(credentials) if credentials else None
+    )
+
+  @override
+  async def run_async(
+      self, *, args: dict[str, Any], tool_context: ToolContext
+  ) -> Any:
+    """Main entry point for tool execution with credential handling.
+
+    This method handles all the OAuth complexity and then delegates
+    to the subclass's run_async_with_credential method.
+    """
+    try:
+      # Get valid credentials
+      credentials = (
+          await self.credentials_manager.get_valid_credentials(tool_context)
+          if self.credentials_manager
+          else None
+      )
+
+      if credentials is None and self.credentials_manager:
+        # OAuth flow in progress
+        return (
+            "User authorization is required to access Google services for"
+            f" {self.name}. Please complete the authorization flow."
+        )
+
+      # Execute the tool's specific logic with valid credentials
+
+      return await self._run_async_with_credential(
+          credentials, args, tool_context
+      )
+
+    except Exception as ex:
+      return {
+          "status": "ERROR",
+          "error_details": str(ex),
+      }
+
+  async def _run_async_with_credential(
+      self,
+      credentials: Credentials,
+      args: dict[str, Any],
+      tool_context: ToolContext,
+  ) -> Any:
+    """Execute the tool's specific logic with valid credentials.
+
+    Args:
+        credentials: Valid Google OAuth credentials
+        args: Arguments passed to the tool
+        tool_context: Tool execution context
+
+    Returns:
+        The result of the tool execution
+    """
+    args_to_call = args.copy()
+    signature = inspect.signature(self.func)
+    if "credentials" in signature.parameters:
+      args_to_call["credentials"] = credentials
+    return await super().run_async(args=args_to_call, tool_context=tool_context)

google/adk/tools/bigquery/bigquery_toolset.py

@@ -0,0 +1,86 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+from typing import List
+from typing import Optional
+from typing import Union
+
+from google.adk.agents.readonly_context import ReadonlyContext
+from typing_extensions import override
+
+from . import metadata_tool
+from . import query_tool
+from ...tools.base_tool import BaseTool
+from ...tools.base_toolset import BaseToolset
+from ...tools.base_toolset import ToolPredicate
+from .bigquery_credentials import BigQueryCredentialsConfig
+from .bigquery_tool import BigQueryTool
+
+
+class BigQueryToolset(BaseToolset):
+  """BigQuery Toolset contains tools for interacting with BigQuery data and metadata."""
+
+  def __init__(
+      self,
+      *,
+      tool_filter: Optional[Union[ToolPredicate, List[str]]] = None,
+      credentials_config: Optional[BigQueryCredentialsConfig] = None,
+  ):
+    self._credentials_config = credentials_config
+    self.tool_filter = tool_filter
+
+  def _is_tool_selected(
+      self, tool: BaseTool, readonly_context: ReadonlyContext
+  ) -> bool:
+    if self.tool_filter is None:
+      return True
+
+    if isinstance(self.tool_filter, ToolPredicate):
+      return self.tool_filter(tool, readonly_context)
+
+    if isinstance(self.tool_filter, list):
+      return tool.name in self.tool_filter
+
+    return False
+
+  @override
+  async def get_tools(
+      self, readonly_context: Optional[ReadonlyContext] = None
+  ) -> List[BaseTool]:
+    """Get tools from the toolset."""
+    all_tools = [
+        BigQueryTool(
+            func=func,
+            credentials=self._credentials_config,
+        )
+        for func in [
+            metadata_tool.get_dataset_info,
+            metadata_tool.get_table_info,
+            metadata_tool.list_dataset_ids,
+            metadata_tool.list_table_ids,
+            query_tool.execute_sql,
+        ]
+    ]
+
+    return [
+        tool
+        for tool in all_tools
+        if self._is_tool_selected(tool, readonly_context)
+    ]
+
+  @override
+  async def close(self):
+    pass

google/adk/tools/bigquery/client.py

@@ -0,0 +1,33 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+import google.api_core.client_info
+from google.cloud import bigquery
+from google.oauth2.credentials import Credentials
+
+USER_AGENT = "adk-bigquery-tool"
+
+
+def get_bigquery_client(*, credentials: Credentials) -> bigquery.Client:
+  """Get a BigQuery client."""
+
+  client_info = google.api_core.client_info.ClientInfo(user_agent=USER_AGENT)
+
+  bigquery_client = bigquery.Client(
+      credentials=credentials, client_info=client_info
+  )
+
+  return bigquery_client

google/adk/tools/bigquery/metadata_tool.py

@@ -0,0 +1,249 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from google.cloud import bigquery
+from google.oauth2.credentials import Credentials
+
+from ...tools.bigquery import client
+
+
+def list_dataset_ids(project_id: str, credentials: Credentials) -> list[str]:
+  """List BigQuery dataset ids in a Google Cloud project.
+
+  Args:
+      project_id (str): The Google Cloud project id.
+      credentials (Credentials): The credentials to use for the request.
+
+  Returns:
+      list[str]: List of the BigQuery dataset ids present in the project.
+
+  Examples:
+      >>> list_dataset_ids("bigquery-public-data")
+      ['america_health_rankings',
+       'american_community_survey',
+       'aml_ai_input_dataset',
+       'austin_311',
+       'austin_bikeshare',
+       'austin_crime',
+       'austin_incidents',
+       'austin_waste',
+       'baseball',
+       'bbc_news']
+  """
+  try:
+    bq_client = client.get_bigquery_client(credentials=credentials)
+
+    datasets = []
+    for dataset in bq_client.list_datasets(project_id):
+      datasets.append(dataset.dataset_id)
+    return datasets
+  except Exception as ex:
+    return {
+        "status": "ERROR",
+        "error_details": str(ex),
+    }
+
+
+def get_dataset_info(
+    project_id: str, dataset_id: str, credentials: Credentials
+) -> dict:
+  """Get metadata information about a BigQuery dataset.
+
+  Args:
+      project_id (str): The Google Cloud project id containing the dataset.
+      dataset_id (str): The BigQuery dataset id.
+      credentials (Credentials): The credentials to use for the request.
+
+  Returns:
+      dict: Dictionary representing the properties of the dataset.
+
+  Examples:
+      >>> get_dataset_info("bigquery-public-data", "penguins")
+      {
+        "kind": "bigquery#dataset",
+        "etag": "PNC5907iQbzeVcAru/2L3A==",
+        "id": "bigquery-public-data:ml_datasets",
+        "selfLink":
+          "https://bigquery.googleapis.com/bigquery/v2/projects/bigquery-public-data/datasets/ml_datasets",
+        "datasetReference": {
+            "datasetId": "ml_datasets",
+            "projectId": "bigquery-public-data"
+        },
+        "access": [
+            {
+                "role": "OWNER",
+                "groupByEmail": "cloud-datasets-eng@google.com"
+            },
+            {
+                "role": "READER",
+                "iamMember": "allUsers"
+            },
+            {
+                "role": "READER",
+                "groupByEmail": "bqml-eng@google.com"
+            }
+        ],
+        "creationTime": "1553208775542",
+        "lastModifiedTime": "1686338918114",
+        "location": "US",
+        "type": "DEFAULT",
+        "maxTimeTravelHours": "168"
+      }
+  """
+  try:
+    bq_client = client.get_bigquery_client(credentials=credentials)
+    dataset = bq_client.get_dataset(
+        bigquery.DatasetReference(project_id, dataset_id)
+    )
+    return dataset.to_api_repr()
+  except Exception as ex:
+    return {
+        "status": "ERROR",
+        "error_details": str(ex),
+    }
+
+
+def list_table_ids(
+    project_id: str, dataset_id: str, credentials: Credentials
+) -> list[str]:
+  """List table ids in a BigQuery dataset.
+
+  Args:
+      project_id (str): The Google Cloud project id containing the dataset.
+      dataset_id (str): The BigQuery dataset id.
+      credentials (Credentials): The credentials to use for the request.
+
+  Returns:
+      list[str]: List of the tables ids present in the dataset.
+
+  Examples:
+      >>> list_table_ids("bigquery-public-data", "ml_datasets")
+      ['census_adult_income',
+       'credit_card_default',
+       'holidays_and_events_for_forecasting',
+       'iris',
+       'penguins',
+       'ulb_fraud_detection']
+  """
+  try:
+    bq_client = client.get_bigquery_client(credentials=credentials)
+
+    tables = []
+    for table in bq_client.list_tables(
+        bigquery.DatasetReference(project_id, dataset_id)
+    ):
+      tables.append(table.table_id)
+    return tables
+  except Exception as ex:
+    return {
+        "status": "ERROR",
+        "error_details": str(ex),
+    }
+
+
+def get_table_info(
+    project_id: str, dataset_id: str, table_id: str, credentials: Credentials
+) -> dict:
+  """Get metadata information about a BigQuery table.
+
+  Args:
+      project_id (str): The Google Cloud project id containing the dataset.
+      dataset_id (str): The BigQuery dataset id containing the table.
+      table_id (str): The BigQuery table id.
+      credentials (Credentials): The credentials to use for the request.
+
+  Returns:
+      dict: Dictionary representing the properties of the table.
+
+  Examples:
+      >>> get_table_info("bigquery-public-data", "ml_datasets", "penguins")
+      {
+        "kind": "bigquery#table",
+        "etag": "X0ZkRohSGoYvWemRYEgOHA==",
+        "id": "bigquery-public-data:ml_datasets.penguins",
+        "selfLink":
+        "https://bigquery.googleapis.com/bigquery/v2/projects/bigquery-public-data/datasets/ml_datasets/tables/penguins",
+        "tableReference": {
+            "projectId": "bigquery-public-data",
+            "datasetId": "ml_datasets",
+            "tableId": "penguins"
+        },
+        "schema": {
+            "fields": [
+                {
+                    "name": "species",
+                    "type": "STRING",
+                    "mode": "REQUIRED"
+                },
+                {
+                    "name": "island",
+                    "type": "STRING",
+                    "mode": "NULLABLE"
+                },
+                {
+                    "name": "culmen_length_mm",
+                    "type": "FLOAT",
+                    "mode": "NULLABLE"
+                },
+                {
+                    "name": "culmen_depth_mm",
+                    "type": "FLOAT",
+                    "mode": "NULLABLE"
+                },
+                {
+                    "name": "flipper_length_mm",
+                    "type": "FLOAT",
+                    "mode": "NULLABLE"
+                },
+                {
+                    "name": "body_mass_g",
+                    "type": "FLOAT",
+                    "mode": "NULLABLE"
+                },
+                {
+                    "name": "sex",
+                    "type": "STRING",
+                    "mode": "NULLABLE"
+                }
+            ]
+        },
+        "numBytes": "28947",
+        "numLongTermBytes": "28947",
+        "numRows": "344",
+        "creationTime": "1619804743188",
+        "lastModifiedTime": "1634584675234",
+        "type": "TABLE",
+        "location": "US",
+        "numTimeTravelPhysicalBytes": "0",
+        "numTotalLogicalBytes": "28947",
+        "numActiveLogicalBytes": "0",
+        "numLongTermLogicalBytes": "28947",
+        "numTotalPhysicalBytes": "5350",
+        "numActivePhysicalBytes": "0",
+        "numLongTermPhysicalBytes": "5350",
+        "numCurrentPhysicalBytes": "5350"
+      }
+  """
+  try:
+    bq_client = client.get_bigquery_client(credentials=credentials)
+    return bq_client.get_table(
+        bigquery.TableReference(
+            bigquery.DatasetReference(project_id, dataset_id), table_id
+        )
+    ).to_api_repr()
+  except Exception as ex:
+    return {
+        "status": "ERROR",
+        "error_details": str(ex),
+    }