genai-toolbox/docs/en/resources/tools/bigquery/bigquery-analyze-contribution.md at 95a00e92e0383a44bcfb95e8aec45918dfd03d85

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-04-09 03:02:26 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

4.1 KiB

Raw Blame History

title, type, weight, description, aliases

title

type

weight

description

aliases

bigquery-analyze-contribution

docs

A "bigquery-analyze-contribution" tool performs contribution analysis in BigQuery.

/resources/tools/bigquery-analyze-contribution

About

A bigquery-analyze-contribution tool performs contribution analysis in BigQuery by creating a temporary CONTRIBUTION_ANALYSIS model and then querying it with ML.GET_INSIGHTS to find top contributors for a given metric.

It's compatible with the following sources:

bigquery

bigquery-analyze-contribution takes the following parameters:

input_data (string, required): The data that contain the test and control data to analyze. This can be a fully qualified BigQuery table ID (e.g., my-project.my_dataset.my_table) or a SQL query that returns the data.
contribution_metric (string, required): The name of the column that contains the metric to analyze. This can be SUM(metric_column_name), SUM(numerator_metric_column_name)/SUM(denominator_metric_column_name) or SUM(metric_sum_column_name)/COUNT(DISTINCT categorical_column_name) depending the type of metric to analyze.
is_test_col (string, required): The name of the column that identifies whether a row is in the test or control group. The column must contain boolean values.
dimension_id_cols (array of strings, optional): An array of column names that uniquely identify each dimension.
top_k_insights_by_apriori_support (integer, optional): The number of top insights to return, ranked by apriori support. Default to '30'.
pruning_method (string, optional): The method to use for pruning redundant insights. Can be 'NO_PRUNING' or 'PRUNE_REDUNDANT_INSIGHTS'. Defaults to 'PRUNE_REDUNDANT_INSIGHTS'.

The behavior of this tool is influenced by the writeMode setting on its bigquery source:

allowed (default) and blocked: These modes do not impose any special restrictions on the bigquery-analyze-contribution tool.
protected: This mode enables session-based execution. The tool will operate within the same BigQuery session as other tools using the same source. This allows the input_data parameter to be a query that references temporary resources (e.g., TEMP tables) created within that session.

The tool's behavior is also influenced by the allowedDatasets restriction on the bigquery source:

Without allowedDatasets restriction: The tool can use any table or query for the input_data parameter.
With allowedDatasets restriction: The tool verifies that the input_data parameter only accesses tables within the allowed datasets.
- If input_data is a table ID, the tool checks if the table's dataset is in the allowed list.
- If input_data is a query, the tool performs a dry run to analyze the query and rejects it if it accesses any table outside the allowed list.

Example

kind: tools
name: contribution_analyzer
type: bigquery-analyze-contribution
source: my-bigquery-source
description: Use this tool to run contribution analysis on a dataset in BigQuery.

Sample Prompt

You can prepare a sample table following https://cloud.google.com/bigquery/docs/get-contribution-analysis-insights. And use the following sample prompts to call this tool:

What drives the changes in sales in the table bqml_tutorial.iowa_liquor_sales_sum_data? Use the project id myproject.
Analyze the contribution for the total_sales metric in the table bqml_tutorial.iowa_liquor_sales_sum_data. The test group is identified by the is_test column. The dimensions are store_name, city, vendor_name, category_name and item_description.

Reference

field	type	required	description
type	string	true	Must be "bigquery-analyze-contribution".
source	string	true	Name of the source the tool should execute on.
description	string	true	Description of the tool that is passed to the LLM.

4.1 KiB Raw Blame History

About

Example

Sample Prompt

Reference

4.1 KiB

Raw Blame History