Skip to content

Commit d68f558

Browse files
authored
docs: Add Resume feature notes to affected features: (#790)
* docs: Add Resume feature notes to affected features: - authentication - confirmation - long running functions * Update authentication.md * Update confirmation.md * Update function-tools.md
1 parent 8b15da2 commit d68f558

File tree

3 files changed

+44
-2
lines changed

3 files changed

+44
-2
lines changed

docs/tools/authentication.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,20 @@ if auth_request_function_call_id and auth_config:
365365

366366
```
367367

368+
!!! note "Note: Authorization response with Resume feature"
369+
370+
If your ADK agent workflow is configured with the
371+
[Resume](/adk-docs/runtime/resume/) feature, you also must include
372+
the Invocation ID (`invocation_id`) parameter with the authorization
373+
response. The Invocation ID you provide must be the same invocation
374+
that generated the authorization request, otherwise the system
375+
starts a new invocation with the authorization response. If your
376+
agent uses the Resume feature, consider including the Invocation ID
377+
as a parameter with your authorization request, so it can be included
378+
with the authorization response. For more details on using the Resume
379+
feature, see
380+
[Resume stopped agents](/adk-docs/runtime/resume/).
381+
368382
**Step 5: ADK Handles Token Exchange & Tool Retry and gets Tool result**
369383

370384
* ADK receives the `FunctionResponse` for `adk_request_credential`.

docs/tools/confirmation.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,20 @@ requirements:
207207
- The `response` object contains the confirmation status and any
208208
additional payload data required by the tool.
209209

210+
!!! note "Note: Confirmation with Resume feature"
211+
212+
If your ADK agent workflow is configured with the
213+
[Resume](/adk-docs/runtime/resume/) feature, you also must include
214+
the Invocation ID (`invocation_id`) parameter with the confirmation
215+
response. The Invocation ID you provide must be the same invocation
216+
that generated the confirmation request, otherwise the system
217+
starts a new invocation with the confirmation response. If your
218+
agent uses the Resume feature, consider including the Invocation ID
219+
as a parameter with your confirmation request, so it can be
220+
included with the response. For more details on using the Resume
221+
feature, see
222+
[Resume stopped agents](/adk-docs/runtime/resume/).
223+
210224
## Known limitations {#known-limitations}
211225

212226
The tool confirmation feature has the following limitations:
@@ -219,4 +233,4 @@ The tool confirmation feature has the following limitations:
219233
## Next steps
220234

221235
For more information on building ADK tools for agent workflows, see [Function
222-
tools](/adk-docs/tools/function-tools/).
236+
tools](/adk-docs/tools/function-tools/).

docs/tools/function-tools.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,20 @@ Define your tool function and wrap it using the `LongRunningFunctionTool` class:
241241

242242
Agent client received an event with long running function calls and check the status of the ticket. Then Agent client can send the intermediate or final response back to update the progress. The framework packages this value (even if it's None) into the content of the `FunctionResponse` sent back to the LLM.
243243

244+
!!! note "Note: Long running function response with Resume feature"
245+
246+
If your ADK agent workflow is configured with the
247+
[Resume](/adk-docs/runtime/resume/) feature, you also must include
248+
the Invocation ID (`invocation_id`) parameter with the long running
249+
function response. The Invocation ID you provide must be the same
250+
invocation that generated the long running function request, otherwise
251+
the system starts a new invocation with the response. If your
252+
agent uses the Resume feature, consider including the Invocation ID
253+
as a parameter with your long running function request, so it can be
254+
included with the response. For more details on using the Resume
255+
feature, see
256+
[Resume stopped agents](/adk-docs/runtime/resume/).
257+
244258
??? Tip "Applies to only Java ADK"
245259

246260
When passing `ToolContext` with Function Tools, ensure that one of the following is true:
@@ -354,4 +368,4 @@ The `AgentTool` class provides the following attributes for customizing its beha
354368
3. Behind the scenes, the `main_agent` will call the `summary_agent` with the long text as input.
355369
4. The `summary_agent` will process the text according to its instruction and generate a summary.
356370
5. **The response from the `summary_agent` is then passed back to the `main_agent`.**
357-
6. The `main_agent` can then take the summary and formulate its final response to the user (e.g., "Here's a summary of the text: ...")
371+
6. The `main_agent` can then take the summary and formulate its final response to the user (e.g., "Here's a summary of the text: ...")

0 commit comments

Comments
 (0)