Commit Graph

45 Commits

Author SHA1 Message Date
Zyan 4453bcd1f6 Add allow_origins flag to cloud run page per issue #1113 - 1 (#2064)
* Add allow_origins flag to cloud run page per issue #1113 - 1

Rendered page: 
Agent's PR: #1118 
Original Issue: #1113 

--

This PR updates the deployment documentation to include --allow_origins flag (with regex support).

While the original draft suggested updating multiple pages, a review of the live site confirmed that this feature is already documented in the main CLI reference for the api_server and web commands.

Additional format changes:

- Fixed Markdown rendering bugs: Repaired broken code blocks in the Environment variables and Cloud Build permissions sections, fixed the misplaced Secret command, and corrected the malformed numbered list under Prerequisites.
- Style changes.

* Update cloud-run.md

* Update cloud-run.md
2026-08-06 16:54:48 -06:00
Amaad Martin c75e61f5f3 docs: normalize Typescript to TypeScript across the site (#2079)
The site rendered one language under two names. Tab labels were split
137 `TypeScript` / 53 `Typescript`, with three pages carrying both
spellings at once (custom-agents.md 7/7, patterns.md 1/7,
function-tools.md 4/1), and the language-support badges were split 67/18
the same way. Because pymdownx.tabbed slugifies tab labels to lowercase,
both variants rendered and linked fine, so no link check or build warning
ever flagged it -- it was visible only to readers, as two names for one
SDK.

Every user-visible occurrence is normalized to `TypeScript`, plus the two
inconsistencies that turned up while doing it. 80 changed lines, accounted
for exactly:

  53  tab label       === "Typescript"            -> === "TypeScript"
  18  badge span      lst-typescript">Typescript  -> TypeScript
   3  prose mention   cloud-run.md, mcp-tools.md, workflows/patterns.md
   2  api-reference/index.md card heading and link text
   1  badge div attr  title="...Python and Typescript."
   1  mkdocs.yml nav  Typescript ADK              -> TypeScript ADK
   1  code fence      ```javascript -> ```typescript on a .ts include
   1  artifacts/index.md closing summary sentence
  ---
  80

The first six rows are pure casing: 78 lines that differ from their
originals by nothing but `Typescript` -> `TypeScript`. The last two are
not, and are the reason this is not a `sed`:

llm-agents.md:872 fenced `--8<-- ".../capital_agent.ts"` as ```javascript.
It was the only javascript-fenced `.ts` include in docs/ (the other 189
TypeScript fences are correct), and it cost that one snippet its
TypeScript highlighting.

artifacts/index.md:1084 closed the page by naming languages and got the
list wrong. It described reaching the artifact methods "using Python's
context objects or directly interacting with the `BaseArtifactService` in
Java" -- a two-language enumeration at the end of a page that carries
Python, TypeScript, Go, Java and Kotlin tabs (11/10/10/10/11), and one
that contradicts :556, which correctly names four of them. The
enumeration is dropped rather than extended: the sentence now describes
the two ways to reach these methods -- through the context object, or
through `BaseArtifactService` -- which is what the page actually teaches
and does not rot when a sixth language is added.

docs/api-reference/index.md is included even though the rest of
docs/api-reference/ is generated output that must not be touched. That
tree holds 3,140 generated HTML files and exactly one hand-authored page:
this one. It is Markdown, it is the only api-reference entry mkdocs.yml
lists as `.md` rather than `index.html` (:272, :441), it uses Material
`grid cards` and `:fontawesome-*:` shortcodes, and it carries a
`CONTRIBUTORS:` note citing issues #1716 and #1717. Its TypeScript card
already said "TypeScript" twice in its body text while its heading and
link text said "Typescript"; those two are now consistent with the body.
No generated file is modified.

Not in this change: the broken `SseConnectionParams` sample in
mcp-tools.md (docs-ts/p6c-mcp-ts-sample) and the `@google/adk` example
version bumps (docs-ts/p6b-example-versions). Only the casing of the
prose line above that sample is touched here.

Verified: `mkdocs build` exits 0 with an empty warning set on both main
and this branch, and the two warning sets are identical. A rendered
before/after diff of the whole site shows every `__tabbed_*` id, every
tab radio id and every heading anchor unchanged. Zero `=== "Typescript"`
and zero `lst-typescript">Typescript` remain anywhere in the repo.

Co-authored-by: Amaad Martin <amaadmartin@google.com>
2026-08-05 15:58:49 -07:00
George Weale 98556ba5ad docs(deploy): correct adk deploy CLI options for Cloud Run and GKE (#2011)
* docs(deploy): correct adk deploy CLI options for Cloud Run and GKE

* Update python.md

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-07-28 20:19:26 +00:00
Kristopher Overholt 233342579d Update ADK Java dependency versions to 1.6.0 (#1939) 2026-07-13 15:52:59 -05:00
Kristopher Overholt 72015b26d4 Update ADK Java dependency versions to 1.5.0 (#1922)
* Update ADK Java dependency versions to 1.5.0

* Clarify ADK version guidance in Firestore note
2026-07-01 15:13:53 -05:00
Haran Rajkumar d802044831 docs: update GenAI auth env var and Client parameter (#1832)
* docs: update GOOGLE_GENAI_USE_VERTEXAI to GOOGLE_GENAI_USE_ENTERPRISE in configs and models

* docs: update GOOGLE_GENAI_USE_VERTEXAI in deployment and setup guides

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

* docs: update GOOGLE_GENAI_USE_VERTEXAI in tutorials and examples

---------

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-06-30 08:51:51 -07:00
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
Kristopher Overholt 8235a1cf00 Update Java ADK dependency versions to 1.4.0 (#1812) 2026-06-02 13:32:31 -05:00
Kristopher Overholt 74c2a2cf39 Update Java ADK dependency versions to 1.3.0 (#1787) 2026-05-21 18:00:22 +00:00
sergiov8 58a51b780f docs: add Cloud Build permissions to Cloud Run deployment prerequisites (#1703)
* docs: update Cloud Run deployment guide for compute service account to have permission to use Cloud Build.

* Update cloud-run.md

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-05-04 21:47:57 +00:00
Kristopher Overholt 0942b60c15 Update Java ADK dependency versions to 1.2.0 (#1691) 2026-04-27 13:31:29 -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
Guillaume Laforge b2adad4083 Update ADK for Java version to 1.0.0 (#1513)
* doc: A2A support in ADK Java

* doc: fix spelling for the Agent2Agent protocol name

* doc: addressing Kris' comments on the A2A Java documentation

* docs: update ADK Java to version 1.0.0
2026-03-30 10:04:07 -05:00
Guillaume Laforge 7a7b6b6789 doc: update ADK Java to 0.6.0 (#1345)
* doc: Reference version 0.5.0 of ADK for Java

* doc: Update references of version 0.6.0 of ADK for Java instead of older versions

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-26 08:02:31 -08:00
Benjamin 2ea412d618 docs: specify deployment flags for webui depending on stack in Cloud Run documentation (#1318)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-17 16:49:54 +00:00
Luke Schlangen fbd2a39899 Add typescript deployment (#1209)
* add initial TS deployment commands

* fix adk typescript deployment

* fix package name

* docs: Reorder language tags and deployment sections for TypeScript and Go, and remove Java gcloud CLI deployment instructions.

* remove TypeScript gcloud command to focus on ADK deployment command

* add spaces to prevent changes to unrelated code

* remove unsupported flags for npx adk deployment

* Update docs/deploy/cloud-run.md

Remove unsupported `--app_name` CLI arg.

* Update docs/deploy/cloud-run.md

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-02-12 12:59:23 -06:00
Thu Ya Kyaw c5f37826b1 doc: added 'Passing gcloud CLI Arguments' section (#1223)
* doc: added 'Passing gcloud CLI Arguments' section to docs/deploy/cldou-run.md file

* Update docs/deploy/cloud-run.md

* Update docs/deploy/cloud-run.md

* Update docs/deploy/cloud-run.md

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-02-04 11:29:06 -06:00
PrismaCloudAI e888a31045 Update cloud-run.md (#1009)
app name don't support "-"

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-01-20 13:31:35 -06:00
Guillaume Laforge 1cde77ece3 doc: Reference version 0.5.0 of ADK for Java (#1088)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-01-09 08:08:09 -08:00
Didier Durand 60c8fa89be doc: fixing typos in various files (#1093)
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-01-05 11:37:02 -06:00
Isaac Alejandro Blanco f61ca141bb Specify the async driver for SQLite examples for the DatabaseSessionService (#1077)
* add: change the sqlite url to be async

* add: explanation of why the use of this

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-12-18 08:20:17 -08:00
fabianhenning 68c1896b1f Fix typo in cloud-run deployment documentation (#1022) 2025-12-03 09:59:34 -06:00
Dmitry Pasiukevich d506137bf2 Update adk-go docs with launcher changes (#967) 2025-11-21 21:05:04 +00:00
Polong Lin 67b7c1579d fix(docs): update wording from agent-to-agent to Agent2Agent (#916) 2025-11-07 08:46:43 -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
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
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
Joe Fernandez c01d20d25f docs: Add Deployment Payload details to deployment docs (#657) 2025-08-27 16:30:23 -07:00
Steren 5364bc16d9 Fix deploy to Cloud Run from gcloud (#639) 2025-08-21 19:45:53 -07: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
purvii-n 28f8f5c93d Update cloud-run.md (#558)
Modified get_fast_api_app method parameters according to current code implementation

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-12 10:31:36 -07:00
Mariano Alvarez 3b12480511 chore: update name of adk package in python examples (#458)
Co-authored-by: Terrence Ryan <tpryan@google.com>
Links are all working. These are valid fixes.
2025-08-08 14:59:06 -07:00
Ryan Pei e06dedac0c docs: add option to use AI Studio API key (#552)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2025-08-05 17:19:23 +00:00
Shangjie Chen 04f31eeaa5 chore: Update param name of fast_api_app based on ADK change (#409)
* Fix

* chore: Update param name of fast_api_app

* Revert "Fix"

This reverts commit da78ebfcf7.

---------

Co-authored-by: Sita Lakshmi Sangameswaran <sitalakshmi@google.com>
2025-07-14 15:54:02 -04:00
Sita Lakshmi Sangameswaran ecc1a59786 fix(agents): fix agent related doc/ sample issues (#463)
* fix(agents): fix agent related doc/ sample issues

* fixes 405

---------

Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-07-11 09:55:06 -04:00
HU, Pili e9d308d43c update arg to session_service_uri (#427) 2025-06-20 11:16:28 -05:00
Kaarthik Andavar f27f9bda74 docs(get_fast_api_app): update agents_dir usage to match API (#360)
Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-06-02 22:21:20 +05:30
triangle-z 9011fcf0a4 docs(cloud-run): Clarify multi-agent project structure for Cloud Run deployment (#245)
Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-05-30 13:52:56 +05:30
Keith Rozario f4962d1923 fix: gcloud deploy cloudrun (#288)
Co-authored-by: Keith Rozario <krozario@google.com>
Co-authored-by: Lavi Nigam <98014943+lavinigam-gcp@users.noreply.github.com>
2025-05-30 12:02:28 +05:30
Megan O'Keefe 0887973bed feat: Initializes Java documentation (#277) 2025-05-20 12:10:27 -04:00
Jack Wotherspoon d8acf78f21 docs: add notes about requirements.txt for deploying ADK to Cloud Run (#227)
* chore: update google-cloud-tools.md

* docs: add notes about requirements.txt for deploying ADK to Cloud Run

---------

Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
Co-authored-by: Polong Lin <polong-lin@users.noreply.github.com>
2025-05-08 13:57:20 +01:00
Didier Durand 2c162d917f Update cloud-run.md: redundant words (#88)
Hi, 'in on' seems redundant: see commit diff.
I chose one ('in')  and removed the other ('on')
2025-04-15 10:29:59 -05:00
Mofi Rahman e8268d991c [WIP] gcloud cli instruction for cloud run deploy (#53)
* fix #52 gcloud cli instruction for cloud run deploy

* default to port 8080

---------

Co-authored-by: Kristopher Overholt <koverholt@gmail.com>
2025-04-13 01:32:11 -05:00
Karl Weinmeister 49c401d422 fix: cloud run deployment instructions with gcloud 2025-04-12 11:01:18 -07:00
Kristopher Overholt d3cec829c9 Initial commit of Agent Development Kit 2025-04-09 08:49:23 -07:00