diff --git a/python/01-tutorials/01-agentkit-runtime/a2a_simple/README_en.md b/python/01-tutorials/01-agentkit-runtime/a2a_simple/README_en.md index 8498bf54..502e9fa0 100644 --- a/python/01-tutorials/01-agentkit-runtime/a2a_simple/README_en.md +++ b/python/01-tutorials/01-agentkit-runtime/a2a_simple/README_en.md @@ -402,7 +402,7 @@ None. - [VeADK Official Documentation](https://volcengine.github.io/veadk-python/) - [AgentKit Development Guide](https://volcengine.github.io/agentkit-sdk-python/) - [A2A Protocol Specification](https://github.com/google/adk) -- [Volcano Ark Model Service](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0&briefType=introduce&type=new&projectName=default) +- [BytePlus Ark Model Service](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) ## License diff --git a/python/01-tutorials/01-agentkit-runtime/image_video_tools/README_en.md b/python/01-tutorials/01-agentkit-runtime/image_video_tools/README_en.md index 21dc3801..433daa35 100644 --- a/python/01-tutorials/01-agentkit-runtime/image_video_tools/README_en.md +++ b/python/01-tutorials/01-agentkit-runtime/image_video_tools/README_en.md @@ -350,7 +350,7 @@ None. - [VeADK Official Documentation](https://volcengine.github.io/veadk-python/) - [AgentKit Development Guide](https://volcengine.github.io/agentkit-sdk-python/) -- [Volcano Ark Model Service](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0&briefType=introduce&type=new&projectName=default) +- [BytePlus Ark Model Service](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - [Video Generation Tool Documentation](https://volcengine.github.io/veadk-python/tools/builtin/#video-generate) ## Code License diff --git a/python/01-tutorials/01-agentkit-runtime/mcp_simple/README_en.md b/python/01-tutorials/01-agentkit-runtime/mcp_simple/README_en.md index 7c3fa7b3..e42414a6 100644 --- a/python/01-tutorials/01-agentkit-runtime/mcp_simple/README_en.md +++ b/python/01-tutorials/01-agentkit-runtime/mcp_simple/README_en.md @@ -202,7 +202,7 @@ None - [VeADK Official Documentation](https://volcengine.github.io/veadk-python/) - [AgentKit Development Guide](https://volcengine.github.io/agentkit-sdk-python/) -- [Volcengine Ark Model Service](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0&briefType=introduce&type=new&projectName=default) +- [BytePlus Ark Model Service](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - [MCP Protocol Specification](https://modelcontextprotocol.io) - [Volcengine MCP Marketplace](https://www.volcengine.com/mcp-marketplace) - [TOS Object Storage Documentation](https://www.volcengine.com/docs/tos) diff --git a/python/01-tutorials/01-agentkit-runtime/multi_agents/README_en.md b/python/01-tutorials/01-agentkit-runtime/multi_agents/README_en.md index 27a1c55a..d5f72f65 100644 --- a/python/01-tutorials/01-agentkit-runtime/multi_agents/README_en.md +++ b/python/01-tutorials/01-agentkit-runtime/multi_agents/README_en.md @@ -484,7 +484,7 @@ None. - [VeADK Official Documentation](https://volcengine.github.io/veadk-python/) - [AgentKit Development Guide](https://volcengine.github.io/agentkit-sdk-python/) -- [Volcano Ark Model Service](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0&briefType=introduce&type=new&projectName=default) +- [BytePlus Ark Model Service](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) ## License diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/README_en.md b/python/01-tutorials/04-agentkit-tools/skills_sandbox/README_en.md index bcf48be1..30d11351 100644 --- a/python/01-tutorials/04-agentkit-tools/skills_sandbox/README_en.md +++ b/python/01-tutorials/04-agentkit-tools/skills_sandbox/README_en.md @@ -163,7 +163,7 @@ uv run client.py - Tool type selection: Preset Tool -> Skill Sandbox -![Skill Sandbox Creation](assets/images/skill-sandbox-iam-role.jpeg) +![Skill Sandbox Creation](assets/images_en/skill-sandbox-iam-role.png) **4. Set Environment Variables:** @@ -245,12 +245,12 @@ table th:nth-of-type(3) { | Example Prompt | Screenshot | | -------- | ------- | -| Please run the following workflow: 1. Help me write a pdf processing skill that can support loading pdfs, editing pdfs, and extracting text from pdfs; 2. Register the written skill to the skill space. | ![Create skill screenshot](assets/images/create.jpeg) | -| Please run the following workflow: 1. Use the veadk-python skill to write a VeADK Agent that can respond to the question 'hello'. 2. Execute the code to ensure there are no problems; 3. Send me the verified code. | ![veadk skill screenshot](assets/images/veadk-skill.png) | -| Use the internal-comms skill to help me write a 3p communication material to notify the 3p team of project progress updates. Regarding the product team, it mainly includes the problems of the past week and the plan for the next week, specifically including the problems: write down the customer problems encountered by the product team (1. GPU+model inference framework performance is lower than the open source version, such as high latency and low throughput; 2. GPU inference tools are difficult to use), and how to solve them; plan: how to plan GPU product functions and performance optimization next year (1. Focus on GPU infrastructure support for image and video generation models; 2. Improve the usability of GPU inference related toolchains). Other content can be organized as appropriate. | ![internal-comms skill screenshot](assets/images/internal-comms-skill.jpeg) | -| Please run the following workflow: 1. Use the canvas-design skill to help me create an art drawing based on geometric shapes. 2. Use the tos-file-access skill to upload the product to the bucket {YOUR_TOS_BUCKET_NAME}. | ![canvas-design skill screenshot](assets/images/cavas-design-skill.jpeg) | -| I need a vegan high-protein recipe for 2 people, with the goal of muscle gain. The weekly budget is 350 yuan, and I like quick dishes that take less than 30 minutes. I don't like mushrooms. Use the healthy-meal-planner skill to help me create a one-week meal plan. | ![healthy-meal-planner skill screenshot](assets/images/health-meal-planner-skill.jpeg) | -| Please run the following workflow: 1. I need a vegan high-protein recipe for 2 people, with the goal of muscle gain. The weekly budget is 350 yuan, and I like quick dishes that take less than 30 minutes. I don't like mushrooms. Use the healthy-meal-planner skill to help me create a one-week meal plan. 2. Write the prepared meal plan to the file recipe.md, then use the tos-file-access skill to upload this file to the bucket {YOUR_TOS_BUCKET_NAME}, and finally send me the link to the uploaded file. | ![healthy-meal-planner skill upload result to TOS screenshot](assets/images/health-meal-planner-skill-tos.png) | +| Please run the following workflow: 1. Help me write a pdf processing skill that can support loading pdfs, editing pdfs, and extracting text from pdfs; 2. Register the written skill to the skill space. | ![Create skill screenshot](assets/images_en/create.png) | +| Please run the following workflow: 1. Use the veadk-python skill to write a VeADK Agent that can respond to the question 'hello'. 2. Execute the code to ensure there are no problems; 3. Send me the verified code. | ![veadk skill screenshot](assets/images_en/veadk-skill.png) | +| Use the internal-comms skill to help me write a 3p communication material to notify the 3p team of project progress updates. Regarding the product team, it mainly includes the problems of the past week and the plan for the next week, specifically including the problems: write down the customer problems encountered by the product team (1. GPU+model inference framework performance is lower than the open source version, such as high latency and low throughput; 2. GPU inference tools are difficult to use), and how to solve them; plan: how to plan GPU product functions and performance optimization next year (1. Focus on GPU infrastructure support for image and video generation models; 2. Improve the usability of GPU inference related toolchains). Other content can be organized as appropriate. | ![internal-comms skill screenshot](assets/images_en/internal-comms-skill.png) | +| Please run the following workflow: 1. Use the canvas-design skill to help me create an art drawing based on geometric shapes. 2. Use the tos-file-access skill to upload the product to the bucket {YOUR_TOS_BUCKET_NAME}. | ![canvas-design skill screenshot](assets/images_en/canvas-design-skill.png) | +| I need a vegan high-protein recipe for 2 people, with the goal of muscle gain. The weekly budget is 350 yuan, and I like quick dishes that take less than 30 minutes. I don't like mushrooms. Use the healthy-meal-planner skill to help me create a one-week meal plan. | ![healthy-meal-planner skill screenshot](assets/images_en/health-meal-planner-skill.png) | +| Please run the following workflow: 1. I need a vegan high-protein recipe for 2 people, with the goal of muscle gain. The weekly budget is 350 yuan, and I like quick dishes that take less than 30 minutes. I don't like mushrooms. Use the healthy-meal-planner skill to help me create a one-week meal plan. 2. Write the prepared meal plan to the file recipe.md, then use the tos-file-access skill to upload this file to the bucket {YOUR_TOS_BUCKET_NAME}, and finally send me the link to the uploaded file. | ![healthy-meal-planner skill upload result to TOS screenshot](assets/images_en/health-meal-planner-skill-tos.png) | ## FAQ @@ -259,8 +259,9 @@ None. ## References - [VeADK Official Documentation](https://volcengine.github.io/veadk-python/) -- [AgentKit Developer Guide](https://volcengine.github.io/agentkit-sdk-python/) -- [Volcengine Ark Model Service](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0&briefType=introduce&type=new&projectName=default) +- [AgentKit Development Guide](https://volcengine.github.io/agentkit-sdk-python/) +- [BytePlus Ark Model Service](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) + ## Code License diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/canvas-design-skill.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/canvas-design-skill.png new file mode 100644 index 00000000..97b22adf Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/canvas-design-skill.png differ diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/create.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/create.png new file mode 100644 index 00000000..260493e2 Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/create.png differ diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/health-meal-planner-skill-tos.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/health-meal-planner-skill-tos.png new file mode 100644 index 00000000..8db56597 Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/health-meal-planner-skill-tos.png differ diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/health-meal-planner-skill.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/health-meal-planner-skill.png new file mode 100644 index 00000000..52d71cae Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/health-meal-planner-skill.png differ diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/internal-comms-skill.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/internal-comms-skill.png new file mode 100644 index 00000000..b7ce4dd9 Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/internal-comms-skill.png differ diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/skill-sandbox-iam-role.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/skill-sandbox-iam-role.png new file mode 100644 index 00000000..18fe9f1b Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/skill-sandbox-iam-role.png differ diff --git a/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/veadk-skill.png b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/veadk-skill.png new file mode 100644 index 00000000..5bf05650 Binary files /dev/null and b/python/01-tutorials/04-agentkit-tools/skills_sandbox/assets/images_en/veadk-skill.png differ diff --git a/python/02-use-cases/ai_coding/README_en.md b/python/02-use-cases/ai_coding/README_en.md index 47ce4e37..1c159075 100644 --- a/python/02-use-cases/ai_coding/README_en.md +++ b/python/02-use-cases/ai_coding/README_en.md @@ -15,7 +15,7 @@ This use case demonstrates how to build a production-level AI programming assist ## Core Functionality -![AI Coding Agent with AgentKit Runtime](img/archtecture_ai_coding.jpg) +![AI Coding Agent with AgentKit Runtime](img/archtecture_ai_coding_en.png) ```text User Request @@ -72,7 +72,7 @@ ai_coding/ 1. Log in to the [BytePlus Console](https://console.byteplus.com) 2. Go to "Access Control" → "Users" -> Create a new user or search for an existing one -> Click the username to go to "User Details" -> Go to "Keys" -> Create a new key or copy an existing AK/SK. - As shown below: - ![BytePlus AK/SK Management](../../assets/images/volcengine_aksk.jpg) + ![BytePlus AK/SK Management](../../assets/images/volcengine_aksk_en.png) 3. Configure access permissions for services required by AgentKit: - On the "User Details" page -> Go to "Permissions" -> Click "Add Permission" and grant the following policies to the user: - `AgentKitFullAccess` (Full access to AgentKit) @@ -81,16 +81,16 @@ ai_coding/ - Log in to the [BytePlus Model Ark Console](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - Go to "API Key Management" -> Create or copy an existing API Key. The `MODEL_AGENT_API_KEY` environment variable will need to be set to this value. - As shown below: - ![Model Ark API Key Management](../../assets/images/ark_api_key_management.jpg) + ![Model Ark API Key Management](../../assets/images/ark_api_key_management_en.png) 5. Activate pre-built model inference endpoints: - Log in to the [BytePlus Model Ark Console](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - - Go to "Activation Management" -> "Language Models" -> Find the desired model -> Click "Activate Service". + - Go to "Foundation Models" -> Find the respective model -> Click "Access API". - Confirm activation and wait for the service to become effective (usually 1-2 minutes). - Activate the following models used in this case: - - `deepseek-v4-pro-260425` - - `doubao-seed-code-preview-251028` + - `deepseek-v4-pro-260425` + - `doubao-seed-code-preview-251028` - As shown below: - ![Model Ark Model Service Management](../../assets/images/ark_model_service_management.jpg) + ![Model Ark Model Service Management](../../assets/images/ark_model_service_management_en.png) #### AgentKit Tool ID @@ -100,7 +100,7 @@ ai_coding/ - Tool Name: `ai-coding-agent` - Description: AI Programming Assistant Tool 4. Copy the generated Tool ID for configuration (the `AGENTKIT_TOOL_ID` environment variable will need to be set to this value), as shown below: - ![AgentKit Sandbox Tool](../../assets/images/agentkit_sandbox_tool.jpg) + ![AgentKit Sandbox Tool](../../assets/images/agentkit_sandbox_tool_en.png) ### Install Dependencies diff --git a/python/02-use-cases/ai_coding/img/archtecture_ai_coding_en.png b/python/02-use-cases/ai_coding/img/archtecture_ai_coding_en.png new file mode 100644 index 00000000..36cf0b5d Binary files /dev/null and b/python/02-use-cases/ai_coding/img/archtecture_ai_coding_en.png differ diff --git a/python/02-use-cases/ai_coding/img/process_ai_coding_en.png b/python/02-use-cases/ai_coding/img/process_ai_coding_en.png new file mode 100644 index 00000000..4357f672 Binary files /dev/null and b/python/02-use-cases/ai_coding/img/process_ai_coding_en.png differ diff --git a/python/02-use-cases/customer_support/README_en.md b/python/02-use-cases/customer_support/README_en.md index 9c4aa14b..7ebe3ee4 100644 --- a/python/02-use-cases/customer_support/README_en.md +++ b/python/02-use-cases/customer_support/README_en.md @@ -14,7 +14,7 @@ This use case demonstrates how to build an enterprise-level customer support sys ## Core Functionality -![Customer Support Agent with AgentKit Runtime](img/archtecture_customer_support.jpg) +![Customer Support Agent with AgentKit Runtime](img/archtecture_customer_support_en.png) ```text Customer Inquiry @@ -72,7 +72,7 @@ customer_support/ 1. Log in to the [BytePlus Console](https://console.byteplus.com) 2. Go to "Access Control" → "Users" -> Create a new user or search for an existing one -> Click the username to go to "User Details" -> Go to "Keys" -> Create a new key or copy an existing AK/SK. - As shown below: - ![BytePlus AK/SK Management](../../assets/images/volcengine_aksk.jpg) + ![BytePlus AK/SK Management](../../assets/images/volcengine_aksk.jpg) 3. Configure access permissions for services required by AgentKit: - On the "User Details" page -> Go to "Permissions" -> Click "Add Permission" and grant the following policies to the user: - `AgentKitFullAccess` (Full access to AgentKit) @@ -81,15 +81,15 @@ customer_support/ - Log in to the [BytePlus Model Ark Console](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - Go to "API Key Management" -> Create or copy an existing API Key. The `MODEL_AGENT_API_KEY` environment variable will need to be set to this value. - As shown below: - ![Model Ark API Key Management](../../assets/images/ark_api_key_management.jpg) + ![Model Ark API Key Management](../../assets/images/ark_api_key_management_en.png) 5. Activate pre-built model inference endpoints: - Log in to the [BytePlus Model Ark Console](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - - Go to "Activation Management" -> "Language Models" -> Find the desired model -> Click "Activate Service". + - Go to "Foundation Models" -> Find the respective model -> Click "Access API". - Confirm activation and wait for the service to become effective (usually 1-2 minutes). - Activate the following models used in this case (you can also activate other models as needed and specify them in the `agent.py` code): - - `deepseek-v4-pro-260425` + - `deepseek-v4-pro-260425` - As shown below: - ![Model Ark Service Management](../../assets/images/ark_model_service_management.jpg) + ![Model Ark Service Management](../../assets/images/ark_model_service_management_en.png) **Knowledge Base (auto-configured on first run):**: @@ -153,6 +153,7 @@ export DATABASE_MEM0_API_KEY= ## Local Execution Use `veadk web` for local debugging: + > `veadk web` is a FastAPI-based web service for debugging Agent applications. Running this command starts a web server that loads and runs your AgentKit agent code, providing a chat interface to interact with the agent. In the sidebar or specific panels of the interface, you can view the agent's operational details, including its thought process, tool calls, and model inputs/outputs. ```bash diff --git a/python/02-use-cases/customer_support/img/archtecture_customer_support_en.png b/python/02-use-cases/customer_support/img/archtecture_customer_support_en.png new file mode 100644 index 00000000..a9328d78 Binary files /dev/null and b/python/02-use-cases/customer_support/img/archtecture_customer_support_en.png differ diff --git a/python/02-use-cases/store_inspection_assistant/README_en.md b/python/02-use-cases/store_inspection_assistant/README_en.md index 05247274..4909b8d7 100644 --- a/python/02-use-cases/store_inspection_assistant/README_en.md +++ b/python/02-use-cases/store_inspection_assistant/README_en.md @@ -69,7 +69,7 @@ Main BytePlus products or Agent components: 1. Log in to the [BytePlus Console](https://console.byteplus.com) 2. Go to "Access Control" → "Users" -> Create a new user or search for an existing username -> Click the username to enter "User Details" -> Go to "Keys" -> Create a new key or copy an existing AK/SK. - As shown below: - ![BytePlus AK/SK Management](../../assets/images/volcengine_aksk.jpg) + ![BytePlus AK/SK Management](../../assets/images/volcengine_aksk_en.png) 3. Configure access permissions for the services AgentKit depends on for the user: - On the "User Details" page -> Go to "Permissions" -> Click "Add Permission" and grant the following policies to the user: - `AgentKitFullAccess` (Full access to AgentKit) @@ -78,16 +78,15 @@ Main BytePlus products or Agent components: - Log in to the [BytePlus Model Ark Console](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - Go to "API Key Management" -> Create or copy an existing API Key. The `MODEL_AGENT_API_KEY` environment variable will need to be set to this value. - As shown below: - ![Model Ark API Key Management](../../assets/images/ark_api_key_management.jpg) + ![Model Ark API Key Management](../../assets/images/ark_api_key_management_en.png) 5. Activate pre-built model inference endpoints: - Log in to the [BytePlus Model Ark Console](https://console.byteplus.com/ark/region:ark+ap-southeast-1/overview) - - Go to "Activation Management" -> "Language Models" -> Find the respective model -> Click "Activate Service". - - Confirm activation and wait for the service to become effective (usually 1-2 minutes). + - Go to "Foundation Models" -> Find the respective model -> Click "Access API". - Activate the following models used in this case (you can also activate other models' pre-built inference endpoints as needed and specify them in the `agent.py` code): - `deepseek-v4-pro-260425` - `doubao-seed-2-0-pro-260215` - As shown below: - ![Model Ark Model Service Management](../../assets/images/ark_model_service_management.jpg) + ![Model Ark Model Service Management](../../assets/images/ark_model_service_management_en.png) ### Install Dependencies @@ -170,7 +169,7 @@ After successful deployment: The agent list page in AgentKit provides a debugging entry point. Click it to debug the agent's functionality in a visual UI. -![img](./img/agent-test-run.png) +![img](./img/agent-test-run-en.png) #### **Debugging with the command line** diff --git a/python/02-use-cases/store_inspection_assistant/img/agent-test-run-en.png b/python/02-use-cases/store_inspection_assistant/img/agent-test-run-en.png new file mode 100644 index 00000000..6bd239a0 Binary files /dev/null and b/python/02-use-cases/store_inspection_assistant/img/agent-test-run-en.png differ diff --git a/python/assets/images/agentkit_sandbox_tool_en.png b/python/assets/images/agentkit_sandbox_tool_en.png new file mode 100644 index 00000000..3df82250 Binary files /dev/null and b/python/assets/images/agentkit_sandbox_tool_en.png differ diff --git a/python/assets/images/ark_api_key_management_en.png b/python/assets/images/ark_api_key_management_en.png new file mode 100644 index 00000000..10def911 Binary files /dev/null and b/python/assets/images/ark_api_key_management_en.png differ diff --git a/python/assets/images/ark_model_service_management_en.png b/python/assets/images/ark_model_service_management_en.png new file mode 100644 index 00000000..0bbcc160 Binary files /dev/null and b/python/assets/images/ark_model_service_management_en.png differ diff --git a/python/assets/images/volcengine_aksk_en.png b/python/assets/images/volcengine_aksk_en.png new file mode 100644 index 00000000..a57ac94b Binary files /dev/null and b/python/assets/images/volcengine_aksk_en.png differ