mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
a4506009b9
## Description
This change addresses the ask where the user may want to use custom
scopes. For instance, the default scope (bigquery) falls short from
running sql that utilizes integration with other google products, such
as Drive, Vertex AI, Cloud Run etc. With this change the user would be
able to configure custom scopes depending on their use case.
The custom scopes can be configured in the tools.yaml file, e.g.:
```yaml
sources:
bigquery-source:
kind: "bigquery"
project: ${BIGQUERY_PROJECT}
location: ${BIGQUERY_LOCATION:}
useClientOAuth: ${BIGQUERY_USE_CLIENT_OAUTH:false}
scopes:
- "https://www.googleapis.com/auth/bigquery"
- "https://www.googleapis.com/auth/drive"
```
and if the [bigquery prebuilt
config](https://github.com/googleapis/genai-toolbox/blob/main/internal/prebuiltconfigs/tools/bigquery.yaml)
is being used, then it can be set in the environment variable as well:
```shell
$ export BIGQUERY_SCOPES="https://www.googleapis.com/auth/bigquery,https://www.googleapis.com/auth/drive"
```
## PR Checklist
> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:
- [ ] Make sure you reviewed
[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a
[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [ ] Make sure to add `!` if this involve a breaking change
🛠️ Fixes #1942
83 lines
2.4 KiB
YAML
83 lines
2.4 KiB
YAML
# 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.
|
|
|
|
sources:
|
|
bigquery-source:
|
|
kind: "bigquery"
|
|
project: ${BIGQUERY_PROJECT}
|
|
location: ${BIGQUERY_LOCATION:}
|
|
useClientOAuth: ${BIGQUERY_USE_CLIENT_OAUTH:false}
|
|
scopes: ${BIGQUERY_SCOPES:}
|
|
|
|
tools:
|
|
analyze_contribution:
|
|
kind: bigquery-analyze-contribution
|
|
source: bigquery-source
|
|
description: Use this tool to analyze the contribution about changes to key metrics in multi-dimensional data.
|
|
|
|
ask_data_insights:
|
|
kind: bigquery-conversational-analytics
|
|
source: bigquery-source
|
|
description: |
|
|
Use this tool to perform data analysis, get insights,
|
|
or answer complex questions about the contents of specific
|
|
BigQuery tables.
|
|
|
|
execute_sql:
|
|
kind: bigquery-execute-sql
|
|
source: bigquery-source
|
|
description: Use this tool to execute sql statement.
|
|
|
|
forecast:
|
|
kind: bigquery-forecast
|
|
source: bigquery-source
|
|
description: Use this tool to forecast time series data.
|
|
|
|
get_dataset_info:
|
|
kind: bigquery-get-dataset-info
|
|
source: bigquery-source
|
|
description: Use this tool to get dataset metadata.
|
|
|
|
get_table_info:
|
|
kind: bigquery-get-table-info
|
|
source: bigquery-source
|
|
description: Use this tool to get table metadata.
|
|
|
|
list_dataset_ids:
|
|
kind: bigquery-list-dataset-ids
|
|
source: bigquery-source
|
|
description: Use this tool to list datasets.
|
|
|
|
list_table_ids:
|
|
kind: bigquery-list-table-ids
|
|
source: bigquery-source
|
|
description: Use this tool to list tables.
|
|
|
|
search_catalog:
|
|
kind: bigquery-search-catalog
|
|
source: bigquery-source
|
|
description: Use this tool to find tables, views, models, routines or connections.
|
|
|
|
toolsets:
|
|
bigquery_database_tools:
|
|
- analyze_contribution
|
|
- ask_data_insights
|
|
- execute_sql
|
|
- forecast
|
|
- get_dataset_info
|
|
- get_table_info
|
|
- list_dataset_ids
|
|
- list_table_ids
|
|
- search_catalog
|