Commit Graph

62 Commits

Author SHA1 Message Date
Toni Klopfenstein 3c515f559d Adding Go instructions to get-started/installation.md (#907) 2025-11-07 08:46:59 -07:00
Kristopher Overholt a94f96bdc9 Fix some issues in Go quickstart (#891)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-11-06 12:07:50 -08:00
Joe Fernandez dea2bb2642 docs: Get Started, update language order, part1 (#889)
* docs: remove "teleport" links

* docs: Get Started, update language order

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-11-06 12:05:28 -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
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
Alejandro Cruzado Ruiz e83e079755 fix: Update Java ADK docs to reflect updated agent dir (#830)
Resolving issues raised in https://github.com/google/adk-java/issues/456#issuecomment-3424597355

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-31 09:35:12 -07:00
Kevin (Kun) "Kassimo" Qian 8d46b7e3cc Remove incorrect state wrapper in session post payload (#822)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-31 09:30:34 -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
Shrey Pacahuri fd259456d4 docs: clarify adk web usage for agent folders Issue:817 (#818)
* docs: clarify adk web usage for agent folders

* docs: clarify adk web usage for agent folders

* Updates and formatting fixes

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-27 15:46:30 -07:00
Sampath Kumar d410964820 fix(docs): Fix link to Java page url (#770)
The link should be https://google.github.io/adk-docs/get-started/java/ instead of https://google.github.io/adk-docs/get-started/java.md
2025-10-10 09:34:52 -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
Tim Rutana 2c9dd106a1 docs: add Gradle instructions for launching the ADK web server (#402)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-10-06 14:06:57 -07:00
Sergei Lilichenko f71f8dcaee Fix minor typo in quickstart.md (#712)
Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-10-01 16:36:45 -05:00
Daniel Amaral 91635b5561 Updated instructions about how to send encoded base64 file (#663)
* Practical example about how to send a file using the default API

#655

* Updated instructions about how to send a file

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-09-10 08:33:58 -07:00
Tim Rutana e058e99c00 docs: replaced deprecated method and update syntax to use best practice (#403)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-09-03 10:51:39 -07:00
Michael Vorburger c7bb5f1405 fix: https://github.com/google/adk-java/issues/152 (#381)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-19 10:00:32 -07:00
Terrence Ryan 551e563ebd fix: add tip about injecting prompts into adk run (#617)
fixes #616

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-15 13:04:28 -07:00
Joe Fernandez 35438f324b fix(docs): Add "application-default" option to gcloud auth (#615)
Fixes https://github.com/google/adk-python/issues/943
2025-08-15 17:42:42 +01:00
Michael Vorburger 7f51ec6f7e fix: Use final static BaseAgent ROOT_AGENT field. (#350)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-14 11:38:12 -07:00
Terrence Ryan 8baf946953 fix: adding windows version of command (#609)
Fixes #154

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-14 10:59:34 -07:00
Terrence Ryan 77d0e39adf fix: Made references requiring file creation cross platform (#606)
* fix (docs): Made references requiring file creation cross platform

Fixes #44

* fix: correct conventional commit

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-14 10:57:10 -07:00
Terrence Ryan f563df660d feat: adding heading identifier to improve linkability (#587)
Fixes: #109
2025-08-11 16:26:28 -07:00
Guillaume Laforge b20faacfd0 docs: update Java version to 0.2.0 in installation guide (#574) 2025-08-07 19:06:19 +01:00
Lavi Nigam 9b78bfa8de docs: fix api_server examples and add comprehensive guide (#525) 2025-07-30 10:03:05 +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
Lavi Nigam 947439092f docs: add gcloud auth instructions for Vertex AI users in quickstart (#515) 2025-07-17 00:34:55 +05:30
Dan 60f3e61360 fix: use the before unused processEvent method (#465)
Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-07-14 12:47:10 +05:30
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
Kristopher Overholt a167be5e97 feat: Testing the newly added link checker (#426)
* Testing the newly added link checker

* Switch actions

* Add detailed config file and URL pattern to ignore

* Additional patterns

* Set projectBaseUrl

* Try default

* More CI tweaks

* Tweak config again

* Edit

* Minimal

* Add status codes

* Fix some links

* Simple config

* Fix more links

* Ignore 403 errors

* Fix Markdown links
2025-06-17 23:23:25 -05:00
Hangfei Lin acf8c011ec doc: Update quickstart-streaming.md (#413) 2025-06-17 05:13:38 +09:00
Hangfei Lin 5ee4fd0797 doc: Update quickstart-streaming.md (#411)
* doc: Update quickstart-streaming.md

doc: remove the model name as it changes very often and it's causing confusion. instead, point them to the right source so they can figure it out.

* doc: Update quickstart-streaming.md

* doc: Update quickstart-streaming.md
2025-06-17 04:14:52 +09:00
Lavi Nigam 6e175eff43 [PR fixes]This PR is trying to fix multiple old PRs. Due to merge conflicts, we are doing all those small changes in this PR. Each changes are listed below: (#342)
- #254 docs/sessions/session.md -> …part of session object's identification.
In the session object identification description, it was unclear (for first time readers), what exactly is id, and app_name and how they are different. Added some examples according to my own understanding. Please change accordingly if you feel so. Thanks.

- #252 Multiple files: quickstart-streaming.md,  quickstart.md, mcp-tools.md
add an option in the CLI to enable or disable the reload feature. So users(esp. windows) can disable this if they come across the '_make_subprocess_transport NotImplementedError' bug on windows.

- #179 docs/agents/models.md -> Add Windows Encoding Note for LiteLLM
When using ADK agents with LiteLlm on Windows, users might encounter a UnicodeDecodeError: 'charmap' codec can't decode byte... error. This often happens when litellm (used by LiteLlm) tries to read cached files (like model pricing information) using the default Windows encoding (cp1252) instead of UTF-8.

- #170 docs/tools/mcp-tools.md  fix: update ADK setup link and add .env file location note in MCPTools.
Also resolved the issue: #169
2025-05-30 19:49:41 +05:30
Rohit b956c98d30 fix: remove incorrect reference to main.py in get-started streaming guide (#341)
Removed the incorrect instruction to copy code into a non-existent `main.py` file. Now it only mentions `__init__.py`, matching the ADK streaming guide and avoiding confusion during setup.

Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-05-30 19:43:54 +05:30
Jaime 4f81494fd6 Update installation.md (#333)
fix pom dependencies symbol missing
2025-05-30 10:08:41 -04:00
Pawel Wojcik 1597075bce fix: typo in the adk-docs/get-started/quickstart (#309)
Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-05-29 21:45:36 +05:30
Kristopher Overholt 77c93e2158 fix: Minor edits to style and formatting on MCP and quickstart pages (#293) 2025-05-21 17:10:59 -05:00
Megan O'Keefe 0887973bed feat: Initializes Java documentation (#277) 2025-05-20 12:10:27 -04:00
Kaz Sato 6d8d499479 feat: add audio Streaming sample (#244)
* feat: add audio Streaming sample

add audio Streaming sample

* fix: added license headers

added license headers
2025-05-12 10:09:30 -05:00
Kaz Sato 0bfb2c3cc9 fix: Fixed the google search tool name and model name (#226)
* fix: Fixed the google search tool name and model name

- With 0.4.0, the tool name has changed to google_search
- As of today, gemini-2.0-flash-exp is the workable model with Streaming for ADK that is soon to be replaced with gemini-2.0-flash-live-001.

* Formatting

---------

Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2025-05-07 08:22:08 -05:00
Kavin Kumar B 5e6fc82b76 fix: google_search import issue (#219) 2025-05-07 08:16:57 -05:00
Mark fc537e38b1 Update quickstart-streaming.md (#209)
Fix error Error in event_generator: cannot import name 'google_search' from 'google.adk.tools'
2025-05-02 17:40:41 -05:00
Kristopher Overholt a1b4ef85bf Fix redirects and links for Safety and Security page (#153) 2025-04-23 14:11:00 -05:00
Lavi Nigam a4057576ea fix: tutorial section overhaul and bug fixes (#143)
* fix: tutorial section overhaul and bug fixes
- Tutorial section is moved out of getting started and is a seperate section
- Fixed a sentence in getting-started page that still showed “google search”
- Given we will have more tutorials as part of docs, now we have sub-sections with the tutorial name
- For weather agent team - fixed issues pointed out in #118 #135
    - It now includes code for asynio in the notebook
    - It also now has .py file to run it through adk web
    - Step 2 is now optional and not connected to other steps. So user can follow other steps if they choose to
    - There is disclaimer at the top - for different method to run the code
    - The text on the page is now synced with notebook
    - Collab and social link are updated with new changes in folder.

* added a redirect in the redirect_maps

* adding license headers in the code for tutorial for .py files
2025-04-23 09:43:32 +05:30
Harsh Modi c8145cd845 fix: Quickstart (streaming): Correct the agent name in drop-down menu (#136) 2025-04-21 10:58:35 +09:00
Kaz Sato 3958bb0007 fix: Quickstart (streaming): fix the SSL error for audio and video, and add Vertex AI support. (#123)
* Added Vertex AI support

* Added a fix for the audio and video SSL errors

---------

Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-04-18 05:27:15 -05:00
Jeremy Peters 83f4669ae3 Fix typo (#117) 2025-04-18 05:23:09 -05:00
Kaz Sato af4ea1ae36 Added the full directory structure for the custom streaming app. (#113) 2025-04-18 13:18:48 +09:00
Ian McKee ad0d42f5f7 Clarify documentation on multimodal model support (#107)
* Clarify documentation on multimodal model support

Multimodal inputs require specific supportedGenerationMethods to be included in the model details, bidiGenerateContent for audio/video, generateContent for text.

* update location

* add List method Documentation link
2025-04-17 16:16:52 +09:00
Laziz Turakulov 0e08c0619f Typo in print output (#103)
Typo in print output, as use uses "AGNET" instead of "AGENT"
2025-04-16 16:54:08 +01:00
Ashley Henry 8e44b6d587 Update tutorial.md (#94) 2025-04-16 03:16:30 +00:00