Skip to content

Commit c2058f3

Browse files
hangfeicopybara-github
authored andcommitted
chore: adk Add more documentations for ADK live feature in ADK.md
Also added commit message guidelines. PiperOrigin-RevId: 783450329
1 parent 94dc037 commit c2058f3

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

AGENTS.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ The Agent Development Kit (ADK) is an open-source, code-first Python toolkit for
1010

1111
Please refer to [ADK Project Overview and Architecture](https://github.com/google/adk-python/blob/main/contributing/adk_project_overview_and_architecture.md) for details.
1212

13+
### ADK Live (Bidi-streaming)
14+
15+
- ADK live feature can be accessed from runner.run_live(...) and corresponding FAST api endpoint.
16+
- ADK live feature is built on top of [Gemini Live API](https://cloud.google.com/vertex-ai/generative-ai/docs/live-api). We integrate Gemini Live API through [GenAI SDK](https://github.com/googleapis/python-genai).
17+
- ADK live related configs are in [run_config.py](https://github.com/google/adk-python/blob/main/src/google/adk/agents/run_config.py).
18+
- ADK live under multi-agent scenario: we convert the audio into text. This text will be passed to next agent as context.
19+
- Most logics are in [base_llm_flow.py](https://github.com/google/adk-python/blob/main/src/google/adk/flows/llm_flows/base_llm_flow.py) and [gemini_llm_connection.py](https://github.com/google/adk-python/blob/main/src/google/adk/models/gemini_llm_connection.py).
20+
- Tests are in [tests/unittests/streaming](https://github.com/google/adk-python/tree/main/tests/unittests/streaming).
21+
1322
## ADK: Style Guides
1423

1524
### Python Style Guide
@@ -200,4 +209,11 @@ The following changes are considered breaking and necessitate a MAJOR version
200209
(e.g., the switch from snake_case to camelCase for all JSON payloads).
201210

202211
- Dependency Removal: Removing support for a previously integrated third-party
203-
library or tool type.
212+
library or tool type.
213+
214+
## Commit Message Format
215+
216+
- Please use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
217+
format.
218+
- If it's not a breaking change, please add #non-breaking tag. If it's a
219+
breaking change, please add #breaking.

0 commit comments

Comments
 (0)