Update ADK doc according to issue #744 - 2 #748
+28
−257
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DeanChensj
reviewed
Oct 10, 2025
| * **CPU-Bound Work:** Purely CPU-intensive synchronous tasks will still block their execution thread in both environments. | ||
| * **Blocking I/O:** For long-running synchronous I/O operations, the framework attempts to prevent stalls. Python ADK may use asyncio.to_thread. | ||
| * **CPU-Bound Work:** Purely CPU-intensive synchronous tasks will still block their execution thread. | ||
|
|
There was a problem hiding this comment.
This part lgtm, though it focuses more on the long running tool, we should also talk about when the system is interrupted or crashed in the middle, they can resume the run using the invocation_id
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: mass deletion of code sample
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: mass deletion of code sample
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: mass deletion of code sample
| // is yielded *after* this tool runs and is processed by the Runner. | ||
| ``` | ||
|
|
||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: mass deletion of code sample
| ### Async is Primary (`run_async`) | ||
|
|
||
| * **Core Design:** The ADK Runtime is fundamentally built on asynchronous libraries (like Python's `asyncio` and Java's `RxJava`) to handle concurrent operations (like waiting for LLM responses or tool executions) efficiently without blocking. | ||
| * **Core Design:** The ADK Runtime is fundamentally built on asynchronous libraries (like Python's `asyncio`) to handle concurrent operations (like waiting for LLM responses or tool executions) efficiently without blocking. |
There was a problem hiding this comment.
PROBLEMATIC CHANGE: Removal of "Java's RxJava" not warranted, out of scope
| * **Main Entry Point:** `Runner.run_async` is the primary method for executing agent invocations. All core runnable components (Agents, specific flows) use `asynchronous` methods internally. | ||
| * **Synchronous Convenience (`run`):** A synchronous `Runner.run` method exists mainly for convenience (e.g., in simple scripts or testing environments). However, internally, `Runner.run` typically just calls `Runner.run_async` and manages the async event loop execution for you. | ||
| * **Developer Experience:** We recommend designing your applications (e.g., web servers using ADK) to be asynchronous for best performance. In Python, this means using `asyncio`; in Java, leverage `RxJava`'s reactive programming model. | ||
| * **Developer Experience:** We recommend designing your applications (e.g., web servers using ADK) to be asynchronous for best performance. In Python, this means using `asyncio`. |
There was a problem hiding this comment.
PROBLEMATIC CHANGE: Removal of "Java's RxJava" not warranted, out of scope
| The `LongRunningFunctionTool` is designed for this purpose. When an agent calls a `LongRunningFunctionTool`, the tool can signal to the runtime to pause the invocation. This is done by returning a result that indicates the operation is pending. The agent's execution is then suspended, and the agent client is notified. | ||
|
|
||
| The client can then, at a later time, resume the invocation by sending back an intermediate or final response for the long-running operation. The ADK runtime will then continue the agent's execution from where it was paused. | ||
|
|
There was a problem hiding this comment.
PROBLEMATIC CHANGE: Removal of "Understanding these behaviors...." language is unwarranted.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new subsection to the runtime documentation explaining the pause and resume feature for long-running tools.