You've already forked adk-python
mirror of
https://github.com/encounter/adk-python.git
synced 2026-07-09 18:19:28 -07:00
Goodnight
322dd1827a
Merge https://github.com/google/adk-python/pull/3937 **Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.** ### Link to Issue or Description of Change Not applicable **Problem:** Several markdown files contained typos, grammatical errors (e.g., "search youtubes"), and awkward phrasing. **Solution:** Performed a comprehensive quality assurance pass on the documentation. - Fixed typos in README.md and AGENTS.md. - Improved grammar and phrasing in CONTRIBUTING.md and sample READMEs. ### Testing Plan This is a documentation and typo fix PR. **Unit Tests:** - [ ] I have added or updated unit tests for my change. - [ ] All unit tests pass locally. N/A - Documentation changes only. **Manual End-to-End (E2E) Tests:** This is a documentation and typo fix PR. ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] New and existing unit tests pass locally with my changes. - [x] I have manually tested my changes end-to-end. - [ ] Any dependent changes have been merged and published in downstream modules. Co-authored-by: Xiang (Sean) Zhou <seanzhougoogle@google.com> COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/3937 from Goodnight77:docs/fix-typos a0cf4db6741f19c77eeb0746c9db524dd02121ac PiperOrigin-RevId: 845599254
105 lines
3.5 KiB
Markdown
105 lines
3.5 KiB
Markdown
# 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_VERTEXAI=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.
|