-
Notifications
You must be signed in to change notification settings - Fork 334
Description
Here are the recommended documentation updates based on the changes in the ADK Python release from v1.13.0 to v1.14.0.
-
[Core] Update docs to use
App
class withRunner
.
TheRunner
class now takes anApp
object in its constructor instead ofapp_name
andagent
. TheApp
object encapsulates theroot_agent
andplugins
. This is a fundamental change that affects many parts of the documentation.Proposed Change:
Update all code examples and documentation that use theRunner
to instantiate it with anApp
object.Example:
Current state:runner = Runner( app_name="my_app", agent=my_agent, ... )
Proposed Change:
from google.adk.apps import App app = App( name="my_app", root_agent=my_agent, plugins=[MyPlugin()], ) runner = Runner( app=app, ... )
Reasoning:
This change is necessary to align the documentation with the new API in the latest ADK release. It also introduces theApp
class as the top-level container for an agentic system.Reference:
- google/adk-python@4df79dd
- src/google/adk/runners.py
- src/google/adk/apps/app.py
-
[A2A] Document the
agent_card
parameter into_a2a
function.
Theto_a2a
function now accepts a pre-builtAgentCard
object or a path to an agent card JSON file. This allows users to provide their own agent card instead of relying on the auto-generated one.Current state:
The documentation indocs/a2a/quickstart-exposing.md
only mentions the auto-generation of the agent card.Proposed Change:
Updatedocs/a2a/quickstart-exposing.md
to include information about theagent_card
parameter in theto_a2a
function. Provide examples of how to use it with a pre-builtAgentCard
object and with a path to a JSON file.Reasoning:
This change is necessary to document the new feature and provide users with more control over the agent card when using theto_a2a
function.Reference:
- google/adk-python@a1679da
- src/google/adk/a2a/utils/agent_to_a2a.py
-
[Tools] Add documentation for
GkeCodeExecutor
.
TheGkeCodeExecutor
is a new feature that allows for sandboxed code execution on GKE. The existing documentation indocs/tools/built-in-tools.md
is incomplete.Proposed Change:
Expand the section onGkeCodeExecutor
indocs/tools/built-in-tools.md
to provide a proper introduction, explain the benefits of using it, and include a complete code example.Reasoning:
This change is necessary to properly document the newGkeCodeExecutor
and guide users on how to use it for secure code execution.Reference:
- google/adk-python@72ff9c6
- src/google/adk/code_executors/gke_code_executor.py
-
[Tools] Document the
audience
parameter forOAuth2Auth
.
TheOAuth2Auth
class now accepts anaudience
parameter, which can be used to specify the audience for the OAuth flow. This is not documented indocs/tools/authentication.md
.Proposed Change:
Updatedocs/tools/authentication.md
to include information about theaudience
parameter in theOAuth2Auth
class.Reasoning:
This change is necessary to document the newaudience
parameter and its usage in OAuth flows.Reference:
- google/adk-python@edda922
- src/google/adk/auth/auth_credential.py
- src/google/adk/auth/auth_handler.py
-
[Tools] Enhance documentation for the BigQuery
forecast
tool.
The new BigQueryforecast
tool is mentioned indocs/mcp/index.md
but could be highlighted more. The "Next Steps" section ofdocs/tutorials/agent-team.md
could be updated to suggest adding a forecast agent.Proposed Change:
- In
docs/mcp/index.md
, add a brief description of theforecast
tool's capabilities. - In
docs/tutorials/agent-team.md
, update the "Next Steps" section to include a suggestion to "add a 'forecast' agent".
Reasoning:
These changes will improve the visibility and encourage the use of the newforecast
tool.Reference:
- google/adk-python@0935a40
- src/google/adk/tools/bigquery/query_tool.py
- In
-
[API] Update API reference docs.
The API reference docs should be updated to reflect the latest changes in the codebase.Proposed Change:
Regenerate the API reference docs to include the following changes:- The new
embedding_model
parameter in theFilesRetrieval
class. - The new
GkeCodeExecutor
class. - The new
ToolConfirmation
class and related changes. - The
App
class. - All other new classes, methods, and parameters.
Reasoning:
Keeping the API reference docs up-to-date is crucial for developers using the ADK.Reference:
- google/adk-python@67f23df
- src/google/adk/tools/retrieval/files_retrieval.py
- The new