Commit Graph

31 Commits

Author SHA1 Message Date
Daria Wieliczko eb989519a7 Upgrade Kotlin docs to adk-kotlin 0.9.0 and move off AdkWebServer (#2191)
* Upgrade Kotlin docs to adk-kotlin 0.9.0 and move off AdkWebServer

adk-kotlin 0.9.0 split the web server into AdkApiServer, which serves the agent
runtime contract headlessly, and AdkDevServer, which adds the development UI.
AdkWebServer is deprecated in that release and goes away at 1.0, so WebMain.kt
as written here stops compiling the day 1.0 ships.

The quickstart snippet now builds an AdkDevServer from an AdkServerConfig. That
drops three imports: AdkServerConfig.inMemory() supplies the agent loader and
the in-memory session and artifact services the old constructor took one by one.

Two behaviour notes come with the split. AdkWebServer pinned host to 0.0.0.0;
the new classes bind loopback, which is a visible change for anyone reaching the
server from a container or a remote box, so the page now says so and names the
host parameter in prose. It prints no worked example on purpose: the only value
such a snippet could carry is either 127.0.0.1, which overrides the default with
itself, or 0.0.0.0, which is a copyable way to publish an unauthenticated server
on every interface, and AdkDevServer construction is already shown in full
earlier on the page. And AdkApiServer is the headless half of the same config,
so it gets a short section rather than a bare mention - the bundled Kotlin API
reference is still generated at 0.5.0 and documents none of these classes, so a
link there would not have helped. The "not meant for production" warning now
sits directly after the screenshot, where go.md, java.md and python.md put it.

The dependency blocks readers copy from still pinned 0.8.0, and so did the
examples project. Verified on Maven Central that 0.9.0 is published for every
artifact named across these pages: -core, -processor, -webserver, -litertlm,
-a2a and -integrations. Checked the 0.9.0 POMs before bumping: Ktor still
resolves to 2.3.13 and a2a-java-sdk-client to 1.0.0.Final, so the explicit pins
stay correct and the two comments citing them only needed their version
reference moved. The `Kotlin v0.x` support badges are deliberately left alone:
they record the release a feature landed in, not the current version.

Verified by compiling: every snippet added here was compiled verbatim against
the published 0.9.0 artifacts on JDK 17, and the whole examples project still
builds at 0.9.0. As a negative control, the old snippet still compiles at 0.9.0
but emits the deprecation warning, which is what makes this a 1.0 break rather
than a present-day one. Note the Kotlin snippet check only builds .kt files
changed in the PR, so it will not cover a markdown-only change like this.

* Apply suggestion from @joefernandez

* Apply suggestion from @joefernandez

* Removing information bloat from the Get Started

see comments for where to locate this information

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-09-02 11:21:12 -07:00
Shahin Saadati 109b278c0b Document the BigQuery agent analytics plugin for Kotlin (#2147)
* Add the Kotlin tab for the BigQuery agent analytics quickstart

adk-kotlin 0.8.0 ships BigQueryAgentAnalyticsPlugin, so the quickstart's setup
group can carry a Kotlin tab alongside Python and Java. Transcluded, so CI
compiles and lints it.

The tab says plainly what the Kotlin plugin does not do, because a bare third
tab under this page's overview would promise far more than it delivers. It logs
INVOCATION_STARTING and INVOCATION_COMPLETED only - not the LLM, tool, state or
HITL events the page's table lists - fills the identity columns and content
while leaving trace_id, latency_ms and attributes null, and writes rows one at a
time through insertAll synchronously on the invocation path, not asynchronously
through the Storage Write API the page describes. Grounded in
BigQueryAgentAnalyticsPlugin.kt at the v0.8.0 tag, not the working tree.

Only the setup group gets Kotlin. The page's six other groups cover event
payloads and configuration surface the Kotlin plugin does not have.

The plugin lives in the integrations module, so examples/kotlin needs that
artifact to compile the snippet. One line is enough: unlike the a2a artifact,
google-adk-kotlin-integrations publishes google-cloud-bigquery and google-auth
on jvmApiElements, so the types its constructor defaults name are already on the
compile classpath.

Verified with the snippet ladder: L0 symbols, L1 compile, L2 ktlint, L3
transclusions, L5 registration and L6 badge all pass against the 0.8.0 pin.

* Scope the Kotlin BigQuery claims to what the plugin actually does

Review of the branch turned up five over-claims, all of the same kind: the page
describes the Python and Java plugins, and adding a Kotlin badge and tab quietly
extended every one of those promises to Kotlin.

- The page-level badge advertised Kotlin next to Python and Java on a page whose
  opening promises Auto Schema Upgrade, tool provenance, HITL tracing, view
  creation, ADK 2.0 workflow events and drop stats. Kotlin implements none of
  them: BigQueryAgentAnalyticsPlugin overrides two Plugin callbacks. The
  correction lived only inside the Kotlin tab, which a reader on the Python tab
  never renders, so it moves to a page-level "Kotlin support" note next to the
  pricing warning, following the "Java support" note this page already uses.
- The page says ingestion goes through the Storage Write API and links its
  pricing. Kotlin calls tabledata.insertAll, a different billing line: charged
  per inserted row with a 1 KB minimum and no monthly free tier, so cost tracks
  invocation count, not bytes.
- BigQuerySchema creates no views, so the v_* names in the captured-events table
  do not exist for Kotlin. A reader would have queried v_invocation_completed
  and got a not-found.
- Configuration options is Python and Java only. Kotlin's whole surface is
  BigQueryLoggerConfig's six fields, now listed, and `location` (default "US")
  was undiscoverable - the snippet takes it as a parameter instead of pinning a
  no-op tableName that already matches the default.
- Every logging failure is swallowed: a table that cannot be created or a row
  that cannot be inserted is logged and the turn continues, so a misconfigured
  agent looks healthy while writing nothing.

A second review pass caught a defect in the first pass's own fix: it told
readers to raise the log level for `bigquery_agent_analytics`, which is the
plugin's ADK name, not its logger. FloggerLoggingProvider names loggers with
kClass.java.name, so the text now gives the class name.

Verified: ./tools/kotlin-snippets/runner.sh build and lint both PASS on the
snippet (JDK 17), check_kotlin_snippets.sh passes, verify_snippets.py L0-L6 all
pass, and the page was rendered with the repo's own markdown extension set to
confirm the Kotlin tab joins the Python/Java tabbed set and the note renders as
an admonition rather than stray text.

* Update bigquery-agent-analytics.md

a few minor updates

* Update bigquery-agent-analytics.md

* Move the Kotlin scoping next to the content it scopes

The Kotlin support note described the page's tables as wrong from a
separate block, so a reader arriving at a table by anchor link, or
reading top to bottom, saw only the unqualified version. Each caveat now
sits with what it qualifies: the captured-events table says Kotlin logs
two event types and creates no views, the schema reference says which
columns are populated, and the lifecycle payload table records the
message content Kotlin writes.

Configuration options gains a Kotlin tab covering BigQueryLoggerConfig,
which is what the quickstart tab was asserting from the outside. With a
real section to point at, the quickstart can lead with how to use the
plugin rather than with what it cannot do.

Drop the BigQuery insert pricing detail; it belongs in the BigQuery
docs, not here.

* Update bigquery-agent-analytics.md

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-08-31 13:24:45 -07:00
Haiyuan Cao 0fba5aa6f0 Enhance BigQuery Agent Analytics documentation (#2028)
* Enhance BigQuery Agent Analytics documentation

Updated documentation to clarify Java and Python plugin differences, added details on dropped-event observability, and improved explanations of event types and attributes.

* Address review: use language support tags and a single drop-reasons table

- Replace the inline Java version callouts in prose with language-support-tag
  blocks on the relevant sections (Built-in redaction, Dropped-event
  observability; ADK 2.0 workflow events already carried one).
- Collapse the duplicated 'Drop reasons (Python)' / 'Drop reasons (Java)'
  tables into a single table with a per-language column.
- Trim the duplicated Java scope prose in the intro and the ADK 2.0 note.

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-08-05 08:50:09 -05:00
Haiyuan Cao 29c409dab3 docs: highlight BigQuery Agent Analytics Looker Block in the dashboard section (#1997)
Add a featured "Looker Block" subsection to "Build a dashboard" pointing to the
ready-to-use BigQuery Agent Analytics Looker Block on the Looker Marketplace,
and move the existing example-notebook guidance under a "Custom dashboard from a
notebook" subsection.
2026-07-23 14:15:45 -05:00
Haiyuan Cao 122d4de847 Enhance BigQuery Agent Analytics with new options (#1942)
* Enhance BigQuery Agent Analytics with new options

Added options for OpenTelemetry correlation, custom metadata capture, and payload column projection in BigQuery Agent Analytics configuration.

* Fix formatting of Interactive Demo Notebook link

fix format

* docs(bigquery-agent-analytics): replace version callouts with language support tags

Address review feedback (koverholt) on PR #1942: the page used ad-hoc,
non-conventional version callouts (per-row table tags, footnotes, version
suffixes in headers, "post-vX.Y.Z" notes) that are unmaintainable and, in
places, stale.

- Drop the "(v2.4.0+)" / "(1.27.0+)" suffixes from config-table rows and
  section headers; convey minimum versions with the repo-standard
  language-support-tag blocks on the relevant sections instead
  (Trace correlation → Python v2.4.0, Automatically Created Views →
  Python v1.27.0, ADK 2.0 workflow events → Python v2.3.0).
- Remove the "‡ Added in v2.4.0" and "† ... not in v2.2.0" view-table
  footnotes; the ADK 2.0 views/columns now point to the ADK 2.0 section.
- Remove the stale top "Version Requirement" note (v2.2.0 is no longer the
  latest release; ADK 2.0 workflow support shipped in v2.3.0) and the stale
  ADK 2.0 section note; de-version the intro prose.
- Remove the "Structured tool declarations (post-v2.4.0)" note: that shape is
  not in any tagged release (v2.4.0 emits tools as a list of names); it will
  be re-added under a language-support-tag once it ships.
- Trim the Trace-correlation section so it no longer restates the option table,
  keeping only the cross-option constraints and the combined example.
2026-07-09 15:58:38 -05:00
Haran Rajkumar d802044831 docs: update GenAI auth env var and Client parameter (#1832)
* docs: update GOOGLE_GENAI_USE_VERTEXAI to GOOGLE_GENAI_USE_ENTERPRISE in configs and models

* docs: update GOOGLE_GENAI_USE_VERTEXAI in deployment and setup guides

* docs: update GOOGLE_GENAI_USE_VERTEXAI and Client parameter in integrations and streaming docs

* docs: update GOOGLE_GENAI_USE_VERTEXAI in tutorials and examples

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-06-30 08:51:51 -07:00
Volodymyr Maliuta 7d3fe44e62 Updating Java documentation for BigQueryAgentAnalyticsPlugin (#1876)
* Fixing  java version, adding java example for formatter, small format fix

* Enhancing example for formatter.
2026-06-26 18:04:35 -05:00
Haiyuan Cao 8b9b8badce Enhance BigQuery Agent Analytics with reliability fixes (#1817)
* Enhance BigQuery Agent Analytics with reliability fixes

Added reliability and observability fixes for BigQuery Agent Analytics, including cross-region storage write routing, dropped-event tracking, and improved span management in Cloud Trace.

* Fix markdown formatting in BQAA doc

Resolve the code-fence/content-tab indentation issues flagged in review:

- Full example: restore the === "Python" content tab and indent the whole
  Python code block uniformly to 8 spaces so it is a proper sibling of the
  === "Java" tab (previously the block was half-de-indented with an orphaned
  opening fence next to a lone Java tab).
- Public methods: move the Python list inside the === "Python" tab (it had
  been pasted at column 0, outside the tab) and remove the duplicated list
  that ended up wrongly nested under the "Async context manager" bullet.

* Revise BigQuery Agent Analytics documentation

Updated version requirements and added details about ADK 2.0 multi-agent workflow features and event types. Enhanced descriptions for internal span tracking and storage behavior.
2026-06-22 12:19:20 -05:00
Haiyuan Cao 9cdc191673 Add context graph section to BigQuery Agent Analytics docs (#1827)
* Add context graph section to BigQuery Agent Analytics docs

Added a section on the context graph, detailing its purpose, structure, and operational references for materialization and deployment.

* Add files via upload

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-06-12 14:50:17 -07:00
Volodymyr Maliuta c22bb059e3 docs: Adding BigQueryAgentAnalyticsPlugin for Java (#1831)
* Update bigquery-agent-analytics.md

* Update bigquery-agent-analytics.md

Java version fix

* Update bigquery-agent-analytics.md

* Update bigquery-agent-analytics.md

* Changing documentation for BigQueryAgentAnalyticsPlugin , adding  java examples.

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-06-12 20:58:39 +00:00
Haiyuan Cao 1282d016ab Add AGENT_RESPONSE event type and view (#1761)
* Add AGENT_RESPONSE event type and view

* Update docs/integrations/bigquery-agent-analytics.md

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-05-12 15:58:18 -05:00
Haiyuan Cao 4df2ba71b8 Restructure BigQuery Agent Analytics doc for scannability (#1726)
* Restructure BigQuery Agent Analytics doc for scannability

## Summary

Full restructure of the BigQuery Agent Analytics plugin doc, addressing #1710. Two phases in one PR:

### Phase 1 — Additive tables (no section moves)
- **Captured-events summary table**: 19-row table near the top listing all event types, when they fire, key fields, and corresponding view
- **Configuration reference tables**: Converted bullet list to two 4-column tables (constructor params + BigQueryLoggerConfig)
- **Collapsible DDL**: Production DDL wrapped in `??? example` admonition
- **Conversational Analytics**: Demoted from standalone `##` to `###` under query section

### Phase 2 — Structural reorder
- **Shortened quickstart**: Minimal 3-import example; full example with GCS/OTel/BigQuery tools moved to collapsible block
- **Agent Runtime moved later**: From position 4 (interrupting core narrative) to position 9 (after query recipes)
- **GCS offloading extracted**: From nested `####` under "Event types" to its own `## Storage behavior: GCS offloading`
- **Query recipes regrouped by task**: Debug a run, Monitor cost/performance, Inspect tools/interactions, Analyze multimodal, AI root cause, Conversational Analytics
- **Operations consolidated**: Tracing, Public methods, and Multiprocessing grouped under one `## Operations` section
- **New anchors**: `{#prerequisites}`, `{#configuration-options}`

### New section order
1. Overview + Use cases + Captured events
2. Quickstart (shortened)
3. Prerequisites + IAM
4. Configuration (tables)
5. Schema + Views
6. Event types + payloads
7. Storage behavior: GCS offloading
8. Query recipes (task-grouped)
9. Deploy to Agent Runtime
10. Security + redaction
11. Operations (tracing, methods, multiprocessing)
12. SDK / dashboards
13. Feedback + resources

### Anchors
All 5 existing anchors preserved: `#deploy-agent-runtime`, `#event-types`, `#hitl-events`, `#security-credentials`, `#built-in-redaction`. Added: `#prerequisites`, `#configuration-options`.

## Test plan
- [ ] Quickstart renders with minimal example + collapsible full example
- [ ] Captured-events table renders all 19 rows
- [ ] Config tables render correctly (constructor + BigQueryLoggerConfig)
- [ ] DDL is collapsible
- [ ] GCS offloading section renders correctly as standalone `##`
- [ ] Query recipes show task-based `###` grouping with `####` subsections
- [ ] Agent Runtime section appears after query recipes
- [ ] Operations section groups tracing + public methods + multiprocessing
- [ ] All 7 anchors resolve correctly
- [ ] No broken internal cross-references

* Fix wrapping and formatting

* Fix 404 link to data apps

* Fix placeholder in code sample

* Convert HTML tables to MD tables

* Make table formatting consistent w/ docs

* Use consistent naming for ADK and A2A

* Additional formatting fixes

* Remove unused import; convert quote to admonition

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-05-06 12:36:27 -05:00
Hai-Yuan Cao e156364b54 Close code-doc parity gaps for BigQuery Agent Analytics plugin (#1689)
- Add A2A_INTERACTION event type, view (v_a2a_interaction), and docs section
- Add TRANSFER_A2A tool origin to provenance table
- Add cache_metadata, usage_cached_tokens, context_cache_hit_rate to
  v_llm_response view columns
- Document all BigQueryAgentAnalyticsPlugin constructor parameters
  including the credentials parameter for non-ADC auth
- Add multiprocessing/fork safety guidance (spawn recommendation,
  Gunicorn patterns)
- Update auto-created view count from 15 to 16

Reviewed against adk-python@7de5bc5 (2026-04-25).
2026-04-27 13:08:55 -05:00
Kristopher Overholt 1214ad915a Update product names in docs (#1673)
* Update names in docs

* Update names in docs

* Code formatting

* Format notebooks

* Update names in docs

* Update names in docs

* Update names in code samples

* Update names in docs

* Update names in docs

* Update names in docs

* Update names in docs

* Update names in docs

* Update names in docs

* Update names in docs

* Update names in docs

* Update icon

* Update names in docs

* Update names in docs
2026-04-22 05:10:38 -07:00
Haiyuan Cao 7d943aa6ab Clarify usage of BigQuery Agent Analytics SDK (#1644)
Updated the section on consuming logged data to clarify the use of the BigQuery Agent Analytics SDK and its example notebook for visualizing performance data.
2026-04-15 13:12:00 -05:00
Haiyuan Cao 9df5ed7719 Revise BigQuery Agent Analytics documentation (#1637)
Updated documentation for the BigQuery Agent Analytics plugin, removing outdated preview release information and adding links to the SDK and dashboard notebook.

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-04-15 09:37:56 -05:00
Haiyuan Cao ecedbc8523 Enhance BigQueryAgentAnalyticsPlugin documentation (#1631)
* Enhance BigQueryAgentAnalyticsPlugin documentation

Updated documentation for BigQueryAgentAnalyticsPlugin configuration options, including new parameters for retry configuration and session metadata logging.

* Add view_prefix option to BigQuery Agent documentation

Updated documentation for BigQuery Agent Analytics plugin to include details about the new `view_prefix` configuration option and its impact on view naming conventions.

* Fix formatting and redaction notes in documentation

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-04-13 09:35:26 -05:00
Joe Fernandez 60f388b81d docs: add note about Gemini latest selector (#1622)
* docs: add note about Gemini latest selector

* Update google-gemini.md

* Update bigquery-agent-analytics.md
2026-04-10 00:57:04 +00:00
Joe Fernandez f7ed80bbc6 docs: Update Gemini flash names (#1594)
* docs: home page

* updates based on feedback

* respond to review feedback

* docs: update gemini selector strings to "flash-latest"

* Update homepage.css
2026-04-09 16:14:27 -05:00
Haiyuan Cao b55aa2c28a Update BigQuery Agent Analytics documentation (#1555)
* Update BigQuery Agent Analytics documentation

Updated file paths and added environment variable descriptions for BigQuery Agent Analytics plugin. Included deployment instructions and security best practices.

* Update bigquery-agent-analytics.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-04-06 15:34:24 -07:00
Kristopher Overholt 58f3aaebca Replace documentation URLs and paths for adk.dev migration (#1536)
* Replace google.github.io/adk-docs URLs and /adk-docs/ paths with adk.dev

Migrate all hardcoded documentation references to use the new custom
domain. Update root-relative links to remove the /adk-docs/ subpath
prefix since the site will be served from the root of adk.dev.

* Additional fixes
2026-04-01 12:48:27 -05:00
Haiyuan Cao 8d8a78b23c Revise title and description for root cause analysis (#1408)
* Revise title and description for root cause analysis

Updated section title for AI-Powered Root Cause Analysis and added description.

* Update section headers for advanced analysis queries

* Update bigquery-agent-analytics.md

removed numbers from heading to avoid confusion that these examples are meant to be executed in order

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-03-16 23:47:35 +00:00
Haiyuan Cao 0e4b91a90d Update documentation for BigQuery Agent Analytics Plugin (#1399)
Added details about the new feature for automatic view creation and updated the documentation to reflect changes in version 1.27.0.

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-03-06 22:31:19 +00:00
Haiyuan Cao d9541f66ef Update BigQuery Agent Analytics plugin documentation (#1334)
* Update BigQuery Agent Analytics plugin documentation

Updated the documentation for the BigQuery Agent Analytics plugin to reflect changes in version requirements and features. Added details on new functionalities such as Auto Schema Upgrade, Tool Provenance tracking, and HITL Event Tracing.

* Update version requirement to Python 1.21.0

* Change default table name from agent_events_v2 to agent_events

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-26 08:15:33 -08:00
neal-google 498c2f6fb8 Update bigquery-agent-analytics.md (#1330)
Fixes a link to "Introduction to object tables"

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-20 14:21:49 -08:00
Haiyuan Cao 6683a5173c Refactor OpenTelemetry setup and event type details (#1323)
Updated OpenTelemetry initialization section and improved event type descriptions.

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-18 09:29:41 -08:00
Haiyuan Cao dcba3b0422 Add feedback section to BigQuery Agent Analytics (#1314)
Added a feedback section for BigQuery Agent Analytics.
2026-02-13 15:05:29 -08:00
Joe Fernandez e0e6a0d49a fix: formatting problem, clarify warning language (#1286) 2026-02-11 16:57:55 +00:00
Kristopher Overholt 94636546e5 Update integrations assets (#1255) 2026-02-06 13:04:22 -06:00
Haiyuan Cao 0ccc7f3666 Update BigQuery Agent Analytics documentation (#1253)
* Update BigQuery Agent Analytics documentation

Removed catalog metadata and added detailed schema reference for agent events.

* Add catalog metadata to BigQuery Agent Analytics

Added metadata for BigQuery Agent Analytics Plugin.
2026-02-06 10:18:52 -08:00
Joe Fernandez b117fc695b docs: centralize 3P and 1P Integrations content (#1249)
* docs: centralize 3P and 1P Integrations content

- move all content to integrations/
- frontmatter headings for all integration listings

* respond to review comments
2026-02-06 09:30:13 -08:00