chore: import upstream snapshot with attribution
Continuous Integration / Pre-commit Linter (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.10) (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.11) (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.12) (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.13) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.10) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.11) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.12) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.13) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.14) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Waiting to run
Copybara PR Handler / close-imported-pr (push) Waiting to run
Continuous Integration / Pre-commit Linter (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.10) (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.11) (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.12) (push) Waiting to run
Continuous Integration / Mypy Check (Python 3.13) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.10) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.11) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.12) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.13) (push) Waiting to run
Continuous Integration / Unit Tests (Python 3.14) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Waiting to run
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Waiting to run
Copybara PR Handler / close-imported-pr (push) Waiting to run
This commit is contained in:
@@ -0,0 +1,104 @@
|
||||
# Bigtable Tools Sample
|
||||
|
||||
## Introduction
|
||||
|
||||
This sample agent demonstrates the Bigtable first-party tools in ADK,
|
||||
distributed via the `google.adk.tools.bigtable` module. These tools include:
|
||||
|
||||
1. `bigtable_list_instances`
|
||||
|
||||
Fetches Bigtable instance ids in a Google Cloud project.
|
||||
|
||||
1. `bigtable_get_instance_info`
|
||||
|
||||
Fetches metadata information about a Bigtable instance.
|
||||
|
||||
1. `bigtable_list_tables`
|
||||
|
||||
Fetches table ids in a Bigtable instance.
|
||||
|
||||
1. `bigtable_get_table_info`
|
||||
|
||||
Fetches metadata information about a Bigtable table.
|
||||
|
||||
1. `bigtable_execute_sql`
|
||||
|
||||
Runs a DQL SQL query in Bigtable database.
|
||||
|
||||
## How to use
|
||||
|
||||
Set up environment variables in your `.env` file for using
|
||||
[Google AI Studio](https://google.github.io/adk-docs/get-started/quickstart/#gemini---google-ai-studio)
|
||||
or
|
||||
[Google Cloud Vertex AI](https://google.github.io/adk-docs/get-started/quickstart/#gemini---google-cloud-vertex-ai)
|
||||
for the LLM service for your agent. For example, for using Google AI Studio you
|
||||
would set:
|
||||
|
||||
- GOOGLE_GENAI_USE_ENTERPRISE=FALSE
|
||||
- GOOGLE_API_KEY={your api key}
|
||||
|
||||
### With Application Default Credentials
|
||||
|
||||
This mode is useful for quick development when the agent builder is the only
|
||||
user interacting with the agent. The tools are run with these credentials.
|
||||
|
||||
1. Create application default credentials on the machine where the agent would
|
||||
be running by following https://cloud.google.com/docs/authentication/provide-credentials-adc.
|
||||
|
||||
1. Set `CREDENTIALS_TYPE=None` in `agent.py`
|
||||
|
||||
1. Run the agent
|
||||
|
||||
### With Service Account Keys
|
||||
|
||||
This mode is useful for quick development when the agent builder wants to run
|
||||
the agent with service account credentials. The tools are run with these
|
||||
credentials.
|
||||
|
||||
1. Create service account key by following https://cloud.google.com/iam/docs/service-account-creds#user-managed-keys.
|
||||
|
||||
1. Set `CREDENTIALS_TYPE=AuthCredentialTypes.SERVICE_ACCOUNT` in `agent.py`
|
||||
|
||||
1. Download the key file and replace `"service_account_key.json"` with the path
|
||||
|
||||
1. Run the agent
|
||||
|
||||
### With Interactive OAuth
|
||||
|
||||
1. Follow
|
||||
https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name.
|
||||
to get your client id and client secret. Be sure to choose "web" as your client
|
||||
type.
|
||||
|
||||
1. Follow https://developers.google.com/workspace/guides/configure-oauth-consent
|
||||
to add scope "https://www.googleapis.com/auth/bigtable.admin" and
|
||||
"https://www.googleapis.com/auth/bigtable.data" as a declaration, this is used
|
||||
for review purpose.
|
||||
|
||||
1. Follow
|
||||
https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred
|
||||
to add http://localhost/dev-ui/ to "Authorized redirect URIs".
|
||||
|
||||
Note: localhost here is just a hostname that you use to access the dev ui,
|
||||
replace it with the actual hostname you use to access the dev ui.
|
||||
|
||||
1. For 1st run, allow popup for localhost in Chrome.
|
||||
|
||||
1. Configure your `.env` file to add two more variables before running the
|
||||
agent:
|
||||
|
||||
- OAUTH_CLIENT_ID={your client id}
|
||||
- OAUTH_CLIENT_SECRET={your client secret}
|
||||
|
||||
Note: don't create a separate .env, instead put it to the same .env file that
|
||||
stores your Vertex AI or Dev ML credentials
|
||||
|
||||
1. Set `CREDENTIALS_TYPE=AuthCredentialTypes.OAUTH2` in `agent.py` and run the
|
||||
agent
|
||||
|
||||
## Sample prompts
|
||||
|
||||
- Show me all instances in the my-project.
|
||||
- Show me all tables in the my-instance instance in my-project.
|
||||
- Describe the schema of the my-table table in the my-instance instance in my-project.
|
||||
- Show me the first 10 rows of data from the my-table table in the my-instance instance in my-project.
|
||||
@@ -0,0 +1,15 @@
|
||||
# Copyright 2026 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 . import agent
|
||||
@@ -0,0 +1,133 @@
|
||||
# Copyright 2026 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 os
|
||||
|
||||
from google.adk.agents.llm_agent import LlmAgent
|
||||
from google.adk.auth.auth_credential import AuthCredentialTypes
|
||||
from google.adk.tools.bigtable import query_tool as bigtable_query_tool
|
||||
from google.adk.tools.bigtable.bigtable_credentials import BigtableCredentialsConfig
|
||||
from google.adk.tools.bigtable.bigtable_toolset import BigtableToolset
|
||||
from google.adk.tools.bigtable.settings import BigtableToolSettings
|
||||
from google.adk.tools.google_tool import GoogleTool
|
||||
import google.auth
|
||||
from google.cloud.bigtable.data.execute_query.metadata import SqlType
|
||||
|
||||
# Define an appropriate credential type.
|
||||
# None for Application Default Credentials
|
||||
CREDENTIALS_TYPE = None
|
||||
|
||||
# Define Bigtable tool config with read capability set to allowed.
|
||||
tool_settings = BigtableToolSettings()
|
||||
|
||||
if CREDENTIALS_TYPE == AuthCredentialTypes.OAUTH2:
|
||||
# Initialize the tools to do interactive OAuth
|
||||
# The environment variables OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET
|
||||
# must be set
|
||||
credentials_config = BigtableCredentialsConfig(
|
||||
client_id=os.getenv("OAUTH_CLIENT_ID"),
|
||||
client_secret=os.getenv("OAUTH_CLIENT_SECRET"),
|
||||
scopes=[
|
||||
"https://www.googleapis.com/auth/bigtable.admin",
|
||||
"https://www.googleapis.com/auth/bigtable.data",
|
||||
],
|
||||
)
|
||||
elif CREDENTIALS_TYPE == AuthCredentialTypes.SERVICE_ACCOUNT:
|
||||
# Initialize the tools to use the credentials in the service account key.
|
||||
# If this flow is enabled, make sure to replace the file path with your own
|
||||
# service account key file
|
||||
# https://cloud.google.com/iam/docs/service-account-creds#user-managed-keys
|
||||
creds, _ = google.auth.load_credentials_from_file("service_account_key.json")
|
||||
credentials_config = BigtableCredentialsConfig(credentials=creds)
|
||||
else:
|
||||
# Initialize the tools to use the application default credentials.
|
||||
# https://cloud.google.com/docs/authentication/provide-credentials-adc
|
||||
application_default_credentials, _ = google.auth.default()
|
||||
credentials_config = BigtableCredentialsConfig(
|
||||
credentials=application_default_credentials
|
||||
)
|
||||
|
||||
bigtable_toolset = BigtableToolset(
|
||||
credentials_config=credentials_config, bigtable_tool_settings=tool_settings
|
||||
)
|
||||
|
||||
_BIGTABLE_PROJECT_ID = ""
|
||||
_BIGTABLE_INSTANCE_ID = ""
|
||||
|
||||
|
||||
def search_hotels_by_location(
|
||||
location_name: str,
|
||||
credentials: google.auth.credentials.Credentials,
|
||||
settings: BigtableToolSettings,
|
||||
tool_context: google.adk.tools.tool_context.ToolContext,
|
||||
):
|
||||
"""Search hotels by location name.
|
||||
|
||||
This function takes a location name and returns a list of hotels
|
||||
in that area.
|
||||
|
||||
Args:
|
||||
location_name (str): The geographical location (e.g., city or town) for the
|
||||
hotel search.
|
||||
Example: { "location_name": "Basel" }
|
||||
|
||||
Returns:
|
||||
The hotels name, price tier.
|
||||
"""
|
||||
|
||||
sql_template = """
|
||||
SELECT
|
||||
TO_INT64(cf['id']) as id,
|
||||
CAST(cf['name'] AS STRING) AS name,
|
||||
CAST(cf['location'] AS STRING) AS location,
|
||||
CAST(cf['price_tier'] AS STRING) AS price_tier,
|
||||
CAST(cf['checkin_date'] AS STRING) AS checkin_date,
|
||||
CAST(cf['checkout_date'] AS STRING) AS checkout_date
|
||||
FROM hotels
|
||||
WHERE LOWER(CAST(cf['location'] AS STRING)) LIKE LOWER(CONCAT('%', @location_name, '%'))
|
||||
"""
|
||||
return bigtable_query_tool.execute_sql(
|
||||
project_id=_BIGTABLE_PROJECT_ID,
|
||||
instance_id=_BIGTABLE_INSTANCE_ID,
|
||||
query=sql_template,
|
||||
credentials=credentials,
|
||||
settings=settings,
|
||||
tool_context=tool_context,
|
||||
parameters={"location": location_name},
|
||||
parameter_types={"location": SqlType.String()},
|
||||
)
|
||||
|
||||
|
||||
# The variable name `root_agent` determines what your root agent is for the
|
||||
# debug CLI
|
||||
root_agent = LlmAgent(
|
||||
name="bigtable_agent",
|
||||
description=(
|
||||
"Agent to answer questions about Bigtable database tables and"
|
||||
" execute SQL queries."
|
||||
), # TODO(b/360128447): Update description
|
||||
instruction="""\
|
||||
You are a data agent with access to several Bigtable tools.
|
||||
Make use of those tools to answer the user's questions.
|
||||
""",
|
||||
tools=[
|
||||
bigtable_toolset,
|
||||
# Or, uncomment to use customized Bigtable tools.
|
||||
# GoogleTool(
|
||||
# func=search_hotels_by_location,
|
||||
# credentials_config=credentials_config,
|
||||
# tool_settings=tool_settings,
|
||||
# ),
|
||||
],
|
||||
)
|
||||
Reference in New Issue
Block a user