cb9b16e5a8
包含： - 核心配置文件（AGENTS.md, SOUL.md, USER.md等） - 记忆系统（memory/文件夹） - 技能库（skills/文件夹） - 小说内容（novel/文件夹） - .gitignore配置
126 lines
3.2 KiB
Markdown
126 lines
3.2 KiB
Markdown
# Agent 定义方法
|
||
|
||
## 导入方法
|
||
|
||
- LLM Agent: `from veadk import Agent`
|
||
- Sequential Agent: `from veadk.agents.sequential_agent import SequentialAgent`
|
||
- Loop Agent: `from veadk.agents.loop_agent import LoopAgent`
|
||
|
||
其中，LLM Agent 是最基础的智能体（由 LLM 启动进行自主决策），Sequential Agent 是按顺序执行的智能体，Loop Agent 是循环执行的智能体。
|
||
|
||
## 代码规范
|
||
|
||
你可以通过如下方式定义智能体：
|
||
|
||
```python
|
||
root_agent = Agent(
|
||
name="...",
|
||
description="...",
|
||
instruction="...", # 智能体系统提示词
|
||
sub_agents=[sub_agent] # 子智能体列表
|
||
)
|
||
|
||
sub_agent = Agent(
|
||
name="...",
|
||
description="...",
|
||
instruction="...", # 智能体系统提示词
|
||
)
|
||
```
|
||
|
||
你也可以生成一个强制按顺序执行的智能体：
|
||
|
||
```python
|
||
sub_agent_1 = Agent(
|
||
name="...",
|
||
description="...",
|
||
instruction="...", # 智能体系统提示词
|
||
)
|
||
|
||
sub_agent_2 = Agent(
|
||
name="...",
|
||
description="...",
|
||
instruction="...", # 智能体系统提示词
|
||
)
|
||
|
||
# SequentialAgent 只需要写入 sub_agent 即可
|
||
root_agent = SequentialAgent(
|
||
sub_agents=[sub_agent_1, sub_agent_2] # 子智能体列表
|
||
)
|
||
```
|
||
|
||
`sub_agent_1` 与 `sub_agent_2` 将会严格按顺序执行
|
||
|
||
注意，根智能体的命名必须为 `root_agent`。
|
||
|
||
## 让 Agent 结构化输出
|
||
|
||
为保证更高的准确率和 Agent 执行时的可控性，使用结构化输出是一种有效的手段。
|
||
|
||
在定义 Agent 时，通过 `model_extra_config={"response_format": ...}` 可以让 Agent 结构化输出。其中，`...` 是你定义的 Pydantic 模型，用于描述 Agent 的输出格式。
|
||
|
||
```python
|
||
from pydantic import BaseModel
|
||
from veadk import Agent, Runner
|
||
|
||
|
||
# 定义分步解析模型（对应业务场景的结构化响应）
|
||
class Step(BaseModel):
|
||
explanation: str # 步骤说明
|
||
output: str # 步骤计算结果
|
||
|
||
|
||
# 定义最终响应模型（包含分步过程和最终答案）
|
||
class MathResponse(BaseModel):
|
||
steps: list[Step] # 解题步骤列表
|
||
final_answer: str # 最终答案
|
||
|
||
|
||
agent = Agent(
|
||
instruction="你是一位数学辅导老师，需详细展示解题步骤",
|
||
model_extra_config={"response_format": MathResponse},
|
||
)
|
||
```
|
||
|
||
运行完毕后，你需要将结果解析为你定义的 Pydantic 模型，例如：
|
||
|
||
```python
|
||
import asyncio
|
||
import json
|
||
|
||
from veadk import Agent, Runner
|
||
|
||
agent = Agent()
|
||
runner = Runner(agent=agent) # 挂载想要运行的 Agent
|
||
|
||
response = asyncio.run(runner.run("你好")) # 使用 `run` 函数执行
|
||
response = json.loads(response)
|
||
|
||
parsed_response = MathResponse(**response)
|
||
print(parsed_response) # BaseModel 实例
|
||
```
|
||
|
||
## 运行 Agent
|
||
|
||
如果你想直接在 Python 中执行 Agent，可以通过定义 Runner 来执行：
|
||
|
||
```python
|
||
import asyncio
|
||
|
||
from veadk import Agent, Runner
|
||
|
||
agent = Agent()
|
||
runner = Runner(agent=agent) # 挂载想要运行的 Agent
|
||
|
||
response = asyncio.run(runner.run("你好")) # 使用 `run` 函数执行
|
||
print(response)
|
||
```
|
||
|
||
通常情况下，你可以定义一个函数来将 Agent 的执行封装起来，例如：
|
||
|
||
```python
|
||
async def run_agent(agent: Agent, prompt: str) -> str:
|
||
runner = Runner(agent=agent)
|
||
response = await runner.run(prompt)
|
||
return response
|
||
```
|