Found docs updates needed from ADK python release v1.21.0 to v1.22.0

[xuanyang15]

Compare Link

This release includes several documentation updates.

---

1. Create new documentation for the Pub/Sub tool

Doc file: docs/tools/google-cloud/pubsub.md

Proposed Change:

Create a new documentation file for the Pub/Sub tool. This file should include:

• An overview of the Pub/Sub tool and its capabilities.
• Instructions on how to install and configure the tool.
• Detailed documentation for each function in the PubSubToolset: publish_message, pull_messages, and acknowledge_messages.
• A complete code example of how to use the PubSubToolset in an agent.

Reasoning:
The new Pub/Sub tool is a significant addition to the ADK and requires comprehensive documentation to enable users to understand and use it effectively. A dedicated documentation page is the best way to provide this information.

Reference: src/google/adk/tools/pubsub/pubsub_toolset.py

---

2. Add Pub/Sub tool to the main tools index

Doc file: docs/tools/index.md

Current state:

The page docs/tools/index.md does not list the Pub/Sub tool.

Proposed Change:

Add a new card to the "Google Cloud tools" section for the Pub/Sub tool. The card should link to the new docs/tools/google-cloud/pubsub.md page and have a brief description of the tool.

Reasoning:
To make the new Pub/Sub tool discoverable to users, it should be included in the main tools index.

Reference: src/google/adk/tools/pubsub/pubsub_toolset.py

---

3. Add Pub/Sub tool to the Google Cloud tools index

Doc file: docs/tools/google-cloud/index.md

Current state:

The page docs/tools/google-cloud/index.md does not list the Pub/Sub tool.

Proposed Change:

Add a new card to the docs/tools/google-cloud/index.md page for the Pub/Sub tool. The card should link to the new docs/tools/google-cloud/pubsub.md page and have a brief description of the tool.

Reasoning:
To make the new Pub/Sub tool discoverable to users browsing Google Cloud tools, it should be included in the Google Cloud tools index.

Reference: src/google/adk/tools/pubsub/pubsub_toolset.py

---

4. Update Agent Config documentation to include PubSubToolset

Doc file: docs/agents/config.md

Current state:

The docs/agents/config.md page does not list PubSubToolset as a supported tool for Agent Config.

Proposed Change:

Add PubSubToolset to the list of supported ADK tools for the Agent Config feature.

Reasoning:
The new PubSubToolset should be usable with Agent Config. Updating the documentation will inform users of this new capability.

Reference: src/google/adk/tools/pubsub/pubsub_toolset.py

---

5. Document new database schema and migration process

Doc file: docs/sessions/session.md

Proposed Change:

Add a new section titled 'Database Schema and Migration' to the docs/sessions/session.md page. This section should explain the new v1 database schema, the deprecation of the v0 pickle-based schema, and provide instructions on how to use the new adk migrate session command to migrate data from the old schema to the new one.

Reasoning:
The new database schema is a significant change that requires documentation. Users need to be aware of the new schema and how to migrate their existing data to avoid data loss and ensure compatibility with the latest version of the ADK.

Reference: src/google/adk/sessions/migration/migration_runner.py

---

6. Add link to migration guide in sessions index

Doc file: docs/sessions/index.md

Current state:

The docs/sessions/index.md page does not mention database schema migration.

Proposed Change:

Add a new item to the list of topics in docs/sessions/index.md for 'Database Schema Migration'. This item should link to the new 'Database Schema and Migration' section in docs/sessions/session.md.

Reasoning:
To make the new database schema migration documentation discoverable, it should be linked from the main sessions documentation page.

Reference: src/google/adk/sessions/migration/migration_runner.py

---

7. Update DatabaseSessionService docs with new schema info

Doc file: docs/sessions/session.md

Current state:

The DatabaseSessionService section in docs/sessions/session.md does not mention the new JSON-based schema.

Proposed Change:

Update the DatabaseSessionService section in docs/sessions/session.md to mention that the latest version of the ADK uses a JSON-based schema for storing event data, replacing the previous pickle-based schema.

Reasoning:
Users should be aware of the new serialization format used by the DatabaseSessionService as it can impact how they interact with the database directly.

Reference: src/google/adk/sessions/schemas/v1.py

---

8. Enhance documentation for per_turn_user_simulator_quality_v1 metric

Doc file: docs/evaluate/criteria.md

Proposed Change:

The per_turn_user_simulator_quality_v1 section should be updated to provide more details about the metric. This includes explaining the new LlmBackedUserSimulatorCriterion, the role of the stop_signal, and how the LLM as a judge is used to evaluate the simulator's performance on a per-turn basis. The documentation should also clarify how the final score is calculated.

Reasoning:
The new per_turn_user_simulator_quality_v1 metric is a powerful tool for evaluating user simulators, and the documentation should provide a clear and comprehensive explanation of how it works to enable users to use it effectively.

Reference: src/google/adk/evaluation/simulation/per_turn_user_simulator_quality_v1.py

---

9. Add per_turn_user_simulator_quality_v1 to evaluation criteria list

Doc file: docs/evaluate/index.md

Current state:

The page docs/evaluate/index.md does not list the per_turn_user_simulator_quality_v1 metric.

Proposed Change:

Add per_turn_user_simulator_quality_v1 to the list of evaluation criteria. The description should mention that this metric evaluates the quality of a user simulator on a per-turn basis using an LLM as a judge.

Reasoning:
To make the new per_turn_user_simulator_quality_v1 metric discoverable to users, it should be included in the main evaluation criteria list.

Reference: src/google/adk/evaluation/eval_metrics.py

---

10. Update user simulation documentation with custom_instructions and new quality metric

Doc file: docs/evaluate/user-sim.md

Current state:

The docs/evaluate/user-sim.md page does not mention the custom_instructions field in LlmBackedUserSimulatorConfig or the per_turn_user_simulator_quality_v1 metric.

Proposed Change:

Update the docs/evaluate/user-sim.md page to include:

• A new section explaining the custom_instructions field in LlmBackedUserSimulatorConfig, which allows users to provide their own instructions to the user simulator.
• A new section on evaluating the user simulator's quality, which introduces the per_turn_user_simulator_quality_v1 metric and explains how it can be used.

Reasoning:
Users should be aware of the new custom_instructions feature to customize the user simulator's behavior and the per_turn_user_simulator_quality_v1 metric to evaluate its performance.

Reference: src/google/adk/evaluation/simulation/llm_backed_user_simulator.py