Update ADK doc according to issue #744 - 8 #762
+93
−500
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
| executed at various stages of an agent workflow lifecycle using callback hooks. | ||
| You use Plugins for functionality that is applicable across your agent workflow. | ||
| Some typical applications of Plugins are as follows: | ||
| Plugins are best used for adding custom behaviors such as: |
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
| * **Logging:** Track important information at each callback point. | ||
| * **Context Management:** Filter the LLM context to reduce its size. | ||
| * **Error Handling:** Implement custom logic to handle tool failures. | ||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
| better modularity and flexibility than Callbacks. For more details, see | ||
| [Callbacks and Plugins for Security Guardrails](/adk-docs/safety/#callbacks-and-plugins-for-security-guardrails). | ||
| ## How to Use | ||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
| If your ADK workflow uses Plugins, you must run your workflow without the | ||
| web interface. | ||
| To use a plugin, you add it to the `plugins` list of your `App`. | ||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
| ```python | ||
| from google.adk.apps import App | ||
| from my_plugins import MyCustomPlugin | ||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
|
|
||
| if __name__ == "__main__": | ||
| asyncio.run(main()) | ||
| ``` |
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
|
|
||
| ### User Message callbacks | ||
| ## Available Plugins | ||
|
|
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
| * [Logging Plugin](logging_plugin.md) | ||
| * [Context Filter Plugin](context_filter_plugin.md) | ||
| * [Save Files As Artifacts Plugin](save_files_as_artifacts_plugin.md) | ||
| * [Reflect and Retry Tool Plugin](reflect_and_retry_tool_plugin.md) |
There was a problem hiding this comment.
BREAKING CHANGE: deleting existing content
| self, *, invocation_context: InvocationContext | ||
| ) -> Optional[None]: | ||
| ``` | ||
| * [Logging Plugin](logging_plugin.md) |
There was a problem hiding this comment.
KEEP: review and update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 documentation for the new
ReflectRetryToolPlugin, as requested in issue #744.