docs: make process_document async and await artifact and memory calls in tool example - #2083
Open
Syed-Umer-Ali wants to merge 8 commits into
Open
docs: make process_document async and await artifact and memory calls in tool example#2083Syed-Umer-Ali wants to merge 8 commits into
Syed-Umer-Ali wants to merge 8 commits into
Conversation
…rts-custom-agents-routes
…to google.adk.apps
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
The example tool
process_documentis a syncdefbut callsawait tool_context.save_artifact(...), which is aSyntaxError. Additionallyload_artifact()andsearch_memory()return coroutines that were never awaited.Why
ToolContext.save_artifact,ToolContext.load_artifact, andToolContext.search_memoryare all async methods (verified viainspect.iscoroutinefunction). Running the file as written raisesSyntaxError: 'await' outside async function. The example is embedded indocs/tools-custom/index.md, so the rendered docs contain the same broken code.FunctionToolsupports async callables (seefunction_tool.pywhich detects coroutine functions), so making the function async is valid.Fix
def process_documenttoasync def process_documentawaittoload_artifact,search_memory, andsave_artifactcallsVerification
python -m py_compilepasses on the file.