Commit Graph

37 Commits

Author SHA1 Message Date
Kaz Sato 03eccf55e0 docs(live): decompose the dev guide and fix staleness vs adk-python main (#2086)
* docs(live): decompose the development guide into capability pages

Split dev-guide/part1-5 into Sessions, Events, Tools, Workflows, Audio and
video, Configuration, Voice, Supported models, and Build a custom server.
Rewrite index.md as the section Overview with a streaming-type decision table.

Implements Phase 2 of the Live Interactions<>ADK documentation revamp.

* docs(live): drop half-cascade model coverage

Half-cascade models are no longer supported for live agents. Remove the
Native Audio vs Half-Cascade architecture framing from Supported models and
the half-cascade caveats from Voice configuration. The eight prebuilt Live
API voices are kept, relabeled as native-audio voices alongside the extended
Text-to-Speech list.

* docs(live): retire the five-part dev guide and rewire navigation

Delete live/dev-guide/ and live/streaming-tools.md now that their content
lives in the capability pages. Regroup the Live nav into Get started / Build /
Ship / Reference, repoint every partN.md cross-link at its new page and
anchor, and add direct redirects for the removed paths (mkdocs-redirects does
not chain, so streaming/* keys point at final destinations).

* docs(live): point at the API reference instead of pinned source

Swap the RunConfig, Event, SequentialAgent, LiveRequestQueue and
Runner.run_live source-reference notes for Python API reference links.
Implementation pointers with line ranges are left as source links, since they
document internals with no public reference equivalent.

* docs(live): fix docs against adk-python main and drop the bidi-demo links

The bidi-demo sample was removed from adk-samples, so all the source links in
docs/live/ were dead. The sample is not shipped here either, so remove every
reference to it instead of repointing the links.

The code snippets themselves are unchanged. What goes away is only the
scaffolding that pointed at the sample:

- 32 code fences lose their linked 'Demo implementation: file.py:NN-MM' title
  and become plain language-tagged fences.
- The 'Complete Demo Implementation' note in custom-server.md and the 'Demo
  Implementation' note in events.md are dropped; both existed only to link out.
- The 'Learn More' note in tools.md and the model setup step in models.md keep
  their guidance but no longer cite the sample's files.
- Prose that named the demo ('The bidi-demo demonstrates how to...') is
  rewritten to describe the pattern directly.
- The Bidi Demo card and its screenshot are removed from the Live demos section
  of index.md; LensMosaic remains.

Staleness fixes verified against adk-python main:

- StreamingMode.BIDI is inert. Only run_async() reads RunConfig.streaming_mode;
  run_live() never does. Remove it from every run_live()-facing sample and
  rewrite the 'StreamingMode: BIDI or SSE' section around the Runner method you
  call. Keeps the old anchor via attr_list.
- configuration.md: run_live(session=...) is gone; use user_id/session_id.
- tools.md: streaming tools are registered lazily on first model call, not
  scanned up front; the input_stream queue is created only for tools annotated
  with LiveRequestQueue, and stop_streaming resets it to None. The old
  runners.py / function_tool.py line references pointed at unrelated code.
- sessions.md: document DEFAULT_MAX_RECONNECT_ATTEMPTS = 5 and the go_away
  reconnect trigger; correct 'automatic closure in SSE mode', which really only
  happens for the internal queue under support_cfc.
- events.md: audio artifacts require RunConfig.save_live_blob=True;
  get_author_for_event() also keys off llm_response.input_transcription.
- configuration.md: document history_config and the
  initial_history_in_client_content=True that ADK sets when seeding history.

Not changed: get-started/streaming-java.md still sets StreamingMode.BIDI, which
could not be verified without an adk-java checkout.

* Refresh the Live API supported-model list

Checked against the Gemini Live API and Agent Platform model docs:

- models.md: replace the model list with a platform/model/stage table covering
  gemini-3.1-flash-live-preview (Preview, Gemini Live API only),
  gemini-2.5-flash-native-audio-preview-12-2025 (Preview), and
  gemini-live-2.5-flash-native-audio (now GA, not "public preview").
- Document what Gemini 3.1 Live does not support: proactivity, affective
  dialog, async function calling, thinking_budget (it uses thinking_level),
  plus multi-part server events and the turn-coverage default change.
- Note that no Gemini 3.x Live model exists on Agent Platform, and that Live
  API models are unavailable in the `global` location.
- voice.md: replace the Platform Compatibility text, which wrongly said
  proactivity and affective dialog are unavailable on Agent Platform, with a
  per-model support table.
- configuration.md: CFC's model check is a literal `gemini-2` prefix match, so
  it rejects Gemini 3.x; refresh the runners.py line anchor.
- bidi-demo: same model table in the README, the 3.1 option and the regional
  location requirement in .env.example, and an expanded model comment in
  agent.py. The default stays on 2.5 native audio because the demo exposes
  proactivity and affective dialog toggles. Re-anchored the agent.py line
  links in models.md, tools.md, and sessions.md.

* docs(live): align docs with current Live API model capabilities

Verified docs/live/ and docs/runtime/runconfig.md against the Gemini Live
API capabilities guide, the Agent Platform Live API docs, and ADK 2.6.3.

Model consistency:

- response_modalities=["TEXT"] was presented as a valid live configuration
  in configuration.md, events.md and sessions.md. Every Live API model ADK
  supports is a native audio model, and those accept AUDIO only. Reframed
  around AUDIO plus output audio transcription, and kept TEXT where it is
  actually correct: the run_async() / SSE path.
- docs/runtime/runconfig.md configured response_modalities=["AUDIO","TEXT"]
  in all three language samples. A session accepts exactly one modality.
- events.md snippets read event.content.parts[0], which drops content on
  gemini-3.1-flash-live-preview because it sends multiple parts per server
  event -- the failure models.md already warns about. All four snippets now
  iterate over parts.
- tools.md gave the streaming-tools root agent model="gemini-flash-latest",
  which has no Live API support, so the example could not run under
  run_live() on either platform. That alias is still used for the one-shot
  generate_content call inside the tool, where it is correct.
- configuration.md "Standard Gemini Models (1.5 Series) Accessed via SSE"
  described a retired model family and labelled gemini-pro-latest /
  gemini-flash-latest as 1.5 with 2M context.
- sessions.md: document that send_client_content is seeding-only on Gemini
  3.x Live, and that ADK reroutes single-part text to send_realtime_input.
- models.md: gemini-live-2.5-flash-native-audio is the only GA Live API
  model on Agent Platform, not the only one.

Coverage and links:

- configuration.md: document explicit_vad_signal, translation_config,
  avatar_config and model_input_context.
- voice.md: note that ADK picks the live API version (v1alpha / v1beta1),
  so proactivity and affective dialog need no http_options.
- Replace redirecting upstream URLs with their current targets:
  live-guide -> live-api/capabilities, live-session ->
  live-api/session-management, live -> live-api, and
  cloud.google.com/vertex-ai -> the Agent Platform equivalents.

Verified correct, left alone: session and context limits, audio and video
specs, the proactivity / affective dialog model matrix, thinking_level vs
thinking_budget, the support_cfc gemini-2 prefix check, and ADK's AUDIO
default in run_live().

* docs(live): trim the response-modality and SSE material

Every Live API model ADK supports is a native audio model, so a live
session's response modality is always AUDIO and there is nothing to
choose. Shrink the section to the one thing that still matters --
reading text off event.output_transcription.

StreamingMode is only read by run_async(); the SSE tutorial that grew
around it here (protocol diagrams, progressive-streaming walkthrough,
mode-selection table, 1.5-series model list) duplicates
runtime/runconfig.md and describes models that no longer exist. Keep
the inert-BIDI warning and the run_live()/run_async() split, drop the
rest.

Document explicit_vad_signal, translation_config, avatar_config and
model_input_context, which had no coverage at all.

* docs(live): cut duplicated and non-ADK material

Six sections carried weight that did not belong to them:

- sessions.md 'Best Practices for Live API Connection and Session
  Management' restated the Session Resumption and Context Window
  Compression sections verbatim, down to the RunConfig snippets.
  Deleted.
- sessions.md 'Concurrency and Thread Safety' + 'Message Ordering
  Guarantees' explained asyncio.Queue at length and reproduced the
  upstream task already in custom-server.md. Condensed to the three
  properties that actually affect calling code, with a pointer to
  the private _queue attribute dropped.
- sessions.md 'Architectural Patterns for Managing Quotas' was an
  ASCII decision tree and a comparison table for two patterns that
  reduce to one sentence each.
- index.md 'Real-world applications' spent five industry vignettes
  making one point.
- events.md 'Deserializing on the Client' pasted 80 lines of the
  bidi-demo's UI code, calling helpers that no longer exist anywhere
  in these docs. Reduced to the event-shape handling it was meant to
  show.
- audio-video.md 'Handling Image Input at the Client' was 130 lines
  of getUserMedia/canvas/FileReader boilerplate plus a seven-point
  recap of it.

Also fix two dead absolute links: /agents/multi-agents/#workflow-agents-as-orchestrators
(the page now redirects to workflows/index.md and the anchor is gone)
and /live/streaming-tools/ (no such page; the content is in tools.md).

* docs(live): restructure the live docs around ADK ownership

The live section had accumulated content it did not own: backend limits
restated on capability pages, Web Audio API implementation presented as
ADK guidance, and shared concepts re-explained rather than linked.

Applies one rule throughout: if a fact would still be true with the ADK
source deleted, it belongs on models.md or behind an upstream link, not
on a capability page.

- audio-video.md is now the format contract only (505 -> 121). The
  browser mic-capture, ring-buffer playback, and camera-frame code was
  Web Audio API with no ADK in it, had no counterpart in adk-python, and
  no test anywhere. Deleted rather than relocated. The twelve numbered
  'Key Implementation Details' lists restated the code comments directly
  above them; deleted. The streaming-tool lifecycle section duplicated
  tools.md; replaced with a link.
- custom-server.md gains 'Connect a client': what adk web handles
  (16 kHz capture, 24 kHz playback, 1 fps JPEG, transcripts, barge-in),
  where it stops, and the /run_live wire protocol, which was previously
  undocumented. Keeps the one JS snippet that shows ADK's event shape.
  Drops 'Client-side patterns'.
- sessions.md hands its platform-limits table and quota numbers to
  models.md, keeping the session-pool design guidance. The same figures
  had been stated in three places across two pages.
- models.md gains 'Platform limits and quotas' as the single source, and
  loses the 'Key characteristics' list that restated configuration.md.
- configuration.md drops the 'Platform Support' column, which read
  'Both' on 13 of 15 rows and labelled the two exceptions as platform
  constraints when they are model constraints.
- tools.md compresses 'Tool execution context' to the one fact that is
  live-specific: an InvocationContext spans the whole run_live() loop,
  not a single turn.
- workflows.md points at graphs/index.md, the ADK 2.0 graph workflow
  page, rather than the v0.1.0 multi-agent umbrella.
- Six internal links used absolute paths, which mkdocs does not
  validate, so --strict had been silently ignoring them. Now relative.
- Fixes class.="grid cards" in get-started/index.md, which was breaking
  the card grid.

* docs(live): standardize page leads and cut duplicated RunConfig prose

Every live page opened by narrating its own table of contents ("This page
covers X, Y, and Z"), which duplicates the rendered TOC, ages badly when
a heading changes, and spends a paragraph before the reader gets a fact.
evaluation.md already did the better thing: state the shared baseline,
link the canonical page, then cover only the delta. That is now the
convention across the section.

- sessions.md, events.md, configuration.md, audio-video.md,
  workflows.md, tools.md, models.md and get-started/index.md now name
  their non-live counterpart in the lead instead of listing their own
  headings. Three pages had no outbound link to the shared concept at
  all: tools.md to Custom Tools, models.md to Models for agents, and
  workflows.md pointed at the v0.1.0 umbrella rather than graph
  workflows.
- configuration.md drops the custom_metadata section (85 lines) for a
  pointer plus the one live-specific consequence: a run_live() call is a
  single invocation, so metadata is stamped on the whole session rather
  than one turn. runtime/runconfig.md already owns the field.
- configuration.md trims max_llm_calls and save_live_blob to the facts
  that are live-specific — max_llm_calls does not apply to run_live() at
  all, and save_live_blob writes ~1.92 MB per minute per session to two
  services — and drops the generic use-case and best-practice lists.
- custom-server.md replaces 'Key concepts', which re-pasted all three
  code blocks from the complete example directly above it, with prose
  explaining why the two tasks must run concurrently.

Live section: 2820 -> 2211 lines.

* docs(live): reframe pages around capabilities, fix eval config key

* Apply batched suggestions from code review

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>

* Apply suggestion from @joefernandez

* Apply batched suggestions from code review

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>

---------

Co-authored-by: Stephen Allen <stephenaallen@google.com>
Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-09-01 17:15:50 -07:00
George Weale 1bd29540df docs(evaluate): fix conformance CLI, defaults, optimizer imports (#2018)
* docs(evaluate): fix conformance CLI, defaults, optimizer imports

* docs(evaluate): fix App construction, agent path type, user-sim coverage

* docs: drop parenthetical asides and future tense from the evaluate corrections

* Update environment_simulation.md

* Update user-sim.md

* Update user-sim.md

* Update index.md

* Update index.md

removing repetitive (and soon out of date) default model declarations.

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-08-14 14:04:31 -07:00
George Weale 839e898fcf docs(tutorials): fix ToolContext, output_key and persistence claims (#2032)
* docs(tutorials): fix ToolContext, output_key and persistence claims

* Update agent-team.md

* docs: address review — revert get-started changes, move streaming note

Reverts docs/get-started/python.md entirely and drops the edit to the
retired quickstart-streaming.md page. The corrected streaming caveat now
lands on docs/live/get-started/streaming-python.md, scoped to the
run_async path and naming SequentialAgent as the only workflow agent
with live support.

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-08-07 13:15:39 -07:00
Kristopher Overholt 9114ba877c Fix broken adk-samples links from deleted samples (#2004) 2026-07-28 12:32:40 -05:00
Zyan ae5a142391 Document GOOGLE_API_KEY auth for Vertex AI evaluation criteria (issue #1227 - 8) (#1967)
* Update index.md

-Added the authentication note
-Did clean up on headers and the notes and warning format

* Document GOOGLE_API_KEY auth for Vertex AI eval criteria; clean up evaluate/index.md

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-07-16 06:54:00 -05:00
Akira Tameoka 709f9147ca docs(evaluate): document rubric_based_multi_turn_trajectory_quality_v1 and clarify Rubric.type / criterion.rubrics (#1853)
* docs(evaluate): document rubric_based_multi_turn_trajectory_quality_v1 and clarify Rubric.type / criterion.rubrics

Closes three gaps in docs/evaluate/criteria.md:

1. Adds a section for `rubric_based_multi_turn_trajectory_quality_v1`. The
   metric is registered in metric_evaluator_registry.py and implemented in
   rubric_based_multi_turn_trajectory_evaluator.py upstream, but the
   explanatory section that its two sibling rubric-based metrics have was
   missing. Also adds the corresponding row to the criteria table.
2. Adds a "Notes On Rubrics" subsection under each of the three
   rubric-based metric sections, stating the required Rubric.type value
   (FINAL_RESPONSE_QUALITY / TOOL_USE_QUALITY / TRAJECTORY_QUALITY) and the
   criterion-vs-EvalCase rubric relationship (criterion.rubrics required
   and non-empty; EvalCase.rubrics is additive, filtered by type).
3. Adds the explicit `type` field to existing JSON examples in the two
   existing rubric-based sections so users have a complete template.

Refs #1852.

* docs(criteria): correct Rubric.type filter scope in the notes

Only EvalCase.rubrics is filtered by type in create_effective_rubrics_list;
criterion-level rubrics on EvalConfig are added unconditionally. Update the
Notes On Rubrics bullet in each of the three rubric-based metric sections
to reflect this, using koverholt's review suggestion.

* docs(criteria): drop inert type field from criterion-level rubric examples

type is only consulted for entries in EvalCase.rubrics, per
create_effective_rubrics_list. Keeping it on criterion-level rubrics
implied they were type-filtered, which they are not. Removed from all
six criterion-level rubric entries across the three rubric-based metric
sections.

* docs(criteria): add EvalCase.rubrics snippets showing where type actually applies

The type field only affects filtering on EvalCase.rubrics per
create_effective_rubrics_list. Show that behavior concretely in each of
the three rubric-based metric sections by adding a small EvalCase.rubrics
snippet with the type field set to the criterion's expected value, plus a
one-line reminder that the effective rubric set passed to the judge is the
union of criterion-level rubrics and any type-matching entries from
EvalCase.rubrics.

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-07-16 05:05:27 -05:00
Joe Fernandez fea383b916 Consolidate Google Cloud and Agent Platform connection info (#1819)
* wip: temporary staging

* Consolidate Google Cloud and Agent Platform connection info

* remove gcp-mentions file

* adding links to central GCP connection page

* minor updates

* responded to review comments
2026-06-26 15:07:00 -07:00
Zyan 7e15976c41 feat: Add Conformance evaluation docs (#1813)
* Update index.md

1. Updated the evaluation page, added the 4th evaluation "adk conformance", 2. removed numbering in headers as suggested, 3. improved the "notes" and "warnings" that had an incorrect formatting.

* Update index.md

* Update index.md

worked on all your comments

* Update index.md
2026-06-17 16:58:26 -06:00
Zyan 326703598e UpdatePythonSupportingVersionUserPersona.md (#1842) 2026-06-15 17:39:36 -06:00
Kristopher Overholt 1c93532ca6 Fix broken external links to adk-python contributing/samples and other internal links (#1773)
* Add link to ignore

* Update links to code samples

* Fix links related to graphs and workflows

* Fix more sample links
2026-05-19 13:53:51 -07:00
Kristopher Overholt 50f7df7f46 Add Kotlin language support to ADK docs (#1768)
* Add Kotlin to hero / front page

* Add quickstart page for Kotlin

* Complete Kotlin quickstart guide and fix hero code sample (#2)

* Replace GitHub repo links with language icons in header (#3)

* Fix header icon FOUC and homepage font weight regression (#4)

* Testing staging pipeline

* Revert test edit (for staging pipeline)

* Update language icon tooltips to indicate GitHub destination (#5)

* Add link to ADK Kotlin release notes (#7)

* Initial commit of ADK Kotlin API reference docs (#6)

* Add script to generate ADK Kotlin API reference docs (#8)

* Update links and link checker ignore list (temporarily) (#9)

* Add ADK Kotlin for Android getting started guide to Advanced setup page (#10)

* Add advanced setup page with steps to "Use ADK Kotlin in Android projects"

* Update temp link checker rules

* Add placeholder folder for adk-samples (#13)

* adding linter/compilation checks for kotlin snippets (#12)

* adding linter/compilation checks for kotlin snippets

* Add Kotlin validation scripts

* Initial commit of Kotlin sample agents for adk-samples (#15)

* Adding kotlin snippet for llm agents (#16)

* Adding kotlin snippets to  Events (#17)

* Pull changes to docs/events/index.md from glaforge-kotlin-snippets

* fixing kotlin event timestamp and longRunningToolIds

* Fix language tags (#19)

* Fix language tags

* Update

* Fix wrapping

* Fix wrapping (again)

* Fix wrapping/format

* Fix language tag on integration page

* Enable check_paths in PyMdown Snippets Extension to make the build fail if a snippet can't be found (#20)

* Update mkdocs config (#21)

* Fix broken links, update URLs to adk.dev, and improve (temp) lychee config (#22)

* Add Kotlin/maven badge to README (#23)

* Adding Kotlin snippets for artifacts  (#18)

* Pull Kotlin snippets for artifacts from glaforge-kotlin-snippets

* Add comprehensive Kotlin snippets for artifacts

* Refactor artifacts documentation to use external Kotlin snippets

* Update Kotlin model to gemini-flash-latest

* Fix GCS initialization in Kotlin artifact snippet

* afixi failing test with capital-agent added to files_to_check

* Fix snippet label syntax for MkDocs build

* Configure proper Gradle project for Kotlin snippets and fix dependencies

* Add KSP support and generated sources to Kotlin snippets build

* fixing capital_agent turnComplete

* Fix syntax error in build.gradle.kts by removing invalid placeholders (#25)

* Adding Kotlin snippets to google-gemini.md (#27)

Pulling kotlin changes to google-gemini.md from glaforge-kotlin-snippets

* Add a warning about not adding an api key to production code. (#28)

* Add a warning about not adding an api key to production code.

* Update note

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>

* Add ADK Demo App sample showcasing Gemini-powered agents (#29)

This sample demonstrates how to use the Google ADK (Agent Development Kit) in an Android application to create a chat interface powered by a Gemini-based "Fun Facts" agent. The implementation features:
*   Integration with the Kotlin ADK core and processor libraries.
*   A `FunFactsAgent` defined using `LlmAgent` and the Gemini model.
*   A `ChatViewModel` utilizing `InMemoryRunner` for asynchronous message streaming.
*   A modern UI built with Jetpack Compose and Material 3.
*   Build configuration logic for secure API key management via environment variables or `local.properties`.

* Update Kotlin docs and samples to align with adk-kotlin API changes (#30)

Rename GeminiModel to Gemini, @AdkTool/@AdkParam to @Tool/@Param,
adkTools() to generatedTools(), replace DebugRunner with InMemoryRunner,
fix AgentLoader import path, use SingleAgentLoader, bump Kotlin to
2.3.21 and KSP to 2.3.7, and update Android minSdk from 24 to 26.

* adding kotlin info to READMEs (#14)

* Reorganize Android sample agent and add READMEs (#31)

* Move Android sample agent

* Update repo README, add Android README, update sample agent README

* Minor edit to language support tags (#32)

* Remove blog post link (#33)

Will re-add after it's published

* Remove examples link (#34)

* Adding Kotlin snippets for Sessions docs (#26)

* initial kotlins snippets additions to sessions docs

* Updating memory docs with kotlin snippets

* Adding kotlin snippets to session state docs.

* update model to gemini-flash-latest

* sessions examples clean-up

* fixing sessions snippet markers

* adding kotlin session snippets to files to test

* adding callback to memory_example

* Fixing capital agent snippet  (#35)

Fixing file name
Updating adkTool > Tool
Updating GeminiModel > Gemini

* Adding kotlin snippets for tools docs (#36)

* adding function tool kotlin snippets

* adding function_tools snippets to files to test

* Adding kotlin snippets to observability docs (#37)

* initial kotlin observability updates

* adding observability snippets to file check (#38)

* Adding Kotlin snippets to Callbacks docs (#39)

*  kotlin callbacks snippets

* adding callbacks snippets to file check

* Align Kotlin and KSP versions with published 0.1.0 artifacts (#40)

* switch CLI entry points from InMemoryRunner to ReplRunner (#41)

* Switch CLI entry points from InMemoryRunner to ReplRunner

* Fix wording

* Update API reference docs for Kotlin, 2026-05-18 (#42)

* Remove ADK on Android note until published (#43)

* Update Kotlin code samples (#44)

* Rename GeminiModel to Gemini in Kotlin snippets and docs

* Remove broken SessionKey call and use sessionId directly in AgentTool snippet

* Rewrite Go hero snippet to use llmagent API

* Use isFinalResponse with safe access in CapitalAgent snippet

* Use Role.USER constant instead of raw string in SetupExample

* Use full semver v0.1.0 in Kotlin language support tags

* Remove Android setup steps, moving to new property (#45)

* Tutorial Kotlin agent (#46)

* Adding multi-tool-agent snippet and updating tutorial
* Fixing Go language order on tutorial page
* adding multi tool agent example to files to test

* Inline Kotlin get-started code sample

* Kotlin Multi agents snippets (#47)

* Multi-agent kotlin snippets

* Fixing docs tags in multiagent example

* Fix Kotlin language support tags, code samples, and google-gemini.md cleanup (#48)

* Add Kotlin v0.1.0 to language support tags across docs

* Fix MultiToolAgent.kt model string and argument style

* Update MultiAgentExample.kt to use gemini-flash-latest model string

* Fix google-gemini.md: add Kotlin sample, remove unsupported Java tabs

* Remove explicit apiKey from CallbackBasic.kt for consistency

* Standardize Gemini() constructor to use named args in all snippets

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Remove adk-samples directory (moved to google/adk-samples#1969) (#49)

* Update API reference docs for ADK Kotlin 0.1.0 (#50)

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Update API reference docs for ADK Kotlin 0.1.0

* Remove kotlin lycheeignore config (#51)

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Remove Kotlin .lycheeignore config links

---------

Co-authored-by: Toni Klopfenstein <2359976+ToniCorinne@users.noreply.github.com>
Co-authored-by: Jolanda Verhoef <JolandaVerhoef@users.noreply.github.com>
2026-05-19 11:43:42 -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
Pierre Thodoroff f04d10d900 Add docs for evaluation set generation using Eval SDK (#1584)
* Add docs for evaluation set generation using Eval SDK

* Update user-sim.md

* Update docs/evaluate/user-sim.md

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-04-13 10:44:24 -05: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
ykchen-g 17505f214a Env simulation doc (#1573)
* add env simulation documation

* add env simulation documation

* Address PR feedback
2026-04-07 16:40:48 -07:00
Ankur c79bf56b65 docs: Adding documentation for the new multi-turn eval metrics (#1554)
* docs: Adding documentation for the new multi-turn eval metrics

* Update criteria.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-04-06 18:15:05 +00:00
jcpagadora737 34382cf3d8 docs: Add evaluation custom metrics documentation (#1490) 2026-03-26 22:54:37 +00:00
Sebastian Caldas b37eda05a5 Fix markdown table for User Personas (#1380)
* docs: Add documentation for per_turn_user_simulator_quality_v1 evaluation criterion

* fixes typo

* Include documentation for User Personas

* Fix User Personas table formatting

---------

Co-authored-by: Sebastian Caldas <scaldas@google.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-27 18:18:56 +00:00
Sebastian Caldas 50b6bb1fec Include documentation for User Personas (#1336)
* docs: Add documentation for per_turn_user_simulator_quality_v1 evaluation criterion

* fixes typo

* Include documentation for User Personas

---------

Co-authored-by: Sebastian Caldas <scaldas@google.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-26 08:17:23 -08:00
Keyur 9c854618d3 Add missing documentation for custom user simulator instructions (#1270)
* Mark rubric-based criteria as user sim compatible

* Add missing documentation for custom user sim instructions

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-09 10:49:22 -08:00
nikkie 76154858d6 Fix: Remove invalid comma from EvalSet JSON example (#1171)
* fix: Correct JSON syntax in evaluate documentation

Fix syntax error in JSON structure by deleting comma.

* Fix evalset JSON structure in evaluate documentation

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-01-26 11:47:21 -06:00
nikkie 401715ddeb docs: Fix missing whitespace (#1170) 2026-01-26 10:44:23 -06:00
Keyur 0fc784c580 Mark rubric-based criteria as user sim compatible (#1109)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-01-13 15:29:56 -08:00
Sebastian Caldas 744411be6b docs: Add documentation for per_turn_user_simulator_quality_v1 evalua… (#1108)
* docs: Add documentation for per_turn_user_simulator_quality_v1 evaluation criterion

* fixes typo

---------

Co-authored-by: Sebastian Caldas <scaldas@google.com>
2026-01-06 14:29:35 -08:00
Ankur 7097903a3a Update documentation to reflect recent changes made to Tool Trajectory metric (#946)
* Update documentation to reflect recent changes made to Tool Trajecotry metrics

* Updated some typos

* Update criteria.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-13 10:03:11 -08:00
Keyur 83afbba342 Add link to User Simulation sample notebook in ADK samples (#897)
* Add link to Colab user sim tutorial in ADK samples

* Add a tip admonition that links to sample notebook

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-11-06 16:44:28 -06:00
Keyur 35f00f9d40 Add documentation for User Simulation (#863)
* Add documentation for User Simulation

* Update user-sim.md with version number

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-05 13:08:43 -08:00
Joe Fernandez f12068a4bb docs: add language support tags to pages (#850)
* docs: add language support tags to pages

- replace img.shield tags
- add language support tags where missing

* update Agents page with general tags

* update language and version tagging

- response to review comments
- rename css styles to avoid style name conflicts

* add tags to api-server page
2025-11-03 16:07:35 -08:00
Ankur b945d318bb docs: Add detail documentation for all eval metrics supported by ADK (#776)
* feat: Add detail documentation for all eval metrics supported by ADK

* Add path to criteria.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-14 09:48:35 -07:00
Joe Fernandez 7113661b81 fix: Add warning about use of paid service for Evalsets (#591) 2025-08-12 10:56:31 -07:00
Kaz Sato d6c9f34257 feat: modifying the Evaluate docs with the new features. (#412)
* feat: modifying the Evaluate docs with the new features.

New features added:
1. Evaluation Configuration: users can now configure custom threshold for the metrics used for each eval run, allowing more control for the evaluation criteria

2. Evaluation Case view & edit: Each eval case added can now be viewed and edited. Right now we only support edit of text responses from Agent. This allows users to customize the response to fit their needs

3. New tracing: We have a new tab which contains all traces grouped by user messages. Each trace row is clickable and hoverable. Upon hover the corresponding message will be highlighted in the chat window. Upon click, the bottom panel will show up that contains Event detail, Request, Response, and Graph that corresponds to that trace row

* fix: modified the Step 2, and added the Trace View section

fix: modified the Step 2, and added the Trace View section

* fix: added gif animations

fix: added gif animations

* fix: inserted the gif animations

fix: inserted the gif animations

* fix: added an explanation for the blue rows

fix: added an explanation for the blue rows
2025-06-18 05:31:19 +09:00
ParkJaesung 3dd3436d86 fix(docs): Fix broken pytest example code (#398) 2025-06-13 14:30:53 -05:00
Megan O'Keefe 0887973bed feat: Initializes Java documentation (#277) 2025-05-20 12:10:27 -04:00
Ankur 2fd184176e docs: Update eval documentation to reflect eval recent schema updates. (#269)
* docs: Updates eval documentation to reflect recent eval schema updates.

* Addressed review comments.

* Added clarification on identifying when to use the migration.
2025-05-18 19:43:03 +01:00
Keith Rozario 56a6b79443 fix: eval_name argument name (#224)
* fixed eval variable name

* fix: eval_name argument name

---------

Co-authored-by: Keith Rozario <krozario@google.com>
Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-05-06 09:22:25 -05:00
nikkie 664ded3a3d docs: Fix init.py -> __init__.py (#114)
references

* https://google.github.io/adk-docs/get-started/quickstart/#__init__py
* https://github.com/google/adk-python/blob/v0.1.0/src/google/adk/cli/cli_tools_click.py#L111

Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-04-18 05:21:06 -05:00
Kristopher Overholt d3cec829c9 Initial commit of Agent Development Kit 2025-04-09 08:49:23 -07:00