|
1 | | -# agentkit-samples |
| 1 | +<div align="center"> |
| 2 | + <h1> |
| 3 | + AgentKit Platform Python Samples |
| 4 | + </h1> |
| 5 | + |
| 6 | + <div align="center"> |
| 7 | + <a href="https://github.com/volcengine/agentkit-samples/graphs/commit-activity"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/volcengine/agentkit-samples"/></a> |
| 8 | + <a href="https://github.com/volcengine/agentkit-samples/pulls"><img alt="GitHub open pull requests" src="https://img.shields.io/github/issues-pr/volcengine/agentkit-samples"/></a> |
| 9 | + <a href="https://github.com/volcengine/agentkit-samples/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/volcengine/agentkit-samples"/></a> |
| 10 | + <a href="https://python.org"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/agentkit-sdk-python"/></a> |
| 11 | + </div> |
| 12 | + |
| 13 | + <p> |
| 14 | + <a href="https://console.volcengine.com/agentkit/"> Volcengine AgentKit</a> |
| 15 | + ◆ <a href="https://volcengine.github.io/agentkit-sdk-python/">SDK/CLI Documentation</a> |
| 16 | + ◆ <a href="https://github.com/volcengine/agentkit-samples/tree/main">Samples</a> |
| 17 | + ◆ <a href="https://pypi.org/project/agentkit-sdk-python/">PyPI Package</a> |
| 18 | + ◆ <a href="https://github.com/volcengine/agentkit-sdk-python">SDK/CLI GitHub</a> |
| 19 | + |
| 20 | + </p> |
| 21 | +</div> |
| 22 | + |
| 23 | +# AgentKit Samples |
| 24 | + |
| 25 | +Welcome to the AgentKit Samples repository! |
| 26 | + |
| 27 | +AgentKit is an enterprise-level AI Agent development platform launched by Volcengine, providing developers with complete solutions for Agent construction, deployment, and operation. Through standardized development toolchains and cloud-native infrastructure, the platform significantly lowers the development and deployment threshold for complex intelligent agent applications. |
| 28 | + |
| 29 | +This repository contains a collection of examples and tutorials to help you understand, implement, and integrate AgentKit functionalities into your applications. |
| 30 | + |
| 31 | +## Project Structure |
| 32 | +```bash |
| 33 | +. |
| 34 | +├── 01-tutorials |
| 35 | +│ └── README.md |
| 36 | +├── 02-use-cases |
| 37 | +│ ├── ai_coding |
| 38 | +│ ├── beginner |
| 39 | +│ │ ├── a2a_simple |
| 40 | +│ │ ├── callback |
| 41 | +│ │ ├── episode_generation |
| 42 | +│ │ ├── hello_world |
| 43 | +│ │ ├── mcp_simple |
| 44 | +│ │ ├── multi_agents |
| 45 | +│ │ ├── restaurant_ordering |
| 46 | +│ │ ├── travel_concierge |
| 47 | +│ │ ├── vikingdb |
| 48 | +│ │ ├── vikingmem |
| 49 | +│ │ └── README.md |
| 50 | +│ ├── customer_support |
| 51 | +│ └── video_gen |
| 52 | +├── README.md |
| 53 | +└── README.zh.md |
| 54 | +``` |
| 55 | + |
| 56 | +### 01-tutorials/ - Interactive Learning & Fundamentals (Coming Soon) |
| 57 | + |
| 58 | +This folder will contain tutorial-based learning materials that teach AgentKit's core functionalities through practical examples. |
| 59 | + |
| 60 | +**Component Categories:** |
| 61 | + |
| 62 | +- **Runtime**: AgentKit runtime environment, providing secure and scalable agent deployment capabilities |
| 63 | +- **Gateway**: Tool gateway, automatically converting APIs and external services into agent-usable tools |
| 64 | +- **Memory**: Agent memory management, supporting cross-session, context-aware, and personalized interactions |
| 65 | +- **Identity**: Agent identity authentication and permission control, building security trust mechanisms across the user→Agent→tool chain |
| 66 | +- **Tools**: Built-in toolset, including code interpreter and browser tools |
| 67 | +- **Observability**: Agent observability, providing tracing, debugging, and monitoring capabilities |
| 68 | + |
| 69 | +These examples are perfect for beginners and users who want to understand core concepts before building actual agent applications. |
| 70 | + |
| 71 | +### 02-use-cases/ - End-to-End Application Examples |
| 72 | + |
| 73 | +Explore practical business scenario implementations that demonstrate how to apply AgentKit functionalities to solve real-world business problems. |
| 74 | + |
| 75 | +**Current Use Cases:** |
| 76 | + |
| 77 | +- **ai_coding/**: AI coding assistant, helping developers write and optimize code |
| 78 | +- **beginner/**: Beginner-level examples, from basic to advanced agent development |
| 79 | +- **customer_support/**: Customer support agent, providing automated after-sales consulting and pre-sales guidance |
| 80 | +- **video_gen/**: Video generation agent, combining multiple tools for video content creation |
| 81 | + |
| 82 | +Each use case includes complete implementations with detailed explanations on how to combine AgentKit components to build applications. |
| 83 | + |
| 84 | +## Quick Start |
| 85 | + |
| 86 | +### Prerequisites |
| 87 | + |
| 88 | +- Python 3.10+ |
| 89 | +- AgentKit SDK |
| 90 | +- Optional: Docker (for containerized deployment) |
| 91 | + |
| 92 | +### Installation |
| 93 | + |
| 94 | +All examples require you to first install the AgentKit SDK [Installation Reference](https://volcengine.github.io/agentkit-sdk-python/content/1.introduction/2.installation.html) |
| 95 | + |
| 96 | +## Development Guide |
| 97 | + |
| 98 | +### Code Structure |
| 99 | + |
| 100 | +Each example follows the standard AgentKit application structure: |
| 101 | + |
| 102 | +``` |
| 103 | +Example Directory/ |
| 104 | +├── agent.py # Agent main program |
| 105 | +├── requirements.txt # Dependency list |
| 106 | +├── config/ # Configuration files |
| 107 | +└── README.md # Detailed instructions |
| 108 | +``` |
| 109 | + |
| 110 | +### Best Practices |
| 111 | + |
| 112 | +1. **Modular Design**: Separate tools, agents, and configurations |
| 113 | +2. **Error Handling**: Implement comprehensive exception handling |
| 114 | +3. **Logging**: Use structured logging for easier debugging |
| 115 | +4. **Configuration Management**: Use environment variables and config files |
| 116 | + |
| 117 | +## Contributing |
| 118 | + |
| 119 | +We welcome community contributions! If you have new examples or improvement suggestions, please: |
| 120 | + |
| 121 | +1. Fork this repository |
| 122 | +2. Create a feature branch (`git checkout -b feature/amazing-example`) |
| 123 | +3. Commit your changes (`git commit -m 'Add amazing example'`) |
| 124 | +4. Push to the branch (`git push origin feature/amazing-example`) |
| 125 | +5. Create a Pull Request |
| 126 | + |
| 127 | +## License |
| 128 | +This project is licensed under the [Apache 2.0 License](./LICENSE) |
| 129 | + |
| 130 | +## Support & Feedback |
| 131 | + |
| 132 | +- **Documentation**: Check [AgentKit Official Documentation](https://www.volcengine.com/docs/86681/1844823?lang=zh) |
| 133 | +- **Issues**: Report problems in GitHub Issues |
| 134 | + |
| 135 | +## Related Resources |
| 136 | + |
| 137 | +- [AgentKit Official Website](https://www.volcengine.com/docs/86681/1844823?lang=zh) |
| 138 | +- [AgentKit SDK/CLI Documentation](https://volcengine.github.io/agentkit-sdk-python/) |
| 139 | +- [veadk Official Documentation](https://volcengine.github.io/veadk-python/) |
| 140 | + |
| 141 | +--- |
| 142 | + |
| 143 | +**Start exploring the powerful capabilities of AgentKit! Choose an example that interests you, follow the tutorials, and build your own agent applications.** |
0 commit comments