Commit Graph

75 Commits

Author SHA1 Message Date
Jeremy Silva b3c71d1447 Add Freeplay to observability page (#816)
* Add Freeplay to observability page

Add details on the Freeplay <> Google ADK integration

* Update freeplay.md

Making requested changes

* Update freeplay.md

Add links at the bottom

* Update mkdocs.yml

Add Freeplay to observability section

* Update docs/observability/freeplay.md

* Update mkdocs.yml

Maintain alphabetical ordering

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-11-07 10:21:11 -06:00
Ivan Cheung 1d0bb2a0ce Added more go references (#909)
Co-authored-by: ivanmkc <ivanmkc@google.com>
2025-11-07 15:48:40 +00:00
Kristopher Overholt c6e679315d Open link to Go API docs in a new tab (#888) 2025-11-06 13:38:22 -06:00
Joe Fernandez c687e9768e docs: remove "teleport" links (#886) 2025-11-06 11:31:31 -08:00
Ivan Cheung 8834593806 [ADK Go] Merging all Go docs from the private repo (#885)
* docs: Add Go language quickstart

* updates based on review comments

* fix tab stops

* update based on review comments

* sync with main

* update to tested version

* Added google_search snippet

* Fix: Address Go style guide issues in google_search.go

* Migrated to new API

* Fixed tool info in md file

* Added partial check

* Added function-tools sample

* Migrated to new API

* Added partial check

* Ran linter

* feat: add go fmt check

* Run go fmt only on changed files

* Added google_search snippet

* Fix: Address Go style guide issues in google_search.go

* Migrated to new API

* Added partial check

* Added function-tools sample

* Migrated to new API

* Added partial check

* Ran linter

* feat: add go fmt check

* Run go fmt only on changed files

* Feat: Add Golang example for LLM agents

* Added schema agent

* Added session support

* Migrated to new API

* Added back OutputKey

* Added missing snippets

* Moved snipped to its own package

* Minor cleanup

* Reverted llm-agents.md

* Added back correct changes to llm-agents.md

* Updated to newest API

* Ran linter

* WIP

* WIP: Added the rest of the agents

* Added sequential agent

* Migrated agents to new API

* Fixed snippet tags

* Updated parallel and sequential with OutputKey

* Updated loop agent

* Cleanup

* Fixed and ran linter

* Removed comment

* Ran linter

* Added custom agent snippets

* Migrated to new API

* Fixed incorrect info about channels since run returns an Iterator, not Channel

* Cleanup and renaming

* Ran linter

* Fixed md

* Added multi-agent docs

* Updated to use AgentTool

* Split snippets

* Added missing file

* Ran linter and fixed API

* Added Models snippets

* Migrated to new API

* Embedded imports

* Ran linter

* Added long running tool

* Ran linter and fixed API

* Switched to two-turn style

* Ran linter

* Added callback snippets

* Added back imports

* Added types of callbacks snippets

* feat(go): align callback snippets with other languages

* Ran linter and updated API

* Added tool callbacks

* Added artifact snippets

* Use story.pdf instead of random bytes

* Fixed issue with artifact loading

* Cleanup unneeded fixes

* Added back inadvertently removed GCS section

* Addressed PR comments

* Ran linter

* feat: Added context snippets

* Fixed callback signature

* Fixed additional callbacks

* Added remaining snippets

* Added conceptual runner example

* Removed duplicate code

* Clean up tags and imports

* Updated API

* Twaked text

* Ran linter

* Fixed broken API issues

* Updated to latest Go ADK API

* Added func param info

* Interleaved Py and Go

* Revert mistakes

* Removed extra newline

* Added example cloud run code and update md with Go (#41)

* Added example cloud run code and update md with Go

* Added a2a_agent_url and fixed future tense

* Moved Go before Java

---------

Co-authored-by: ivanmkc <ivanmkc@google.com>

* adding go snippets to runconfig docs

* realigning runconfig go examples with current state of adk-go.

* adding language support tags to individual runtime config fields

* removing unsupported supportcfc go examples

* removing unsupported streamingmode.bidi go snippets

* Added AgentTool examples (#31)

* Added AgentTool example

* Ran formatter

---------

Co-authored-by: ivanmkc <ivanmkc@google.com>

* adding initial go sessions.sessions snippets

* updating go session docs + session examples

* update go session snippets

* updating DatabaseSessionService language support tag

* cleaning up go vertex ai comments

* removing go.mod for session_management_example

* docs: add language support tags for Go

* initial go runtime sample updates

* fixing runtime go snippet formatting

* formatting updates to runtime go snippets

* updating runtime go examples to streamline to newer go features

* adding go snippets for events

* updating go snippets for events

* adding artifactdelta snippet for go

* minor java fixes, cleaning up go event.content

* Custom tools: Merging again  (#44)

* Added missing custom-tools snippets

* Split user_preference runner code

* Split more files

* Tweaks

* Split session into 1 and 2 and added artifact saving

* Fixed conflict

---------

Co-authored-by: ivanmkc <ivanmkc@google.com>

* Fixed tab issue with cloud-run md (#45)

Co-authored-by: ivanmkc <ivanmkc@google.com>

* adding initial go snippets for memory services

* updating go memory sample, adding python formatting in docs to clarify current support.

* removing go replace for memory example

* removing go.sum from memory_example

* fixing go formatting for memory example

* fixing go memory snippets to streamline examples in docs

* removing unnecessary go.mod for memory_example.go and snippet cleanup

* adding go session state snippets."

* adding additional go state examples for state injection

* fixing go formatting

* fixing language ordering on session/state.md; removing unnecessary go.mod files

* reworking error functions in go session state samples

* fixing go formatting on session state samples

* initial go snippets for safety tools

* fixing go snippet formatting in safety/index.md

* temp storing safety example

* cleaning up go snippets in safety docs; deferring safety go full example

* cleaning up go safety snippets

* Added link to Go API docs (#47)

Co-authored-by: ivanmkc <ivanmkc@google.com>

* Added a2a_basic sample (#46)

* Added a2a_basic sample

* Removed dummy LLMs

* Added md

Fix inaccuracies in md

Ran formatter

* Cleaned up index

---------

Co-authored-by: ivanmkc <ivanmkc@google.com>

* Reverted to proper ToC and added missing links (#48)

Co-authored-by: ivanmkc <ivanmkc@google.com>

* Added missing get-started/go.md (#50)

Co-authored-by: ivanmkc <ivanmkc@google.com>

* Added missing JSON tags for Go structs (#51)

* Added json tags

* Added jsonschema and json tags

---------

Co-authored-by: ivanmkc <ivanmkc@google.com>

* Renamed Golang to Go (#52)

Co-authored-by: ivanmkc <ivanmkc@google.com>

---------

Co-authored-by: Joe Fernandez <joefernandez@google.com>
Co-authored-by: ivanmkc <ivanmkc@google.com>
Co-authored-by: Toni Klopfenstein <tklopfenstein@google.com>
2025-11-06 14:13:13 -05:00
adk-bot e72a9640e4 docs: Reflect and Retry Tool Plugin - Update ADK doc according to issue #796 - 3 (#802)
* docs: Add documentation for ReflectAndRetryToolPlugin

* docs: add Reflect and Retry plugin page

* docs: Reflect and Retry Plugin page

* resolve review comments

* final review comments

* fix broken link

---------

Co-authored-by: Joe Fernandez <joefernandez@google.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-05 14:44:27 -08: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
Kristopher Overholt b9a06b8558 Add Tavily to third-party tools page (#860)
* Add page for Tavily tool

* Add to sidebar nav

* Update

* Fix links

* Fix heading

* Update mkdocs config / nav

* Add listing to tools page

* Add example usage and available tools

* Add screenshot

* Add left and right padding to tool cards

* Edits to Tavily page

* Update tool descriptions
2025-11-04 18:59:22 -06:00
Kristopher Overholt 7a918e48ad Add Browserbase to third-party tools page (#861)
* Add page for Browserbase tool

* Set links to relative for staging preview

* Update fields

* Add to sidebar nav

* Add to tools listing page

* Fix table width

* Shorten link text
2025-11-04 18:39:16 -06:00
Joe Fernandez c1c5d53907 docs: Add Context Caching doc (#849)
* docs: Add Context Caching doc

* add language support tag

* resolve review comments
2025-11-03 19:28:20 -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
Kristopher Overholt 4cb3a891a1 feat: Add sections and groupings to sidebar navigation menu (#791)
* Add navigation sections to docs

* Move two pages

* Move more sections

* Update nav

* Fix whitespace, newlines

* Fix section headings

* Fix top level headings

* Move Technical Overview in nav

* Change Testing page to API Server page

* Reorder sub-pages in Components section

* Add Home as top level nav; remove redundant site title

* Update links to API server docs page

* Formatting

* Formatting
2025-11-03 12:48:32 -06:00
Kristopher Overholt 243794ea13 Add Notion to third-party tools page (#847) 2025-11-03 10:49:27 -06:00
Joe Fernandez ab549957fe docs: Add Context compaction docs (#840)
* docs: Add documentation for context_window_compression in RunConfig

* docs: add Context Compaction feature docs

* revert adk-bot changes

* revert changes

* updated based on review input

* final changes

---------

Co-authored-by: adk-bot <adk-bot@google.com>
2025-10-31 12:34:33 -07:00
Kristopher Overholt 18ac8db444 Add Exa to third-party tools (#842)
* Add page for Exa tool

* Add card and fix link

* Fix image link

* Fix absolute link
2025-10-31 11:38:01 -05:00
Kaz Sato 2c6defcf26 fix: recovering Quickstart and removing SSE sample app (#841)
fix: recovering Quickstart and removing SSE sample app

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-31 09:27:45 -07:00
Kristopher Overholt ac968aff44 Refactor 3P tool wrappers (#837)
* Refactor third-party tools pages

* Remove 3P tool wrapper references

* Update mkdocs.yml - redirect old page locations

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-31 09:23:26 -07:00
Kristopher Overholt 9b457dc319 Add Firecrawl to third-party tools (#839)
* Add Firecrawl tools page

* Add abolute path

* Python code samples

* Update icon and cards

* Update Firecrawl page content

* Update nav

* Fix image link

* Other cleanup

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-31 09:14:01 -07:00
Joe Fernandez ffdae95fb6 docs: move AG-UI into third party tools for better discovery (#835) 2025-10-29 11:14:32 -07:00
Joe Fernandez 17505eee3f docs: moving MCP Toolbox tool to separate page (#831)
* docs: moving MCP Toolbox tool to separate page

* updated docs link on MCP page
2025-10-28 12:15:28 -07:00
Kristopher Overholt dd6bd99e1b feat: Add initial third-party tools pages, rework tool wrapper pages (#811)
* Add 3P tools pages

* Move OpenAPI tools to custom tools

* Add cards for 3P tools, reorg wrappers

* Fix links to wrapper pages

* Update nav

* Add 3P tools icons

* Fix post-conflict merge

* Remove redundant headings

* Reword header

* Move 3P tools pages in nav; move OpenAPI tools file and in nav

* Update redirect paths, add back openapi-tools page
2025-10-28 12:27:05 -05:00
adk-bot b139235658 Update ADK doc according to issue #796 - 2 (#800)
* docs: Add documentation for ComputerUseToolset

* docs: update Computer Use Toolset docs draft

* furhter updates

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
Co-authored-by: Joe Fernandez <joefernandez@google.com>
2025-10-27 10:31:15 -07:00
Joe Fernandez dd94c28c9d docs: Add Code Execution with Agent Engine tool (#810)
* docs: Add Code Execution with Agent Engine tool

* update final version base on comments
2025-10-23 12:56:01 -07:00
Holt Skinner 95bc295e92 docs: Add markdown view option (#794) 2025-10-22 16:24:50 -05:00
Max Korp 44596d1fc2 Add AG-UI adk-middleware tutorial (#743)
* Add AG-UI adk-middleware tutorial

* Significantly trim down docs

* Change some headers

* Add AG-UI page to nav

* Shorten description on tutorials page

* Edits throughout tutorial

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-10-21 09:54:54 -05:00
Joe Fernandez 42d2aafbfb docs: put third party tools in /tools/third-party/ (#788)
- restructuring for future updates
2025-10-20 12:54:23 -07:00
Joe Fernandez d0c64869f1 docs: Add Resume feature docs (#784)
* docs: Add Resume feature

* docs: Add Resume feature docs

* remove generated update.

* final review fixes.
2025-10-17 16:56:20 -07:00
Joe Fernandez 340a2fb03a docs: Add ADK Tools list to docs (#781)
* docs: Add ADK Tools list to docs

* docs: Update Plugins page (#780)

Add links to code examples, fix repetition of tips

* Update docs/tools/list.md

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

* Update docs/tools/list.md

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

* docs: Update Python API Reference to v1.16 release (#782)

* Update mkdocs.yml

* docs: reconfigure tools to emphasize pre-built tool

- added new tools listing page
- created separate directory for custom tool dev

* fix MCP Toolbox name

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-10-17 13:01:00 -07: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
Kristopher Overholt d32d50a4e7 Add feature for content.action.edit to edit existing content in GitHub (#774) 2025-10-13 20:05:32 -05:00
Joe Fernandez b947bc849f Phase 1: ADK Onboarding journey revision (#739)
* Phase 1: ADK Onboarding journey revision

- Quickstart: split by language and reduce time
- Build your agent: new section for agent building
- Home page: Simplify onboarding choices
- Surface "About ADK" in navigation

* Updates from first review round and Java research

- completely revised Java quickstart

* further updates from review

* more review updates

---------

Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-10-09 15:33:02 -07:00
Joe Fernandez 653640ba92 docs: Add Tool Confirmation feature (#681) 2025-09-09 16:08:39 -07:00
Joe Fernandez 146203feed docs: Add analytics to the documentation site (#669)
* docs: Add analytics to the documentation site

DO_NOT_MERGE

- add Google analytics
- add Cookie consent interface

* docs: Add analytics to the documentation site

DO_NOT_MERGE

- add Google analytics
- add Cookie consent interface

* docs: Add analytics to the documentation site

DO_NOT_MERGE

- add Google analytics
- add Cookie consent interface
2025-09-04 16:04:15 -07:00
Joe Fernandez c73e113b7b feat: Add docs for tool parallel execution (#651) 2025-08-26 15:44:02 -07:00
Sampath Kumar d6730fb135 Chore: Cleaned up the (failed) Google Analytics code. (#643)
The CICD tests responsible for generating static pages are failing to add the necessary keys to the site. The current settings proved unhelpful, so they have been cleared.
2025-08-26 09:22:40 -07:00
Joe Fernandez 7a0a98607e docs: Agent config docs v2 (#636)
* docs: Add Agent Config docs, v2

* fix: update mkdocs file
2025-08-20 17:11:08 -07:00
google-labs-jules[bot] 05376de47f docs: Add documentation for the REST API. (#613)
This commit adds a new page to the documentation for the REST API, with
details about the `/run` and `/run_sse` endpoints.

A new file is created at `docs/api-reference/rest/index.md` and linked
from the main API reference page and the navigation bar.

Joe: Modified navigation ordering, and added information to point to REST API guide in Testing topic.

fixes #126

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-15 11:00:55 -07:00
Terrence Ryan a744a16067 fix: adding cli reference to index. (#590)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-12 13:51:12 -07:00
Sampath Kumar eb4405365e feat: add Google Analytics config. (#556)
* feat: add Google Analytics config.

Secret Key is added to Github Repo > Settings > Actions

* feat: fix broken link
2025-08-06 22:47:31 +02:00
Joe Fernandez 5136469bce docs: Add Plugins developer guide (#549) 2025-08-01 15:08:51 +01:00
Alvin Prayuda 50edb824a2 docs: add cloud trace observability guide and assets (#520)
* docs: add cloud trace observability guide and assets

* docs: reorder observability sections and clarify cloud trace setup instructions

* docs: add cloud tracing setup instructions for ADK CLI deployments

---------

Co-authored-by: Polong Lin <polong-lin@users.noreply.github.com>
2025-07-30 10:08:15 +01:00
Polong Lin cc5d81e5a1 feat(docs): add init A2A documentation (#536)
* feat(docs): add init a2a documentation

* update docs based on feedback

* update incorrect syntax for to_a2a()

* added more context on to_a2a() vs adk api_server
2025-07-29 21:48:09 +01:00
Sita Lakshmi Sangameswaran 077c121ce2 fix(auth): update model authentication info (#516)
* fix(auth): update model authentication info

* add cloudpickle dependency to AE

* update link

* Update models.md
2025-07-17 16:20:43 +01:00
Anubhav Singh 2747fa3e0b docs: Add weave by W&B as an observability option (#498)
* docs: Add weave by W&B as an observability option

* Updated menu item name and Added screenshots

---------

Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-07-17 14:06:25 +05:30
Dwij a3354e3861 docs: add agentops integration documentation (#376)
* feat: add Observability section to mkdocs configuration and Agentops integration

This commit introduces a new "Observability" section in the mkdocs.yml file, including a link to the AgentOps Integration documentation. This enhancement improves the navigation structure of the documentation.

* small docs revisions

* Alex updates

* Update agentops.md

* fix: update navigation label for AgentOps in mkdocs.yml

* Update agentops.md

* Update README.md

* Update README.md

* Update mkdocs.yml

---------

Co-authored-by: Braelyn Boynton <bboynton97@gmail.com>
Co-authored-by: Alex Reibman <meta.alex.r@gmail.com>
Co-authored-by: Sita Lakshmi Sangameswaran <sitalakshmi@google.com>
2025-07-11 09:38:22 -04:00
Xuan Yang 69b9f89602 docs: add ADK logging documentation (#502)
* docs: add ADK logging documentation

* updated mkdocs.yml with the new guide

---------

Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
Co-authored-by: Lavi Nigam <lavinigam@google.com>
2025-07-11 18:13:28 +05:30
Anthony Z 8400336372 feat: Update express mode code sample (#494)
* Update quickstart.md

* Create express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update mkdocs.yml

* Update mkdocs.yml

* Update session.md

* Update mkdocs.yml

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update quickstart.md

* Update express-mode.md

* Add files via upload

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Delete examples/python/notebooks/express-mode-weather-agent.ipynb

* Add files via upload

* Delete examples/python/notebooks/express-mode-weather-agent.ipynb

* Add files via upload

* Update express-mode-weather-agent.ipynb

* Update quickstart.md

* Update express-mode.md

* Update express-mode.md

* Update mkdocs.yml

* Delete examples/python/notebooks/express-mode-weather-agent.ipynb

* Add files via upload

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update mkdocs.yml

* Update express-mode.md

---------

Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-07-11 14:51:52 +05:30
Kaz Sato 3dccaba437 feat: add Vertex AI Search grounding doc (#500)
feat: add Vertex AI Search grounding doc
2025-07-11 07:16:44 +09:00
Kaz Sato 9474f0a55e feat: add google search grounding doc (#444)
feat: add google search grounding doc as per the request from the Search product team.
2025-07-09 17:13:55 +09:00
Anthony Z 19a026393e feat(docs): Add vertex express mode documentation for Agent Engine (#439)
* Update quickstart.md

* Create express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update mkdocs.yml

* Update mkdocs.yml

* Update session.md

* Update mkdocs.yml

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Update quickstart.md

* Update express-mode.md

* Add files via upload

* Update express-mode.md

* Update express-mode.md

* Update express-mode.md

* Delete examples/python/notebooks/express-mode-weather-agent.ipynb

* Add files via upload

* Delete examples/python/notebooks/express-mode-weather-agent.ipynb

* Add files via upload

* Update express-mode-weather-agent.ipynb

* Update quickstart.md

* Update express-mode.md

* Update express-mode.md

* Update mkdocs.yml

---------

Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-07-08 17:58:29 +05:30