cognis 0.3.1

Cognis umbrella crate: agent builder, multi-agent orchestration, memory, middleware (rate limit, retry, PII, prompt caching), built-in tools, and re-exports of cognis-core, cognis-graph, cognis-llm, and cognis-rag.
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

//! Planning middleware — inject a "plan first, execute after" instruction.
//!
//! This is the conservative, prompt-only variant. It nudges the model to
//! emit a numbered plan before running tools. For dynamic plan tracking
//! (mark steps in_progress / completed), use the `todo` middleware paired
//! with a todo-list tool.

use std::sync::Arc;

use async_trait::async_trait;

use cognis_core::{Message, Result};
use cognis_llm::chat::ChatResponse;

use super::{Middleware, MiddlewareCtx, Next};

const MARKER: &str = "<!-- cognis:planning-mw -->";
const DEFAULT_INSTRUCTION: &str =
    "Before taking any action, write out a short numbered plan of the steps \
     you'll take. Then execute each step. After completing all steps, \
     summarize the result.";

/// Inserts a planning instruction at the head of every request. Idempotent.
pub struct Planning {
    instruction: String,
}

impl Default for Planning {
    fn default() -> Self {
        Self::new()
    }
}

impl Planning {
    /// Default instruction.
    pub fn new() -> Self {
        Self {
            instruction: DEFAULT_INSTRUCTION.to_string(),
        }
    }

    /// Override the instruction.
    pub fn with_instruction(mut self, s: impl Into<String>) -> Self {
        self.instruction = s.into();
        self
    }
}

#[async_trait]
impl Middleware for Planning {
    async fn call(&self, mut ctx: MiddlewareCtx, next: Arc<dyn Next>) -> Result<ChatResponse> {
        let already = ctx
            .messages
            .iter()
            .any(|m| matches!(m, Message::System(s) if s.content.contains(MARKER)));
        if !already {
            let body = format!("{MARKER}\n{}", self.instruction);
            ctx.messages.insert(0, Message::system(body));
        }
        next.invoke(ctx).await
    }

    fn name(&self) -> &str {
        "Planning"
    }
}

#[cfg(test)]
mod tests {
    use super::super::tests_util::*;
    use super::*;
    use crate::middleware::MiddlewarePipeline;

    use cognis_llm::chat::ChatOptions;
    use cognis_llm::Client;

    #[tokio::test]
    async fn injects_planning_instruction() {
        let rec = make_recording_provider("ok");
        let pipe = MiddlewarePipeline::new()
            .push(Planning::new())
            .build(Client::new(rec.clone()));
        let _ = pipe
            .invoke(
                vec![Message::human("solve x")],
                Vec::new(),
                ChatOptions::default(),
            )
            .await
            .unwrap();
        let received = rec.received.lock().unwrap();
        assert!(received[0].0[0].content().contains(MARKER));
    }

    #[tokio::test]
    async fn idempotent_no_double_insert() {
        let rec = make_recording_provider("ok");
        let pipe = MiddlewarePipeline::new()
            .push(Planning::new())
            .build(Client::new(rec.clone()));
        let already = vec![
            Message::system(format!("{MARKER}\nold")),
            Message::human("hi"),
        ];
        let _ = pipe
            .invoke(already, Vec::new(), ChatOptions::default())
            .await
            .unwrap();
        let received = rec.received.lock().unwrap();
        let count = received[0]
            .0
            .iter()
            .filter(|m| m.content().contains(MARKER))
            .count();
        assert_eq!(count, 1);
    }
}