Update README.md (#107)

update read me and add feature highlights
This commit is contained in:
Hangfei Lin 2025-04-11 22:49:13 -07:00 committed by GitHub
parent ee2a75368a
commit eecb9e65be
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 59 additions and 41 deletions

100
README.md
View File

@ -16,22 +16,30 @@
</h3> </h3>
</html> </html>
The Agent Development Kit (ADK) is designed for developers seeking fine-grained control and flexibility when building advanced AI agents that are tightly integrated with services in Google Cloud. It allows you to define agent behavior, orchestration, and tool use directly in code, enabling robust debugging, versioning, and deployment anywhere from your laptop to the cloud. Agent Development Kit (ADK) is designed for developers seeking fine-grained
control and flexibility when building advanced AI agents that are tightly
integrated with services in Google Cloud. It allows you to define agent
behavior, orchestration, and tool use directly in code, enabling robust
debugging, versioning, and deployment anywhere from your laptop to the cloud.
--- ---
## ✨ Key Features ## ✨ Key Features
* **Code-First Development:** Define agents, tools, and orchestration logic for maximum control, testability, and versioning. - **Rich Tool Ecosystem**: Utilize pre-built tools, custom functions,
* **Multi-Agent Architecture:** Build modular and scalable applications by composing multiple specialized agents in flexible hierarchies. OpenAPI specs, or integrate existing tools to give agents diverse
* **Rich Tool Ecosystem:** Equip agents with diverse capabilities using pre-built tools, custom Python functions, API specifications, or integrating existing tools. capabilities, all for tight integration with the Google ecosystem.
* **Flexible Orchestration:** Define workflows using built-in agents for predictable pipelines, or leverage LLM-driven dynamic routing for adaptive behavior.
* **Integrated Developer Experience:** Develop, test, and debug locally with a CLI and visual web UI. - **Code-First Development**: Define agent logic, tools, and orchestration
* **Built-in Evaluation:** Measure agent performance by evaluating response quality and step-by-step execution trajectory. directly in Python for ultimate flexibility, testability, and versioning.
* **Deployment Ready:** Containerize and deploy your agents anywhere scale with Vertex AI Agent Engine, Cloud Run, or Docker.
* **Native Streaming Support:** Build real-time, interactive experiences with native support for bidirectional streaming (text and audio). - **Modular Multi-Agent Systems**: Design scalable applications by composing
* **State, Memory & Artifacts:** Manage short-term conversational context, configure long-term memory, and handle file uploads/downloads. multiple specialized agents into flexible hierarchies.
* **Extensibility:** Customize agent behavior deeply with callbacks and easily integrate third-party tools and services.
- **Deploy Anywhere**: Easily containerize and deploy agents on Cloud Run or
scale seamlessly with Vertex AI Agent Engine.
## 🚀 Installation ## 🚀 Installation
@ -40,59 +48,65 @@ You can install the ADK using `pip`:
```bash ```bash
pip install google-adk pip install google-adk
``` ```
## 📚 Documentation
## 🔑 Setup API Key Explore the full documentation for detailed guides on building, evaluating, and
deploying agents:
Follow this [guide](https://google.github.io/adk-docs/agents/models/) to get and setup your key. * **[Documentation](https://google.github.io/adk-docs)**
## 🏁 Getting Started ## 🏁 Feature Highlight
Create your first agent (`my_agent/agent.py`):
### Define a single agent:
```python ```python
# my_agent/agent.py
from google.adk.agents import Agent from google.adk.agents import Agent
from google.adk.tools import google_search from google.adk.tools import google_search
root_agent = Agent( root_agent = Agent(
name="search_assistant", name="search_assistant",
model="gemini-2.0-flash-exp", # Or your preferred Gemini model model="gemini-2.0-flash", # Or your preferred Gemini model
instruction="You are a helpful assistant. Answer user questions using Google Search when needed.", instruction="You are a helpful assistant. Answer user questions using Google Search when needed.",
description="An assistant that can search the web.", description="An assistant that can search the web.",
tools=[google_search] tools=[google_search]
) )
``` ```
Create `my_agent/__init__.py`: ### Define a multi-agent system:
Define a multi-agent system with cooridnator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.
```python ```python
# my_agent/__init__.py from google.adk.agents import LlmAgent, BaseAgent
from . import agent
# Define individual agents
greeter = LlmAgent(name="Greeter", model="gemini-2.0-flash")
task_exectuor = CustomAgent(name="TaskExecutor") # A subclass of BaseAgent, as a Non-LLM agent.
# Create parent agent and assign children via sub_agents
coordinator = LlmAgent(
name="Coordinator",
model="gemini-2.0-flash",
description="I coordinate greetings and tasks.",
sub_agents=[ # Assign sub_agents here
greeter,
task_exectuor
]
)
``` ```
Run it via the CLI (from the directory *containing* `my_agent`): ### Development UI
A built-in development UI to help you test, evaluate, debug, and showcase your agent(s).
<img src="assets/adk-web-dev-ui-function-call.png"/>
### Evaluate Agents
```bash ```bash
adk run my_agent adk eval \
samples_for_testing/hello_world \
samples_for_testing/hello_world/hello_world_eval_set_001.evalset.json
``` ```
Or launch the Web UI from the folder that contains `my_agent` folder:
```bash
adk web
```
For a full step-by-step guide, check out the [quickstart](https://google.github.io/adk-docs/get-started/quickstart/) or [sample agents](https://github.com/google/adk-samples).
## 📚 Resources
Explore the full documentation for detailed guides on building, evaluating, and deploying agents:
* **[Get Started](https://google.github.io/adk-docs/get-started/)**
* **[Browse Sample Agents](https://github.com/google/adk-samples)**
* **[Evaluate Agents](https://google.github.io/adk-docs/evaluate/)**
* **[Deploy Agents](https://google.github.io/adk-docs/deploy/)**
* **[API Reference](https://google.github.io/adk-docs/api-reference/)**
## 🤝 Contributing ## 🤝 Contributing
@ -102,6 +116,10 @@ We welcome contributions from the community! Whether it's bug reports, feature r
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
## Preview
This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products?hl=en#product-launch-stages).
--- ---
*Happy Agent Building!* *Happy Agent Building!*

Binary file not shown.

After

Width:  |  Height:  |  Size: 463 KiB