rucora 0.1.4

High-performance, type-safe LLM agent framework with built-in tools and multi-provider support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
//! rucora 中间件示例
//!
//! 展示中间件系统的概念和使用方法,以及如何将中间件内嵌到不同类型的 Agent 中。
//!
//! ## 运行方法
//! ```bash
//! cargo run --example 08_middleware
//! ```
//!
//! ## 功能演示
//!
//! 1. **中间件链** - 创建和配置中间件链
//! 2. **自定义中间件** - 实现认证、过滤、格式化中间件
//! 3. **SimpleAgent + 中间件** - 简单问答场景
//! 4. **ChatAgent + 中间件** - 多轮对话场景
//! 5. **ToolAgent + 中间件** - 工具调用场景
//! 6. **ReActAgent + 中间件** - 推理行动场景
//! 7. **ReflectAgent + 中间件** - 反思迭代场景

use async_trait::async_trait;
use rucora::agent::{ChatAgent, ReActAgent, ReflectAgent, SimpleAgent, ToolAgent};
use rucora::middleware::{
    CacheMiddleware, LoggingMiddleware, MetricsMiddleware, Middleware, MiddlewareChain,
    RateLimitMiddleware,
};
use rucora::prelude::Agent;
use rucora::provider::OpenAiProvider;
use rucora::tools::EchoTool;
use rucora_core::agent::{AgentError, AgentInput, AgentOutput};
use rucora_core::tool::types::{ToolCall, ToolResult};
use serde_json::json;
use tracing::{Level, info};
use tracing_subscriber::FmtSubscriber;

// ═══════════════════════════════════════════════════════════
// 自定义中间件示例
// ═══════════════════════════════════════════════════════════

/// 自定义认证中间件
///
/// 验证用户身份(示例实现)
#[derive(Clone)]
struct AuthMiddleware {
    api_key: String,
}

impl AuthMiddleware {
    fn new(api_key: impl Into<String>) -> Self {
        Self {
            api_key: api_key.into(),
        }
    }
}

#[async_trait]
impl Middleware for AuthMiddleware {
    fn name(&self) -> &str {
        "auth"
    }

    async fn on_request(&self, input: &mut AgentInput) -> Result<(), AgentError> {
        // 检查输入中是否包含 API Key
        if !self.api_key.is_empty() {
            info!("middleware.auth: 验证 API Key...");
            // 简化实现:实际应该验证 token 或 session
            if input.text.contains("UNAUTHORIZED") {
                return Err(AgentError::Message("认证失败:无效的 API Key".to_string()));
            }
        }
        Ok(())
    }

    async fn on_response(&self, _output: &mut AgentOutput) -> Result<(), AgentError> {
        info!("middleware.auth: 响应已验证");
        Ok(())
    }
}

/// 自定义敏感词过滤中间件
///
/// 过滤输入中的敏感词
#[derive(Clone)]
struct SensitiveWordFilterMiddleware {
    sensitive_words: Vec<String>,
}

impl SensitiveWordFilterMiddleware {
    fn new(sensitive_words: Vec<&str>) -> Self {
        Self {
            sensitive_words: sensitive_words.into_iter().map(String::from).collect(),
        }
    }
}

#[async_trait]
impl Middleware for SensitiveWordFilterMiddleware {
    fn name(&self) -> &str {
        "sensitive_word_filter"
    }

    async fn on_request(&self, input: &mut AgentInput) -> Result<(), AgentError> {
        let mut filtered = input.text.clone();
        for word in &self.sensitive_words {
            if filtered.contains(word.as_str()) {
                info!(
                    "middleware.sensitive_word_filter: 检测到敏感词 \"{}\"",
                    word
                );
                filtered = filtered.replace(word.as_str(), "***");
            }
        }
        input.text = filtered;
        Ok(())
    }
}

/// 自定义响应格式化中间件
///
/// 格式化输出内容
#[derive(Clone)]
struct ResponseFormatMiddleware;

#[async_trait]
impl Middleware for ResponseFormatMiddleware {
    fn name(&self) -> &str {
        "response_format"
    }

    async fn on_response(&self, output: &mut AgentOutput) -> Result<(), AgentError> {
        // 在响应中添加格式化标记
        info!("middleware.response_format: 格式化响应");

        // 修改输出内容,添加标记
        if let Some(content) = output.value.as_object_mut() {
            content.insert("formatted".to_string(), json!(true));
        }

        Ok(())
    }
}

/// 工具调用日志中间件
///
/// 记录工具调用的输入输出
#[derive(Clone)]
struct ToolCallLoggingMiddleware;

#[async_trait]
impl Middleware for ToolCallLoggingMiddleware {
    fn name(&self) -> &str {
        "tool_call_logging"
    }

    async fn on_tool_call_before(&self, call: &mut ToolCall) -> Result<(), AgentError> {
        info!(
            "middleware.tool_call_before: 工具调用 \"{}\", 输入:{}",
            call.name, call.input
        );
        Ok(())
    }

    async fn on_tool_call_after(&self, result: &mut ToolResult) -> Result<(), AgentError> {
        info!(
            "middleware.tool_call_after: 工具结果 \"{}\", 输出:{}",
            result.tool_call_id, result.output
        );
        Ok(())
    }
}

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    dotenv::dotenv().ok();

    // 初始化日志
    let subscriber = FmtSubscriber::builder()
        .with_max_level(Level::INFO)
        .with_target(false)
        .finish();
    tracing::subscriber::set_global_default(subscriber)?;

    info!("╔════════════════════════════════════════╗");
    info!("║   rucora 中间件系统示例             ║");
    info!("╚════════════════════════════════════════╝\n");

    // 检查配置
    let has_api_config =
        std::env::var("OPENAI_API_KEY").is_ok() || std::env::var("OPENAI_BASE_URL").is_ok();

    if !has_api_config {
        info!("⚠ 未设置 API 配置");
        info!("   使用 OpenAI: export OPENAI_API_KEY=sk-your-key");
        info!("   使用 Ollama: export OPENAI_BASE_URL=http://localhost:11434");
        info!("\n注意:以下 Agent 演示将跳过实际 API 调用\n");
    }

    let model_name = std::env::var("MODEL_NAME").unwrap_or_else(|_| "gpt-4o-mini".to_string());

    // ═══════════════════════════════════════════════════════════
    // 示例 1: 创建中间件链
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 1: 创建中间件链");
    info!("═══════════════════════════════════════\n");

    info!("1.1 创建中间件链...");
    let chain = MiddlewareChain::new()
        .with(LoggingMiddleware::new())
        .with(CacheMiddleware::new())
        .with(RateLimitMiddleware::new(100));

    info!("✓ 中间件链创建成功");
    info!("  中间件数量:{}\n", chain.len());

    // ═══════════════════════════════════════════════════════════
    // 示例 2: 指标收集中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 2: 指标收集中间件");
    info!("═══════════════════════════════════════\n");

    info!("2.1 创建指标中间件...");
    let metrics = MetricsMiddleware::new();
    info!("✓ 指标中间件创建成功\n");

    info!("2.2 初始指标:");
    info!("  请求计数:{}", metrics.get_request_count());
    info!("  响应计数:{}\n", metrics.get_response_count());

    // ═══════════════════════════════════════════════════════════
    // 示例 3: 自定义中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 3: 自定义中间件");
    info!("═══════════════════════════════════════\n");

    info!("3.1 创建认证中间件...");
    let auth_middleware = AuthMiddleware::new("sk-test-key");
    info!("✓ 认证中间件创建成功\n");

    info!("3.2 创建敏感词过滤中间件...");
    let filter_middleware = SensitiveWordFilterMiddleware::new(vec!["敏感词", "违规"]);
    info!("✓ 敏感词过滤中间件创建成功\n");

    info!("3.3 创建响应格式化中间件...");
    let format_middleware = ResponseFormatMiddleware;
    info!("✓ 响应格式化中间件创建成功\n");

    info!("3.4 创建工具调用日志中间件...");
    let tool_call_logging = ToolCallLoggingMiddleware;
    info!("✓ 工具调用日志中间件创建成功\n");

    // ═══════════════════════════════════════════════════════════
    // 示例 4: SimpleAgent + 中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 4: SimpleAgent + 中间件");
    info!("═══════════════════════════════════════\n");

    if has_api_config {
        info!("4.1 创建 Provider...");
        let provider = OpenAiProvider::from_env()?;
        info!("✓ Provider 创建成功\n");

        info!("4.2 创建带中间件的 SimpleAgent...");
        let simple_agent = SimpleAgent::builder()
            .provider(provider)
            .model(&model_name)
            .system_prompt("你是一个翻译助手,负责将中文翻译成英文。")
            .temperature(0.3)
            .with_middleware(LoggingMiddleware::new())
            .with_middleware(RateLimitMiddleware::new(60))
            .build();
        info!("✓ SimpleAgent 创建成功(带日志和限流中间件)\n");

        info!("4.3 测试 SimpleAgent...");
        let task = "你好";
        info!("  输入:\"{}\"", task);

        match simple_agent.run(task.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");
    } else {
        info!("⚠ 跳过 SimpleAgent 测试(未设置 API Key)\n");
    }

    // ═══════════════════════════════════════════════════════════
    // 示例 5: ChatAgent + 中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 5: ChatAgent + 中间件");
    info!("═══════════════════════════════════════\n");

    if has_api_config {
        info!("5.1 创建 Provider...");
        let provider = OpenAiProvider::from_env()?;
        info!("✓ Provider 创建成功\n");

        info!("5.2 创建带中间件和对话历史的 ChatAgent...");
        let chat_agent = ChatAgent::builder()
            .provider(provider)
            .model(&model_name)
            .system_prompt("你是友好的心理咨询助手。")
            .with_conversation(true)
            .with_middleware_chain(
                MiddlewareChain::new()
                    .with(LoggingMiddleware::new())
                    .with(CacheMiddleware::new())
                    .with(auth_middleware.clone()),
            )
            .build();
        info!("✓ ChatAgent 创建成功(带日志、缓存、认证中间件)\n");

        info!("5.3 测试 ChatAgent - 第一轮...");
        let task1 = "我今天心情不好";
        info!("  输入:\"{}\"", task1);

        match chat_agent.run(task1.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");

        info!("5.4 测试 ChatAgent - 第二轮(保持上下文)...");
        let task2 = "因为工作压力大";
        info!("  输入:\"{}\"", task2);

        match chat_agent.run(task2.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");
    } else {
        info!("⚠ 跳过 ChatAgent 测试(未设置 API Key)\n");
    }

    // ═══════════════════════════════════════════════════════════
    // 示例 6: ToolAgent + 中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 6: ToolAgent + 中间件");
    info!("═══════════════════════════════════════\n");

    if has_api_config {
        info!("6.1 创建 Provider...");
        let provider = OpenAiProvider::from_env()?;
        info!("✓ Provider 创建成功\n");

        info!("6.2 创建带中间件的 ToolAgent...");
        let tool_agent = ToolAgent::builder()
            .provider(provider)
            .model(&model_name)
            .system_prompt("你是一个友好的助手。")
            .tool(EchoTool)
            .with_middleware(LoggingMiddleware::new())
            .with_middleware(CacheMiddleware::new())
            .with_middleware(MetricsMiddleware::new())
            .with_middleware(filter_middleware.clone())
            .with_middleware(format_middleware.clone())
            .with_middleware(tool_call_logging.clone())
            .max_steps(5)
            .build();
        info!("✓ ToolAgent 创建成功(带多个中间件,包括工具调用日志)\n");

        info!("6.3 测试 ToolAgent...");
        let task = "你好,这是一个测试。";
        info!("  输入:\"{}\"", task);

        match tool_agent.run(task.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                    info!("  输出值:{:?}", output.value);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");

        info!("6.4 测试敏感词过滤...");
        let task2 = "这是一个敏感词测试,包含违规内容。";
        info!("  输入:\"{}\"", task2);

        match tool_agent.run(task2.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");
    } else {
        info!("⚠ 跳过 ToolAgent 测试(未设置 API Key)\n");
    }

    // ═══════════════════════════════════════════════════════════
    // 示例 7: ReActAgent + 中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 7: ReActAgent + 中间件");
    info!("═══════════════════════════════════════\n");

    if has_api_config {
        info!("7.1 创建 Provider...");
        let provider = OpenAiProvider::from_env()?;
        info!("✓ Provider 创建成功\n");

        info!("7.2 创建带中间件的 ReActAgent...");
        let react_agent = ReActAgent::builder()
            .provider(provider)
            .model(&model_name)
            .system_prompt("你是一个善于推理的助手。请先思考,再行动。")
            .tool(EchoTool)
            .with_middleware_chain(
                MiddlewareChain::new()
                    .with(LoggingMiddleware::new())
                    .with(RateLimitMiddleware::new(30)),
            )
            .max_steps(15)
            .build();
        info!("✓ ReActAgent 创建成功(带日志和限流中间件)\n");

        info!("7.3 测试 ReActAgent...");
        let task = "请重复这句话:Hello, ReAct!";
        info!("  输入:\"{}\"", task);

        match react_agent.run(task.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");
    } else {
        info!("⚠ 跳过 ReActAgent 测试(未设置 API Key)\n");
    }

    // ═══════════════════════════════════════════════════════════
    // 示例 8: ReflectAgent + 中间件
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 8: ReflectAgent + 中间件");
    info!("═══════════════════════════════════════\n");

    if has_api_config {
        info!("8.1 创建 Provider...");
        let provider = OpenAiProvider::from_env()?;
        info!("✓ Provider 创建成功\n");

        info!("8.2 创建带中间件的 ReflectAgent...");
        let reflect_agent = ReflectAgent::builder()
            .provider(provider)
            .model(&model_name)
            .system_prompt("你是一个追求卓越的助手。请不断反思和改进你的答案。")
            .with_middleware(LoggingMiddleware::new())
            .with_middleware(ResponseFormatMiddleware)
            .max_iterations(3)
            .build();
        info!("✓ ReflectAgent 创建成功(带日志和格式化中间件)\n");

        info!("8.3 测试 ReflectAgent...");
        let task = "用一句话解释什么是人工智能。";
        info!("  输入:\"{}\"", task);

        match reflect_agent.run(task.into()).await {
            Ok(output) => {
                if let Some(text) = output.text() {
                    info!("  输出:\"{}\"", text);
                    info!("  输出值:{:?}", output.value);
                }
            }
            Err(e) => {
                info!("  Agent 运行出错:{}", e);
            }
        }
        info!("");
    } else {
        info!("⚠ 跳过 ReflectAgent 测试(未设置 API Key)\n");
    }

    // ═══════════════════════════════════════════════════════════
    // 示例 9: 中间件执行流程说明
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例 9: 中间件执行流程");
    info!("═══════════════════════════════════════\n");

    info!("9.1 请求处理流程:");
    info!("  用户输入 → LoggingMiddleware → RateLimitMiddleware");
    info!("           → CacheMiddleware → AuthMiddleware");
    info!("           → SensitiveWordFilter → Agent 处理\n");

    info!("9.2 响应处理流程(逆序):");
    info!("  Agent 输出 → ResponseFormat → AuthMiddleware");
    info!("             → CacheMiddleware → RateLimitMiddleware");
    info!("             → LoggingMiddleware → 用户\n");

    info!("9.3 错误处理流程(逆序):");
    info!("  错误 → AuthMiddleware → CacheMiddleware");
    info!("       → RateLimitMiddleware → LoggingMiddleware");
    info!("       → 返回给用户\n");

    // ═══════════════════════════════════════════════════════════
    // 总结
    // ═══════════════════════════════════════════════════════════
    info!("═══════════════════════════════════════");
    info!("示例完成!");
    info!("═══════════════════════════════════════\n");

    info!("📝 中间件系统总结:\n");

    info!("1. 支持的 Agent 类型:");
    info!("   - SimpleAgent: 简单问答");
    info!("   - ChatAgent: 多轮对话");
    info!("   - ToolAgent: 工具调用");
    info!("   - ReActAgent: 推理 + 行动");
    info!("   - ReflectAgent: 反思迭代\n");

    info!("2. 中间件链:");
    info!("   - 按顺序执行所有中间件");
    info!("   - 支持请求前、响应后、错误处理钩子");
    info!("   - 内嵌到所有 Agent 执行流程中\n");

    info!("3. 内置中间件:");
    info!("   - LoggingMiddleware: 日志记录");
    info!("   - RateLimitMiddleware: 请求限流");
    info!("   - CacheMiddleware: 响应缓存");
    info!("   - MetricsMiddleware: 指标收集\n");

    info!("4. 自定义中间件:");
    info!("   - 实现 Middleware trait");
    info!("   - 实现 name()、on_request()、on_response()、on_error()");
    info!("   - 可以修改输入和输出\n");

    info!("5. 与 Agent 集成:");
    info!("   - 方式 1: with_middleware_chain() 一次性设置");
    info!("   - 方式 2: with_middleware() 逐个添加");
    info!("   - 所有 Agent 类型都支持中间件\n");

    info!("6. 使用场景:");
    info!("   - 横切关注点:日志、监控、认证");
    info!("   - 请求预处理:参数验证、数据转换");
    info!("   - 响应后处理:格式化、压缩");
    info!("   - 错误处理:统一错误格式\n");

    Ok(())
}