Commit Graph

1158 Commits

Author SHA1 Message Date
Kristopher Overholt 624c676ee3 Update Contributing Guide with TypeScript and Go links (#1068)
* Add adk-js links to contributing page

* Update languages

* Add links

* Add ADK samples

* Update
2025-12-15 16:41:22 -06:00
Joe Fernandez 4d4651cd7f docs: ADK TS fixes (#1067)
- remove duplicate Go tab
- TS tag for Types of Callbacks
- fix TS tab rendering and ordering problem
2025-12-15 14:24:40 -08:00
Kristopher Overholt f4baec3a8d Update README with TypeScript links (#1066)
* Update README with adk-js link and badges

* Update README
2025-12-15 16:12:41 -06:00
Kristopher Overholt 8766f5f61e Update README with new llms.txt approach, coding with AI guide, and placeholder llms.txt files (#1064)
* Update README and pointers for previous llms.txt and llms-full.txt files

* Update

* Update README

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-12-15 16:03:56 -06:00
Shahin Saadati 1abc0aaacb Fixed the blank typescript code snippet. (#1065) 2025-12-15 13:30:34 -08:00
Shahin Saadati fd7c7a3dca feat: Merge all the typescript code samples and snippets into the main repo. (#1063)
* Deleted redundant files.

* Deleted redundant files.

* Deleted redundant files.

* Deleted redundant files.

* Deleted redundant files.

* Deleted redundant files.

* Delete .gitignore

Deleted redundant files.

* Delete .gitignore

Deleted redundant files.

* Delete .gitignore

* Delete .gitignore

* Delete .gitignore

* Revert changes to .gitignore

* Revert changes to .gitignore

* Revert changes to .gitignore

* Revert changes to .gitignore

* Revert changes to .gitignore

* Revert changes to .gitignore

* Add MCP Tools TS example

* Removed unnecessary changes

* Removed extra slashes

* Added the custom agent sample.

* Corrected an error in the package.json file.

* Updated custom-agent.md

* Made small fixes.

* Add Session TS examples

* Added the typescript code snippets for multi agent.

* added the code sample for loop agent

* Added the code sample for loop agent

* Added the code sample for parallel agent

* Fixed a few issues and bugs

* Added the code sample for sequential agent

* Renamed run back to runAsync

* Updated the capital agent code sample.

* Corrected the snippet

* Renamed run() to runAsync()

* Add Runtime TS examples

* Fixed the snippets after library updates.

* Fixed the sample code after library changes.

* Added final touchups and fixes.

* Updated the code based on recent library changes.

* Updated package.json

* Updated package.json

* Updated package.json

* Updated the code with runAsync and package.json

* Updated the typescript sample.

* Updated after_tool_callback.ts with runAsync

* Updated after_model_callback.ts

* Updated before_model_callback.ts

* Updated before_tool_callback.ts

* Created before_agent_callback.ts

* Update before_agent_callback.ts

Changed the condition

* Update before_model_callback.ts

Changed the condition

* Update after_model_callback.ts

Changed the condition

* Update after_tool_callback.ts

Changed the condition

* Update after_agent_callback.ts

Changed the condition

* Update callback_basic.ts

Changed the condition

* Update storyflow_agent.ts

Changed the condition

* Update sequential_agent_code_development_agent.ts

Changed the condition

* Updated before_agent_callback.ts

* Removed unnecessary comment.

* Updated comment

* Renamed run to runAsync

* Added artifact code snippets.

* Fixed .link-checker-config.json

* Added tsconfig.json

* Update .gitignore with node modules files

* Added 7 typescript code snippets

* Cleaned up and corrected the snippets for plugins

* Update index.md

Undid the changes in artifacts/index.md

* Escaped properly.

* Add Long Running Function Tool TS examples

* Resolved code review feedback

* Fixed the code sample per git comments.

* Fixed the code per git comments.

* Fixed the md file per git comments.

* Fixed the issues per git comments.

* Fixed issues per github comments.

* Fixed the issues per PR comments.

* Fixed issues per PR comments.

* Added a code sample for HITL

* Fixed the indentations in the typescript code

* Used createPartFromBase64 when appropriate.

* Switched to use createUserContent.

* docs: Add JavaScript Quickstart, short unified format

* Added a simulated user delay to the code sample.

* Made some cosmetic improvements

* Added the code snippet with HITL with policy

* Made cosmetic modifications to multi-agents.md

* Added more tutorial for the HITL with policy

* Modularized the main function and added helper functions.

* Resolved code review feedback

* Resolved code review feedback

* Resolved code review feedback

* Fixed minor things in the typescript code per PR comments.

* Fixed the import for Event and used createEventActions.

* Simplified functionResponse code.

* Corrected the Event import and used createEventActions.

* Updated ADK versions in package.json.

* Final review of all changes & Add Safety TS example

* Make tsconfig.json files consistent

* Generated the API Reference for typescript

* Resolved code review feedback

* feat: Add Typescript API reference to docs

This commit adds the generated TypeDoc documentation for the Typescript ADK to the documentation site.

It also updates the main API reference page to include a link to the new Typescript API reference.

* docs: update TypeScript quickstart

* docs: Add version tags for Build Agents topics

- add version tags
- move TS content to second position (after Python)

* docs: Add MCP Toolbox for databases TS SDK Documentation

* Update mcp-toolbox-for-databases.md

* use typescript code block

* minor changes

* Update mcp-toolbox-for-databases.md

* Auto generated the typescript API reference.

* Added the TS code snippets for context.

* Fixed TS code snippets for context.

* Modified the sample based on the comment.

* docs: adding TypeScript language tags (2 of 3)

- Update all Run Agents section topics
- change all TS tags to v0.2.0 per eng agreement

* docs: Add TypeScript language support tags, Components (3 of 3)

- add TS language support tags
- re-order TS examples to be second
- minor fixes: remove trailing spaces

* Added callback samples for typescript to the markdown files.

* Updated adk version in quickstart

* Updated google/adk version for typescript.

---------

Co-authored-by: manchan <manchan@google.com>
Co-authored-by: Mandy Chan <75594070+slothwriter@users.noreply.github.com>
Co-authored-by: Joe Fernandez <joefernandez@google.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
Co-authored-by: Twisha Bansal <58483338+twishabansal@users.noreply.github.com>
2025-12-15 12:53:24 -08:00
Haiyuan Cao dd8d30d7a6 Move BigQuery Agent Analytics docs to observability directory and update the plugin doc to v2 (#1060)
* Move BigQuery Agent Analytics docs to plugins directory

* Enhance BigQuery Agent Analytics documentation

Updated the documentation for the BigQuery Agent Analytics plugin to clarify event logging configurations and added a code sample for setting up the plugin.

* Move BigQuery analytics to observability and update index link

* Remove default comment from max_content_length

* Update mkdocs.yml for BigQuery Analytics move

* Update BigQuery Agent Analytics configuration defaults

* Move BQ observabilty page in nav

* Fix markdown list formatting in IAM permissions

* Clarify ADK 1.21.0 version requirement

* Update BigQuery Agent Analytics documentation

* Strongly recommend latest ADK version

* Refine BigQuery Agent Analytics documentation

* Update bigquery-agent-analytics.md

* Remove deprecated documentation

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-12-12 15:55:04 -08:00
Kristopher Overholt cc23e2b23e Add PayPal to third-party tools (#1026)
* Update page content

* Updates

* Formatting

* Update tool cards

* Edit mkdocs.yml
2025-12-12 16:45:33 -06:00
Kristopher Overholt 357c6246f2 Add n8n to third-party tools (#1030)
* Add n8n page to third-party tools

* Updates
2025-12-12 16:44:26 -06:00
Joe Fernandez bcbaa09eaf docs: add Gemini model Interaction API coverage (#1059)
* docs: add Gemini model Interaction API coverage

* respond to review comments
2025-12-12 09:00:00 -08:00
Kristopher Overholt 486ceb4395 Update CLI docs for ADK 1.20.0 (#1037)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-12-11 19:32:35 -08:00
Anush 82e9fa553f docs: Added Qdrant to third-party tools (#1039)
* docs: Added Qdrant tool

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* Review update qdrant.md

---------

Signed-off-by: Anush008 <anushshetty90@gmail.com>
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-12-10 10:30:48 -06:00
Kaz Sato b441103579 fix: updating Bidi-streaming index page (#1038)
- Adding two YouTube videos
2025-12-10 09:57:56 -06:00
Joe Fernandez ede481a0e0 fix: Correct code tabe rendering on llm-agents.md page (#1035) 2025-12-05 16:37:50 -06:00
Kristopher Overholt 2bad58c487 Add autogeneration of llms.txt during mkdocs build; add docs page on using llms.txt (#1023)
* Add mkdocs-llmstxt and related config

* Remove existing llms.txt and llms-full.txt from repo

* Add docs page for llms.txt

* Minor edit

* Minor edit

* Add *.md to glob syntax in mkdocs-llmstxt config

* Add explicit URLs in API reference section to avoid build warnings

* Fix all build warnings related to bad cross-links and incorrect anchor links

* Suppress INFO logs about absolute links - the CI link checker will catch any issues

* Fix remaining build warnings

* Add Gemini CLI instructions

* Fix link to bidi tutorial
2025-12-05 11:08:14 -06:00
Joe Fernandez ca0a8aae51 docs: update ADK Python API Reference to 1.20.0 (#1031) 2025-12-05 08:07:06 -08:00
Jeremy Silva 35060b663c Update freeplay.md (#1028)
* Update freeplay.md

Replace the loom link with an embedded youtube video

* Update video w/ YouTube embed

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-12-04 20:13:58 -06:00
Joe Fernandez eb51a8c17f docs: Rewind feature for sessions (#1020)
* docs: Rewind feature for sessions

* update based on comments
2025-12-04 16:30:45 -08:00
ali 933f14b0d6 Fix agent_name assignment in log_tool_usage function (#1027) 2025-12-04 14:16:21 -06:00
Kaz Sato 25987cbd1f fix: update links to the sample code and other minor fixes (#1021)
* fix: update links to the sample code and other minor fixes

fix: update links to the sample code and other minor fixes

* fix: deleting the old custom streaming guides.

fix: deleting the old custom streaming guides.

* docs(streaming): sync bidi-streaming guide updates

  - Remove version-specific references (v1.18.0, v1.19.0) for evergreen docs
  - Update source permalinks from blob/main to v1.20.0 commit hashes
  - Fix dead link: streamed-conversations → live-api (404 fix)
  - Convert info admonitions to regular sections per style guide
2025-12-04 16:08:52 +09:00
Kaz Sato 440c5a4d24 fix: update Bidi-streaming guide to 1.19.0 (#1004)
* fix: update Bidi-streaming guide to 1.19.0

fix: update Bidi-streaming guide to 1.19.0

* fix: adding env var loading order note

fix: adding env var loading order note
2025-12-04 14:15:56 +09:00
Joe Fernandez 30c8ba2248 Fix ApigeeLlm code example formatting (#1024) 2025-12-03 14:33:55 -08:00
Sai Saran Vaidyanathan dfbd1f9bdb feat: Support for ApigeeLLM (Java) (#1019)
* feat: add Java doc

* Update models.md

* Update models.md

* Update models.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-12-03 14:23:37 -08:00
Kristopher Overholt 6cafce5dd5 Add Atlassian to third-party tools (#1018)
* Add Atlassian page to third-party tools

* Update page content

* Fix tense
2025-12-03 15:11:56 -06:00
Kristopher Overholt 1ab27dfe52 Add Linear to third-party tools (#1017)
* Add Linear page to third-party tools

* Add timeout
2025-12-03 15:07:41 -06:00
Kristopher Overholt 5f8905140b Add Apify to third-party tools (#1015)
* Add Apify page to third-party tools

* Remove example URL - inlined in code samples

* Update tools

* Minor edits

* Fix tool sample code for consistency
2025-12-03 15:06:43 -06:00
Ivan Cheung 4f74c1c091 PR and Regression testing for Go snippets (#973)
* Added pr checks and regression test code

* Added github workflows and go.mod/go.sum

* Added comments to files_to_test.txt

* Moved check_go_snippets.sh

* Fixed issues with workflows

* Removed unneeded workflow

* Revert bad change

* Added runner tests

* Added README

* refactor(go-snippets): Unify Go module structure and dynamically update ADK dependency

Consolidate all Go snippet module dependencies to a single  file located at . This simplifies dependency management and ensures consistent versions across all Go examples.

Update Usage: tools/go-snippets/runner.sh <build|run> [file1 file2 ...] to dynamically fetch the latest  module () before running any builds or tests. This ensures that PR and regression checks always validate against the most recent ADK release, preventing outdated dependency issues.

Address breaking changes in  by removing the  initialization from , which is no longer available.

Cleaned up extraneous  and  files from subdirectories within , as well as the unused  file.

* feat(go-snippets): Reinforce strict `files_to_test.txt` adherence

Reverts previous attempts to infer Go snippet dependencies and clarifies the strict testing model.

- **`runner.sh`**: Restores `find_snippet_line` to rely on exact substring matching of changed files within `files_to_test.txt` lines. Adds `go get` exit code check.
- **`tools/go-snippets/README.md`**: Adds "Understanding the Test Runner" section detailing `files_to_test.txt` adherence, multi-file `package main` requirements, and `_test.go` file handling.
- **`runner_test.sh`**: Adds `test_find_snippet_line_multi_file_match` to verify correct behavior for multi-file snippets listed on a single line.

---------

Co-authored-by: ivanmkc <ivanmkc@google.com>
2025-12-03 14:32:21 -05:00
alan blount 8a9f4343b9 docs: relocate code execution section vs planner section (#1014)
* docs: relocate code execution section and add Python and Java code examples.

* Update llm-agents.md

Added Java support tag

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-12-03 09:27:25 -08:00
fabianhenning 68c1896b1f Fix typo in cloud-run deployment documentation (#1022) 2025-12-03 09:59:34 -06:00
Joe Fernandez df4d12a90c docs: ADK Java v0.4.0 release notice (#1016) 2025-12-02 13:02:53 -06:00
Sangyeon Cho 15b6222670 docs: rename 'compactor' to 'summarizer' in documentation (#1007)
* Rename 'compactor' to 'summarizer' in documentation

Updated documentation to replace 'compactor' with 'summarizer' and adjusted references accordingly.

* Formatting

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-12-02 09:40:37 -06:00
Joe Fernandez 878e9761fd docs: Add ADK Web development use only notes (#1013) 2025-12-01 16:40:26 -08:00
Yuki Watanabe 69868c95cc Add MLflow tracing integration guide (#1008)
* Add MLflow tracint integration guide:

Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>

* Formatting

* Formatting and wording

* Formatting

---------

Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-12-01 16:12:45 -06:00
Kaz Sato 72d8e16411 feat: Add comprehensive ADK Bidi-streaming development guide series (#955)
* Add comprehensive ADK Bidi-streaming development guide series

- Add Part 1: Introduction to ADK Bidi-streaming
  - Fundamentals of Bidi-streaming and Live API technology
  - ADK architecture components (LiveRequestQueue, Runner, Agent)
  - Complete application lifecycle with FastAPI examples
  - Comparison between raw Live API and ADK abstractions

- Add Part 2: Sending messages with LiveRequestQueue
  - Upstream message flow from application to agent
  - Message types: text content, audio/video blobs, activity signals
  - Concurrency patterns and thread safety
  - Queue management best practices

- Add Part 3: Event handling with run_live()
  - Downstream event flow from agent to application
  - Event types: text, audio, transcriptions, tool calls, metadata, errors
  - Event serialization for network transport
  - Automatic tool execution and multi-agent workflows

- Add Part 4: Understanding RunConfig
  - Response modalities (TEXT vs AUDIO)
  - Streaming modes (BIDI vs SSE)
  - Session management and resumption
  - Context window compression and quota management

- Add Part 5: How to Use Audio, Image and Video
  - Audio specifications (16kHz input, 24kHz output)
  - Native Audio vs Half-Cascade model architectures
  - Audio transcription and voice configuration
  - Voice Activity Detection (VAD) and proactive/affective dialog

- Update docs/streaming/index.md
  - Add all 5 parts of development guide series with descriptions
  - Add Bidi-streaming Demo Application section
  - Fix grammar issues in Streaming Tools description
  - Remove redundant experimental admonition

- Add supporting assets
  - Add quota console screenshot
  - Add bidi-demo application screenshot

* Fix documentation links

- Fix ADK Session Management documentation link in part1.md
- Update FinishReason and BlockedReason API reference links in part3.md to use correct Python API documentation URLs

* Fix ADK Agent documentation link in part1.md

* fix: addressing mkdocs rendering issues and comments

fix: addressing mkdocs rendering issues and comments

* Improve documentation formatting and consistency across all guide parts

- Convert demo implementation references to inline code block titles with links
- Convert source references to inline code block titles with links
- Convert blockquote notes (💡, 📖) to proper admonition blocks
- Fix internal link anchors to match actual section IDs
- Consolidate redundant source reference notes into cleaner format
- Improve readability and navigation throughout the guide series

Changes span all 5 parts (part1-part5) for consistent documentation style.

* review edits

- added Left Navigation
- fixed a bunch of lists that were not rendering

* fix: removing the Stay Tuned part

fix: removing the Stay Tuned part

---------

Co-authored-by: Joe Fernandez <joefernandez@google.com>
2025-11-22 09:58:06 +09:00
Kristopher Overholt d37d35e3f8 Add GitLab to third-party tools (#1002) 2025-11-21 17:44:21 -06:00
adk-bot 48bb198cd7 Update ADK doc according to issue #989 - 1 - Python 3.10 update (#993)
* Update Python version requirement to 3.10

* add front page warning about Python 3.10 requirement

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
Co-authored-by: Joe Fernandez <joefernandez@google.com>
2025-11-21 15:35:26 -08:00
cl3m3nt e327ba7abc Add async session initialization example when running in .py script (#976)
* Add async session initialization example when running in .py script

Added example code for initializing a session asynchronously when running in .py script

* Update docs/tutorials/agent-team.md

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-11-21 15:34:32 -06:00
Dmitry Pasiukevich d506137bf2 Update adk-go docs with launcher changes (#967) 2025-11-21 21:05:04 +00:00
Joe Fernandez 8becdaf691 docs: add Go v0.2.0 banner and release notes page (#1000) 2025-11-21 11:37:27 -06:00
Kristopher Overholt ee93084985 Update from deprecated MCPToolset to McpToolset class on MCP page and third-party tools pages (#999)
* Update McpToolset and imports on MCP page

* Update McpToolset and imports on all third-party tools pages

* Update McpToolset on Agent Config page

* Update imports from from google.adk.tools.mcp_tool.mcp_session_manager
2025-11-21 10:08:03 -06:00
Kristopher Overholt b24e27795e Add ScrapeGraphAI to third-party tools page (#984)
* Add ScrapeGraphAI to third-party tools

* Add ScrapeGraphAI to nav

* Update sample code

* Update links
2025-11-21 08:02:10 -08:00
Joe Fernandez 60cd7bc01b docs: update Python API Reference docs to v1.19.0 (#996) 2025-11-20 10:34:44 -08:00
Haiyuan Cao f271e3d72a Remove the notice in big query plugin (#988)
* Remove the notice

* Update bigquery-agent-analytics.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-20 10:16:32 -08:00
Joe Fernandez 0e5b7ff2c3 docs: Add Kaggle 5-Day AI Agents Intensive Course (#986)
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-11-20 10:15:58 -06:00
Kristopher Overholt 457afb523a ci: Add CI workflow to check docs build in PRs (#985)
* Add CI workflow to check docs build in PRs

* Intentionally break mkdocs.yml to check CI test

* Revert intentional config breakage / test

* Test CI run
2025-11-19 18:54:04 -06:00
Kristopher Overholt bb5f3bf52c Update event loop diagram on Runtime page (#969)
* Update event loop diagram on Runtime page

* Adjust size

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-19 13:23:48 -08:00
Yasir Modak 99d70b11bb replace the outdated SlidingWindowCompactor with the correct LlmEventSummarizer (#956)
I have rewritten the documentation to replace the outdated `SlidingWindowCompactor` with the correct `LlmEventSummarizer`, and I've updated the code example and explanatory text to match.

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-19 12:49:23 -08:00
Joe Fernandez d4524570b8 Add link to BigQuery Plugin docs (#983) 2025-11-19 12:47:14 -08:00
Kristopher Overholt 79759241fb fix: Correct links and link checker config for failing CI tests (#982)
* Add Exa to link checker config

* Update link to Secret Manager

* Fix URL pattern
2025-11-19 11:24:45 -06:00
Joe Fernandez 57d1a19840 docs: Update ADK Quickstarts to Gemini 3 (#981) 2025-11-18 19:03:19 -08:00