Skip to content

Found docs updates needed from ADK python release v1.13.0 to v1.14.0 #689

@adk-bot

Description

@adk-bot

Here are the recommended documentation updates based on the changes in the ADK Python release from v1.13.0 to v1.14.0.

  1. [Core] Update docs to use App class with Runner.
    The Runner class now takes an App object in its constructor instead of app_name and agent. The App object encapsulates the root_agent and plugins. This is a fundamental change that affects many parts of the documentation.

    Proposed Change:
    Update all code examples and documentation that use the Runner to instantiate it with an App 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 the App class as the top-level container for an agentic system.

    Reference:

  2. [A2A] Document the agent_card parameter in to_a2a function.
    The to_a2a function now accepts a pre-built AgentCard 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 in docs/a2a/quickstart-exposing.md only mentions the auto-generation of the agent card.

    Proposed Change:
    Update docs/a2a/quickstart-exposing.md to include information about the agent_card parameter in the to_a2a function. Provide examples of how to use it with a pre-built AgentCard 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 the to_a2a function.

    Reference:

  3. [Tools] Add documentation for GkeCodeExecutor.
    The GkeCodeExecutor is a new feature that allows for sandboxed code execution on GKE. The existing documentation in docs/tools/built-in-tools.md is incomplete.

    Proposed Change:
    Expand the section on GkeCodeExecutor in docs/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 new GkeCodeExecutor and guide users on how to use it for secure code execution.

    Reference:

  4. [Tools] Document the audience parameter for OAuth2Auth.
    The OAuth2Auth class now accepts an audience parameter, which can be used to specify the audience for the OAuth flow. This is not documented in docs/tools/authentication.md.

    Proposed Change:
    Update docs/tools/authentication.md to include information about the audience parameter in the OAuth2Auth class.

    Reasoning:
    This change is necessary to document the new audience parameter and its usage in OAuth flows.

    Reference:

  5. [Tools] Enhance documentation for the BigQuery forecast tool.
    The new BigQuery forecast tool is mentioned in docs/mcp/index.md but could be highlighted more. The "Next Steps" section of docs/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 the forecast 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 new forecast tool.

    Reference:

  6. [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 the FilesRetrieval 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:

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions