Volcengine Agent Development Kit Logo

License Deepwiki

An open-source kit for agent development, integrated the powerful capabilities of Volcengine.

For more details, see our documents.

A tutorial is available by Jupyter Notebook, or open it in Google Colab directly.

pip install veadk-python
# install extensions
pip install veadk-python[extensions]

We use uv to build this project (how-to-install-uv).

git clone ... # clone repo first
cd veadk-python
# create a virtual environment with python 3.12
uv venv --python 3.12
# only install necessary requirements
uv sync
# or, install extra requirements
# uv sync --extra database
# uv sync --extra eval
# uv sync --extra cli
# or, directly install all requirements
# uv sync --all-extras
# install veadk-python with editable mode
uv pip install -e .

We recommand you to create a config.yaml file in the root directory of your own project, VeADK is able to read it automatically. For running a minimal agent, you just need to set the following configs in your config.yaml file:

model:
 agent:
 provider: openai
 name: doubao-seed-1-6-250615
 api_base: https://ark.cn-beijing.volces.com/api/v3/
 api_key: # <-- set your Volcengine ARK api key here

You can refer to the config instructions for more details.

Enjoy a minimal agent from VeADK:

from veadk import Agent
import asyncio
agent = Agent()
res = asyncio.run(agent.run("hello!"))
print(res)

VeADK provides several useful command line tools for faster deployment and optimization, such as:

• veadk deploy: deploy your project to Volcengine VeFaaS platform (you can use veadk init to init a demo project first)
• veadk prompt: otpimize the system prompt of your agent by PromptPilot

Before making your contribution to our repository, please install and config the pre-commit linter first.

pip install pre-commit
pre-commit install

Before commit or push your changes, please make sure the unittests are passed ,otherwise your PR will be rejected by CI/CD workflow. Running the unittests by:

pytest -n 16

Join our discussion group by scanning the QR code below:

Volcengine Agent Development Kit Logo

This project is licensed under the Apache 2.0 License.