docs: Add nested state access documentation for template injection #1003
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
This commit adds comprehensive documentation for the nested state access
feature in template injection, which allows developers to access deeply
nested properties using dot notation and optional chaining.
Previously, developers could only access top-level state variables in
instruction templates (e.g., {user}). This enhancement enables accessing
nested properties like {user.profile.role} without needing to flatten
the state structure.
Key features documented:
- Dot notation for accessing nested dictionaries and object attributes
- Optional chaining with ? operator for safe navigation
- Error handling behavior for missing keys
- Support for mixed dictionary and object attribute access
Example usage:
```python
# Define nested state
callback_context.state["user"] = {
"name": "Alice",
"profile": {"role": "Software Engineer"}
}
# Use in instruction template
template = "Current user is {user.name} and {user.profile.role}"
```
This documentation supports the implementation in adk-python.
Related issue: google/adk-python#575
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.
Related PR: google/adk-python#3673
Related issue: google/adk-python#575
Summary
Documents the new nested state access feature for instruction templates, allowing developers to use dot notation and optional chaining to access nested properties.
What's New
Dot notation: Access nested values with {user.profile.role}
Optional chaining: Safely handle missing values with {user?.profile?.role?}
Example
Changes