|
| 1 | +export const description = |
| 2 | + 'Robyn AI 提供代理与记忆功能,用于构建具有对话历史、上下文感知和可插拔 AI 运行器的智能应用。' |
| 3 | + |
| 4 | +# AI Agent 与 Memory |
| 5 | + |
| 6 | +Robyn 内置了 AI 能力,可让你创建带有对话记忆、上下文感知和可插拔代理运行器的智能应用。AI 模块为记忆存储和代理执行提供了抽象,便于与你的 Robyn 应用集成。 |
| 7 | + |
| 8 | +## 安装 |
| 9 | + |
| 10 | +AI 功能已包含在 Robyn 的基础安装中: |
| 11 | + |
| 12 | +```bash |
| 13 | +pip install robyn |
| 14 | +``` |
| 15 | + |
| 16 | + |
| 17 | +## 快速开始 |
| 18 | + |
| 19 | +下面是一个使用 Robyn AI 功能的简单示例: |
| 20 | + |
| 21 | +```python |
| 22 | +from robyn import Robyn |
| 23 | +from robyn.ai import agent, memory |
| 24 | + |
| 25 | +app = Robyn(__file__) |
| 26 | + |
| 27 | +# Create memory instance |
| 28 | +mem = memory(provider="inmemory", user_id="user123") |
| 29 | + |
| 30 | +# Create agent with memory |
| 31 | +chat_agent = agent(runner="simple", memory=mem) |
| 32 | + |
| 33 | +@app.get("/chat") |
| 34 | +async def chat_endpoint(request): |
| 35 | + query = request.query_params.get("q", [""])[0] |
| 36 | + if not query: |
| 37 | + return {"error": "Query required"} |
| 38 | + |
| 39 | + # Run agent with conversation history |
| 40 | + result = await chat_agent.run(query, history=True) |
| 41 | + return result |
| 42 | +``` |
| 43 | + |
| 44 | +## Memory 系统 |
| 45 | + |
| 46 | +Memory 系统一用于持久化存储对话历史与上下文。它支持多种提供者并提供一致的接口来存取对话数据。 |
| 47 | + |
| 48 | +### Memory 提供者 |
| 49 | + |
| 50 | +#### InMemory 提供者 |
| 51 | + |
| 52 | +最简单的提供者,数据存储在内存中。应用重启后数据会丢失。 |
| 53 | + |
| 54 | +```python |
| 55 | +from robyn.ai import memory |
| 56 | + |
| 57 | +# Create in-memory storage |
| 58 | +mem = memory(provider="inmemory", user_id="user123") |
| 59 | + |
| 60 | +# Add messages |
| 61 | +await mem.add("Hello, how are you?") |
| 62 | +await mem.add("I'm doing great, thanks!") |
| 63 | + |
| 64 | +# Retrieve all messages |
| 65 | +messages = await mem.get() |
| 66 | + |
| 67 | +# Clear memory |
| 68 | +await mem.clear() |
| 69 | +``` |
| 70 | + |
| 71 | + |
| 72 | +### Memory API |
| 73 | + |
| 74 | +Memory 类提供以下主要方法: |
| 75 | + |
| 76 | +- `add(message, metadata=None)` - 存储一条消息并可附带可选元数据 |
| 77 | +- `get(query=None)` - 检索消息,可按查询过滤 |
| 78 | +- `clear()` - 清除该用户的所有存储消息 |
| 79 | + |
| 80 | +## Agent 系统 |
| 81 | + |
| 82 | +Agents 提供 AI 功能的执行层。它们可以使用不同的 runner,并与 memory 集成以提供上下文感知的回复。 |
| 83 | + |
| 84 | +### Agent Runners |
| 85 | + |
| 86 | +#### Simple Runner |
| 87 | + |
| 88 | +带有 OpenAI 集成的 runner,可生成智能回复: |
| 89 | + |
| 90 | +```python |
| 91 | +from robyn.ai import agent |
| 92 | + |
| 93 | +# Create simple agent with OpenAI |
| 94 | +from robyn.ai import configure |
| 95 | + |
| 96 | +config = configure(openai_api_key="your-openai-key") |
| 97 | +simple_agent = agent(runner="simple", config=config) |
| 98 | + |
| 99 | +# Use the agent |
| 100 | +result = await simple_agent.run("What's the weather like?") |
| 101 | +# Returns structured response with AI-generated content |
| 102 | +``` |
| 103 | + |
| 104 | + |
| 105 | +### Agent API |
| 106 | + |
| 107 | +Agent 类提供: |
| 108 | + |
| 109 | +- `run(query, history=False, **kwargs)` - 执行代理并可选择包含历史上下文 |
| 110 | +- 在提供 memory 时自动进行记忆集成 |
| 111 | +- 支持自定义 runner 与配置 |
| 112 | + |
| 113 | +## 完整示例 |
| 114 | + |
| 115 | +下面是一个展示所有功能的综合示例: |
| 116 | + |
| 117 | +```python |
| 118 | +from robyn import Robyn |
| 119 | +from robyn.ai import agent, memory |
| 120 | + |
| 121 | +app = Robyn(__file__) |
| 122 | + |
| 123 | +# Create memory with InMemory provider |
| 124 | +mem = memory( |
| 125 | + provider="inmemory", |
| 126 | + user_id="guest" |
| 127 | +) |
| 128 | + |
| 129 | +# Create agent with memory |
| 130 | +chat_agent = agent(runner="simple", memory=mem) |
| 131 | + |
| 132 | +@app.get("/") |
| 133 | +async def home(): |
| 134 | + return {"message": "Robyn AI Chat API"} |
| 135 | + |
| 136 | +@app.post("/chat") |
| 137 | +async def chat(request): |
| 138 | + """Chat with AI agent""" |
| 139 | + data = request.json() |
| 140 | + query = data.get("query", "") |
| 141 | + include_history = data.get("history", True) |
| 142 | + |
| 143 | + if not query: |
| 144 | + return {"error": "Query is required"} |
| 145 | + |
| 146 | + try: |
| 147 | + result = await chat_agent.run(query, history=include_history) |
| 148 | + return { |
| 149 | + "query": query, |
| 150 | + "response": result.get("response"), |
| 151 | + "history_included": include_history |
| 152 | + } |
| 153 | + except Exception as e: |
| 154 | + return {"error": str(e)} |
| 155 | + |
| 156 | +@app.get("/memory") |
| 157 | +async def get_memory(): |
| 158 | + """Retrieve conversation history""" |
| 159 | + try: |
| 160 | + memories = await mem.get() |
| 161 | + return {"memories": memories, "count": len(memories)} |
| 162 | + except Exception as e: |
| 163 | + return {"error": str(e)} |
| 164 | + |
| 165 | +@app.delete("/memory") |
| 166 | +async def clear_memory(): |
| 167 | + """Clear conversation history""" |
| 168 | + try: |
| 169 | + await mem.clear() |
| 170 | + return {"message": "Memory cleared"} |
| 171 | + except Exception as e: |
| 172 | + return {"error": str(e)} |
| 173 | + |
| 174 | +@app.post("/memory") |
| 175 | +async def add_memory(request): |
| 176 | + """Add message to memory""" |
| 177 | + data = request.json() |
| 178 | + message = data.get("message", "") |
| 179 | + metadata = data.get("metadata", {}) |
| 180 | + |
| 181 | + if not message: |
| 182 | + return {"error": "Message is required"} |
| 183 | + |
| 184 | + try: |
| 185 | + await mem.add(message, metadata) |
| 186 | + return {"message": "Added to memory"} |
| 187 | + except Exception as e: |
| 188 | + return {"error": str(e)} |
| 189 | + |
| 190 | +if __name__ == "__main__": |
| 191 | + app.start(host="127.0.0.1", port=8080) |
| 192 | +``` |
| 193 | + |
| 194 | +## 高级用法 |
| 195 | + |
| 196 | +### 自定义 Memory 提供者 |
| 197 | + |
| 198 | +你可以通过扩展 `MemoryProvider` 抽象基类来创建自定义的 memory 提供者: |
| 199 | + |
| 200 | +```python |
| 201 | +from robyn.ai import MemoryProvider |
| 202 | +from typing import Dict, List, Any, Optional |
| 203 | + |
| 204 | +class CustomMemoryProvider(MemoryProvider): |
| 205 | + async def store(self, user_id: str, data: Dict[str, Any]) -> None: |
| 206 | + # Implement custom storage logic |
| 207 | + pass |
| 208 | + |
| 209 | + async def retrieve(self, user_id: str, query: Optional[str] = None) -> List[Dict[str, Any]]: |
| 210 | + # Implement custom retrieval logic |
| 211 | + return [] |
| 212 | + |
| 213 | + async def clear(self, user_id: str) -> None: |
| 214 | + # Implement custom clearing logic |
| 215 | + pass |
| 216 | + |
| 217 | +# Use custom provider |
| 218 | +from robyn.ai import Memory |
| 219 | +custom_mem = Memory(provider=CustomMemoryProvider(), user_id="user123") |
| 220 | +``` |
| 221 | + |
| 222 | +### 自定义 Agent Runners |
| 223 | + |
| 224 | +类似地,你可以创建自定义的 agent runner: |
| 225 | + |
| 226 | +```python |
| 227 | +from robyn.ai import AgentRunner |
| 228 | +from typing import Dict, Any |
| 229 | + |
| 230 | +class CustomAgentRunner(AgentRunner): |
| 231 | + async def run(self, query: str, **kwargs) -> Dict[str, Any]: |
| 232 | + # Implement custom agent logic |
| 233 | + return { |
| 234 | + "response": f"Custom response to: {query}", |
| 235 | + "processed": True |
| 236 | + } |
| 237 | + |
| 238 | +# Use custom runner |
| 239 | +from robyn.ai import Agent |
| 240 | +custom_agent = Agent(runner=CustomAgentRunner()) |
| 241 | +``` |
| 242 | + |
| 243 | +## 最佳实践 |
| 244 | + |
| 245 | +1. **用户隔离**:始终使用唯一的用户 ID 来隔离不同用户之间的记忆 |
| 246 | +2. **错误处理**:将 AI 操作放在 try-catch 块中,因为外部服务可能会失败 |
| 247 | +3. **记忆管理**:定期清理或归档旧的记忆以防止无限增长 |
| 248 | +4. **配置管理**:将敏感配置(API 密钥等)存储在环境变量中 |
| 249 | +5. **测试**:在部署复杂代理之前,在开发和测试中使用 simple runner |
| 250 | + |
| 251 | +## 故障排查 |
| 252 | + |
| 253 | +### 常见问题 |
| 254 | + |
| 255 | +**ImportError for openai**: Install the required package: |
| 256 | +```bash |
| 257 | +pip install openai |
| 258 | +``` |
| 259 | + |
| 260 | +**Memory not persisting**:请注意,InMemory 提供者在应用重启时会丢失数据。生产环境请考虑实现持久化的自定义提供者。 |
| 261 | + |
| 262 | +**Agent timeouts**:复杂的操作可能耗时较长。建议在你的端点中实现超时处理以避免请求长时间挂起。 |
| 263 | + |
| 264 | +**Memory growing too large**:定期清理记忆或使用具有内置保留策略的提供者,以防记忆体积无限增长。 |
0 commit comments