File size: 9,022 Bytes
d90101d | 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 | use serde_json::json;
use crate::{
Context, ContextMessage, MessageEntry, ModelId, ToolCallFull, ToolCallId, ToolName, ToolResult,
};
/// Converts a condensed string pattern into a Context with messages.
///
/// This utility type is primarily used in tests to quickly create Context
/// objects with specific message sequences without verbose setup code.
///
/// # Pattern Format
///
/// Each character in the pattern represents a message with a specific role:
/// - `'u'` = User message
/// - `'a'` = Assistant message
/// - `'s'` = System message
/// - `'t'` = Assistant message with tool call
/// - `'r'` = Tool result message
///
/// # Examples
///
/// ```rust,ignore
/// // Creates: User -> Assistant -> User
/// let context = MessagePattern::new("uau").build();
///
/// // Creates: System -> System -> User -> System -> User -> System -> User -> System -> Assistant -> Assistant -> System -> Assistant
/// let context = MessagePattern::new("ssusususaasa").build();
///
/// // Creates: User -> Assistant with tool call -> Tool result -> User
/// let context = MessagePattern::new("utru").build();
/// ```
#[derive(Debug, Clone)]
pub struct MessagePattern {
pattern: String,
}
impl MessagePattern {
/// Creates a new MessagePattern from the given pattern string.
///
/// # Arguments
///
/// * `pattern` - A string where each character represents a message role:
/// - `'u'` for User
/// - `'a'` for Assistant
/// - `'s'` for System
/// - `'t'` for Assistant with tool call
/// - `'r'` for Tool result
pub fn new(pattern: impl Into<String>) -> Self {
Self { pattern: pattern.into() }
}
/// Builds a Context from the pattern.
///
/// Each message will have content in the format "Message {index}" where
/// index starts from 1. Tool calls and tool results use predefined test
/// data.
///
/// # Panics
///
/// Panics if the pattern contains any character other than 'u', 'a', 's',
/// 't', or 'r'.
pub fn build(self) -> Context {
let model_id = ModelId::new("gpt-4");
let tool_call = ToolCallFull {
name: ToolName::new("read"),
call_id: Some(ToolCallId::new("call_123")),
arguments: json!({"path": "/test/path"}).into(),
thought_signature: None,
};
let tool_result = ToolResult::new(ToolName::new("read"))
.call_id(ToolCallId::new("call_123"))
.success(json!({"content": "File content"}).to_string());
let messages: Vec<MessageEntry> = self
.pattern
.chars()
.enumerate()
.map(|(i, c)| {
let content = format!("Message {}", i + 1);
match c {
'u' => ContextMessage::user(&content, Some(model_id.clone())),
'a' => ContextMessage::assistant(&content, None, None, None),
's' => ContextMessage::system(&content),
't' => ContextMessage::assistant(
&content,
None,
None,
Some(vec![tool_call.clone()]),
),
'r' => ContextMessage::tool_result(tool_result.clone()),
_ => {
panic!("Invalid character '{c}' in pattern. Use 'u', 'a', 's', 't', or 'r'")
}
}
})
.map(MessageEntry::from)
.collect();
Context::default().messages(messages)
}
}
impl From<&str> for MessagePattern {
fn from(pattern: &str) -> Self {
Self::new(pattern)
}
}
impl From<String> for MessagePattern {
fn from(pattern: String) -> Self {
Self::new(pattern)
}
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use super::*;
use crate::{ContextMessage, ModelId, Role, TextMessage};
#[test]
fn test_message_pattern_single_user() {
let fixture = MessagePattern::new("u");
let actual = fixture.build();
let expected = Context::default().messages(vec![
ContextMessage::Text(
TextMessage::new(Role::User, "Message 1").model(ModelId::new("gpt-4")),
)
.into(),
]);
assert_eq!(actual, expected);
}
#[test]
fn test_message_pattern_user_assistant_user() {
let fixture = MessagePattern::new("uau");
let actual = fixture.build();
let expected = Context::default().messages(vec![
ContextMessage::Text(
TextMessage::new(Role::User, "Message 1").model(ModelId::new("gpt-4")),
)
.into(),
ContextMessage::Text(TextMessage::new(Role::Assistant, "Message 2")).into(),
ContextMessage::Text(
TextMessage::new(Role::User, "Message 3").model(ModelId::new("gpt-4")),
)
.into(),
]);
assert_eq!(actual, expected);
}
#[test]
fn test_message_pattern_complex() {
let fixture = MessagePattern::new("ssusususaasa");
let actual = fixture.build();
assert_eq!(actual.messages.len(), 12);
assert!(actual.messages[0].has_role(Role::System));
assert!(actual.messages[1].has_role(Role::System));
assert!(actual.messages[2].has_role(Role::User));
assert!(actual.messages[3].has_role(Role::System));
assert!(actual.messages[4].has_role(Role::User));
assert!(actual.messages[5].has_role(Role::System));
assert!(actual.messages[6].has_role(Role::User));
assert!(actual.messages[7].has_role(Role::System));
assert!(actual.messages[8].has_role(Role::Assistant));
assert!(actual.messages[9].has_role(Role::Assistant));
assert!(actual.messages[10].has_role(Role::System));
assert!(actual.messages[11].has_role(Role::Assistant));
}
#[test]
fn test_message_pattern_empty() {
let fixture = MessagePattern::new("");
let actual = fixture.build();
let expected = Context::default();
assert_eq!(actual, expected);
}
#[test]
fn test_message_pattern_all_system() {
let fixture = MessagePattern::new("sss");
let actual = fixture.build();
assert_eq!(actual.messages.len(), 3);
assert!(actual.messages.iter().all(|m| m.has_role(Role::System)));
}
#[test]
#[should_panic(expected = "Invalid character 'x' in pattern. Use 'u', 'a', 's', 't', or 'r'")]
fn test_message_pattern_invalid_character() {
let fixture = MessagePattern::new("uax");
fixture.build();
}
#[test]
fn test_message_pattern_from_str() {
let fixture = MessagePattern::from("ua");
let actual = fixture.build();
assert_eq!(actual.messages.len(), 2);
}
#[test]
fn test_message_pattern_from_string() {
let fixture = MessagePattern::from("ua".to_string());
let actual = fixture.build();
assert_eq!(actual.messages.len(), 2);
}
#[test]
fn test_message_pattern_content_numbering() {
let fixture = MessagePattern::new("uau");
let actual = fixture.build();
assert_eq!(actual.messages[0].content().unwrap(), "Message 1");
assert_eq!(actual.messages[1].content().unwrap(), "Message 2");
assert_eq!(actual.messages[2].content().unwrap(), "Message 3");
}
#[test]
fn test_message_pattern_with_tool_call() {
let fixture = MessagePattern::new("utr");
let actual = fixture.build();
assert_eq!(actual.messages.len(), 3);
assert!(actual.messages[0].has_role(Role::User));
assert!(actual.messages[1].has_role(Role::Assistant));
assert!(actual.messages[1].has_tool_call());
assert!(actual.messages[2].has_tool_result());
}
#[test]
fn test_message_pattern_with_multiple_tool_calls() {
let fixture = MessagePattern::new("utrtr");
let actual = fixture.build();
assert_eq!(actual.messages.len(), 5);
assert!(actual.messages[1].has_tool_call());
assert!(actual.messages[2].has_tool_result());
assert!(actual.messages[3].has_tool_call());
assert!(actual.messages[4].has_tool_result());
}
#[test]
fn test_message_pattern_complex_with_tools() {
let fixture = MessagePattern::new("sutruaua");
let actual = fixture.build();
assert_eq!(actual.messages.len(), 8);
assert!(actual.messages[0].has_role(Role::System));
assert!(actual.messages[1].has_role(Role::User));
assert!(actual.messages[2].has_tool_call());
assert!(actual.messages[3].has_tool_result());
assert!(actual.messages[4].has_role(Role::User));
assert!(actual.messages[5].has_role(Role::Assistant));
assert!(actual.messages[6].has_role(Role::User));
assert!(actual.messages[7].has_role(Role::Assistant));
}
}
|