Skip to content

docs: BigQuery Agent Analytics plugin — v2.4.0 config options, token view columns, structured tool declarations#1941

Closed
caohy1988 wants to merge 2 commits into
google:mainfrom
caohy1988:docs/bqaa-plugin-july-feature-updates
Closed

docs: BigQuery Agent Analytics plugin — v2.4.0 config options, token view columns, structured tool declarations#1941
caohy1988 wants to merge 2 commits into
google:mainfrom
caohy1988:docs/bqaa-plugin-july-feature-updates

Conversation

@caohy1988

Copy link
Copy Markdown
Contributor

Summary

Updates the BigQuery Agent Analytics plugin doc (docs/integrations/bigquery-agent-analytics.md) to cover the plugin features shipped since the last doc update (2026-06-30), verified against the plugin source and the v2.4.0 release tag in google/adk-python:

Plugin change Commit (adk-python) In release
enable_otel_correlation, custom_metadata_allowlist, payload_column_denylist 38d715c v2.4.0
usage_thinking_tokens / usage_tool_use_tokens view columns c14258d v2.4.0
Structured tool declarations ({name, description, parameters}) in LLM_REQUEST ecef5f8 main (post-v2.4.0)

Changes

  1. Configuration options table: three new BigQueryLoggerConfig rows (enable_otel_correlation, custom_metadata_allowlist, payload_column_denylist), marked v2.4.0+.
  2. New subsection "Trace correlation, metadata capture, and column projection (v2.4.0+)" in the Python tab: what each option does, the safety-pipeline guarantees for captured metadata, the schema-first projection behavior, and the documented interaction rules (denying attributes disables otel/custom_metadata capture; combining it with a non-empty allowlist raises at construction) — matching the constraints enforced in the plugin source. Includes a short code sample.
  3. Views table: v_llm_response gains usage_thinking_tokens and usage_tool_use_tokens (marked with a footnote giving the source JSON paths in attributes.usage_metadata).
  4. LLM_REQUEST payload example: updated the attributes.tools example from a bare name list to the structured {name, description, parameters} entries now logged on main, with a note that releases up to and including v2.4.0 log bare names, and that v_llm_request exposes it as the tools (JSON) column.

Verification

  • All option names, defaults, JSON paths, and interaction rules were taken from src/google/adk/plugins/bigquery_agent_analytics_plugin.py docstrings and view definitions at head, not paraphrased from commit messages.
  • Release attribution checked via git compare against the v2.4.0 tag: 38d715c and c14258d are in v2.4.0; ecef5f8 is not (main only). Maintainers may want to hold item 4 until the next release, or keep the wording as-is since it already distinguishes the two behaviors.

Draft for maintainer review — happy to split item 4 into a separate PR if you prefer docs to track releases strictly.

…tion, custom_metadata allowlist, column projection, thinking/tool-use token columns, structured tool declarations)
@netlify

netlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit d6e1c37
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6a4f450b3665980008329fcf
😎 Deploy Preview https://deploy-preview-1941--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

… structured declarations as a post-v2.4.0 note
@caohy1988

Copy link
Copy Markdown
Contributor Author

Updated the LLM_REQUEST example to lead with released (v2.4.0) behavior — the JSON example shows the bare tool-name list a current install produces, and the structured {name, description, parameters} declarations moved into a "post-v2.4.0" note (using the page's existing admonition style). This resolves the judgment call flagged in the PR description; the docs now track released behavior throughout, with main-only behavior clearly boxed.

@caohy1988

Copy link
Copy Markdown
Contributor Author

Closing this draft — superseding it with a different plan for the doc update.

@caohy1988 caohy1988 closed this Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant