|
18 | 18 | </h3> |
19 | 19 | </html> |
20 | 20 |
|
21 | | -**⚠️ Unofficial Port & Experimental Status:** This is an unofficial TypeScript port of the [Google ADK Python library](https://github.com/google/adk-python). It's currently in an experimental (alpha) stage, so some features and APIs may be unstable or contain bugs. |
| 21 | +**⚠️ Unofficial Port & Experimental Status:** This is an unofficial TypeScript port of the [Google ADK Python library](https://github.com/google/adk-python). Currently in alpha - APIs may change. |
22 | 22 |
|
23 | | -**Agent Development Kit (ADK)** for TypeScript is a flexible and modular framework for developing and deploying AI agents. While optimized for Gemini and the Google ecosystem, ADK is model-agnostic, deployment-agnostic, and is built for compatibility with other frameworks. ADK was designed to make agent development feel more like software development, to make it easier for developers to create, deploy, and orchestrate agentic architectures that range from simple tasks to complex workflows. |
| 23 | +**ADK TypeScript** is a code-first framework for building and deploying AI agents. Optimized for Gemini but model-agnostic. Build agents like software: modular, testable, and production-ready. |
24 | 24 |
|
25 | 25 |
|
26 | 26 | --- |
27 | 27 |
|
28 | 28 | ## ✨ Key Features |
29 | 29 |
|
30 | | -- **Rich Tool Ecosystem**: Utilize pre-built tools, custom functions, |
31 | | - OpenAPI specs, or integrate existing tools to give agents diverse |
32 | | - capabilities, all for tight integration with the Google ecosystem. |
| 30 | +- **Code-First Development**: Define agents, tools, and orchestration in TypeScript. Full control, testability, and version management. |
33 | 31 |
|
34 | | -- **Code-First Development**: Define agent logic, tools, and orchestration |
35 | | - directly in TypeScript for ultimate flexibility, testability, and versioning. |
| 32 | +- **Rich Tool Ecosystem**: Pre-built tools, custom functions, OpenAPI specs. Tight Google ecosystem integration. |
36 | 33 |
|
37 | | -- **Modular Multi-Agent Systems**: Design scalable applications by composing |
38 | | - multiple specialized agents into flexible hierarchies. |
| 34 | +- **Multi-Agent Systems**: Compose specialized agents into scalable hierarchies. |
39 | 35 |
|
40 | | -- **Deploy Anywhere**: Easily containerize and deploy agents on Cloud Run or |
41 | | - scale with other cloud platforms. |
| 36 | +- **Deploy Anywhere**: Cloud Run, Docker, or any platform. Your choice. |
42 | 37 |
|
43 | | -- **Integrated Developer Tooling**: Develop and iterate locally with ease using the included CLI (`npx adk`) and Developer UI (`npx adk web`) for running agents, inspecting execution (`Event` stream), debugging, and visualizing agent graphs (`npx adk graph`). |
| 38 | +- **Developer Tooling**: CLI (`npx adk`), Web UI (`npx adk web`), graph visualization, and execution inspection. |
44 | 39 |
|
45 | | -- **Native Streaming Support**: Build real-time, interactive experiences with native support for bidirectional streaming (text, potentially audio/video) using `Runner.runLive` and `LiveRequestQueue`. |
| 40 | +- **Native Streaming**: Bidirectional streaming support via `Runner.runLive` and `LiveRequestQueue`. |
46 | 41 |
|
47 | | -- **Built-in Agent Evaluation**: Assess agent performance systematically with the `evaluation` module (`AgentEvaluator`). Create multi-turn evaluation datasets (`.test.json` files) and run evaluations locally via the CLI (`npx adk eval`). |
| 42 | +- **Built-in Evaluation**: Test agents with `.test.json` datasets via `npx adk eval`. |
48 | 43 |
|
49 | 44 | ## 🚀 Installation |
50 | 45 |
|
@@ -218,7 +213,7 @@ npx adk deploy cloud_run <path_to_agent_folder> --project <your-gcp-project> --r |
218 | 213 |
|
219 | 214 | ## 🤝 Contributing |
220 | 215 |
|
221 | | -We welcome contributions from the community! As this is a work-in-progress port, contributions are especially valuable. Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our [**Contributing Guidelines**](./CONTRIBUTING.md) (Link may need updating for TypeScript specifics) to get started. |
| 216 | +Contributions welcome! This is a community-driven port. Bug reports, features, docs, and code all appreciated. See [**Contributing Guidelines**](./CONTRIBUTING.md). |
222 | 217 |
|
223 | 218 | ## 📄 License |
224 | 219 |
|
|
0 commit comments